aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails_generator/generators/components
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/rails_generator/generators/components')
-rw-r--r--railties/lib/rails_generator/generators/components/plugin/USAGE17
-rw-r--r--railties/lib/rails_generator/generators/components/plugin/plugin_generator.rb12
-rw-r--r--railties/lib/rails_generator/generators/components/plugin/templates/USAGE8
-rw-r--r--railties/lib/rails_generator/generators/components/plugin/templates/generator.rb8
4 files changed, 43 insertions, 2 deletions
diff --git a/railties/lib/rails_generator/generators/components/plugin/USAGE b/railties/lib/rails_generator/generators/components/plugin/USAGE
index 55e35be595..e858ada9b9 100644
--- a/railties/lib/rails_generator/generators/components/plugin/USAGE
+++ b/railties/lib/rails_generator/generators/components/plugin/USAGE
@@ -7,6 +7,9 @@ Description:
The generator creates a plugin directory in vendor/plugins that includes
both init.rb and README files as well as lib, task, and test directories.
+ It's also possible to generate stub files for a generator to go with the
+ plugin by using --with-generator
+
Example:
./script/generate plugin BrowserFilters
@@ -15,4 +18,16 @@ Example:
vendor/plugins/browser_filters/init.rb
vendor/plugins/browser_filters/lib/browser_filters.rb
vendor/plugins/browser_filters/test/browser_filters_test.rb
- vendor/plugins/browser_filters/tasks/browser_filters_tasks.rake \ No newline at end of file
+ vendor/plugins/browser_filters/tasks/browser_filters_tasks.rake
+
+ ./script/generate plugin BrowserFilters --with-generator
+
+ This will create:
+ vendor/plugins/browser_filters/README
+ vendor/plugins/browser_filters/init.rb
+ vendor/plugins/browser_filters/lib/browser_filters.rb
+ vendor/plugins/browser_filters/test/browser_filters_test.rb
+ vendor/plugins/browser_filters/tasks/browser_filters_tasks.rake
+ vendor/plugins/browser_filters/generators/browser_filters/browser_filters_generator.rb
+ vendor/plugins/browser_filters/generators/browser_filters/USAGE
+ vendor/plugins/browser_filters/generators/browser_filters/templates/ \ No newline at end of file
diff --git a/railties/lib/rails_generator/generators/components/plugin/plugin_generator.rb b/railties/lib/rails_generator/generators/components/plugin/plugin_generator.rb
index d43a8df03f..18ac5a1c5c 100644
--- a/railties/lib/rails_generator/generators/components/plugin/plugin_generator.rb
+++ b/railties/lib/rails_generator/generators/components/plugin/plugin_generator.rb
@@ -1,7 +1,8 @@
class PluginGenerator < Rails::Generator::NamedBase
attr_reader :plugin_path
- def initialize(*args)
+ def initialize(runtime_args, runtime_options = {})
+ @with_generator = runtime_args.delete("--with-generator")
super
@plugin_path = "vendor/plugins/#{file_name}"
end
@@ -18,6 +19,15 @@ class PluginGenerator < Rails::Generator::NamedBase
m.template 'plugin.rb', "#{plugin_path}/lib/#{file_name}.rb"
m.template 'tasks.rake', "#{plugin_path}/tasks/#{file_name}_tasks.rake"
m.template 'unit_test.rb', "#{plugin_path}/test/#{file_name}_test.rb"
+
+ if @with_generator
+ m.directory "#{plugin_path}/generators"
+ m.directory "#{plugin_path}/generators/#{file_name}"
+ m.directory "#{plugin_path}/generators/#{file_name}/templates"
+
+ m.template 'generator.rb', "#{plugin_path}/generators/#{file_name}/#{file_name}_generator.rb"
+ m.template 'USAGE', "#{plugin_path}/generators/#{file_name}/USAGE"
+ end
end
end
end
diff --git a/railties/lib/rails_generator/generators/components/plugin/templates/USAGE b/railties/lib/rails_generator/generators/components/plugin/templates/USAGE
new file mode 100644
index 0000000000..f927799428
--- /dev/null
+++ b/railties/lib/rails_generator/generators/components/plugin/templates/USAGE
@@ -0,0 +1,8 @@
+Description:
+ Explain the generator
+
+Example:
+ ./script/generate <%= file_name %> Thing
+
+ This will create:
+ what/will/it/create \ No newline at end of file
diff --git a/railties/lib/rails_generator/generators/components/plugin/templates/generator.rb b/railties/lib/rails_generator/generators/components/plugin/templates/generator.rb
new file mode 100644
index 0000000000..3e800df6c5
--- /dev/null
+++ b/railties/lib/rails_generator/generators/components/plugin/templates/generator.rb
@@ -0,0 +1,8 @@
+class <%= class_name %>Generator < Rails::Generator::NamedBase
+ def manifest
+ record do |m|
+ # m.directory "lib"
+ # m.template 'README', "README"
+ end
+ end
+end