允许您为属性创建别名，包括 getter、setter 和谓词。

class Content < ActiveRecord::Base
  # has a title attribute
end

class Email < Content
  alias_attribute :subject, :title
end

e = Email.find(1)
e.title    # => "Superstars"
e.subject  # => "Superstars"
e.subject? # => true
e.subject = "Megastars"
e.title    # => "Megastars"

模块可能有或可能没有名称。

module M; end
M.name # => "M"

m = Module.new
m.name # => nil

anonymous? 方法如果模块没有名称，则返回 true，否则返回 false

Module.new.anonymous? # => true

module M; end
M.anonymous?          # => false

模块在首次分配给常量时获得名称。通过module 或 class 关键字，或通过显式分配。

m = Module.new # creates an anonymous module
m.anonymous?   # => true
M = m          # m gets a name here as a side-effect
m.name         # => "M"
m.anonymous?   # => false

声明一个由内部命名实例变量支持的属性读取器和写入器。

声明一个由内部命名实例变量支持的属性读取器。

声明一个由内部命名实例变量支持的属性写入器。

如果模块或类是匿名的，则返回该模块或类的副本。如果它已命名，则返回self。

Object.deep_dup == Object # => true
klass = Class.new
klass.deep_dup == klass # => false

提供一个delegate 类方法，可以轻松地将包含对象的公共方法公开为您自己的方法。

选项

• :to - 将目标对象名称指定为符号或字符串

• :prefix - 使用目标名称或自定义前缀为新方法添加前缀

• :allow_nil - 如果设置为 true，则阻止引发ActiveSupport::DelegationError

• :private - 如果设置为 true，则将方法可见性更改为私有

宏接收一个或多个方法名称（指定为符号或字符串）以及目标对象的名称，通过:to 选项（也是符号或字符串）。

委托对 Active Record 关联特别有用

class Greeter < ActiveRecord::Base
  def hello
    'hello'
  end

  def goodbye
    'goodbye'
  end
end

class Foo < ActiveRecord::Base
  belongs_to :greeter
  delegate :hello, to: :greeter
end

Foo.new.hello   # => "hello"
Foo.new.goodbye # => NoMethodError: undefined method `goodbye' for #<Foo:0x1af30c>

允许对同一目标进行多次委托

class Foo < ActiveRecord::Base
  belongs_to :greeter
  delegate :hello, :goodbye, to: :greeter
end

Foo.new.goodbye # => "goodbye"

方法可以通过提供符号来委托给实例变量、类变量或常量

class Foo
  CONSTANT_ARRAY = [0,1,2,3]
  @@class_array  = [4,5,6,7]

  def initialize
    @instance_array = [8,9,10,11]
  end
  delegate :sum, to: :CONSTANT_ARRAY
  delegate :min, to: :@@class_array
  delegate :max, to: :@instance_array
end

Foo.new.sum # => 6
Foo.new.min # => 4
Foo.new.max # => 11

也可以通过使用:class 将方法委托给类

class Foo
  def self.hello
    "world"
  end

  delegate :hello, to: :class
end

Foo.new.hello # => "world"

委托可以可选地使用:prefix 选项添加前缀。如果该值为true，则委托方法将以被委托对象名称为前缀。

Person = Struct.new(:name, :address)

class Invoice < Struct.new(:client)
  delegate :name, :address, to: :client, prefix: true
end

john_doe = Person.new('John Doe', 'Vimmersvej 13')
invoice = Invoice.new(john_doe)
invoice.client_name    # => "John Doe"
invoice.client_address # => "Vimmersvej 13"

也可以提供自定义前缀。

class Invoice < Struct.new(:client)
  delegate :name, :address, to: :client, prefix: :customer
end

invoice = Invoice.new(john_doe)
invoice.customer_name    # => 'John Doe'
invoice.customer_address # => 'Vimmersvej 13'

委托方法默认是公共的。传递private: true 来改变它。

class User < ActiveRecord::Base
  has_one :profile
  delegate :first_name, to: :profile
  delegate :date_of_birth, to: :profile, private: true

  def age
    Date.today.year - date_of_birth.year
  end
end

User.new.first_name # => "Tomas"
User.new.date_of_birth # => NoMethodError: private method `date_of_birth' called for #<User:0x00000008221340>
User.new.age # => 2

如果目标为nil 并且没有响应委托方法，则会引发ActiveSupport::DelegationError。如果您希望改为返回nil，请使用:allow_nil 选项。

