Methods

Class Public 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”.

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 214
        def self.check_class_collision(options = {}) # :doc:
          define_method :check_class_collision do
            name = if respond_to?(:controller_class_name, true) # for ResourceHelpers
              controller_class_name
            else
              class_name
            end

            class_collisions "#{options[:prefix]}#{name}#{options[:suffix]}"
          end
        end
🔎 See on GitHub

Instance Public methods

js_template(source, destination)

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 29
        def js_template(source, destination)
          template(source + ".js", destination + ".js")
        end
🔎 See on GitHub

template(source, *args, &block)

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 23
        def template(source, *args, &block)
          inside_template do
            Rails::Generators.add_generated_file(super)
          end
        end
🔎 See on GitHub

Instance Private methods

application_name()

Tries to retrieve the application name or simply return application.

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 138
        def application_name # :doc:
          if defined?(Rails) && Rails.application
            Rails.application.class.name.split("::").first.underscore
          else
            "application"
          end
        end
🔎 See on GitHub

attributes_names()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 188
        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
🔎 See on GitHub

class_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 70
        def class_name # :doc:
          (class_path + [file_name]).map!(&:camelize).join("::")
        end
🔎 See on GitHub

class_path()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 58
        def class_path # :doc:
          inside_template? || !namespaced? ? regular_class_path : namespaced_class_path
        end
🔎 See on GitHub

edit_helper(...)

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 105
        def edit_helper(...) # :doc:
          "edit_#{show_helper(...)}"
        end
🔎 See on GitHub

file_path()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 54
        def file_path # :doc:
          @file_path ||= (class_path + [file_name]).join("/")
        end
🔎 See on GitHub

fixture_file_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 125
        def fixture_file_name # :doc:
          @fixture_file_name ||= (pluralize_table_names? ? plural_file_name : file_name)
        end
🔎 See on GitHub

human_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 74
        def human_name # :doc:
          @human_name ||= singular_name.humanize
        end
🔎 See on GitHub

i18n_scope()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 82
        def i18n_scope # :doc:
          @i18n_scope ||= file_path.tr("/", ".")
        end
🔎 See on GitHub

index_helper(type: nil)

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 97
        def index_helper(type: nil) # :doc:
          [plural_route_name, ("index" if uncountable?), type].compact.join("_")
        end
🔎 See on GitHub

inside_template()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 43
        def inside_template # :doc:
          @inside_template = true
          yield
        ensure
          @inside_template = false
        end
🔎 See on GitHub

inside_template?()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 50
        def inside_template? # :doc:
          @inside_template
        end
🔎 See on GitHub

model_resource_name(base_name = singular_table_name, prefix: "")

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 150
        def model_resource_name(base_name = singular_table_name, prefix: "") # :doc:
          resource_name = "#{prefix}#{base_name}"
          if options[:model_name]
            "[#{controller_class_path.map { |name| ":" + name }.join(", ")}, #{resource_name}]"
          else
            resource_name
          end
        end
🔎 See on GitHub

mountable_engine?()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 200
        def mountable_engine? # :doc:
          defined?(ENGINE_ROOT) && namespaced?
        end
🔎 See on GitHub

namespaced_class_path()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 66
        def namespaced_class_path # :doc:
          @namespaced_class_path ||= namespace_dirs + @class_path
        end
🔎 See on GitHub

new_helper(type: :url)

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 109
        def new_helper(type: :url) # :doc:
          "new_#{singular_route_name}_#{type}"
        end
🔎 See on GitHub

plural_file_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 121
        def plural_file_name # :doc:
          @plural_file_name ||= file_name.pluralize
        end
🔎 See on GitHub

plural_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 78
        def plural_name # :doc:
          @plural_name ||= singular_name.pluralize
        end
🔎 See on GitHub

plural_route_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 167
        def plural_route_name # :doc:
          if options[:model_name]
            "#{controller_class_path.join('_')}_#{plural_table_name}"
          else
            plural_table_name
          end
        end
🔎 See on GitHub

plural_table_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 117
        def plural_table_name # :doc:
          @plural_table_name ||= (pluralize_table_names? ? table_name : table_name.pluralize)
        end
🔎 See on GitHub

pluralize_table_names?()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 196
        def pluralize_table_names? # :doc:
          !defined?(ActiveRecord::Base) || ActiveRecord::Base.pluralize_table_names
        end
🔎 See on GitHub

redirect_resource_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 146
        def redirect_resource_name # :doc:
          model_resource_name(prefix: "@")
        end
🔎 See on GitHub

regular_class_path()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 62
        def regular_class_path # :doc:
          @class_path
        end
🔎 See on GitHub

route_url()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 129
        def route_url # :doc:
          @route_url ||= controller_class_path.collect { |dname| "/" + dname }.join + "/" + plural_file_name
        end
🔎 See on GitHub

show_helper(arg = "@#{singular_table_name}", type: :url)

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 101
        def show_helper(arg = "@#{singular_table_name}", type: :url) # :doc:
          "#{singular_route_name}_#{type}(#{arg})"
        end
🔎 See on GitHub

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.

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 39
        def singular_name # :doc:
          file_name
        end
🔎 See on GitHub

singular_route_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 159
        def singular_route_name # :doc:
          if options[:model_name]
            "#{controller_class_path.join('_')}_#{singular_table_name}"
          else
            singular_table_name
          end
        end
🔎 See on GitHub

singular_table_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 113
        def singular_table_name # :doc:
          @singular_table_name ||= (pluralize_table_names? ? table_name.singularize : table_name)
        end
🔎 See on GitHub

table_name()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 86
        def table_name # :doc:
          @table_name ||= begin
            base = pluralize_table_names? ? plural_name : singular_name
            (class_path + [base]).join("_")
          end
        end
🔎 See on GitHub

uncountable?()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 93
        def uncountable? # :doc:
          singular_name == plural_name
        end
🔎 See on GitHub

url_helper_prefix()

📝 Source code
# File railties/lib/rails/generators/named_base.rb, line 133
        def url_helper_prefix # :doc:
          @url_helper_prefix ||= (class_path + [file_name]).join("_")
        end
🔎 See on GitHub