mhennemeyer-matchy 0.2.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-10-03
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jeremy McAnally
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+matchy.gemspec
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/matchy.rb
+lib/matchy/version.rb
+lib/matchy/expectation_builder
+lib/matchy/modals.rb
+lib/matchy/def_matcher.rb
+lib/matchy/matcher_builder.rb
+lib/matchy/built_in/enumerable_expectations.rb
+lib/matchy/built_in/error_expectations.rb
+lib/matchy/built_in/operator_expectations.rb
+lib/matchy/built_in/truth_expectations.rb
+lib/matchy/built_in/change_expectations.rb
+setup.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on matchy, see http://matchy.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,119 @@
+= matchy
+
+* http://github.com/mhennemeyer/matchy
+
+== DESCRIPTION:
+A 300loc refactoring of Jeremy Mcanally's Matchy. Original Description: 
+Hate writing assertions?  Need a little behavior-driven love in your tests?  Then matchy is for you.
+
+== FEATURES/PROBLEMS:
+
+* Get the beauty of RSpec without all the overhead
+* Create your own matchers with ease and def_matcher()
+
+== SYNOPSIS:
+
+* Get BDD on your objects
+
+    x = 13 * 4
+    x.should == 42
+    
+    y = "hello"
+    y.length.should_not be(4)
+
+* Use familiar syntax to specify things
+
+    # RSpec
+    "my string".should =~ /string/
+    lambda { raise "FAIL" }.should raise_error
+    
+    # matchy
+    "my string".should =~ /string/
+    lambda { raise "FAIL" }.should raise_error
+
+* Most of familiar RSpec Matchers are built in
+
+    # raise_error matcher
+    lambda {raise}.should raise_error                                  #pass
+    lambda {raise MyCustomError.new}.should raise_error(MyCustomError) #pass
+    lambda {raise "message"}.should raise_error("message")             #pass
+    lambda {raise "message"}.should raise_error(/essa/)                #pass
+
+    # change matcher
+    lambda {@var+=1}.should change {@var}
+    # passes
+    lambda { }.should change {@var}
+    # fails
+    @var = 1
+    lambda {@var+=1}.should change {@var}.from(1).to(2)
+    # passes
+
+    # be_something matcher
+    @obj.should be_something
+    # passes if @obj.something? is true
+
+    * a lot more ...
+    
+* Get the speed of Test:Unit with the syntax of RSpec
+
+* Create your own matchers
+    
+    # nil_matcher (As a simple and quick example)
+    def_matcher :be_nil do |receiver, matcher, args|
+      receiver.nil?
+    end
+
+    nil.should be_nil            # pass
+    nil.should_not be_nil        # fails
+    'notnil'.should be_nil       # fails
+    'notnil'.should_not be_nil   # pass
+
+    # have(n).somethings matcher (A little bit more complex)
+    def_matcher :have do |receiver, matcher, args|  
+		  count = args[0]
+		  something = matcher.msgs[0].name
+		  actual = receiver.send(something).length
+		  matcher.positive_msg = "Expected #{receiver} to have #{actual} #{something}, but found #{count} "
+		  actual == count
+		end
+		
+		class Thing
+		  def widgets
+		    @widgets ||= []
+		  end
+		end
+		@thing.should have(3).widgets 
+
+== REQUIREMENTS:
+
+* Test::Unit (you got it)
+
+== INSTALL:
+
+    $ gem sources -a http://gems.github.com
+    $ sudo gem install mhennemeyer-matchy
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Jeremy McAnally
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'matchy/version'
+
+AUTHOR = 'Jeremy McAnally'  # can also be an array of Authors
+EMAIL = "jeremy@entp.com"
+DESCRIPTION = "RSpec-esque matchers for use in Test::Unit"
+GEM_NAME = 'matchy' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'matchy' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Matchy::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'matchy documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README.rdoc",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/matchy.rb

@@ -0,0 +1,54 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# Matchy should work with either test/unit 
+# or minitest
+module Matchy
+  def self.minitest?
+    # This needs to be better.
+    # How can we decide if we really have a 
+    # suite of MiniTest Tests?
+    # Rails for example defines MiniTest, so only check for
+    # defined?(MiniTest) would be malicious
+    defined?(MiniTest) && defined?(MiniTest::Assertions) && 
+        (!defined?(Test::Unit::TestCase) || !(Test::Unit::TestCase < MiniTest::Assertions))
+  end
+  def self.assertions_module
+    minitest? ? MiniTest::Assertions : Test::Unit::Assertions
+  end
+  def self.test_case_class
+    minitest? ? MiniTest::Unit::TestCase : Test::Unit::TestCase
+  end
+end
+
+require 'rubygems'
+require 'test/unit' unless Matchy.minitest?
+
+require 'matchy/expectation_builder'
+require 'matchy/modals'
+require 'matchy/version'
+require 'matchy/matcher_builder'
+require 'matchy/def_matcher'
+
+require 'matchy/built_in/enumerable_expectations'
+require 'matchy/built_in/error_expectations'
+require 'matchy/built_in/truth_expectations'
+require 'matchy/built_in/operator_expectations'
+require 'matchy/built_in/change_expectations'
+
+
+# Hack of Evil.
+# Track the current testcase and 
+# provide it to the operator matchers.
+Matchy.test_case_class.class_eval do
+  alias_method :old_run_method_aliased_by_matchy, :run
+  def run(whatever, *args, &block)
+    $current_test_case = self
+    old_run_method_aliased_by_matchy(whatever, *args, &block)
+  end
+end
+
+Matchy.test_case_class.send(:include, Matchy::Expectations::TestCaseExtensions)
+
+include Matchy::DefMatcher
+

data/lib/matchy/built_in/change_expectations.rb