class User < ActiveRecord::Base
  has_one :profile
  delegate :age, to: :profile
end

User.new.age
# => ActiveSupport::DelegationError: User#age delegated to profile.age, but profile is nil

但如果没有配置文件，则可以接受这种情况，不应将其视为错误条件

class User < ActiveRecord::Base
  has_one :profile
  delegate :age, to: :profile, allow_nil: true
end

User.new.age # nil

请注意，如果目标不是nil，则无论:allow_nil 选项如何，都会尝试调用，因此如果所述对象没有响应该方法，仍然会引发异常

class Foo
  def initialize(bar)
    @bar = bar
  end

  delegate :name, to: :@bar, allow_nil: true
end

Foo.new("Bar").name # raises NoMethodError: undefined method `name'

目标方法必须是公共的，否则将引发NoMethodError。

在构建装饰器时，可能会出现常见的模式

class Partition
  def initialize(event)
    @event = event
  end

  def person
    detail.person || creator
  end

  private
    def respond_to_missing?(name, include_private = false)
      @event.respond_to?(name, include_private)
    end

    def method_missing(method, *args, &block)
      @event.send(method, *args, &block)
    end
end

使用Module#delegate_missing_to，上述内容可以简化为

class Partition
  delegate_missing_to :@event

  def initialize(event)
    @event = event
  end

  def person
    detail.person || creator
  end
end

目标可以在对象中任何可调用内容，例如实例变量、方法、常量等。

委托方法在目标上必须是公共的，否则将引发ActiveSupport::DelegationError。如果您希望改为返回nil，请使用:allow_nil 选项。

由于当调用Marshal.dump(object) 时可能存在干扰，因此marshal_dump 和_dump 方法不包含在委托中，因为object 的委托目标方法可能会添加或删除实例变量。

deprecate :foo, deprecator: MyLib.deprecator
deprecate :foo, bar: "warning!", deprecator: MyLib.deprecator

一个废弃器通常是 ActiveSupport::Deprecation 的实例，但您也可以传递任何响应deprecation_warning(deprecated_method_name, message, caller_backtrace) 的对象，您可以在其中实现自定义警告行为。

class MyLib::Deprecator
  def deprecation_warning(deprecated_method_name, message, caller_backtrace = nil)
    message = "#{deprecated_method_name} is deprecated and will be removed from MyLibrary | #{message}"
    Kernel.warn message
  end
end

定义类属性的类和实例访问器。所有创建的类和实例方法都将是公开的，即使此方法在私有或受保护的访问修饰符下调用。

module HairColors
  mattr_accessor :hair_colors
end

class Person
  include HairColors
end

HairColors.hair_colors = [:brown, :black, :blonde, :red]
HairColors.hair_colors # => [:brown, :black, :blonde, :red]
Person.new.hair_colors # => [:brown, :black, :blonde, :red]

如果子类更改了值，那么这也将更改父类的值。类似地，如果父类更改了值，那么也将更改子类的值。

class Citizen < Person
end

Citizen.new.hair_colors << :blue
Person.new.hair_colors # => [:brown, :black, :blonde, :red, :blue]

要省略实例写入器方法，请传递 instance_writer: false。要省略实例读取器方法，请传递 instance_reader: false。

module HairColors
  mattr_accessor :hair_colors, instance_writer: false, instance_reader: false
end

class Person
  include HairColors
end

Person.new.hair_colors = [:brown]  # => NoMethodError
Person.new.hair_colors             # => NoMethodError

或者传递 instance_accessor: false，省略两个实例方法。

module HairColors
  mattr_accessor :hair_colors, instance_accessor: false
end

class Person
  include HairColors
end

Person.new.hair_colors = [:brown]  # => NoMethodError
Person.new.hair_colors             # => NoMethodError

您可以为属性设置默认值。

module HairColors
  mattr_accessor :hair_colors, default: [:brown, :black, :blonde, :red]
  mattr_accessor(:hair_styles) { [:long, :short] }
end

class Person
  include HairColors
end

Person.class_variable_get("@@hair_colors") # => [:brown, :black, :blonde, :red]
Person.class_variable_get("@@hair_styles") # => [:long, :short]

定义一个类属性并创建类和实例读取器方法。如果未事先定义，则基础类变量将设置为 nil。所有创建的类和实例方法都将是公开的，即使此方法在私有或受保护的访问修饰符下调用。

