Skip to content
This repository
tag: v3.0.6.rc2
Fetching contributors…

Cannot retrieve contributors at this time

file 90 lines (84 sloc) 2.915 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
require 'active_support/core_ext/kernel/singleton_class'
require 'active_support/core_ext/module/remove_method'

class Class
  # Declare a class-level attribute whose value is inheritable by subclasses.
  # Subclasses can change their own value and it will not impact parent class.
  #
  # class Base
  # class_attribute :setting
  # end
  #
  # class Subclass < Base
  # end
  #
  # Base.setting = true
  # Subclass.setting # => true
  # Subclass.setting = false
  # Subclass.setting # => false
  # Base.setting # => true
  #
  # In the above case as long as Subclass does not assign a value to setting
  # by performing <tt>Subclass.setting = _something_ </tt>, <tt>Subclass.setting</tt>
  # would read value assigned to parent class. Once Subclass assigns a value then
  # the value assigned by Subclass would be returned.
  #
  # This matches normal Ruby method inheritance: think of writing an attribute
  # on a subclass as overriding the reader method. However, you need to be aware
  # when using +class_attribute+ with mutable structures as +Array+ or +Hash+.
  # In such cases, you don't want to do changes in places but use setters:
  #
  # Base.setting = []
  # Base.setting # => []
  # Subclass.setting # => []
  #
  # # Appending in child changes both parent and child because it is the same object:
  # Subclass.setting << :foo
  # Base.setting # => [:foo]
  # Subclass.setting # => [:foo]
  #
  # # Use setters to not propagate changes:
  # Base.setting = []
  # Subclass.setting += [:foo]
  # Base.setting # => []
  # Subclass.setting # => [:foo]
  #
  # For convenience, a query method is defined as well:
  #
  # Subclass.setting? # => false
  #
  # Instances may overwrite the class value in the same way:
  #
  # Base.setting = true
  # object = Base.new
  # object.setting # => true
  # object.setting = false
  # object.setting # => false
  # Base.setting # => true
  #
  # To opt out of the instance writer method, pass :instance_writer => false.
  #
  # object.setting = false # => NoMethodError
  def class_attribute(*attrs)
    instance_writer = !attrs.last.is_a?(Hash) || attrs.pop[:instance_writer]

    attrs.each do |name|
      class_eval <<-RUBY, __FILE__, __LINE__ + 1
def self.#{name}() nil end
def self.#{name}?() !!#{name} end

def self.#{name}=(val)
singleton_class.class_eval do
remove_possible_method(:#{name})
define_method(:#{name}) { val }
end
val
end

def #{name}
defined?(@#{name}) ? @#{name} : singleton_class.#{name}
end

def #{name}?
!!#{name}
end
RUBY

      attr_writer name if instance_writer
    end
  end
end
Something went wrong with that request. Please try again.