Class: Rails::PluginBuilder

Inherits:
Object show all
Defined in:
railties/lib/rails/generators/rails/plugin/plugin_generator.rb

Overview

The plugin builder allows you to override elements of the plugin generator without being forced to reverse the operations of the default generator.

This allows you to override entire operations, like the creation of the Gemfile, README, or JavaScript files, without needing to know exactly what those operations do so you can create another template action.

Constant Summary collapse

PASSTHROUGH_OPTIONS =
[
  :skip_active_record, :skip_active_storage, :skip_action_mailer, :skip_javascript, :skip_action_cable, :skip_sprockets, :database,
  :api, :quiet, :pretend, :skip
]

Instance Method Summary collapse

Instance Method Details

#appObject


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 19

def app
  if mountable?
    if api?
      directory "app", exclude_pattern: %r{app/(views|helpers)}
    else
      directory "app"
      empty_directory_with_keep_file "app/assets/images/#{namespaced_name}"
    end
  elsif full?
    empty_directory_with_keep_file "app/models"
    empty_directory_with_keep_file "app/controllers"
    empty_directory_with_keep_file "app/mailers"

    unless api?
      empty_directory_with_keep_file "app/assets/images/#{namespaced_name}"
      empty_directory_with_keep_file "app/helpers"
      empty_directory_with_keep_file "app/views"
    end
  end
end

#assets_manifestObject


141
142
143
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 141

def assets_manifest
  template "rails/engine_manifest.js", "app/assets/config/#{underscored_name}_manifest.js"
end

#bin(force = false) ⇒ Object


154
155
156
157
158
159
160
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 154

def bin(force = false)
  bin_file = engine? ? "bin/rails.tt" : "bin/test.tt"
  template bin_file, force: force do |content|
    "#{shebang}\n" + content
  end
  chmod "bin", 0755, verbose: false
end

#configObject


78
79
80
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 78

def config
  template "config/routes.rb" if engine?
end

#gemfileObject


44
45
46
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 44

def gemfile
  template "Gemfile"
end

#gemfile_entryObject


162
163
164
165
166
167
168
169
170
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 162

def gemfile_entry
  return unless inside_application?

  gemfile_in_app_path = File.join(rails_app_path, "Gemfile")
  if File.exist? gemfile_in_app_path
    entry = "\ngem '#{name}', path: '#{relative_path}'"
    append_file gemfile_in_app_path, entry
  end
end

#gemspecObject


52
53
54
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 52

def gemspec
  template "%name%.gemspec"
end

#generate_test_dummy(force = false) ⇒ Object


100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 100

def generate_test_dummy(force = false)
  opts = (options.dup || {}).keep_if { |k, _| PASSTHROUGH_OPTIONS.map(&:to_s).include?(k) }
  opts[:force] = force
  opts[:skip_bundle] = true
  opts[:skip_listen] = true
  opts[:skip_git] = true
  opts[:skip_turbolinks] = true
  opts[:skip_webpack_install] = true
  opts[:dummy_app] = true

  invoke Rails::Generators::AppGenerator,
    [ File.expand_path(dummy_path, destination_root) ], opts
end

#gitignoreObject


56
57
58
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 56

def gitignore
  template "gitignore", ".gitignore"
end

#libObject


66
67
68
69
70
71
72
73
74
75
76
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 66

def lib
  template "lib/%namespaced_name%.rb"
  template "lib/tasks/%namespaced_name%_tasks.rake"
  template "lib/%namespaced_name%/version.rb"

  if engine?
    template "lib/%namespaced_name%/engine.rb"
  else
    template "lib/%namespaced_name%/railtie.rb"
  end
end

#licenseObject


48
49
50
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 48

def license
  template "MIT-LICENSE"
end

#rakefileObject


15
16
17
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 15

def rakefile
  template "Rakefile"
end

#readmeObject


40
41
42
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 40

def readme
  template "README.md"
end

#stylesheetsObject


145
146
147
148
149
150
151
152
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 145

def stylesheets
  if mountable?
    copy_file "rails/stylesheets.css",
              "app/assets/stylesheets/#{namespaced_name}/application.css"
  elsif full?
    empty_directory_with_keep_file "app/assets/stylesheets/#{namespaced_name}"
  end
end

#testObject


82
83
84
85
86
87
88
89
90
91
92
93
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 82

def test
  template "test/test_helper.rb"
  template "test/%namespaced_name%_test.rb"
  append_file "Rakefile", <<-EOF

#{rakefile_test_tasks}
task default: :test
  EOF
  if engine?
    template "test/integration/navigation_test.rb"
  end
end

#test_dummy_assetsObject


122
123
124
125
126
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 122

def test_dummy_assets
  template "rails/javascripts.js",    "#{dummy_path}/app/javascript/packs/application.js", force: true
  template "rails/stylesheets.css",   "#{dummy_path}/app/assets/stylesheets/application.css", force: true
  template "rails/dummy_manifest.js", "#{dummy_path}/app/assets/config/manifest.js", force: true
end

#test_dummy_cleanObject


128
129
130
131
132
133
134
135
136
137
138
139
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 128

def test_dummy_clean
  inside dummy_path do
    remove_file ".ruby-version"
    remove_file "db/seeds.rb"
    remove_file "Gemfile"
    remove_file "lib/tasks"
    remove_file "public/robots.txt"
    remove_file "README.md"
    remove_file "test"
    remove_file "vendor"
  end
end

#test_dummy_configObject


114
115
116
117
118
119
120
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 114

def test_dummy_config
  template "rails/boot.rb", "#{dummy_path}/config/boot.rb", force: true
  template "rails/application.rb", "#{dummy_path}/config/application.rb", force: true
  if mountable?
    template "rails/routes.rb", "#{dummy_path}/config/routes.rb", force: true
  end
end

#version_controlObject


60
61
62
63
64
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 60

def version_control
  if !options[:skip_git] && !options[:pretend]
    run "git init", capture: options[:quiet], abort_on_failure: false
  end
end