aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/generators/base.rb
diff options
context:
space:
mode:
authorCarlos Antonio da Silva <carlosantoniodasilva@gmail.com>2012-02-03 09:17:59 -0200
committerCarlos Antonio da Silva <carlosantoniodasilva@gmail.com>2012-02-03 10:18:58 -0200
commitc6ef45d6c4e718b306ba8309e15ee5c1fb532878 (patch)
tree41808274ab680486545c44f47ccfc52564d610d8 /railties/lib/rails/generators/base.rb
parent2abaa19e77d1097730cfa6e0924ee7c1660ac01f (diff)
downloadrails-c6ef45d6c4e718b306ba8309e15ee5c1fb532878.tar.gz
rails-c6ef45d6c4e718b306ba8309e15ee5c1fb532878.tar.bz2
rails-c6ef45d6c4e718b306ba8309e15ee5c1fb532878.zip
Add convenience method to hide a generator from the available ones
It is usually useful to be able to hide a generator when running rails generate command. Such generators might be used only to dry up generators code and shouldn't be available to end users.
Diffstat (limited to 'railties/lib/rails/generators/base.rb')
-rw-r--r--railties/lib/rails/generators/base.rb6
1 files changed, 6 insertions, 0 deletions
diff --git a/railties/lib/rails/generators/base.rb b/railties/lib/rails/generators/base.rb
index 8f779316c1..60e94486bb 100644
--- a/railties/lib/rails/generators/base.rb
+++ b/railties/lib/rails/generators/base.rb
@@ -48,6 +48,12 @@ module Rails
@namespace ||= super.sub(/_generator$/, '').sub(/:generators:/, ':')
end
+ # Convenience method to hide this generator from the available ones when
+ # running rails generator command.
+ def self.hide!
+ Rails::Generators.hide_namespace self.namespace
+ end
+
# Invoke a generator based on the value supplied by the user to the
# given option named "name". A class option is created when this method
# is invoked and you can set a hash to customize it.