Module: Test::Unit::Attribute::ClassMethods

Defined in:
lib/test/unit/attribute.rb

Constant Summary collapse

@@attribute_observers = 
StringifyKeyHash.new

Instance Method Summary collapse

Instance Method Details

#attribute(name, value) ⇒ void #attribute(name, value, *method_names) ⇒ void #attribute(name, value, options) ⇒ void #attribute(name, value, options, *method_names) ⇒ void

Set an attribute to test methods.

Overloads:

  • #attribute(name, value) ⇒ void

    This method returns an undefined value.

    Examples:

    attribute :speed, :slow
def test_my_slow_method
  self[:speed] # => :slow
end

    Parameters:

    • name (Object) —

      the attribute name

    • value (Object) —

      the attribute value

  • #attribute(name, value, *method_names) ⇒ void

    This method returns an undefined value.

    Examples:

    def test_my_slow_method1
  self[:speed] # => :slow
end

attribute :speed, :slow, :test_my_slow_method1, :test_my_slow_method2

def test_my_slow_method2
  self[:speed] # => :slow
end

    Parameters:

    • name (Object) —

      the attribute name

    • value (Object) —

      the attribute value

    • method_names (Array<Symbol, String>) —

      the test method names set the attribute

  • #attribute(name, value, options) ⇒ void

    This method returns an undefined value.

    Examples:

    attribute :speed, :slow, keep: true
def test_my_slow_method1
  self[:speed] # => :slow
end

def test_my_slow_method2
  self[:speed] # => :slow
end

    Parameters:

    • name (Object) —

      the attribute name

    • value (Object) —

      the attribute value

    Options Hash (options):

    • :keep (Boolean) —

      whether or not to set attribute to following test methods

  • #attribute(name, value, options, *method_names) ⇒ void

    This method returns an undefined value.

    Examples:

    def test_my_slow_method1
  self[:speed] # => :slow
end

# There are no valid options for now.
attribute :speed, :slow, {}, :test_my_slow_method1

def test_my_slow_method2
  self[:speed] # => nil
end

    Parameters:

    • name (Object) —

      the attribute name

    • value (Object) —

      the attribute value

    • options (Hash) —

      ignored

    • method_names (Array<Symbol, String>) —

      the test method names set the attribute



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/test/unit/attribute.rb', line 120

def attribute(name, value, options={}, *method_names)
  unless options.is_a?(Hash)
    method_names << options
    options = {}
  end
  if method_names.empty?
    current_attributes[name] = options.merge(:value => value)
  else
    method_names.each do |method_name|
      set_attributes(method_name, {name => value})
    end
  end
end

#attribute_observers(attribute_name) ⇒ Object 



214
215
216
 
# File 'lib/test/unit/attribute.rb', line 214

def attribute_observers(attribute_name)
  @@attribute_observers[attribute_name]
end

#attributes(method_name) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/test/unit/attribute.rb', line 165

def attributes(method_name)
  attributes = attributes_table[method_name]
  ancestors.each do |ancestor|
    next if ancestor == self
    if ancestor.is_a?(Class) and ancestor < Test::Unit::Attribute
      parent_attributes = ancestor.attributes(method_name)
      if attributes
        attributes = (parent_attributes || {}).merge(attributes)
      else
        attributes = parent_attributes
      end
      break
    end
  end
  attributes || StringifyKeyHash.new
end

#attributes_table ⇒ Object 



142
143
144
145
 
# File 'lib/test/unit/attribute.rb', line 142

def attributes_table
  @attributes_table ||= StringifyKeyHash.new
  super.merge(@attributes_table)
end

#current_attribute(name) ⇒ Object 



138
139
140
 
# File 'lib/test/unit/attribute.rb', line 138

def current_attribute(name)
  current_attributes[name] || StringifyKeyHash.new
end

#current_attributes ⇒ Object 



134
135
136
 
# File 'lib/test/unit/attribute.rb', line 134

def current_attributes
  @current_attributes ||= StringifyKeyHash.new
end

#find_attribute(method_name, name, options = {}) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/test/unit/attribute.rb', line 182

def find_attribute(method_name, name, options={})
  recursive_p = options[:recursive]
  recursive_p = true if recursive_p.nil?

  @attributes_table ||= StringifyKeyHash.new
  if @attributes_table.key?(method_name)
    attributes = @attributes_table[method_name]
    if attributes.key?(name)
      return attributes[name]
    end
  end

  return nil unless recursive_p
  return nil if self == TestCase

  @cached_parent_test_case ||= ancestors.find do |ancestor|
    ancestor != self and
      ancestor.is_a?(Class) and
      ancestor < Test::Unit::Attribute
  end
  return nil if @cached_parent_test_case.nil?

  @cached_parent_test_case.find_attribute(method_name, name, options)
end

#method_added(name) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/test/unit/attribute.rb', line 38

def method_added(name)
  super
  return unless defined?(@current_attributes)

  attributes = {}
  kept_attributes = StringifyKeyHash.new
  @current_attributes.each do |attribute_name, attribute|
    attributes[attribute_name] = attribute[:value]
    if attribute[:keep]
      keep_hook = attribute[:keep_hook]
      attribute = keep_hook.call(attribute) if keep_hook
      kept_attributes[attribute_name] = attribute
    end
  end
  set_attributes(name, attributes)
  @current_attributes = kept_attributes
end

#register_attribute_observer(attribute_name, observer = nil, &block) ⇒ Object 



208
209
210
211
212
 
# File 'lib/test/unit/attribute.rb', line 208

def register_attribute_observer(attribute_name, observer=nil, &block)
  observer ||= Proc.new(&block)
  @@attribute_observers[attribute_name] ||= []
  @@attribute_observers[attribute_name] << observer
end

#set_attributes(method_name, new_attributes) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/test/unit/attribute.rb', line 147

def set_attributes(method_name, new_attributes)
  return if new_attributes.empty?
  @attributes_table ||= StringifyKeyHash.new
  @attributes_table[method_name] ||= StringifyKeyHash.new
  current_attributes = @attributes_table[method_name]
  new_attributes.each do |key, value|
    observers = attribute_observers(key) || []
    observers.each do |observer|
      observer.call(self,
                    StringifyKeyHash.stringify(key),
                    (attributes(method_name) || {})[key],
                    value,
                    method_name)
    end
    current_attributes[key] = value
  end
end