module HairColors
  mattr_reader :hair_colors
end

HairColors.hair_colors # => nil
HairColors.class_variable_set("@@hair_colors", [:brown, :black])
HairColors.hair_colors # => [:brown, :black]

属性名称必须是 Ruby 中有效的 方法名。

module Foo
  mattr_reader :"1_Badname"
end
# => NameError: invalid attribute name: 1_Badname

要省略实例读取器方法，请传递 instance_reader: false 或 instance_accessor: false。

module HairColors
  mattr_reader :hair_colors, instance_reader: false
end

class Person
  include HairColors
end

Person.new.hair_colors # => NoMethodError

您可以为属性设置默认值。

module HairColors
  mattr_reader :hair_colors, default: [:brown, :black, :blonde, :red]
  mattr_reader(:hair_styles) { [:long, :short] }
end

class Person
  include HairColors
end

Person.new.hair_colors # => [:brown, :black, :blonde, :red]
Person.new.hair_styles # => [:long, :short]

定义一个类属性并创建类和实例写入器方法，以允许对属性进行赋值。所有创建的类和实例方法都将是公开的，即使此方法在私有或受保护的访问修饰符下调用。

module HairColors
  mattr_writer :hair_colors
end

class Person
  include HairColors
end

HairColors.hair_colors = [:brown, :black]
Person.class_variable_get("@@hair_colors") # => [:brown, :black]
Person.new.hair_colors = [:blonde, :red]
HairColors.class_variable_get("@@hair_colors") # => [:blonde, :red]

要省略实例写入器方法，请传递 instance_writer: false 或 instance_accessor: false。

module HairColors
  mattr_writer :hair_colors, instance_writer: false
end

class Person
  include HairColors
end

Person.new.hair_colors = [:blonde, :red] # => NoMethodError

您可以为属性设置默认值。

module HairColors
  mattr_writer :hair_colors, default: [:brown, :black, :blonde, :red]
  mattr_writer(:hair_styles) { [:long, :short] }
end

class Person
  include HairColors
end

Person.class_variable_get("@@hair_colors") # => [:brown, :black, :blonde, :red]
Person.class_variable_get("@@hair_styles") # => [:long, :short]

根据其名称返回包含此模块的模块。

module M
  module N
  end
end
X = M::N

M::N.module_parent # => M
X.module_parent    # => M

顶级模块和匿名模块的父级是 Object。

M.module_parent          # => Object
Module.new.module_parent # => Object

返回包含此模块的模块的名称。

M::N.module_parent_name # => "M"

返回此模块的所有父级（根据其名称），按从嵌套到外部的顺序排列。接收器不包含在结果中。

module M
  module N
  end
end
X = M::N

M.module_parents    # => [Object]
M::N.module_parents # => [M, Object]
X.module_parents    # => [M, Object]

用传递的块替换现有的方法定义（如果有）。

用传递的块替换现有的单例方法定义（如果有）。

如果存在，则删除命名方法。

如果存在，则删除命名的单例方法。

如果存在，则将命名方法标记为打算重新定义。抑制 Ruby 方法重新定义警告。如果可能，请优先使用 redefine_method。

定义类属性的类和实例访问器。

class Account
  thread_mattr_accessor :user
end

Account.user = "DHH"
Account.user     # => "DHH"
Account.new.user # => "DHH"

与 mattr_accessor 不同，值**不**与子类或父类共享。如果子类更改了值，则不会更改父类的值。如果父类更改了值，则不会更改子类的值。

class Customer < Account
end

Account.user   # => "DHH"
Customer.user  # => nil
Customer.user  = "Rafael"
Customer.user  # => "Rafael"
Account.user   # => "DHH"

要省略实例写入器方法，请传递 instance_writer: false。要省略实例读取器方法，请传递 instance_reader: false。

class Current
  thread_mattr_accessor :user, instance_writer: false, instance_reader: false
end

Current.new.user = "DHH"  # => NoMethodError
Current.new.user          # => NoMethodError

或者传递 instance_accessor: false，省略两个实例方法。

class Current
  thread_mattr_accessor :user, instance_accessor: false
end

Current.new.user = "DHH"  # => NoMethodError
Current.new.user          # => NoMethodError

可以使用 :default 选项指定默认值。由于多个线程可以访问默认值，因此未冻结的默认值将被 dup 并冻结。