Methods
A
C
F
H
I
K
M
N
P
R
S
T
U
W
Attributes
[R] file_name
[R] singular_name
Class Protected methods
check_class_collision(options={})

Add a class collisions name to be checked on class initialization. You can supply a hash with a :prefix or :suffix to be tested.

Examples

check_class_collision :suffix => "Observer"

If the generator is invoked with class name Admin, it will check for the presence of “AdminObserver”.

# File railties/lib/rails/generators/named_base.rb, line 179
def self.check_class_collision(options={})
  define_method :check_class_collision do
    name = if self.respond_to?(:controller_class_name) # for ScaffoldBase
      controller_class_name
    else
      class_name
    end

    class_collisions "#{options[:prefix]}#{name}#{options[:suffix]}"
  end
end
Instance Public methods
template(source, *args, &block)
# File railties/lib/rails/generators/named_base.rb, line 25
def template(source, *args, &block)
  inside_template do
    super
  end
end
Instance Protected methods
application_name()

Tries to retrieve the application name or simple return application.

# File railties/lib/rails/generators/named_base.rb, line 144
def application_name
  if defined?(Rails) && Rails.application
    Rails.application.class.name.split('::').first.underscore
  else
    "application"
  end
end
class_name()
# File railties/lib/rails/generators/named_base.rb, line 96
def class_name
  (class_path + [file_name]).map!{ |m| m.camelize }.join('::')
end
class_path()
# File railties/lib/rails/generators/named_base.rb, line 77
def class_path
  inside_template? || !namespaced? ? regular_class_path : namespaced_class_path
end
file_path()
# File railties/lib/rails/generators/named_base.rb, line 73
def file_path
  @file_path ||= (class_path + [file_name]).join('/')
end
human_name()
# File railties/lib/rails/generators/named_base.rb, line 100
def human_name
  @human_name ||= singular_name.humanize
end
i18n_scope()
# File railties/lib/rails/generators/named_base.rb, line 108
def i18n_scope
  @i18n_scope ||= file_path.gsub('/', '.')
end
indent(content, multiplier = 2)
# File railties/lib/rails/generators/named_base.rb, line 44
def indent(content, multiplier = 2)
  spaces = " " * multiplier
  content = content.each_line.map {|line| "#{spaces}#{line}" }.join
end
index_helper()
# File railties/lib/rails/generators/named_base.rb, line 123
def index_helper
  uncountable? ? "#{plural_table_name}_index" : plural_table_name
end
inside_template()
# File railties/lib/rails/generators/named_base.rb, line 54
def inside_template
  @inside_template = true
  yield
ensure
  @inside_template = false
end
inside_template?()
# File railties/lib/rails/generators/named_base.rb, line 61
def inside_template?
  @inside_template
end
key_value(key, value)

Returns Ruby 1.9 style key-value pair if current code is running on Ruby 1.9.x. Returns the old-style (with hash rocket) otherwise.

# File railties/lib/rails/generators/named_base.rb, line 193
def key_value(key, value)
  if options[:old_style_hash] || RUBY_VERSION < '1.9'
    ":#{key} => #{value}"
  else
    "#{key}: #{value}"
  end
end
module_namespacing(&block)

Wrap block with namespace of current application if namespace exists and is not skipped

# File railties/lib/rails/generators/named_base.rb, line 38
def module_namespacing(&block)
  content = capture(&block)
  content = wrap_with_namespace(content) if namespaced?
  concat(content)
end
namespace()
# File railties/lib/rails/generators/named_base.rb, line 65
def namespace
  Rails::Generators.namespace
end
namespaced?()
# File railties/lib/rails/generators/named_base.rb, line 69
def namespaced?
  !options[:skip_namespace] && namespace
end
namespaced_class_path()
# File railties/lib/rails/generators/named_base.rb, line 89
def namespaced_class_path
  @namespaced_class_path ||= begin
    namespace_path = namespace.name.split("::").map {|m| m.underscore }
    namespace_path + @class_path
  end
end
namespaced_file_path()
# File railties/lib/rails/generators/named_base.rb, line 85
def namespaced_file_path
  @namespaced_file_path ||= namespaced_class_path.join("/")
end
plural_file_name()
# File railties/lib/rails/generators/named_base.rb, line 135
def plural_file_name
  @plural_file_name ||= file_name.pluralize
end
plural_name()
# File railties/lib/rails/generators/named_base.rb, line 104
def plural_name
  @plural_name ||= singular_name.pluralize
end
plural_table_name()
# File railties/lib/rails/generators/named_base.rb, line 131
def plural_table_name
  @plural_table_name ||= (pluralize_table_names? ? table_name : table_name.pluralize)
end
pluralize_table_names?()
# File railties/lib/rails/generators/named_base.rb, line 165
def pluralize_table_names?
  !defined?(ActiveRecord::Base) || ActiveRecord::Base.pluralize_table_names
end
regular_class_path()
# File railties/lib/rails/generators/named_base.rb, line 81
def regular_class_path
  @class_path
end
route_url()
# File railties/lib/rails/generators/named_base.rb, line 139
def route_url
  @route_url ||= class_path.collect{|dname| "/" + dname  }.join('') + "/" + plural_file_name
end
singular_table_name()
# File railties/lib/rails/generators/named_base.rb, line 127
def singular_table_name
  @singular_table_name ||= (pluralize_table_names? ? table_name.singularize : table_name)
end
table_name()
# File railties/lib/rails/generators/named_base.rb, line 112
def table_name
  @table_name ||= begin
    base = pluralize_table_names? ? plural_name : singular_name
    (class_path + [base]).join('_')
  end
end
uncountable?()
# File railties/lib/rails/generators/named_base.rb, line 119
def uncountable?
  singular_name == plural_name
end
wrap_with_namespace(content)
# File railties/lib/rails/generators/named_base.rb, line 49
def wrap_with_namespace(content)
  content = indent(content).chomp
  "module #{namespace.name}\n#{content}\nend\n"
end