Class: Test::Unit::Assertions::AssertionMessage

Inherits:

Object

• Object
• Test::Unit::Assertions::AssertionMessage

Includes:

Util::BacktraceFilter

Defined in:

lib/test/unit/assertions.rb

Defined Under Namespace

Classes: DelayedLiteral, HashInspector, Literal, MaybeContainer, Template

Constant Summary

MAX_DIFF_TARGET_STRING_SIZE =

1000

Constants included from Util::BacktraceFilter

Util::BacktraceFilter::TESTUNIT_FILE_SEPARATORS, Util::BacktraceFilter::TESTUNIT_PREFIX, Util::BacktraceFilter::TESTUNIT_RB_FILE

Class Attribute Summary

• .use_pp ⇒ Object

  Returns the value of attribute use_pp.

Class Method Summary

• .convert(object) ⇒ Object
• .delayed_diff(from, to) ⇒ Object
• .delayed_literal(&block) ⇒ Object
• .diff_target_string?(string) ⇒ Boolean
• .ensure_diffable_string(string) ⇒ Object
• .literal(value) ⇒ Object
• .max_diff_target_string_size ⇒ Object
• .maybe_container(value, &formatter) ⇒ Object
• .prepare_for_diff(from, to) ⇒ Object

Instance Method Summary

• #add_period(string) ⇒ Object
• #convert(object) ⇒ Object
• #initialize(head, template_string, parameters) ⇒ AssertionMessage constructor

  A new instance of AssertionMessage.

• #template ⇒ Object
• #to_s ⇒ Object

Methods included from Util::BacktraceFilter

filter_backtrace

Constructor Details

#initialize(head, template_string, parameters) ⇒ AssertionMessage

Returns a new instance of AssertionMessage.

# File 'lib/test/unit/assertions.rb', line 1641

def initialize(head, template_string, parameters)
  @head = head
  @template_string = template_string
  @parameters = parameters
end

Class Attribute Details

.use_pp ⇒ Object

Returns the value of attribute use_pp.

# File 'lib/test/unit/assertions.rb', line 1418

def use_pp
  @use_pp
end

Class Method Details

.convert(object) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1499

def convert(object)
  case object
  when Exception
    <<EOM.chop
Class: <#{convert(object.class)}>
Message: <#{convert(object.message)}>
---Backtrace---
#{Util::BacktraceFilter.filter_backtrace(object.backtrace).join("\n")}
---------------
EOM
  else
    if use_pp
      begin
        require 'pp' unless defined?(PP)
        if HashInspector.target?(object)
          pp_target = HashInspector.new(object)
        else
          pp_target = object
        end
        begin
          return PP.pp(pp_target, '').chomp
        rescue NameError
        end
      rescue LoadError
        self.use_pp = false
      end
    end
    object.inspect
  end
end

.delayed_diff(from, to) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1476

def delayed_diff(from, to)
  delayed_literal do
    from, to = prepare_for_diff(from, to)

    diff = "" if from.nil? or to.nil?
    diff ||= Diff.readable(from, to)
    if /^[-+]/ !~ diff
      diff = ""
    elsif /^[ ?]/ =~ diff or /(?:.*\n){2,}/ =~ diff
      diff = "\n\ndiff:\n#{diff}"
    else
      diff = ""
    end

    if Diff.need_fold?(diff)
      folded_diff = Diff.folded_readable(from, to)
      diff << "\n\nfolded diff:\n#{folded_diff}"
    end

    diff
  end
end

.delayed_literal(&block) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1424

def delayed_literal(&block)
  DelayedLiteral.new(block)
end

.diff_target_string?(string) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/test/unit/assertions.rb', line 1445

def diff_target_string?(string)
  if string.respond_to?(:bytesize)
    string.bytesize < max_diff_target_string_size
  else
    string.size < max_diff_target_string_size
  end
end

.ensure_diffable_string(string) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1453

def ensure_diffable_string(string)
  if string.respond_to?(:encoding) and
      !string.encoding.ascii_compatible?
    string = string.dup.force_encoding("ASCII-8BIT")
  end
  string
end

.literal(value) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1420

def literal(value)
  Literal.new(value)
end

.max_diff_target_string_size ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1433

def max_diff_target_string_size
  size = ENV["TEST_UNIT_MAX_DIFF_TARGET_STRING_SIZE"]
  if size
    begin
      size = Integer(size)
    rescue ArgumentError
      size = nil
    end
  end
  size || MAX_DIFF_TARGET_STRING_SIZE
end

.maybe_container(value, &formatter) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1428

def maybe_container(value, &formatter)
  MaybeContainer.new(value, &formatter)
end

.prepare_for_diff(from, to) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1461

def prepare_for_diff(from, to)
  if !from.is_a?(String) or !to.is_a?(String)
    from = convert(from)
    to = convert(to)
  end

  if diff_target_string?(from) and diff_target_string?(to)
    from = ensure_diffable_string(from)
    to = ensure_diffable_string(to)
    [from, to]
  else
    [nil, nil]
  end
end

Instance Method Details

#add_period(string) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1655

def add_period(string)
  (string =~ /\.\Z/ ? string : string + '.')
end

#convert(object) ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1647

def convert(object)
  self.class.convert(object)
end

#template ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1651

def template
  @template ||= Template.create(@template_string)
end

#to_s ⇒ Object

# File 'lib/test/unit/assertions.rb', line 1659

def to_s
  message_parts = []
  if (@head)
    head = @head.to_s 
    unless(head.empty?)
      message_parts << add_period(head)
    end
  end
  tail = template.result(@parameters.collect{|e| convert(e)})
  message_parts << tail unless(tail.empty?)
  message_parts.join("\n")
end