Class: ActiveModel::Name

Inherits:
Object show all
Includes:
Comparable
Defined in:
activemodel/lib/active_model/naming.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(klass, namespace = nil, name = nil) ⇒ Name

Returns a new ActiveModel::Name instance. By default, the namespace and name option will take the namespace and name of the given class respectively.

module Foo
  class Bar
  end
end

ActiveModel::Name.new(Foo::Bar).to_s
# => "Foo::Bar"

Raises:

  • (ArgumentError) 


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'activemodel/lib/active_model/naming.rb', line 164

def initialize(klass, namespace = nil, name = nil)
  @name = name || klass.name

  raise ArgumentError, "Class name cannot be blank. You need to supply a name argument when anonymous class given" if @name.blank?

  @unnamespaced = @name.sub(/^#{namespace.name}::/, "") if namespace
  @klass        = klass
  @singular     = _singularize(@name)
  @plural       = ActiveSupport::Inflector.pluralize(@singular)
  @element      = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(@name))
  @human        = ActiveSupport::Inflector.humanize(@element)
  @collection   = ActiveSupport::Inflector.tableize(@name)
  @param_key    = (namespace ? _singularize(@unnamespaced) : @singular)
  @i18n_key     = @name.underscore.to_sym

  @route_key          = (namespace ? ActiveSupport::Inflector.pluralize(@param_key) : @plural.dup)
  @singular_route_key = ActiveSupport::Inflector.singularize(@route_key)
  @route_key << "_index" if @plural == @singular
end

Instance Attribute Details

#collection ⇒ Object (readonly) Also known as: cache_key

Returns the value of attribute collection



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def collection
  @collection
end

#element ⇒ Object (readonly)

Returns the value of attribute element



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def element
  @element
end

#i18n_key ⇒ Object (readonly)

Returns the value of attribute i18n_key



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def i18n_key
  @i18n_key
end

#name ⇒ Object (readonly)

Returns the value of attribute name



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def name
  @name
end

#param_key ⇒ Object (readonly)

Returns the value of attribute param_key



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def param_key
  @param_key
end

#plural ⇒ Object (readonly)

Returns the value of attribute plural



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def plural
  @plural
end

#route_key ⇒ Object (readonly)

Returns the value of attribute route_key



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def route_key
  @route_key
end

#singular ⇒ Object (readonly)

Returns the value of attribute singular



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def singular
  @singular
end

#singular_route_key ⇒ Object (readonly)

Returns the value of attribute singular_route_key



11
12
13
 
# File 'activemodel/lib/active_model/naming.rb', line 11

def singular_route_key
  @singular_route_key
end

Instance Method Details

#human(options = {}) ⇒ Object

Transform the model name into a more human format, using I18n. By default, it will underscore then humanize the class name.

class BlogPost
  extend ActiveModel::Naming
end

BlogPost.model_name.human # => "Blog post"

Specify options with additional translating options.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'activemodel/lib/active_model/naming.rb', line 194

def human(options = {})
  return @human unless @klass.respond_to?(:lookup_ancestors) &&
                       @klass.respond_to?(:i18n_scope)

  defaults = @klass.lookup_ancestors.map do |klass|
    klass.model_name.i18n_key
  end

  defaults << options[:default] if options[:default]
  defaults << @human

  options = { scope: [@klass.i18n_scope, :models], count: 1, default: defaults }.merge!(options.except(:default))
  I18n.translate(defaults.shift, **options)
end