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

Inherits:
Object
  • Object
show all
Includes:
Util::BacktraceFilter
Defined in:
lib/test/unit/assertions.rb

Defined Under Namespace

Classes: ArrayInspector, DelayedLiteral, HashInspector, Inspector, Literal, MaybeContainer, Template

Constant Summary collapse

MAX_DIFF_TARGET_STRING_SIZE = 
1000
@@max_diff_target_string_size = 
nil

Constants included from Util::BacktraceFilter

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

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util::BacktraceFilter

filter_backtrace

Constructor Details

#initialize(head, template_string, parameters) ⇒ AssertionMessage

Returns a new instance of AssertionMessage.



1739
1740
1741
1742
1743
 
# File 'lib/test/unit/assertions.rb', line 1739

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.



1425
1426
1427
 
# File 'lib/test/unit/assertions.rb', line 1425

def use_pp
  @use_pp
end

Class Method Details

.convert(object) ⇒ Object 



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/test/unit/assertions.rb', line 1513

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

.delayed_diff(from, to) ⇒ Object 



1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/test/unit/assertions.rb', line 1490

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 



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

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

.diff_target_string?(string) ⇒ Boolean

Returns:

  • (Boolean) 


1459
1460
1461
1462
1463
1464
1465
 
# File 'lib/test/unit/assertions.rb', line 1459

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 



1467
1468
1469
1470
1471
1472
1473
 
# File 'lib/test/unit/assertions.rb', line 1467

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 



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

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

.max_diff_target_string_size ⇒ Object 



1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/test/unit/assertions.rb', line 1440

def max_diff_target_string_size
  return @@max_diff_target_string_size if @@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

.max_diff_target_string_size=(size) ⇒ Object 



1455
1456
1457
 
# File 'lib/test/unit/assertions.rb', line 1455

def max_diff_target_string_size=(size)
  @@max_diff_target_string_size = size
end

.maybe_container(value, &formatter) ⇒ Object 



1435
1436
1437
 
# File 'lib/test/unit/assertions.rb', line 1435

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

.prepare_for_diff(from, to) ⇒ Object 



1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/test/unit/assertions.rb', line 1475

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 



1753
1754
1755
 
# File 'lib/test/unit/assertions.rb', line 1753

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

#convert(object) ⇒ Object 



1745
1746
1747
 
# File 'lib/test/unit/assertions.rb', line 1745

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

#template ⇒ Object 



1749
1750
1751
 
# File 'lib/test/unit/assertions.rb', line 1749

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

#to_s ⇒ Object 



1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
 
# File 'lib/test/unit/assertions.rb', line 1757

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