class method self.attribute

Ruby on Rails 7.1.6

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

Signature

self.attribute(*names)

Declares one or more attributes that will be given both class and instance accessor methods.

Parameters

names rest
Source
# File activesupport/lib/active_support/current_attributes.rb, line 104
      def attribute(*names)
        invalid_attribute_names = names.map(&:to_sym) & INVALID_ATTRIBUTE_NAMES
        if invalid_attribute_names.any?
          raise ArgumentError, "Restricted attribute names: #{invalid_attribute_names.join(", ")}"
        end

        ActiveSupport::CodeGenerator.batch(generated_attribute_methods, __FILE__, __LINE__) do |owner|
          names.each do |name|
            owner.define_cached_method(name, namespace: :current_attributes) do |batch|
              batch <<
                "def #{name}" <<
                "attributes[:#{name}]" <<
                "end"
            end
            owner.define_cached_method("#{name}=", namespace: :current_attributes) do |batch|
              batch <<
                "def #{name}=(value)" <<
                "attributes[:#{name}] = value" <<
                "end"
            end
          end
        end

        ActiveSupport::CodeGenerator.batch(singleton_class, __FILE__, __LINE__) do |owner|
          names.each do |name|
            owner.define_cached_method(name, namespace: :current_attributes_delegation) do |batch|
              batch <<
                "def #{name}" <<
                "instance.#{name}" <<
                "end"
            end
            owner.define_cached_method("#{name}=", namespace: :current_attributes_delegation) do |batch|
              batch <<
                "def #{name}=(value)" <<
                "instance.#{name} = value" <<
                "end"
            end
          end
        end
      end

Defined in activesupport/lib/active_support/current_attributes.rb line 104 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveSupport::CurrentAttributes

Type at least 2 characters to search.

↑↓ navigate · open · esc close