Methods
A
C
E
F
H
I
J
M
N
P
R
S
T
U
W
Attributes
[R] file_name

TODO Change this to private once we've dropped Ruby 2.2 support. Workaround for Ruby 2.2 “private attribute?” warning.

Class Private 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: "Decorator"

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

# File railties/lib/rails/generators/named_base.rb, line 228
def self.check_class_collision(options = {}) # :doc:
  define_method :check_class_collision do
    name = if 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
js_template(source, destination)
# File railties/lib/rails/generators/named_base.rb, line 30
def js_template(source, destination)
  template(source + ".js", destination + ".js")
end
template(source, *args, &block)
# File railties/lib/rails/generators/named_base.rb, line 24
def template(source, *args, &block)
  inside_template do
    super
  end
end
Instance Private methods
application_name()

Tries to retrieve the application name or simply return application.

# File railties/lib/rails/generators/named_base.rb, line 181
def application_name # :doc:
  if defined?(Rails) && Rails.application
    Rails.application.class.name.split("::").first.underscore
  else
    "application"
  end
end
attributes_names()
# File railties/lib/rails/generators/named_base.rb, line 202
def attributes_names # :doc:
  @attributes_names ||= attributes.each_with_object([]) do |a, names|
    names << a.column_name
    names << "password_confirmation" if a.password_digest?
    names << "#{a.name}_type" if a.polymorphic?
  end
end
class_name()
# File railties/lib/rails/generators/named_base.rb, line 109
def class_name # :doc:
  (class_path + [file_name]).map!(&:camelize).join("::")
end
class_path()
# File railties/lib/rails/generators/named_base.rb, line 93
def class_path # :doc:
  inside_template? || !namespaced? ? regular_class_path : namespaced_class_path
end
edit_helper()
# File railties/lib/rails/generators/named_base.rb, line 144
def edit_helper # :doc:
  "edit_#{show_helper}"
end
file_path()
# File railties/lib/rails/generators/named_base.rb, line 89
def file_path # :doc:
  @file_path ||= (class_path + [file_name]).join("/")
end
fixture_file_name()
# File railties/lib/rails/generators/named_base.rb, line 168
def fixture_file_name # :doc:
  @fixture_file_name ||= (pluralize_table_names? ? plural_file_name : file_name)
end
human_name()
# File railties/lib/rails/generators/named_base.rb, line 113
def human_name # :doc:
  @human_name ||= singular_name.humanize
end
i18n_scope()
# File railties/lib/rails/generators/named_base.rb, line 121
def i18n_scope # :doc:
  @i18n_scope ||= file_path.tr("/", ".")
end
indent(content, multiplier = 2)
# File railties/lib/rails/generators/named_base.rb, line 56
def indent(content, multiplier = 2) # :doc:
  spaces = " " * multiplier
  content.each_line.map { |line| line.blank? ? line : "#{spaces}#{line}" }.join
end
index_helper()
# File railties/lib/rails/generators/named_base.rb, line 136
def index_helper # :doc:
  uncountable? ? "#{plural_table_name}_index" : plural_table_name
end
inside_template()
# File railties/lib/rails/generators/named_base.rb, line 66
def inside_template # :doc:
  @inside_template = true
  yield
ensure
  @inside_template = false
end
inside_template?()
# File railties/lib/rails/generators/named_base.rb, line 73
def inside_template? # :doc:
  @inside_template
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 50
def module_namespacing(&block) # :doc:
  content = capture(&block)
  content = wrap_with_namespace(content) if namespaced?
  concat(content)
end
mountable_engine?()
# File railties/lib/rails/generators/named_base.rb, line 214
def mountable_engine? # :doc:
  defined?(ENGINE_ROOT) && namespaced?
end
namespace()
# File railties/lib/rails/generators/named_base.rb, line 77
def namespace # :doc:
  Rails::Generators.namespace
end
namespaced?()
# File railties/lib/rails/generators/named_base.rb, line 81
def namespaced? # :doc:
  !options[:skip_namespace] && namespace
end
namespaced_class_path()
# File railties/lib/rails/generators/named_base.rb, line 101
def namespaced_class_path # :doc:
  @namespaced_class_path ||= namespace_dirs + @class_path
end
namespaced_path()
# File railties/lib/rails/generators/named_base.rb, line 105
def namespaced_path # :doc:
  @namespaced_path ||= namespace_dirs.join("/")
end
new_helper()
# File railties/lib/rails/generators/named_base.rb, line 148
def new_helper # :doc:
  "new_#{singular_table_name}_url"
end
plural_file_name()
# File railties/lib/rails/generators/named_base.rb, line 164
def plural_file_name # :doc:
  @plural_file_name ||= file_name.pluralize
end
plural_name()
# File railties/lib/rails/generators/named_base.rb, line 117
def plural_name # :doc:
  @plural_name ||= singular_name.pluralize
end
plural_table_name()
# File railties/lib/rails/generators/named_base.rb, line 160
def plural_table_name # :doc:
  @plural_table_name ||= (pluralize_table_names? ? table_name : table_name.pluralize)
end
pluralize_table_names?()
# File railties/lib/rails/generators/named_base.rb, line 210
def pluralize_table_names? # :doc:
  !defined?(ActiveRecord::Base) || ActiveRecord::Base.pluralize_table_names
end
regular_class_path()
# File railties/lib/rails/generators/named_base.rb, line 97
def regular_class_path # :doc:
  @class_path
end
route_url()
# File railties/lib/rails/generators/named_base.rb, line 172
def route_url # :doc:
  @route_url ||= class_path.collect { |dname| "/" + dname }.join + "/" + plural_file_name
end
show_helper()
# File railties/lib/rails/generators/named_base.rb, line 140
def show_helper # :doc:
  "#{singular_table_name}_url(@#{singular_table_name})"
end
singular_name()

FIXME: We are avoiding to use alias because a bug on thor that make this method public and add it to the task list.

# File railties/lib/rails/generators/named_base.rb, line 44
def singular_name # :doc:
  file_name
end
singular_table_name()
# File railties/lib/rails/generators/named_base.rb, line 156
def singular_table_name # :doc:
  @singular_table_name ||= (pluralize_table_names? ? table_name.singularize : table_name)
end
table_name()
# File railties/lib/rails/generators/named_base.rb, line 125
def table_name # :doc:
  @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 132
def uncountable? # :doc:
  singular_name == plural_name
end
url_helper_prefix()
# File railties/lib/rails/generators/named_base.rb, line 176
def url_helper_prefix # :doc:
  @url_helper_prefix ||= (class_path + [file_name]).join("_")
end
wrap_with_namespace(content)
# File railties/lib/rails/generators/named_base.rb, line 61
def wrap_with_namespace(content) # :doc:
  content = indent(content).chomp
  "module #{namespace.name}\n#{content}\nend\n"
end