@@ -0,0 +1,31 @@
+module Matchy
+  module Expectations
+    module TestCaseExtensions
+      # Checks if the given block alters the value of the block attached to change
+      #
+      # ==== Examples
+      #   lambda {var += 1}.should change {var}.by(1)
+      #   lambda {var += 2}.should change {var}.by_at_least(1)
+      #   lambda {var += 1}.should change {var}.by_at_most(1)
+      #   lambda {var += 2}.should change {var}.from(1).to(3) if var = 1
+      def change(&block)
+        build_matcher(:change) do |receiver, matcher, args|
+          before, done, after = block.call, receiver.call, block.call
+          comparison = after != before
+          if list = matcher.msgs
+            comparison = case list[0].name
+              # todo: provide meaningful messages
+            when :by          then (after == before + list[0].args[0] || after == before - list[0].args[0])
+            when :by_at_least then (after >= before + list[0].args[0] || after <= before - list[0].args[0])
+            when :by_at_most  then (after <= before + list[0].args[0] && after >= before - list[0].args[0])
+            when :from        then (before == list[0].args[0]) && (after == list[1].args[0])
+            end
+          end
+          matcher.positive_msg = "given block shouldn't alter the block attached to change"
+          matcher.negative_msg = "given block should alter the block attached to change"
+          comparison
+        end
+      end
+    end
+  end
+end

data/lib/matchy/built_in/enumerable_expectations.rb

@@ -0,0 +1,41 @@
+module Matchy
+  module Expectations 
+    module TestCaseExtensions
+      
+      # Calls +include?+ on the receiver for any object.  You can also provide
+      # multiple arguments to see if all of them are included.
+      #
+      # ==== Examples
+      #   
+      #   [1,2,3].should include(1)
+      #   [7,8,8].should_not include(3)
+      #   ['a', 'b', 'c'].should include('a', 'c')
+      #
+      def include(*obj)
+        _clude(:include, obj)
+      end
+      
+      # Expects the receiver to exclude the given object(s). You can provide
+      # multiple arguments to see if all of them are included.
+      #
+      # ==== Examples
+      #   
+      #   [1,2,3].should exclude(16)
+      #   [7,8,8].should_not exclude(7)
+      #   ['a', 'b', 'c'].should exclude('e', 'f', 'g')
+      #
+      def exclude(*obj)
+        _clude(:exclude, obj)
+      end
+      
+      private
+      def _clude(sym, obj)
+        build_matcher(sym, obj) do |given, matcher, args|
+          matcher.positive_msg = "Expected #{given.inspect} to #{sym} #{args.inspect}."
+          matcher.negative_msg = "Expected #{given.inspect} to not #{sym} #{args.inspect}."
+          args.inject(true) {|m,o| m && (given.include?(o) == (sym == :include)) }
+        end
+      end
+    end
+  end
+end

data/lib/matchy/built_in/error_expectations.rb

@@ -0,0 +1,66 @@
+module Matchy
+  module Expectations
+    module TestCaseExtensions
+      # Expects a lambda to raise an error.  You can specify the error or leave it blank to encompass
+      # any error.
+      #
+      # ==== Examples
+      #
+      #   lambda { raise "FAILURE." }.should raise_error
+      #   lambda { puts i_dont_exist }.should raise_error(NameError)
+      #
+      def raise_error(*obj)
+        build_matcher(:raise_error, obj) do |receiver, matcher, args|
+          expected = args[0] || Exception
+          raised = false
+          error = nil
+          begin
+            receiver.call
+          rescue Exception => e
+            raised = true
+            error = e
+          end
+          if expected.respond_to?(:ancestors) && expected.ancestors.include?(Exception)
+            matcher.positive_msg = "Expected #{receiver.inspect} to raise #{expected.name}, " + 
+              (error ? "but #{error.class.name} was raised instead." : "but none was raised.")
+            matcher.negative_msg = "Expected #{receiver.inspect} to not raise #{expected.name}."
+            comparison = (raised && error.class.ancestors.include?(expected))
+          else
+            message = error ? error.message : "none"
+            matcher.positive_msg = "Expected #{receiver.inspect} to raise error with message matching '#{expected}', but '#{message}' was raised."
+            matcher.negative_msg = "Expected #{receiver.inspect} to raise error with message not matching '#{expected}', but '#{message}' was raised."
+            comparison = (raised && (expected.kind_of?(Regexp) ? ((error.message =~ expected) ? true : false) : expected == error.message))
+          end
+          comparison
+        end
+      end
+      
+      # Expects a lambda to throw an error.
+      #
+      # ==== Examples
+      #
+      #   lambda { throw :thing }.should throw_symbol(:thing)
+      #   lambda { "not this time" }.should_not throw_symbol(:hello)
+      #
+      def throw_symbol(*obj)
+        build_matcher(:throw_symbol, obj) do |receiver, matcher, args|
+          raised, thrown_symbol, expected = false, nil, args[0]
+          begin
+            receiver.call
+          rescue NameError => e
+            raise e unless e.message =~ /uncaught throw/
+            raised = true
+            thrown_symbol = e.name.to_sym if e.respond_to?(:name)
+          rescue ArgumentError => e
+            raise e unless e.message =~ /uncaught throw/
+            thrown_symbol = e.message.match(/uncaught throw :(.+)/)[1].to_sym
+          end
+          matcher.positive_msg = "Expected #{receiver.inspect} to throw :#{expected}, but " +
+            "#{thrown_symbol ? ':' + thrown_symbol.to_s + ' was thrown instead' : 'no symbol was thrown'}."
+          matcher.negative_msg = "Expected #{receiver.inspect} to not throw :#{expected}."
+          expected == thrown_symbol
+        end
+      end      
+    end
+  end
+end