treetop 0.1.0 → 1.0.0

data/test/parser/terminal_parse_failure_test.rb

@@ -0,0 +1,22 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../test_helper"
+
+describe "A terminal parse failure" do
+  def setup
+    @input = "test input"
+    @failure = Runtime::TerminalParseFailure.new(@input, 1, "foo")
+  end
+  
+  it "is == to a parse failure at the same index expecting the same string" do
+    @failure.should == Runtime::TerminalParseFailure.new(@input, 1, "foo")
+  end
+  
+  it "is eql to a parse failure at the same index expecting the same string" do
+    @failure.should eql(Runtime::TerminalParseFailure.new(@input, 1, "foo"))
+    @failure.hash.should == Runtime::TerminalParseFailure.new(@input, 1, "foo").hash
+  end
+  
+  it "is considered identical to another failure with the same index and expected string in an array" do        
+    [Runtime::TerminalParseFailure.new(@input, 1, "foo"), Runtime::TerminalParseFailure.new(@input, 1, "foo")].uniq.size.should == 1
+  end
+end

data/test/ruby_extensions/string_test.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class StringTest < Screw::Unit::TestCase
+  
+  def setup
+    @string = %{
+      0123456789
+      012345
+      01234567
+      0123
+    }.tabto(0).strip
+  end
+  
+  test "column numbers" do
+    @string.column_of(0).should == 1
+    @string.column_of(5).should == 6
+    @string.column_of(10).should == 11
+    @string.column_of(11).should == 1
+    @string.column_of(17).should == 7
+    @string.column_of(18).should == 1
+    @string.column_of(24).should == 7
+  end
+  
+  test "line numbers" do
+    @string.line_of(0).should == 1
+    @string.line_of(5).should == 1
+    @string.line_of(10).should == 1
+    @string.line_of(11).should == 2
+    @string.line_of(17).should == 2
+    @string.line_of(18).should == 3
+    @string.line_of(24).should == 3
+  end
+end

data/test/screw/Rakefile

@@ -0,0 +1,16 @@
+spec = Gem::Specification.new do |s| 
+  s.name = "Screw::Unit"
+  s.version = "0.0.1"
+  s.author = "Nathan Sobo"
+  s.email = "nathansobo@gmail.com"
+  s.homepage = "http://screwunit.rubyforge.org"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "RSpec-style syntactic sugar that is backward compatible with Test::Unit"
+  s.files = FileList["{unit}/**/*"].to_a
+  s.require_path = "lib"
+  s.autorequire = "name"
+  s.test_files = FileList["{test}/**/*test.rb"].to_a
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README"]
+  s.add_dependency("dependency", ">= 0.x.x")
+end

data/test/screw/unit.rb

@@ -0,0 +1,37 @@
+dir = File.dirname(__FILE__)
+require 'rubygems'
+require 'spec/expectations'
+require 'spec/matchers'
+
+require File.join(dir, 'unit', 'util')
+require File.join(dir, 'unit', 'assertion_failed_error')
+require File.join(dir, 'unit', 'assertions')
+require File.join(dir, 'unit', 'collector')
+require File.join(dir, 'unit', 'error')
+require File.join(dir, 'unit', 'failure')
+require File.join(dir, 'unit', 'test_case')
+require File.join(dir, 'unit', 'test_result')
+require File.join(dir, 'unit', 'test_suite')
+require File.join(dir, 'unit', 'ui')
+require File.join(dir, 'unit', 'auto_runner')
+require File.join(dir, 'unit', 'sugar')
+
+module Screw
+  module Unit
+    # If set to false Screw::Unit will not automatically run at exit.
+    def self.run=(flag)
+      @run = flag
+    end
+
+    # Automatically run tests at exit?
+    def self.run?
+      @run ||= false
+    end
+  end
+end
+
+at_exit do
+  unless $! || Screw::Unit.run?
+    exit Screw::Unit::AutoRunner.run
+  end
+end

data/test/screw/unit/assertion_failed_error.rb

@@ -0,0 +1,14 @@
+#--
+#
+# Author:: Nathaniel Talbott.
+# Copyright:: Copyright (c) 2000-2002 Nathaniel Talbott. All rights reserved.
+# License:: Ruby license.
+
+module Screw
+  module Unit
+
+    # Thrown by Screw::Unit::Assertions when an assertion fails.
+    class AssertionFailedError < StandardError
+    end
+  end
+end

