class MIPSUnit::MSpec::TestDefinitionGroup

A (potentially nested) group of TestDefinition objects and related meta-data

Author: Zachary Kurmas
Copyright: Copyright © 2012

Attributes

before[R]

the list of before blocks

definitions[R]

the list of TestDefinition objects immediately contained in the describe block

description[R]

the description for this group (i.e., the parameter passed to the describe block)

nested_groups[R]

the list of nested TestDefinitionGroup objects (These tend to correspond to nested describe blocks.)

subject[R]

the name of the function under test. (May be nil)

Public Instance Methods

add_data_label(label) click to toggle source

Add a new data label, and complain if that label’s name is not unique

# File lib/mipsunit/mspec/test_definition_group.rb, line 102
def add_data_label(label)
  assert_label_not_defined_in_group_scope(label)
  @data_labels << label
end

ancestor_labels() click to toggle source

return an immutable array containing the labels defined for all ancestors

# File lib/mipsunit/mspec/test_definition_group.rb, line 80
def ancestor_labels
  (@parent.nil? ? [] : (@parent.ancestor_labels + @parent.local_data_labels)).freeze
end

assert_label_not_defined_in_group_scope(label) click to toggle source

Raises InvalidSpecException if a label with the same name has already been defined in the scope of this TestDefinitionGroup. A group’s scope includes all of its ancestors or descendants.

# File lib/mipsunit/mspec/test_definition_group.rb, line 110
def assert_label_not_defined_in_group_scope(label)
  if (data_labels + descendant_labels).map { |item| item.local_name }.include?(label.local_name)
    raise InvalidSpecException.new "Label \"#{label.local_name}\" already defined in this scope."
  end
end

assert_label_not_defined_in_object_scope(label) click to toggle source

Raises InvalidSpecException if a label with the same name has already been defined in the scope of a specific TestFactory object. A TestFactory’s scope includes the TestDefinitionGroup to which it belongs and all of that group’s ancestors.

# File lib/mipsunit/mspec/test_definition_group.rb, line 119
def assert_label_not_defined_in_object_scope(label)
  if (data_labels).map { |item| item.local_name }.include?(label.local_name)
    raise InvalidSpecException.new "Label \"#{label.local_name}\" already defined in this scope."
  end
end

cumulative_before() click to toggle source

Get all the before blocks for this group and its ancestors

# File lib/mipsunit/mspec/test_definition_group.rb, line 69
def cumulative_before
  @parent.nil? ? before : @parent.cumulative_before + before
end

cumulative_description() click to toggle source

Concatenate this group’s description and the descriptions of all of its ancestors

# File lib/mipsunit/mspec/test_definition_group.rb, line 62
def cumulative_description
  parent_description = @parent.nil? ? "" : "#{@parent.cumulative_description} "
  "#{parent_description}#{description}"
end

data_labels() click to toggle source

returns an immutable array of all data labels “in scope”

# File lib/mipsunit/mspec/test_definition_group.rb, line 96
def data_labels
  #(ancestor_labels + local_data_labels + descendant_labels).freeze
  (ancestor_labels + local_data_labels).freeze
end

descendant_labels() click to toggle source

return an immutable array containing the labels defined for this object and all descendants

# File lib/mipsunit/mspec/test_definition_group.rb, line 86
def descendant_labels
  @nested_groups.map { |ng| (ng.local_data_labels + ng.descendant_labels) }.flatten.freeze
end

local_data_labels() click to toggle source

return an immutable array containing this object’s data labels

# File lib/mipsunit/mspec/test_definition_group.rb, line 75
def local_data_labels
  @data_labels.dup.freeze
end

Public Class Methods

new(description, parent) click to toggle source

# File lib/mipsunit/mspec/test_definition_group.rb, line 27
def initialize(description, parent)
  @description = description.to_s
  @definitions = []
  @before = []
  @nested_groups = []
  @data_labels = []
  @parent = parent

  # This assumes that this object being initialized has not yet
  # been added to the parent's list of nested groups
  #  @order = parent.nil? ? 0 : @parent.nested_groups.size

  # if the description is a symbol, then assume that symbol
  # corresponds to the name of the procedure to test (i.e., the
  # "subject").  If the description is not a symbol, see if some
  # outer describe block did define a subject.  If there is no
  # parent, then there is no specified subject.  (Not specifying
  # a subject just means that calls to "it" must contain an
  # explicit parameter.)  Throw an exception if both this
  # describe block and some parent block attempt to specify a subject.
  if (description.is_a? Symbol)
    if @parent.nil? || @parent.subject.nil?
      @subject = description.to_s
    else
      raise InvalidSpecException.new("Error: Nested descriptions may specify only one subject." +
                                         "(In other words, you can't pass a symbol to a nested description " +
                                         "if some parent description is also described using a symbol.)")
    end # inner else
  else
    @subject = @parent.nil? ? nil : @parent.subject
  end # outer else
end