instance method `thread_mattr_accessor`

Ruby on Rails 8.0.4

Since v5.2.8.1

Available in: v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

thread_mattr_accessor(*syms, instance_reader: true, instance_writer: true, instance_accessor: true, default: nil)

Defines both class and instance accessors for class attributes.

class Account
  thread_mattr_accessor :user
end

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

Unlike mattr_accessor, values are not shared with subclasses or parent classes. If a subclass changes the value, the parent class’ value is not changed. If the parent class changes the value, the value of subclasses is not changed.

class Customer < Account
end

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

To omit the instance writer method, pass instance_writer: false. To omit the instance reader method, pass 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

Or pass instance_accessor: false, to omit both instance methods.

class Current
  thread_mattr_accessor :user, instance_accessor: false
end

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

A default value may be specified using the :default option. Because multiple threads can access the default value, non-frozen default values will be duped and frozen.

Parameters

syms rest
instance_reader key = true
instance_writer key = true
instance_accessor key = true
default key = nil

Source

# File activesupport/lib/active_support/core_ext/module/attribute_accessors_per_thread.rb, line 170
  def thread_mattr_accessor(*syms, instance_reader: true, instance_writer: true, instance_accessor: true, default: nil)
    thread_mattr_reader(*syms, instance_reader: instance_reader, instance_accessor: instance_accessor, default: default)
    thread_mattr_writer(*syms, instance_writer: instance_writer, instance_accessor: instance_accessor)
  end

Defined in activesupport/lib/active_support/core_ext/module/attribute_accessors_per_thread.rb line 170 · View on GitHub · Improve this page · Find usages on GitHub

Defined in Module

Signature

Parameters