Class: Class

Inherits:
Object show all
Defined in:
lib/merb-core/core_ext/class.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 



50
51
52
53
 
# File 'lib/merb-core/core_ext/class.rb', line 50

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

#cattr_reader(*syms) ⇒ Object

:nodoc:



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/merb-core/core_ext/class.rb', line 9

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 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/merb-core/core_ext/class.rb', line 28

def cattr_writer(*syms)
  options = syms.last.is_a?(Hash) ? syms.pop : {}
  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 



128
129
130
131
 
# File 'lib/merb-core/core_ext/class.rb', line 128

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

#class_inheritable_array(*syms) ⇒ Object 



133
134
135
136
 
# File 'lib/merb-core/core_ext/class.rb', line 133

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

#class_inheritable_array_writer(*syms) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/merb-core/core_ext/class.rb', line 90

def class_inheritable_array_writer(*syms)
  options = syms.last.is_a?(Hash) ? syms.pop : {}
  syms.each do |sym|
    class_eval <<-EOS, __FILE__, __LINE__

      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 



138
139
140
141
 
# File 'lib/merb-core/core_ext/class.rb', line 138

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

#class_inheritable_hash_writer(*syms) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/merb-core/core_ext/class.rb', line 109

def class_inheritable_hash_writer(*syms)
  options = syms.last.is_a?(Hash) ? syms.pop : {}
  syms.each do |sym|
    class_eval <<-EOS, __FILE__, __LINE__

      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 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/merb-core/core_ext/class.rb', line 55

def class_inheritable_reader(*syms)
  syms.each do |sym|
    next if sym.is_a?(Hash)
    class_eval <<-EOS, __FILE__, __LINE__

      def self.#{sym}
        read_inheritable_attribute(:#{sym})
      end

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

#class_inheritable_writer(*syms) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/merb-core/core_ext/class.rb', line 71

def class_inheritable_writer(*syms)
  options = syms.last.is_a?(Hash) ? syms.pop : {}
  syms.each do |sym|
    class_eval <<-EOS, __FILE__, __LINE__

      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 



143
144
145
 
# File 'lib/merb-core/core_ext/class.rb', line 143

def inheritable_attributes
  @inheritable_attributes ||= EMPTY_INHERITABLE_ATTRIBUTES
end

#read_inheritable_attribute(key) ⇒ Object 



164
165
166
 
# File 'lib/merb-core/core_ext/class.rb', line 164

def read_inheritable_attribute(key)
  inheritable_attributes[key]
end

#reset_inheritable_attributes ⇒ Object 



168
169
170
 
# File 'lib/merb-core/core_ext/class.rb', line 168

def reset_inheritable_attributes
  @inheritable_attributes = EMPTY_INHERITABLE_ATTRIBUTES
end

#write_inheritable_array(key, elements) ⇒ Object 



154
155
156
157
 
# File 'lib/merb-core/core_ext/class.rb', line 154

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 



147
148
149
150
151
152
 
# File 'lib/merb-core/core_ext/class.rb', line 147

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 



159
160
161
162
 
# File 'lib/merb-core/core_ext/class.rb', line 159

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