MacSpec 0.3.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matthias Hennemeyer
+
+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/README.rdoc

@@ -0,0 +1,20 @@
+= MacSpec
+
+MacSpec is a (yet) feature minimal RSpec clone that is specifically built to work with MacRuby.
+It is built ontop of MiniTest that ships with MacRuby and works out of the box with the MacRuby App 
+Template for Xcode. All you have to do is to replace two lines of code and start writing your tests.
+No special command for running tests required. Just set your active Target to Test and hit Cmd-B.
+
+MacSpec ships with a testing framework similar to RSpec's. 
+
+The matchy matcher system is built in. (-> http://github.com/jm/matchy)
+
+Even a mocking framework is built in.
+
+== Philosophy
+
+The highest priority feature will always be MacRuby compatibility. We will expand MacSpec's feature set  towards RSpec's  feature set step by step.
+
+== Copyright
+
+Copyright (c) 2010 Matthias Hennemeyer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+require 'lib/mac_spec/version.rb'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.version = MacSpec::VERSION
+    gem.name = "MacSpec"
+    gem.summary = %Q{MacSpec is a feature minimal RSpec clone that is specifically built to work with MacRuby.}
+    gem.description = %Q{MacSpec is a feature minimal RSpec clone that is specifically built to work with MacRuby.}
+    gem.email = "mhennemeyer@me.com"
+    gem.homepage = "http://github.com/mhennemeyer/MacSpec"
+    gem.authors = ["Matthias Hennemeyer"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "MacSpec #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/mac_spec.rb

@@ -0,0 +1,59 @@
+require "rubygems"
+require "minitest/unit"
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module MacSpec
+  class << self
+    
+    def assert(bool=false)
+      @current_test_case.assert(bool)
+    end
+    
+    def flunk(msg="No Error Message given.")
+      @current_test_case.flunk(msg)
+    end
+    
+    def current_test_case
+      @current_test_case 
+    end
+    
+    def current_test_case=(tc)
+      @current_test_case = tc
+    end
+    
+    def assertions_module
+      MiniTest::Assertions
+    end
+
+    def test_case_class
+      MiniTest::Unit::TestCase
+    end
+
+    def assertion_failed_error
+      MiniTest::Assertion
+    end
+  end
+end
+MiniTest::Unit.autorun unless defined?(MacSpecNoAutoRun)
+require 'mac_spec/version'
+require 'mac_spec/matcher_system'
+require 'mac_spec/testing_framework'
+require 'mac_spec/mocking_framework'
+unless defined?(LOADED)
+  # Track the current testcase and 
+  # provide it to the operator matchers and mocking framework.
+  # Otherwise expectations won't be counted as assertions
+  # todo no global
+  MacSpec.test_case_class.class_eval do
+    alias_method :old_run_method_aliased_by_macspec, :run
+    def run(whatever, *args, &block)
+      MacSpec.current_test_case = self
+      old_run_method_aliased_by_macspec(whatever, *args, &block)
+    end
+  end
+  LOADED = true
+end
+
+MacSpec.test_case_class.send(:include, MacSpec::MatcherSystem::Expectations::TestCaseExtensions)
+include MacSpec::MatcherSystem::DefMatcher

data/lib/mac_spec/matcher_system.rb

@@ -0,0 +1,19 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'matcher_system/core/expectation_builder'
+require 'matcher_system/core/modals'
+require 'matcher_system/core/matcher_builder'
+require 'matcher_system/core/def_matcher'
+require 'matcher_system/core/exceptions'
+
+require 'matcher_system/built_in/enumerable_expectations'
+require 'matcher_system/built_in/error_expectations'
+require 'matcher_system/built_in/truth_expectations'
+require 'matcher_system/built_in/operator_expectations'
+require 'matcher_system/built_in/change_expectations'
+
+module MacSpec
+  module MatcherSystem
+    # todo doc
+  end
+end

data/lib/mac_spec/matcher_system/built_in/change_expectations.rb

@@ -0,0 +1,36 @@
+module MacSpec
+  module MatcherSystem
+    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)
+            specifiers = matcher.chained_messages
+            if specifiers
+              comparison = case specifiers[0].name
+                # todo: provide meaningful messages
+              when :by          then (after == before + specifiers[0].args[0] || after == before - specifiers[0].args[0])
+              when :by_at_least then (after >= before + specifiers[0].args[0] || after <= before - specifiers[0].args[0])
+              when :by_at_most  then (after <= before + specifiers[0].args[0] && after >= before - specifiers[0].args[0])
+              when :from        then (before == specifiers[0].args[0]) && (after == specifiers[1].args[0])
+              else raise MacSpec::MatcherSystem::Exceptions::UnsupportedMessageSentToMatcher.new(
+                "Message: #{specifiers[0].name} sent to change matcher.")
+              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
+end

data/lib/mac_spec/matcher_system/built_in/enumerable_expectations.rb

@@ -0,0 +1,43 @@
+module MacSpec
+  module MatcherSystem
+    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
+end

data/lib/mac_spec/matcher_system/built_in/error_expectations.rb

@@ -0,0 +1,68 @@
+module MacSpec
+  module MatcherSystem
+    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
+end

data/lib/mac_spec/matcher_system/built_in/operator_expectations.rb

@@ -0,0 +1,45 @@
+module MacSpec
+  module MatcherSystem
+    module Expectations
+      # Class to handle operator expectations.
+      #
+      # ==== Examples
+      #   
+      #   13.should == 13
+      #   "hello".length.should_not == 2
+      #
+      class OperatorExpectation #< Base
+        include ::MacSpec.assertions_module
+
+        def initialize(receiver, match)
+          @receiver, @match = receiver, match
+        end
+
+        ['==', '===', '=~', '>', '>=', '<', '<='].each do |op|
+          define_method(op) do |expected|
+            @expected = expected
+            (@receiver.send(op,expected) ? true : false) == @match ? pass! : fail!(op)
+          end
+        end
+
+        protected
+        def pass!
+          MacSpec.assert(true)
+        end
+
+        def fail!(operator)
+          msg = @match ? failure_message(operator) : negative_failure_message(operator)
+          MacSpec.flunk msg
+        end
+
+        def failure_message(operator)
+          "Expected #{@receiver.inspect} to #{operator} #{@expected.inspect}."
+        end
+
+        def negative_failure_message(operator)
+          "Expected #{@receiver.inspect} to not #{operator} #{@expected.inspect}."
+        end
+      end
+    end
+  end
+end

data/lib/mac_spec/matcher_system/built_in/truth_expectations.rb

@@ -0,0 +1,148 @@
+module MacSpec
+  module MatcherSystem
+    module Expectations
+      module TestCaseExtensions
+        # Simply checks if the receiver matches the expected object.
+        # TODO: Fill this out to implement much of the RSpec functionality (and then some)
+        #
+        # ==== Examples
+        #
+        #   "hello".should be("hello")
+        #   (13 < 20).should be(true)
+        #
+        def be(*obj)
+          build_matcher(:be, obj) do |receiver, matcher, args|
+            @receiver, expected = receiver, args[0]
+            matcher.positive_msg = "Expected #{@receiver.inspect} to be #{expected.inspect}."
+            matcher.negative_msg = "Expected #{@receiver.inspect} to not be #{expected.inspect}."
+            expected == @receiver
+          end
+        end
+
+        # Checks if the given object is within a given object and delta.
+        #
+        # ==== Examples
+        #
+        #   (20.0 - 2.0).should be_close(18.0)
+        #   (13.0 - 4.0).should be_close(9.0, 0.5)
+        #
+        def be_close(obj, delta = 0.3)
+          build_matcher(:be_close, [obj, delta]) do |receiver, matcher, args|
+            @receiver, expected, delta = receiver, args[0], args[1]
+            matcher.positive_msg = "Expected #{@receiver.inspect} to be close to #{expected.inspect} (delta: #{delta})."
+            matcher.negative_msg = "Expected #{@receiver.inspect} to not be close to #{expected.inspect} (delta: #{delta})."
+            (@receiver - expected).abs < delta
+          end
+        end
+
+        # Calls +exist?+ on the given object.
+        #
+        # ==== Examples
+        #
+        #   # found_user.exist?
+        #   found_user.should exist
+        #
+        def exist
+          ask_for(:exist, :with_arg => nil)
+        end   
+
+        # Calls +eql?+ on the given object (i.e., are the objects the same value?)
+        #
+        # ==== Examples
+        #   
+        #    1.should_not eql(1.0)
+        #    (12 / 6).should eql(6)
+        #
+        def eql(*obj)
+          ask_for(:eql, :with_arg => obj)
+        end
+
+        # Calls +equal?+ on the given object (i.e., do the two objects have the same +object_id+?)
+        #
+        # ==== Examples
+        # 
+        #   x = [1,2,3]
+        #   y = [1,2,3]
+        #
+        #   # Different object_id's...
+        #   x.should_not equal(y)
+        #
+        #   # The same object_id
+        #   x[0].should equal(y[0])
+        #
+        def equal(*obj)
+          ask_for(:equal, :with_arg => obj)
+        end
+
+        # A last ditch way to implement your testing logic.  You probably shouldn't use this unless you
+        # have to.
+        #
+        # ==== Examples
+        #
+        #   (13 - 4).should satisfy(lambda {|i| i < 20})
+        #   "hello".should_not satisfy(lambda {|s| s =~ /hi/})
+        #
+        def satisfy(*obj)
+          build_matcher(:satisfy, obj) do |receiver, matcher, args|
+            @receiver, expected = receiver, args[0]
+            matcher.positive_msg = "Expected #{@receiver.inspect} to satisfy given block."
+            matcher.negative_msg = "Expected #{@receiver.inspect} to not satisfy given block."
+            expected.call(@receiver) == true
+          end
+        end
+
+        # Checks if the given object responds to the given method
+        #
+        # ==== Examples
+        #
+        #   "foo".should respond_to(:length)
+        #   {}.should respond_to(:has_key?)
+        def respond_to(*meth)
+          ask_for(:respond_to, :with_arg => meth)
+        end
+
+        # Asks given for success?().
+        # This is necessary because Rails Integration::Session
+        # overides method_missing without grace.
+        #
+        # ==== Examples
+        #
+        #   @response.should be_success
+        def be_success
+          ask_for(:success, :with_arg => nil)
+        end
+
+        alias_method :old_missing, :method_missing
+        # ==be_*something(*args)
+        #
+        # ===This method_missing acts as a matcher builder. 
+        # If a call to be_xyz() reaches this method_missing (say: obj.should be_xyz), 
+        # a matcher with the name xyz will be built, whose defining property
+        # is that it returns the value of obj.xyz? for matches?.
+        # ==== Examples
+        #
+        #   nil.should be_nil
+        #   17.should be_kind_of(Fixnum)
+        #   obj.something? #=> true
+        #   obj.should be_something
+        def method_missing(name, *args, &block)
+          if (name.to_s =~ /^be_(.+)/)
+            ask_for($1, :with_arg => args)
+          else
+            old_missing(name, *args, &block)
+          end
+        end
+
+      private
+        def ask_for(sym, option={})
+          build_matcher(sym, (option[:with_arg] || [])) do |receiver, matcher, args|
+            expected, meth = args[0], (sym.to_s + "?" ).to_sym
+            matcher.positive_msg = "Expected #{receiver.inspect} to return true for #{sym}?, with '#{(expected && expected.inspect) || 'no args'}'."
+            matcher.negative_msg = "Expected #{receiver.inspect} to not return true for #{sym}?, with '#{(expected && expected.inspect) || 'no args'}'."
+            expected ? receiver.send(meth, expected) : receiver.send(meth)
+          end
+        end
+      end
+    end
+  end
+end