Class: ActiveModel::Name

Inherits:
String show all
Defined in:
activemodel/lib/active_model/naming.rb

Constant Summary

Constants inherited from String

String::NON_WHITESPACE_REGEXP

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from String

#acts_like_string?, #as_json, #at, #blank?, #camelize, #classify, #constantize, #dasherize, #deconstantize, #demodulize, #encode_json, #encoding_aware?, #exclude?, #first, #foreign_key, #from, #html_safe, #humanize, #inquiry, #is_utf8?, #last, #mb_chars, #ord, #parameterize, #pluralize, #safe_constantize, #singularize, #squish, #squish!, #strip_heredoc, #tableize, #titleize, #to, #to_date, #to_datetime, #to_time, #truncate, #underscore

Constructor Details

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

Returns a new instance of Name

Raises:

  • (ArgumentError)

15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'activemodel/lib/active_model/naming.rb', line 15

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

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

  super(name)

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

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

Instance Attribute Details

#collectionObject (readonly) Also known as: cache_key

Returns the value of attribute collection


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def collection
  @collection
end

#elementObject (readonly)

Returns the value of attribute element


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def element
  @element
end

#i18n_keyObject (readonly)

Returns the value of attribute i18n_key


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def i18n_key
  @i18n_key
end

#param_keyObject (readonly)

Returns the value of attribute param_key


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def param_key
  @param_key
end

#partial_pathObject (readonly)

Returns the value of attribute partial_path


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def partial_path
  @partial_path
end

#pluralObject (readonly)

Returns the value of attribute plural


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def plural
  @plural
end

#route_keyObject (readonly)

Returns the value of attribute route_key


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def route_key
  @route_key
end

#singularObject (readonly)

Returns the value of attribute singular


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def singular
  @singular
end

#singular_route_keyObject (readonly)

Returns the value of attribute singular_route_key


8
9
10
# File 'activemodel/lib/active_model/naming.rb', line 8

def singular_route_key
  @singular_route_key
end

Instance Method Details

#human(options = {}) ⇒ Object

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

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

Specify options with additional translating options.


45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'activemodel/lib/active_model/naming.rb', line 45

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