expectations 0.0.5 → 0.0.7

data/README

@@ -16,13 +16,13 @@ expectations is designed to encourage unit testing best practices such as
   - provide one syntax for setting up state based or behavior based expectation
   - focus on readability by providing no mechanism for describing an expectation other than the code in the expectation.
 
-Mocking is done utilizing Mocha
+Mocking is done utilizing Mocha[http://mocha.rubyforge.org]
 
 by Jay[http://blog.jayfields.com] Fields[http://blog.jayfields.com]
 
 == Download and Installation
 
-You can download arbs from here[http://rubyforge.org/projects/expectations] or install it with the following command.
+You can download expectations from here[http://rubyforge.org/projects/expectations] or install it with the following command.
 
  $ gem install expectations
 
@@ -55,8 +55,8 @@ expectations can be used for state based and behavior based testing.
 	  end
 	
 	  # Behavior based test on a concrete mock
-	  expect Object.to_receive(:deal).with(1) do
-	    Object.deal(1)
+	  expect Object.to_receive(:deal) do
+	    Object.deal
 	  end
 	  
 	end

data/lib/expectations/behavior_based_expectation.rb

@@ -0,0 +1,22 @@
+module Expectations::BehaviorBasedExpectation
+  include Mocha::Standalone
+
+  def execute
+    begin
+      mocha_setup
+      instance_exec expected.mock, &block
+      mock.verify
+      self.extend(Expectations::Results::Fulfilled)
+    rescue Mocha::ExpectationError => ex
+      self.extend(Expectations::Results::BehaviorFailure)
+      self.message = ex.message
+    rescue Exception => ex
+      self.extend(Expectations::Results::BehaviorBasedError)
+      self.exception = ex
+    ensure
+      mocha_teardown
+    end
+    self
+  end
+  
+end

data/lib/expectations/expectation.rb

@@ -1,48 +1,15 @@
 class Expectations::Expectation
-  include Mocha::Standalone
 
   attr_accessor :expected, :block, :file, :line, :actual
+  
   def initialize(expected, &block)
     self.expected, self.block = expected, block
     self.file, self.line = eval "[__FILE__, __LINE__]", block.binding
-  end
-  
-  def execute
-    expected.is_a?(Mocha::Expectation) ? behavior_based_execute : state_based_execute
-  end
-  
-  def behavior_based_execute
-    begin
-      mock = expected.instance_variable_get(:@mock)
-      mock.expectations.expectations.clear
-      mock.add_expectation(expected)
-      mocha_setup
-      instance_exec mock, &block
-      mock.verify
-      self.extend(Expectations::Results::Fulfilled)
-    rescue Mocha::ExpectationError => ex
-      self.extend(Expectations::Results::BehaviorFailure)
-      self.message = ex.message
-    rescue Exception => ex
-      self.extend(Expectations::Results::BehaviorBasedError)
-      self.exception = ex
-    ensure
-      mocha_teardown
-    end
-    self
-  end
-    
-  def state_based_execute
-    begin
-      self.actual = block.call
-      return self.extend(Expectations::Results::Fulfilled) if expected == actual
-    rescue Exception => ex
-      return self.extend(Expectations::Results::Fulfilled) if expected == ex.class
-      self.extend(Expectations::Results::StateBasedError)
-      self.exception = ex 
-      self.actual = ex.class if expected.is_a?(Class) && expected < StandardError
-      return self
+    if expected.is_a?(Expectations::MockRecorder)
+      extend(Expectations::BehaviorBasedExpectation)
+    else
+      extend(Expectations::StateBasedExpectation)
     end
-    self.extend(Expectations::Results::StateBasedFailure)
   end
+  
 end

data/lib/expectations/mocha.rb

@@ -1,9 +1,9 @@
-module Mocha
-  class Mock
-    attr_reader :expectations
-    alias to_receive expects
-  end
-  class ExpectationList
-    attr_reader :expectations
-  end
-end
+# module Mocha
+#   class Mock
+#     attr_reader :expectations
+#     alias to_receive expects
+#   end
+#   class ExpectationList
+#     attr_reader :expectations
+#   end
+# end

data/lib/expectations/mock_recorder.rb

@@ -0,0 +1,30 @@
+class Expectations::MockRecorder
+  attr_accessor :target
+  def initialize(target, method)
+    self.target = target
+    events << MockEvent.new(:expects, [method])
+  end
+  
+  def events
+    @events ||= []
+  end
+  
+  def method_missing(method, *args)
+    events << MockEvent.new(method, args)
+    self
+  end
+  
+  def mock
+    events.inject(target) do |result, element|
+      result.send(element.method, *element.args)
+    end
+    target
+  end
+  
+  class MockEvent
+    attr_accessor :method, :args
+    def initialize(method, args)
+      self.method, self.args = method, args
+    end
+  end
+end

data/lib/expectations/object.rb

@@ -1,5 +1,7 @@
 class Object
-  alias to_receive expects
+  def to_receive(method)
+    Expectations::MockRecorder.new(self, method)
+  end
 
   unless defined? instance_exec # 1.9
     module InstanceExecMethods #:nodoc:

data/lib/expectations/results.rb

@@ -25,7 +25,9 @@ module Expectations::Results
     include Expectations::Results
     char "F"
     def message 
-      "expected: <#{expected.inspect}> got: <#{actual.inspect}>"
+      result = "expected: <#{expected.inspect}> got: <#{actual.inspect}>"
+      result += "\nstring details: #{expected.diff(actual)}" if expected.is_a?(String) && actual.is_a?(String)
+      result
     end
   end
 end
@@ -55,11 +57,8 @@ end
 
 module Expectations::Results
   module StateBasedError
-    attr_accessor :exception
+    attr_accessor :exception, :message
     include Expectations::Results
     char "E"
-    def message 
-      "expected: <#{expected.inspect}> got: <#{actual.inspect}>"
-    end
   end
 end

data/lib/expectations/state_based_expectation.rb

@@ -0,0 +1,15 @@
+module Expectations::StateBasedExpectation
+  def execute
+    begin
+      self.actual = block.call
+      return self.extend(Expectations::Results::Fulfilled) if expected == actual
+    rescue Exception => ex
+      return self.extend(Expectations::Results::Fulfilled) if expected == ex.class
+      self.extend(Expectations::Results::StateBasedError)
+      self.exception = ex 
+      self.message = "expected: <#{expected.inspect}> got: <#{ex.class.inspect}>" if expected.is_a?(Class) && expected < StandardError
+      return self
+    end
+    self.extend(Expectations::Results::StateBasedFailure)
+  end
+end

data/lib/expectations/string.rb

@@ -0,0 +1,15 @@
+class String
+  def diff(other)
+    (0..self.size).inject("") do |result, index|
+      if self[index, 1] == other[index, 1]
+        result += self[index, 1]
+      else
+        result += "[#{self[index, 1]}|#{other[index, 1]}], mismatch at index #{index}\n"
+        result += "trailing expected: <#{self[index+1, self.size - index]}>\n"
+        result += "trailing actual: <#{other[index+1, other.size - index]}>"
+        return result
+      end
+      result
+    end
+  end
+end

data/lib/expectations/suite.rb

@@ -1,8 +1,7 @@
 class Expectations::Suite
-  include Mocha::Standalone
 
-  def initialize
-    mocha_setup
+  def mock
+    Mocha::Mock.new
   end
   
   def execute(out=STDOUT)

data/lib/expectations/suite_results.rb

@@ -43,7 +43,8 @@ class Expectations::SuiteResults
         out.puts "file <#{error.file}>"
         out.puts "line <#{error.line}>"
         out.puts "error <#{error.exception.message}>"
-        out.puts "#{error.message}" if error.message.any?
+        out.puts "trace #{filter_backtrace(error.exception.backtrace)}"
+        out.puts "#{error.message}" if error.message && error.message.any?
         out.puts "\n"
       end
       out.puts "\n--Failures--" if failures.any?
@@ -55,4 +56,14 @@ class Expectations::SuiteResults
       end
     end
   end
+  
+  def filter_backtrace(trace)
+    patterns_to_strip = [/\/expectations\/lib\/expectations\//, /\/lib\/ruby\/1\.8\//]
+    result = patterns_to_strip.inject(trace) do |result, element|
+      result = result.select { |line| line !~ element}
+    end
+    result.collect do |line|
+      "\n  #{line}"
+    end
+  end
 end

data/lib/expectations.rb

@@ -11,9 +11,13 @@ require 'mocha/standalone'
 require 'singleton'
 require 'benchmark'
 require File.expand_path(File.dirname(__FILE__) + '/expectations/object')
+require File.expand_path(File.dirname(__FILE__) + '/expectations/string')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/mocha')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/suite')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/suite_runner')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/suite_results')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/expectation')
+require File.expand_path(File.dirname(__FILE__) + '/expectations/behavior_based_expectation')
+require File.expand_path(File.dirname(__FILE__) + '/expectations/state_based_expectation')
+require File.expand_path(File.dirname(__FILE__) + '/expectations/mock_recorder')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/results')

data/rakefile.rb

@@ -16,8 +16,6 @@ Rake::RDocTask.new do |task|
   task.rdoc_files.include('README', 'lib/**/*.rb')
 end
 
-task :rdoc => :readme
-
 desc "Generate README"
 task :readme do
   %x[erb README_TEMPLATE > README]
@@ -25,7 +23,9 @@ end
 
 
 desc "Upload RDoc to RubyForge"
-task :publish_rdoc => :rdoc do
+task :publish_rdoc do
+  Rake::Task[:readme].invoke
+  Rake::Task[:rdoc].invoke
   Rake::SshDirPublisher.new("jaycfields@rubyforge.org", "/var/www/gforge-projects/expectations", "doc").upload
 end
 
@@ -41,7 +41,7 @@ specification = Gem::Specification.new do |s|
   expect NoMethodError do 
     Object.invalid_method_call 
   end."
-	s.version = "0.0.5"
+	s.version = "0.0.7"
 	s.author = 'Jay Fields'
   s.description = "A lightweight unit testing framework. Tests (expectations) will be written as follows 
   expect 2 do 

data/test/expectations/expectation_test.rb

@@ -13,10 +13,6 @@ Expectations do
     Expectations::Expectation.new(1) { raise }.execute.is_a?(Expectations::Results::StateBasedError)
   end
   
-  expect NoMethodError do
-    Expectations::Expectation.new(ArgumentError) { Object.no_method }.execute.actual
-  end
-  
   expect "undefined method `no_method' for Object:Class" do
     Expectations::Expectation.new(ArgumentError) { Object.no_method }.execute.exception.to_s
   end

data/test/expectations/string_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+Expectations do
+  expect "fo[o|a], mismatch at index 2\ntrailing expected: < bar baz>\ntrailing actual: < bar bat>" do
+    "foo bar baz".diff("foa bar bat")
+  end
+end

data/test/sample_expectations_test.rb

@@ -22,5 +22,5 @@ Expectations do
   expect Object.to_receive(:deal) do
     Object.deal
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: expectations
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors: 
 - Jay Fields
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-12-28 00:00:00 -05:00
+date: 2008-01-06 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -22,10 +22,14 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- lib/expectations/behavior_based_expectation.rb
 - lib/expectations/expectation.rb
 - lib/expectations/mocha.rb
+- lib/expectations/mock_recorder.rb
 - lib/expectations/object.rb
 - lib/expectations/results.rb
+- lib/expectations/state_based_expectation.rb
+- lib/expectations/string.rb
 - lib/expectations/suite.rb
 - lib/expectations/suite_results.rb
 - lib/expectations/suite_runner.rb
@@ -33,6 +37,7 @@ files:
 - test/all_tests.rb
 - test/expectations/expectation_test.rb
 - test/expectations/results_test.rb
+- test/expectations/string_test.rb
 - test/expectations/suite_results_test.rb
 - test/expectations/suite_test.rb
 - test/sample_expectations_test.rb