Class: Rails::PluginBuilder

Inherits:
Object
  • Object
show all
Defined in:
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

DUMMY_IGNORE_OPTIONS = 
%i[dev edge master template]

Instance Method Summary collapse

Instance Method Details

#app ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 20

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

    empty_directory_with_keep_file "app/models/concerns"
    empty_directory_with_keep_file "app/controllers/concerns"
    remove_dir "app/mailers" if options[:skip_action_mailer]
    remove_dir "app/jobs" if options[:skip_active_job]
  elsif full?
    empty_directory_with_keep_file "app/models"
    empty_directory_with_keep_file "app/controllers"
    empty_directory_with_keep_file "app/models/concerns"
    empty_directory_with_keep_file "app/controllers/concerns"
    empty_directory_with_keep_file "app/mailers" unless options[:skip_action_mailer]
    empty_directory_with_keep_file "app/jobs" unless options[:skip_active_job]

    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_manifest ⇒ Object 



170
171
172
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 170

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

#bin ⇒ Object 



183
184
185
186
187
188
189
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 183

def bin
  exclude_pattern = Regexp.union([(engine? ? /test\.tt/ : /rails\.tt/), (/rubocop/ if skip_rubocop?)].compact)
  directory "bin", { exclude_pattern: exclude_pattern } do |content|
    "#{shebang}\n" + content
  end
  chmod "bin", 0755 & ~File.umask, verbose: false
end

#cifiles ⇒ Object 



69
70
71
72
73
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 69

def cifiles
  empty_directory ".github/workflows"
  template "github/ci.yml", ".github/workflows/ci.yml"
  template "github/dependabot.yml", ".github/dependabot.yml"
end

#config ⇒ Object 



97
98
99
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 97

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

#gemfile ⇒ Object 



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

def gemfile
  template "Gemfile"
end

#gemfile_entry ⇒ Object 



191
192
193
194
195
196
197
198
199
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 191

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

#gemspec ⇒ Object 



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

def gemspec
  template "%name%.gemspec"
end

#generate_test_dummy(force = false) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 122

def generate_test_dummy(force = false)
  opts = options.transform_keys(&:to_sym).except(*DUMMY_IGNORE_OPTIONS)
  opts[:force] = force
  opts[:skip_brakeman] = true
  opts[:skip_bundle] = true
  opts[:skip_ci] = true
  opts[:skip_git] = true
  opts[:skip_hotwire] = true
  opts[:skip_rubocop] = true
  opts[:dummy_app] = true

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

#gitignore ⇒ Object 



65
66
67
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 65

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

#lib ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 85

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

#license ⇒ Object 



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

def license
  template "MIT-LICENSE" unless inside_application?
end

#rakefile ⇒ Object 



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

def rakefile
  template "Rakefile"
end

#readme ⇒ Object 



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

def readme
  template "README.md"
end

#rubocop ⇒ Object 



75
76
77
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 75

def rubocop
  template "rubocop.yml", ".rubocop.yml"
end

#stylesheets ⇒ Object 



174
175
176
177
178
179
180
181
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 174

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

#test ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 101

def test
  template "test/test_helper.rb"
  template "test/%namespaced_name%_test.rb"

  if engine?
    empty_directory_with_keep_file "test/fixtures/files"
    empty_directory_with_keep_file "test/controllers"
    empty_directory_with_keep_file "test/mailers"
    empty_directory_with_keep_file "test/models"
    empty_directory_with_keep_file "test/integration"

    unless api?
      empty_directory_with_keep_file "test/helpers"
    end

    template "test/integration/navigation_test.rb"
  end
end

#test_dummy_clean ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 157

def test_dummy_clean
  inside dummy_path do
    remove_file ".ruby-version"
    remove_dir "db"
    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_config ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 137

def test_dummy_config
  template "rails/boot.rb", "#{dummy_path}/config/boot.rb", force: true

  if mountable?
    template "rails/routes.rb", "#{dummy_path}/config/routes.rb", force: true
  end
  if engine? && !api?
    insert_into_file "#{dummy_path}/config/application.rb", indent(<<~RUBY, 4), after: /^\s*config\.load_defaults.*\n/

      # For compatibility with applications that use this config
      config.action_controller.include_all_helpers = false
    RUBY
  end
end

#test_dummy_sprocket_assets ⇒ Object 



152
153
154
155
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 152

def test_dummy_sprocket_assets
  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

#version_control ⇒ Object 



79
80
81
82
83
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 79

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