data/test/screw/unit/assertions.rb

@@ -0,0 +1,615 @@
+module Screw
+  module Unit
+
+    ##
+    # Screw::Unit::Assertions contains the standard Screw::Unit assertions.
+    # Assertions is included in Screw::Unit::TestCase.
+    #
+    # To include it in your own code and use its functionality, you simply
+    # need to rescue Screw::Unit::AssertionFailedError. Additionally you may
+    # override add_assertion to get notified whenever an assertion is made.
+    #
+    # Notes:
+    # * The message to each assertion, if given, will be propagated with the
+    #   failure.
+    # * It is easy to add your own assertions based on assert_block().
+    #
+    # = Example Custom Assertion
+    #
+    #   def deny(boolean, message = nil)
+    #     message = build_message message, '<?> is not false or nil.', boolean
+    #     assert_block message do
+    #       not boolean
+    #     end
+    #   end
+
+    module Assertions
+
+      ##
+      # The assertion upon which all other assertions are based. Passes if the
+      # block yields true.
+      #
+      # Example:
+      #   assert_block "Couldn't do the thing" do
+      #     do_the_thing
+      #   end
+
+      public
+      def assert_block(message="assert_block failed.") # :yields: 
+        _wrap_assertion do
+          if (! yield)
+            raise AssertionFailedError.new(message.to_s)
+          end
+        end
+      end
+
+      ##
+      # Asserts that +boolean+ is not false or nil.
+      #
+      # Example:
+      #   assert [1, 2].include?(5)
+
+      public
+      def assert(boolean, message=nil)
+        _wrap_assertion do
+          assert_block("assert should not be called with a block.") { !block_given? }
+          assert_block(build_message(message, "<?> is not true.", boolean)) { boolean }
+        end
+      end
+
+      ##
+      # Passes if +expected+ == +actual.
+      #
+      # Note that the ordering of arguments is important, since a helpful
+      # error message is generated when this one fails that tells you the
+      # values of expected and actual.
+      #
+      # Example:
+      #   assert_equal 'MY STRING', 'my string'.upcase
+
+      public
+      def assert_equal(expected, actual, message=nil)
+        full_message = build_message(message, <<EOT, expected, actual)
+<?> expected but was
+<?>.
+EOT
+        assert_block(full_message) { expected == actual }
+      end
+
+      private
+      def _check_exception_class(args) # :nodoc:
+        args.partition do |klass|
+          next if klass.instance_of?(Module)
+          assert(Exception >= klass, "Should expect a class of exception, #{klass}")
+          true
+        end
+      end
+
+      private
+      def _expected_exception?(actual_exception, exceptions, modules) # :nodoc:
+        exceptions.include?(actual_exception.class) or
+          modules.any? {|mod| actual_exception.is_a?(mod)}
+      end
+
+      ##
+      # Passes if the block raises one of the given exceptions.
+      #
+      # Example:
+      #   assert_raise RuntimeError, LoadError do
+      #     raise 'Boom!!!'
+      #   end
+
+      public
+      def assert_raise(*args)
+        _wrap_assertion do
+          if Module === args.last
+            message = ""
+          else
+            message = args.pop
+          end
+          exceptions, modules = _check_exception_class(args)
+          expected = args.size == 1 ? args.first : args
+          actual_exception = nil
+          full_message = build_message(message, "<?> exception expected but none was thrown.", expected)
+          assert_block(full_message) do
+            begin
+              yield
+            rescue Exception => actual_exception
+              break
+            end
+            false
+          end
+          full_message = build_message(message, "<?> exception expected but was\n?", expected, actual_exception)
+          assert_block(full_message) {_expected_exception?(actual_exception, exceptions, modules)}
+          actual_exception
+        end
+      end
+
+      ##
+      # Alias of assert_raise.
+      #
+      # Will be deprecated in 1.9, and removed in 2.0.
+
+      public
+      def assert_raises(*args, &block)
+        assert_raise(*args, &block)
+      end
+
+      ##
+      # Passes if +object+ .instance_of? +klass+
+      #
+      # Example:
+      #   assert_instance_of String, 'foo'
+
+      public
+      def assert_instance_of(klass, object, message="")
+        _wrap_assertion do
+          assert_equal(Class, klass.class, "assert_instance_of takes a Class as its first argument")
+          full_message = build_message(message, <<EOT, object, klass, object.class)
+<?> expected to be an instance of
+<?> but was
+<?>.
+EOT
+          assert_block(full_message){object.instance_of?(klass)}
+        end
+      end
+
+      ##
+      # Passes if +object+ is nil.
+      #
+      # Example:
+      #   assert_nil [1, 2].uniq!
+
+      public
+      def assert_nil(object, message="")
+        assert_equal(nil, object, message)
+      end
+
+      ##
+      # Passes if +object+ .kind_of? +klass+
+      #
+      # Example:
+      #   assert_kind_of Object, 'foo'
+
+      public
+      def assert_kind_of(klass, object, message="")
+        _wrap_assertion do
+          assert(klass.kind_of?(Module), "The first parameter to assert_kind_of should be a kind_of Module.")
+          full_message = build_message(message, "<?>\nexpected to be kind_of\\?\n<?> but was\n<?>.", object, klass, object.class)
+          assert_block(full_message){object.kind_of?(klass)}
+        end
+      end
+
+      ##
+      # Passes if +object+ .respond_to? +method+
+      #
+      # Example:
+      #   assert_respond_to 'bugbear', :slice
+
+      public
+      def assert_respond_to(object, method, message="")
+        _wrap_assertion do
+          full_message = build_message(nil, "<?>\ngiven as the method name argument to #assert_respond_to must be a Symbol or #respond_to\\?(:to_str).", method)
+
+          assert_block(full_message) do
+            method.kind_of?(Symbol) || method.respond_to?(:to_str)
+          end
+          full_message = build_message(message, <<EOT, object, object.class, method)
+<?>
+of type <?>
+expected to respond_to\\?<?>.
+EOT
+          assert_block(full_message) { object.respond_to?(method) }
+        end
+      end
+
+      ##
+      # Passes if +string+ =~ +pattern+.
+      #
+      # Example:
+      #   assert_match(/\d+/, 'five, 6, seven')
+
+      public
+      def assert_match(pattern, string, message="")
+        _wrap_assertion do
+          pattern = case(pattern)
+            when String
+              Regexp.new(Regexp.escape(pattern))
+            else
+              pattern
+          end
+          full_message = build_message(message, "<?> expected to be =~\n<?>.", string, pattern)
+          assert_block(full_message) { string =~ pattern }
+        end
+      end
+
+      ##
+      # Passes if +actual+ .equal? +expected+ (i.e. they are the same
+      # instance).
+      #
+      # Example:
+      #   o = Object.new
+      #   assert_same o, o
+
+      public
+      def assert_same(expected, actual, message="")
+        full_message = build_message(message, <<EOT, expected, expected.__id__, actual, actual.__id__)
+<?>
+with id <?> expected to be equal\\? to
+<?>
+with id <?>.
+EOT
+        assert_block(full_message) { actual.equal?(expected) }
+      end
+
+      ##
+      # Compares the +object1+ with +object2+ using +operator+.
+      #
+      # Passes if object1.__send__(operator, object2) is true.
+      #
+      # Example:
+      #   assert_operator 5, :>=, 4
+
+      public
+      def assert_operator(object1, operator, object2, message="")
+        _wrap_assertion do
+          full_message = build_message(nil, "<?>\ngiven as the operator for #assert_operator must be a Symbol or #respond_to\\?(:to_str).", operator)
+          assert_block(full_message){operator.kind_of?(Symbol) || operator.respond_to?(:to_str)}
+          full_message = build_message(message, <<EOT, object1, AssertionMessage.literal(operator), object2)
+<?> expected to be
+?
+<?>.
+EOT
+          assert_block(full_message) { object1.__send__(operator, object2) }
+        end
+      end
+
+      ##
+      # Passes if block does not raise an exception.
+      #
+      # Example:
+      #   assert_nothing_raised do
+      #     [1, 2].uniq
+      #   end
+
+      public
+      def assert_nothing_raised(*args)
+        _wrap_assertion do
+          if Module === args.last
+            message = ""
+          else
+            message = args.pop
+          end
+          exceptions, modules = _check_exception_class(args)
+          begin
+            yield
+          rescue Exception => e
+            if ((args.empty? && !e.instance_of?(AssertionFailedError)) ||
+                _expected_exception?(e, exceptions, modules))
+              assert_block(build_message(message, "Exception raised:\n?", e)){false}
+            else
+              raise
+            end
+          end
+          nil
+        end
+      end
+
+      ##
+      # Flunk always fails.
+      #
+      # Example:
+      #   flunk 'Not done testing yet.'
+
+      public
+      def flunk(message="Flunked")
+        assert_block(build_message(message)){false}
+      end
+
+      ##
+      # Passes if ! +actual+ .equal? +expected+
+      #
+      # Example:
+      #   assert_not_same Object.new, Object.new
+
+      public
+      def assert_not_same(expected, actual, message="")
+        full_message = build_message(message, <<EOT, expected, expected.__id__, actual, actual.__id__)
+<?>
+with id <?> expected to not be equal\\? to
+<?>
+with id <?>.
+EOT
+        assert_block(full_message) { !actual.equal?(expected) }
+      end
+
+      ##
+      # Passes if +expected+ != +actual+
+      #
+      # Example:
+      #   assert_not_equal 'some string', 5
+
+      public
+      def assert_not_equal(expected, actual, message="")
+        full_message = build_message(message, "<?> expected to be != to\n<?>.", expected, actual)
+        assert_block(full_message) { expected != actual }
+      end
+
+      ##
+      # Passes if ! +object+ .nil?
+      #
+      # Example:
+      #   assert_not_nil '1 two 3'.sub!(/two/, '2')
+
+      public
+      def assert_not_nil(object, message="")
+        full_message = build_message(message, "<?> expected to not be nil.", object)
+        assert_block(full_message){!object.nil?}
+      end
+
+      ##
+      # Passes if +regexp+ !~ +string+ 
+      #
+      # Example:
+      #   assert_no_match(/two/, 'one 2 three')
+
+      public
+      def assert_no_match(regexp, string, message="")
+        _wrap_assertion do
+          assert_instance_of(Regexp, regexp, "The first argument to assert_no_match should be a Regexp.")
+          full_message = build_message(message, "<?> expected to not match\n<?>.", regexp, string)
+          assert_block(full_message) { regexp !~ string }
+        end
+      end
+
+      UncaughtThrow = {NameError => /^uncaught throw \`(.+)\'$/,
+                       ThreadError => /^uncaught throw \`(.+)\' in thread /} #`
+
+      ##
+      # Passes if the block throws +expected_symbol+
+      #
+      # Example:
+      #   assert_throws :done do
+      #     throw :done
+      #   end
+
+      public
+      def assert_throws(expected_symbol, message="", &proc)
+        _wrap_assertion do
+          assert_instance_of(Symbol, expected_symbol, "assert_throws expects the symbol that should be thrown for its first argument")
+          assert_block("Should have passed a block to assert_throws."){block_given?}
+          caught = true
+          begin
+            catch(expected_symbol) do
+              proc.call
+              caught = false
+            end
+            full_message = build_message(message, "<?> should have been thrown.", expected_symbol)
+            assert_block(full_message){caught}
+          rescue NameError, ThreadError => error
+            if UncaughtThrow[error.class] !~ error.message
+              raise error
+            end
+            full_message = build_message(message, "<?> expected to be thrown but\n<?> was thrown.", expected_symbol, $1.intern)
+            flunk(full_message)
+          end
+        end
+      end
+
+      ##
+      # Passes if block does not throw anything.
+      #
+      # Example:
+      #  assert_nothing_thrown do
+      #    [1, 2].uniq
+      #  end
+
+      public
+      def assert_nothing_thrown(message="", &proc)
+        _wrap_assertion do
+          assert(block_given?, "Should have passed a block to assert_nothing_thrown")
+          begin
+            proc.call
+          rescue NameError, ThreadError => error
+            if UncaughtThrow[error.class] !~ error.message
+              raise error
+            end
+            full_message = build_message(message, "<?> was thrown when nothing was expected", $1.intern)
+            flunk(full_message)
+          end
+          assert(true, "Expected nothing to be thrown")
+        end
+      end
+
+      ##
+      # Passes if +expected_float+ and +actual_float+ are equal
+      # within +delta+ tolerance.
+      #
+      # Example:
+      #   assert_in_delta 0.05, (50000.0 / 10**6), 0.00001
+
+      public
+      def assert_in_delta(expected_float, actual_float, delta, message="")
+        _wrap_assertion do
+          {expected_float => "first float", actual_float => "second float", delta => "delta"}.each do |float, name|
+            assert_respond_to(float, :to_f, "The arguments must respond to to_f; the #{name} did not")
+          end
+          assert_operator(delta, :>=, 0.0, "The delta should not be negative")
+          full_message = build_message(message, <<EOT, expected_float, actual_float, delta)
+<?> and
+<?> expected to be within
+<?> of each other.
+EOT
+          assert_block(full_message) { (expected_float.to_f - actual_float.to_f).abs <= delta.to_f }
+        end
+      end
+
+      ##
+      # Passes if the method send returns a true value.
+      #
+      # +send_array+ is composed of:
+      # * A receiver
+      # * A method
+      # * Arguments to the method
+      #
+      # Example:
+      #   assert_send [[1, 2], :include?, 4]
+
+      public
+      def assert_send(send_array, message="")
+        _wrap_assertion do
+          assert_instance_of(Array, send_array, "assert_send requires an array of send information")
+          assert(send_array.size >= 2, "assert_send requires at least a receiver and a message name")
+          full_message = build_message(message, <<EOT, send_array[0], AssertionMessage.literal(send_array[1].to_s), send_array[2..-1])
+<?> expected to respond to
+<?(?)> with a true value.
+EOT
+          assert_block(full_message) { send_array[0].__send__(send_array[1], *send_array[2..-1]) }
+        end
+      end
+
+      ##
+      # Builds a failure message.  +head+ is added before the +template+ and
+      # +arguments+ replaces the '?'s positionally in the template.
+
+      public
+      def build_message(head, template=nil, *arguments)
+        template &&= template.chomp
+        return AssertionMessage.new(head, template, arguments)
+      end
+
+      private
+      def _wrap_assertion
+        @_assertion_wrapped ||= false
+        unless (@_assertion_wrapped)
+          @_assertion_wrapped = true
+          begin
+            add_assertion
+            return yield
+          ensure
+            @_assertion_wrapped = false
+          end
+        else
+          return yield
+        end
+      end
+      
+      ##
+      # Called whenever an assertion is made.  Define this in classes that
+      # include Screw::Unit::Assertions to record assertion counts.
+
+      private
+      def add_assertion
+      end
+
+      ##
+      # Select whether or not to use the pretty-printer. If this option is set
+      # to false before any assertions are made, pp.rb will not be required.
+
+      public
+      def self.use_pp=(value)
+        AssertionMessage.use_pp = value
+      end
+      
+      # :stopdoc:
+
+      class AssertionMessage
+        @use_pp = true
+        class << self
+          attr_accessor :use_pp
+        end
+
+        class Literal
+          def initialize(value)
+            @value = value
+          end
+          
+          def inspect
+            @value.to_s
+          end
+        end
+
+        class Template
+          def self.create(string)
+            parts = (string ? string.scan(/(?=[^\\])\?|(?:\\\?|[^\?])+/m) : [])
+            self.new(parts)
+          end
+
+          attr_reader :count
+
+          def initialize(parts)
+            @parts = parts
+            @count = parts.find_all{|e| e == '?'}.size
+          end
+
+          def result(parameters)
+            raise "The number of parameters does not match the number of substitutions." if(parameters.size != count)
+            params = parameters.dup
+            @parts.collect{|e| e == '?' ? params.shift : e.gsub(/\\\?/m, '?')}.join('')
+          end
+        end
+
+        def self.literal(value)
+          Literal.new(value)
+        end
+
+        include Util::BacktraceFilter
+
+        def initialize(head, template_string, parameters)
+          @head = head
+          @template_string = template_string
+          @parameters = parameters
+        end
+
+        def convert(object)
+          case object
+            when Exception
+              <<EOM.chop
+Class: <#{convert(object.class)}>
+Message: <#{convert(object.message)}>
+---Backtrace---
+#{filter_backtrace(object.backtrace).join("\n")}
+---------------
+EOM
+            else
+              if(self.class.use_pp)
+                begin
+                  require 'pp'
+                rescue LoadError
+                  self.class.use_pp = false
+                  return object.inspect
+                end unless(defined?(PP))
+                PP.pp(object, '').chomp
+              else
+                object.inspect
+              end
+          end
+        end
+
+        def template
+          @template ||= Template.create(@template_string)
+        end
+
+        def add_period(string)
+          (string =~ /\.\Z/ ? string : string + '.')
+        end
+
+        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
+      end
+
+      # :startdoc:
+
+    end
+  end
+end