method

thread_mattr_reader

v6.1.7.7 - Show latest stable - Class: Module

thread_mattr_reader(*syms, instance_reader: true, instance_accessor: true, default: nil)

public

Defines a per-thread class attribute and creates class and instance reader methods. The underlying per-thread class variable is set to nil, if it is not previously defined.

module Current
  thread_mattr_reader :user
end

Current.user # => nil
Thread.current[:attr_Current_user] = "DHH"
Current.user # => "DHH"

The attribute name must be a valid method name in Ruby.

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

To omit the instance reader method, pass instance_reader: false or instance_accessor: false.

class Current
  thread_mattr_reader :user, instance_reader: false
end

Current.new.user # => NoMethodError

# File activesupport/lib/active_support/core_ext/module/attribute_accessors_per_thread.rb, line 36
  def thread_mattr_reader(*syms, instance_reader: true, instance_accessor: true, default: nil) # :nodoc:
    syms.each do |sym|
      raise NameError.new("invalid attribute name: #{sym}") unless /^[_A-Za-z]\w*$/.match?(sym)

      # The following generated method concatenates `name` because we want it
      # to work with inheritance via polymorphism.
      class_eval(        def self.#{sym}          Thread.current["attr_" + name + "_#{sym}"]        end, __FILE__, __LINE__ + 1)

      if instance_reader && instance_accessor
        class_eval(          def #{sym}            self.class.#{sym}          end, __FILE__, __LINE__ + 1)
      end

      Thread.current["attr_" + name + "_#{sym}"] = default unless default.nil?
    end
  end

thread_mattr_reader

Related methods