Class: Rails::Generators::PluginGenerator

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

Overview

:nodoc:

Constant Summary

Constants inherited from AppBase

AppBase::DATABASES, AppBase::JDBC_DATABASES

Instance Attribute Summary

Attributes inherited from AppBase

#rails_template

Instance Method Summary collapse

Methods inherited from AppBase

add_shared_options_for, strict_args_position

Methods inherited from Base

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

Methods included from Actions

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

Constructor Details

#initialize(*args) ⇒ PluginGenerator

Returns a new instance of PluginGenerator.



195
196
197
198
199
200
201
202
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 195

def initialize(*args)
  @dummy_path = nil
  super

  unless plugin_path
    raise Error, "Plugin name should be provided in arguments. For details run: rails plugin new --help"
  end
end

Instance Method Details

#create_app_files ⇒ Object 



216
217
218
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 216

def create_app_files
  build(:app)
end

#create_assets_manifest_file ⇒ Object 



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

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

#create_bin_files ⇒ Object 



240
241
242
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 240

def create_bin_files
  build(:bin)
end

#create_config_files ⇒ Object 



220
221
222
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 220

def create_config_files
  build(:config)
end

#create_javascript_files ⇒ Object 



236
237
238
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 236

def create_javascript_files
  build(:javascripts) unless api?
end

#create_lib_files ⇒ Object 



224
225
226
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 224

def create_lib_files
  build(:lib)
end

#create_public_stylesheets_files ⇒ Object 



232
233
234
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 232

def create_public_stylesheets_files
  build(:stylesheets) unless api?
end

#create_root_files ⇒ Object 



207
208
209
210
211
212
213
214
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 207

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

#create_test_dummy_files ⇒ Object 



248
249
250
251
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 248

def create_test_dummy_files
  return unless with_dummy_app?
  create_dummy_app
end

#create_test_files ⇒ Object 



244
245
246
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 244

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

#finish_template ⇒ Object 



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

def finish_template
  build(:leftovers)
end

#name ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 269

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



285
286
287
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 285

def namespaced_name
  @namespaced_name ||= name.gsub('-', '/')
end

#run_after_bundle_callbacks ⇒ Object 



263
264
265
266
267
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 263

def run_after_bundle_callbacks
  @after_bundle_callbacks.each do |callback|
    callback.call
  end
end

#underscored_name ⇒ Object 



281
282
283
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 281

def underscored_name
  @underscored_name ||= original_name.underscore
end

#update_gemfile ⇒ Object 



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

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