Class: Class

Inherits:
Object show all
Defined in:
lib/inactive_support/core_ext/class/attribute_accessors.rb,
lib/inactive_support/core_ext/class/inheritable_attributes.rb

Overview

Allows attributes to be shared within an inheritance hierarchy, but where each descendant gets a copy of their parents’ attributes, instead of just a pointer to the same. This means that the child can add elements to, for example, an array without those additions being shared with either their parent, siblings, or children, which is unlike the regular class-level attributes that are shared across the entire hierarchy.

Constant Summary collapse

EMPTY_INHERITABLE_ATTRIBUTES =

Prevent this constant from being created multiple times

{}.freeze

Instance Method Summary collapse

Instance Method Details

#cattr_accessor(*syms) ⇒ Object 



44
45
46
47
 
# File 'lib/inactive_support/core_ext/class/attribute_accessors.rb', line 44

def cattr_accessor(*syms)
  cattr_reader(*syms)
  cattr_writer(*syms)
end

#cattr_reader(*syms) ⇒ Object

:nodoc:



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/inactive_support/core_ext/class/attribute_accessors.rb', line 4

def cattr_reader(*syms)
  syms.flatten.each do |sym|
    next if sym.is_a?(Hash)
    class_eval(<<-EOS, __FILE__, __LINE__)
      unless defined? @@#{sym}
        @@#{sym} = nil
      end

      def self.#{sym}
        @@#{sym}
      end

      def #{sym}
        @@#{sym}
      end
    EOS
  end
end

#cattr_writer(*syms) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/inactive_support/core_ext/class/attribute_accessors.rb', line 23

def cattr_writer(*syms)
  options = syms.extract_options!
  syms.flatten.each do |sym|
    class_eval(<<-EOS, __FILE__, __LINE__)
      unless defined? @@#{sym}
        @@#{sym} = nil
      end

      def self.#{sym}=(obj)
        @@#{sym} = obj
      end

      #{"
      def #{sym}=(obj)
        @@#{sym} = obj
      end
      " unless options[:instance_writer] == false }
    EOS
  end
end

#class_inheritable_accessor(*syms) ⇒ Object 



76
77
78
79
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 76

def class_inheritable_accessor(*syms)
  class_inheritable_reader(*syms)
  class_inheritable_writer(*syms)
end

#class_inheritable_array(*syms) ⇒ Object 



81
82
83
84
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 81

def class_inheritable_array(*syms)
  class_inheritable_reader(*syms)
  class_inheritable_array_writer(*syms)
end

#class_inheritable_array_writer(*syms) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 42

def class_inheritable_array_writer(*syms)
  options = syms.extract_options!
  syms.each do |sym|
    class_eval <<-EOS
      def self.#{sym}=(obj)
        write_inheritable_array(:#{sym}, obj)
      end

      #{"
      def #{sym}=(obj)
        self.class.#{sym} = obj
      end
      " unless options[:instance_writer] == false }
    EOS
  end
end

#class_inheritable_hash(*syms) ⇒ Object 



86
87
88
89
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 86

def class_inheritable_hash(*syms)
  class_inheritable_reader(*syms)
  class_inheritable_hash_writer(*syms)
end

#class_inheritable_hash_writer(*syms) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 59

def class_inheritable_hash_writer(*syms)
  options = syms.extract_options!
  syms.each do |sym|
    class_eval <<-EOS
      def self.#{sym}=(obj)
        write_inheritable_hash(:#{sym}, obj)
      end

      #{"
      def #{sym}=(obj)
        self.class.#{sym} = obj
      end
      " unless options[:instance_writer] == false }
    EOS
  end
end

#class_inheritable_reader(*syms) ⇒ Object

:nodoc:



10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 10

def class_inheritable_reader(*syms)
  syms.each do |sym|
    next if sym.is_a?(Hash)
    class_eval <<-EOS
      def self.#{sym}
        read_inheritable_attribute(:#{sym})
      end

      def #{sym}
        self.class.#{sym}
      end
    EOS
  end
end

#class_inheritable_writer(*syms) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 25

def class_inheritable_writer(*syms)
  options = syms.extract_options!
  syms.each do |sym|
    class_eval <<-EOS
      def self.#{sym}=(obj)
        write_inheritable_attribute(:#{sym}, obj)
      end

      #{"
      def #{sym}=(obj)
        self.class.#{sym} = obj
      end
      " unless options[:instance_writer] == false }
    EOS
  end
end

#inheritable_attributes ⇒ Object 



91
92
93
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 91

def inheritable_attributes
  @inheritable_attributes ||= EMPTY_INHERITABLE_ATTRIBUTES
end

#read_inheritable_attribute(key) ⇒ Object 



112
113
114
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 112

def read_inheritable_attribute(key)
  inheritable_attributes[key]
end

#reset_inheritable_attributes ⇒ Object 



116
117
118
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 116

def reset_inheritable_attributes
  @inheritable_attributes = EMPTY_INHERITABLE_ATTRIBUTES
end

#write_inheritable_array(key, elements) ⇒ Object 



102
103
104
105
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 102

def write_inheritable_array(key, elements)
  write_inheritable_attribute(key, []) if read_inheritable_attribute(key).nil?
  write_inheritable_attribute(key, read_inheritable_attribute(key) + elements)
end

#write_inheritable_attribute(key, value) ⇒ Object 



95
96
97
98
99
100
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 95

def write_inheritable_attribute(key, value)
  if inheritable_attributes.equal?(EMPTY_INHERITABLE_ATTRIBUTES)
    @inheritable_attributes = {}
  end
  inheritable_attributes[key] = value
end

#write_inheritable_hash(key, hash) ⇒ Object 



107
108
109
110
 
# File 'lib/inactive_support/core_ext/class/inheritable_attributes.rb', line 107

def write_inheritable_hash(key, hash)
  write_inheritable_attribute(key, {}) if read_inheritable_attribute(key).nil?
  write_inheritable_attribute(key, read_inheritable_attribute(key).merge(hash))
end