Class: Rails::Generators::PluginGenerator

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

Overview

:nodoc:

Constant Summary

Constants inherited from AppBase

AppBase::BUN_VERSION, AppBase::NODE_LTS_VERSION

Constants included from AppName

AppName::RESERVED_NAMES

Constants included from Database

Database::DATABASES, Database::JDBC_DATABASES

Instance Attribute Summary

Attributes inherited from AppBase

#rails_template

Instance Method Summary collapse

Methods inherited from AppBase

add_shared_options_for, edge_branch, strict_args_position

Methods included from Database

#build_package_for_database, #convert_database_option_for_jruby, #deploy_package_for_database, #docker_for_database_build, #docker_for_database_deploy, #gem_for_database

Methods inherited from Base

base_root, class_option, default_source_root, desc, exit_on_failure?, hide!, hook_for, inherited, namespace, remove_hook_for, source_root

Methods included from Actions

#add_source, #environment, #gem, #gem_group, #generate, #git, #github, #initializer, #lib, #rails_command, #rake, #rakefile, #readme, #route, #vendor

Constructor Details

#initialize(*args) ⇒ PluginGenerator

Returns a new instance of PluginGenerator.



214
215
216
217
218
219
220
221
222
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 214

def initialize(*args)
  @dummy_path = nil
  super
  imply_options

  if !engine? || !with_dummy_app?
    self.options = options.merge(skip_asset_pipeline: true).freeze
  end
end

Instance Method Details

#create_app_filesObject



242
243
244
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 242

def create_app_files
  build(:app)
end

#create_assets_manifest_fileObject



254
255
256
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 254

def create_assets_manifest_file
  build(:assets_manifest) if !api? && engine?
end

#create_bin_filesObject



262
263
264
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 262

def create_bin_files
  build(:bin)
end

#create_config_filesObject



246
247
248
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 246

def create_config_files
  build(:config)
end

#create_lib_filesObject



250
251
252
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 250

def create_lib_files
  build(:lib)
end

#create_public_stylesheets_filesObject



258
259
260
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 258

def create_public_stylesheets_files
  build(:stylesheets) unless api?
end

#create_root_filesObject



232
233
234
235
236
237
238
239
240
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 232

def create_root_files
  build(:readme)
  build(:rakefile)
  build(:gemspec)   unless options[:skip_gemspec]
  build(:license)
  build(:gitignore) unless options[:skip_git]
  build(:gemfile)
  build(:version_control)
end

#create_test_dummy_filesObject



270
271
272
273
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 270

def create_test_dummy_files
  return unless with_dummy_app?
  create_dummy_app
end

#create_test_filesObject



266
267
268
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 266

def create_test_files
  build(:test) unless options[:skip_test]
end

#finish_templateObject



279
280
281
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 279

def finish_template
  build(:leftovers)
end

#nameObject



285
286
287
288
289
290
291
292
293
294
295
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 285

def name
  @name ||= begin
    # same as ActiveSupport::Inflector#underscore except not replacing '-'
    underscored = original_name.dup
    underscored.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
    underscored.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
    underscored.downcase!

    underscored
  end
end

#namespaced_nameObject



301
302
303
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 301

def namespaced_name
  @namespaced_name ||= name.tr("-", "/")
end

#target_rails_prereleaseObject



228
229
230
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 228

def target_rails_prerelease
  super("plugin new")
end

#underscored_nameObject



297
298
299
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 297

def underscored_name
  @underscored_name ||= original_name.underscore
end

#update_gemfileObject



275
276
277
# File 'railties/lib/rails/generators/rails/plugin/plugin_generator.rb', line 275

def update_gemfile
  build(:gemfile_entry) unless options[:skip_gemfile_entry]
end