expectations 0.2.1 → 0.2.3

data/README

@@ -57,13 +57,25 @@ expectations can be used for state based and behavior based testing.
 	  end
 	  
 	  # Behavior based test using a traditional mock
-	  expect mock.to_receive(:dial).with("2125551212").times(2) do |phone|
+	  expect mock.to.receive(:dial).with("2125551212").times(2) do |phone|
+	    phone.dial("2125551212")
+	    phone.dial("2125551212")
+	  end
+	
+	  # Behavior based test using a stub
+	  expect stub.to.receive(:dial).with("2125551212").times(2) do |phone|
+	    phone.dial("2125551212")
+	    phone.dial("2125551212")
+	  end
+	
+	  # Behavior based test using a stub_everything
+	  expect stub_everything.to.receive(:dial).with("2125551212").times(2) do |phone|
 	    phone.dial("2125551212")
 	    phone.dial("2125551212")
 	  end
 	
 	  # Behavior based test on a concrete mock
-	  expect Object.to_receive(:deal) do
+	  expect Object.to.receive(:deal) do
 	    Object.deal
 	  end
 	  
@@ -140,10 +152,28 @@ expectations can be used for state based and behavior based testing.
 	    end
 	  end
 	  # State based delegation test
-	  expect klass.new.to_delegate(:save).to(:record) do |instance|
+	  expect klass.new.to.delegate(:save).to(:record) do |instance|
 	    instance.save(1)
 	  end
 	  
+	  # this is normally defined in the file specific to the class
+	  klass = Class.new do
+	    attr_accessor :started
+	  end
+	  # State based fluent interface boolean test using to be
+	  expect klass.new.to.be.started do |process|
+	    process.started = true
+	  end
+	  
+	  # this is normally defined in the file specific to the class
+	  klass = Class.new do
+	    attr_accessor :finished
+	  end
+	  # State based fluent interface boolean test using to have
+	  expect klass.new.to.have.finished do |process|
+	    process.finished = true
+	  end
+	  
 	end
 
 == Contributors

data/lib/expectations/delegate_recorder.rb

@@ -1,22 +1,40 @@
-class Expectations::DelegateRecorder
-  attr_reader :klass, :subject, :meth
-  def initialize(klass, meth)
-    @klass, @subject_mock, @meth = klass, Mocha::Mock.new, meth
-    @subject_mock.expects(meth).returns(:the_subjects_response)
+module Expectations::DelegateRecorder
+  attr_accessor :delegation_result
+  
+  def delegate!(meth)
+    @subject_mock = Mocha::Mock.new
+    @meth = meth
+    @subject_mock.expects(meth).returns(:a_delegated_return_value)
+    recorder = self
+    mod = Module.new do
+      define_method meth do |*args|
+        recorder.delegation_result = super
+      end
+    end
+    subject.extend mod
   end
   
-  def to(subject)
-    @subject = subject
+  def to(receiver)
+    @receiver = receiver
     self
   end
   
-  def mock
-    @klass.stubs(@subject).returns(@subject_mock)
-    @klass
+  def subject!
+    subject.stubs(@receiver).returns(@subject_mock)
+    subject
   end
   
-  def verify(actual)
+  def verify
     @subject_mock.verify
-    actual == :the_subjects_response
+    :a_delegated_return_value == delegation_result
+  end
+  
+  def failure_message
+    "expected #{subject}.#{@meth} to return the value of #{subject}.#{@receiver}.#{@meth}; however, #{subject}.#{@meth} returned #{delegation_result}"
   end
+  
+  def mocha_error_message(ex)
+    "expected #{subject} to delegate #{@meth} to #{@receiver}; however, #{subject}.#{@meth} was never called"
+  end
+  
 end

data/lib/expectations/expectation.rb

@@ -2,14 +2,11 @@ class Expectations::Expectation
   include Mocha::Standalone
   attr_accessor :expected, :block, :file, :line, :actual
   
-  def initialize(expected, &block)
+  def initialize(expected, file, line, &block)
     self.expected, self.block = expected, block
-    self.file, self.line = eval "[__FILE__, __LINE__]", block.binding
+    self.file, self.line = file, line.to_i
     case
-      when expected.is_a?(Expectations::DelegateRecorder) then extend(Expectations::DelegateExpectation)
-      when expected.is_a?(Expectations::PositiveStateBasedRecorder) then extend(Expectations::RecordedStateBasedExpectation)
-      when expected.is_a?(Expectations::NegativeStateBasedRecorder) then extend(Expectations::RecordedStateBasedExpectation)
-      when expected.is_a?(Expectations::MockRecorder) then extend(Expectations::BehaviorBasedExpectation)
+      when expected.is_a?(Expectations::Recorder) then extend(Expectations::RecordedExpectation)
       else extend(Expectations::StateBasedExpectation)
     end
   end

data/lib/expectations/mock_recorder.rb

@@ -1,40 +1,31 @@
-class Expectations::MockRecorder
-  attr_accessor :target
-  def initialize(target, method=nil)
-    self.target = target
-    events << MockEvent.new(:expects, [method]) unless method.nil?
-  end
+module Expectations::MockRecorder
   
-  def to_receive(method)
-    events << MockEvent.new(:expects, [method])
+  def receive!(method)
+    method_stack << [:expects, [method]]
     self
   end
   
-  def events
-    @events ||= []
+  def method_stack
+    @method_stack ||= []
   end
   
-  def method_missing(method, *args)
-    super if events.empty?
-    events << MockEvent.new(method, args)
+  def method_missing(sym, *args)
+    super if method_stack.empty?
+    method_stack << [sym, args]
     self
   end
   
-  def mock
-    events.inject(target) do |result, element|
-      result.send(element.method, *element.args)
-    end
-    target
+  def subject!
+    method_stack.inject(subject) { |result, element| result.send element.first, *element.last }
+    subject
   end
   
   def verify
-    target.verify
+    subject.verify
   end
   
-  class MockEvent
-    attr_accessor :method, :args
-    def initialize(method, args)
-      self.method, self.args = method, args
-    end
+  def mocha_error_message(ex)
+    ex.message
   end
+  
 end

data/lib/expectations/object.rb

@@ -1,21 +1,13 @@
 class Object
-  def to_receive(method)
-    Expectations::MockRecorder.new(self, method)
-  end
-  
-  def to_delegate(method)
-    Expectations::DelegateRecorder.new(self, method)
-  end
-  
   def to
-    Expectations::StateBasedRecorder.new(self).extend Expectations::PositiveStateBasedRecorder
+    Expectations::Recorder.new(self)
   end
   
   def not
     Not.new(self)
   end
   
-  def __negate__
+  def not!
     !self
   end
 
@@ -27,7 +19,7 @@ class Object
     end
 
     def method_missing(sym, *args, &blk)
-      @subject.send(sym,*args,&blk).__negate__
+      @subject.send(sym,*args,&blk).not!
     end
   end
   

data/lib/expectations/{recorded_state_based_expectation.rb → recorded_expectation.rb}

@@ -1,14 +1,17 @@
-module Expectations::RecordedStateBasedExpectation
+module Expectations::RecordedExpectation
   def execute
     begin
       mocha_setup
-      instance_exec expected.subject, &block
-      if expected.verify
+      instance_exec expected.subject!, &block if block
+      if expected.verify!
         self.extend(Expectations::Results::Fulfilled)
       else
         self.extend(Expectations::Results::StateBasedFailure)
-        self.message = expected.message
+        self.message = expected.failure_message
       end
+    rescue Mocha::ExpectationError => ex
+      self.extend(Expectations::Results::BehaviorBasedFailure)
+      self.message = expected.mocha_error_message(ex)
     rescue Exception => ex
       self.extend(Expectations::Results::Error)
       self.exception = ex

data/lib/expectations/recorder.rb

@@ -0,0 +1,44 @@
+class Expectations::Recorder
+
+  attr_reader :subject
+  def initialize(subject)
+    @subject = subject
+  end
+  
+  def receive(meth)
+    extend Expectations::MockRecorder
+    receive!(meth)
+    self
+  end
+  
+  def have
+    extend Expectations::StateBasedRecorder
+    message_parts << "to have"
+    self
+  end
+  
+  def be
+    extend Expectations::StateBasedRecorder
+    message_parts << "to be"
+    self
+  end
+  
+  def delegate(method)
+    extend Expectations::DelegateRecorder
+    delegate!(method)
+    self
+  end
+  
+  def subject!
+    subject
+  end
+
+  def not!
+    extend Expectations::ReverseResult
+  end
+  
+  def verify!
+    verify
+  end
+  
+end

data/lib/expectations/reverse_result.rb

@@ -0,0 +1,7 @@
+module Expectations::ReverseResult
+  
+  def verify!
+    not verify
+  end
+  
+end

data/lib/expectations/state_based_recorder.rb

@@ -1,29 +1,26 @@
-class Expectations::StateBasedRecorder
-  attr_reader :subject
-  def initialize(subject)
-    @subject = subject
-    @message_parts = []
+module Expectations::StateBasedRecorder
+
+  def verify
+    method_stack.inject(subject) { |result, element| result.send element.first, *element.last }
   end
-  
-  def have
-    @message_parts << "have"
-    self
-  end
-  
-  def be
-    @message_parts << "be"
-    self
+    
+  def failure_message
+    "expected #{subject} #{@message_parts.join(" ")}"
   end
-  
+
   def method_stack
     @method_stack ||= []
   end
   
+  def message_parts
+    @message_parts ||= self.is_a?(Expectations::ReverseResult) ? [:not] : []
+  end
+  
   def method_missing(sym, *args)
     @message_parts << "#{sym}"
     args.each { |arg| @message_parts << arg.inspect }
     method_stack << [sym, args]
     self
   end
-  
+
 end

data/lib/expectations/suite.rb

@@ -1,8 +1,6 @@
 class Expectations::Suite
   
-  def mock
-    Expectations::MockRecorder.new(Mocha::Mock.new)
-  end
+  include Mocha::Standalone
   
   def xml(string)
     Expectations::XmlString.new(string)
@@ -20,7 +18,7 @@ class Expectations::Suite
   end
   
   def expect(expected, &block)
-    expectations << Expectations::Expectation.new(expected, &block)
+    expectations << Expectations::Expectation.new(expected, *caller.first.split(/:/), &block)
   end
   
   def do_not_run
@@ -32,7 +30,6 @@ class Expectations::Suite
     [expectations.inject { |result, expectation| expectation.line > line.to_i ? result : expectation }]
   end
 
-  private
   def expectations
     @expectations ||= []
   end

data/lib/expectations.rb

@@ -16,12 +16,11 @@ require 'benchmark'
 require 'erb'
 require 'fileutils'
 require File.expand_path(File.dirname(__FILE__) + '/expectations/object')
-require File.expand_path(File.dirname(__FILE__) + '/expectations/delegate_expectation')
+require File.expand_path(File.dirname(__FILE__) + '/expectations/recorder')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/delegate_recorder')
-require File.expand_path(File.dirname(__FILE__) + '/expectations/recorded_state_based_expectation')
+require File.expand_path(File.dirname(__FILE__) + '/expectations/recorded_expectation')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/state_based_recorder')
-require File.expand_path(File.dirname(__FILE__) + '/expectations/positive_state_based_recorder')
-require File.expand_path(File.dirname(__FILE__) + '/expectations/negative_state_based_recorder')
+require File.expand_path(File.dirname(__FILE__) + '/expectations/reverse_result')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/xml_string')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/regexp')
 require File.expand_path(File.dirname(__FILE__) + '/expectations/range')
@@ -31,7 +30,6 @@ 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

@@ -46,7 +46,7 @@ specification = Gem::Specification.new do |s|
   expect NoMethodError do 
     Object.invalid_method_call 
   end."
-  s.version = "0.2.1"
+  s.version = "0.2.3"
   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

@@ -2,43 +2,27 @@ require File.dirname(__FILE__) + "/../test_helper"
 
 Expectations do
   expect Expectations::Results::StateBasedFailure do
-    Expectations::Expectation.new(1) { 2 }.execute
+    Expectations::Expectation.new(1, nil, nil) { 2 }.execute
   end
   
   expect Expectations::Results::Fulfilled do
-    Expectations::Expectation.new(1) { 1 }.execute
+    Expectations::Expectation.new(1, nil, nil) { 1 }.execute
   end
   
   expect Expectations::Results::Error do
-    Expectations::Expectation.new(1) { raise }.execute
+    Expectations::Expectation.new(1, nil, nil) { raise }.execute
   end
   
   expect "undefined method `no_method' for Object:Class" do
-    Expectations::Expectation.new(ArgumentError) { Object.no_method }.execute.exception.to_s
+    Expectations::Expectation.new(ArgumentError, nil, nil) { Object.no_method }.execute.exception.to_s
   end
   
   expect Expectations::Results::Fulfilled do
-    Expectations::Expectation.new(NoMethodError) { Object.no_method }.execute
+    Expectations::Expectation.new(NoMethodError, nil, nil) { Object.no_method }.execute
   end
   
   expect nil do
-    Expectations::Expectation.new(String) { Object.no_method }.execute.actual
+    Expectations::Expectation.new(String, nil, nil) { Object.no_method }.execute.actual
   end
   
-  expect __LINE__ + 1 do
-    Expectations::Expectation.new(1) { 2 }.execute.line
-  end
-
-  expect __LINE__ + 1 do
-    Expectations::Expectation.new(1) { raise }.execute.line
-  end
-
-  expect __FILE__ do
-    Expectations::Expectation.new(1) { 2 }.execute.file
-  end
-  
-  expect __FILE__ do
-    Expectations::Expectation.new(1) { raise }.execute.file
-  end
-
 end

data/test/expectations/expectations_test.rb

@@ -2,11 +2,11 @@ require File.dirname(__FILE__) + "/../test_helper"
 
 Expectations do
 
-  expect Expectations::SuiteRunner.to_receive(:suite_eval) do |suite|
+  expect Expectations::SuiteRunner.to.receive(:suite_eval) do |suite|
     Expectations {  }
   end
 
-  expect Expectations::SuiteRunner.to_receive(:do_not_run) do |suite|
+  expect Expectations::SuiteRunner.to.receive(:do_not_run) do |suite|
     Expectations { Object.no_method_error_should_raise } rescue nil
   end
 

data/test/expectations/suite_runner_test.rb

@@ -1,12 +1,12 @@
 require File.dirname(__FILE__) + "/../test_helper"
 
 Expectations do
-  expect mock.to_receive(:instance_eval) do |suite|
+  expect mock.to.receive(:instance_eval) do |suite|
     Expectations::SuiteRunner.stubs(:instance).returns stub(:suite => suite)
     Expectations::SuiteRunner.suite_eval {}
   end
 
-  expect mock.to_receive(:do_not_run) do |suite|
+  expect mock.to.receive(:do_not_run) do |suite|
     Expectations::SuiteRunner.stubs(:instance).returns stub(:suite => suite)
     Expectations::SuiteRunner.do_not_run
   end

data/test/expectations/suite_test.rb

@@ -20,12 +20,8 @@ Expectations do
     suite.execute(Silent).succeeded?
   end
   
-  expect Expectations::MockRecorder do
-    Expectations::Suite.new.mock
-  end
-  
   expect Mocha::Mock do
-    Expectations::Suite.new.mock.target
+    Expectations::Suite.new.mock
   end
   
   expect 3 do
@@ -50,4 +46,28 @@ Expectations do
     suite.expectations_for(__LINE__ - 1).first.expected
   end
   
+  expect __LINE__ + 2 do
+    suite = Expectations::Suite.new
+    suite.expect(1) { 2 }
+    suite.expectations.first.line
+  end
+  
+  expect __LINE__ + 2 do
+    suite = Expectations::Suite.new
+    suite.expect(1) { raise }
+    suite.expectations.first.line
+  end
+  
+  expect __FILE__ do
+    suite = Expectations::Suite.new
+    suite.expect(1) { 2 }
+    suite.expectations.first.file
+  end
+  
+  expect __FILE__ do
+    suite = Expectations::Suite.new
+    suite.expect(1) { raise }
+    suite.expectations.first.file
+  end
+  
 end

data/test/failures_test.rb

@@ -15,7 +15,7 @@ Expectations do
 
   expect Expectations::Results::BehaviorBasedFailure do
     suite = Expectations::Suite.new
-    suite.expect(mock.to_receive(:dial).with("2125551212").times(2)) do |phone|
+    suite.expect Mocha::Mock.new.to.receive(:dial).with("2125551212").times(2) do |phone|
       phone.dial("2125551212")
       phone.dial("2125551212")
       phone.dial("2125551212")
@@ -25,13 +25,15 @@ Expectations do
 
   expect Expectations::Results::BehaviorBasedFailure do
     suite = Expectations::Suite.new
-    suite.expect(mock.to_receive(:dial).with("2125551212").times(2)) { |phone| phone.dial("2125551212") }
+    suite.expect Mocha::Mock.new.to.receive(:dial).with("2125551212").times(2) do |phone| 
+      phone.dial("2125551212")
+    end
     suite.execute(Silent).expectations.first
   end
 
   expect Expectations::Results::BehaviorBasedFailure do
     suite = Expectations::Suite.new
-    suite.expect(Object.to_receive(:deal)) {  }
+    suite.expect(Object.to.receive(:deal)) {  }
     suite.execute(Silent).expectations.first
   end
 

data/test/successes_test.rb

@@ -13,13 +13,25 @@ Expectations do
   end
   
   # Behavior based test using a traditional mock
-  expect mock.to_receive(:dial).with("2125551212").times(2) do |phone|
+  expect mock.to.receive(:dial).with("2125551212").times(2) do |phone|
+    phone.dial("2125551212")
+    phone.dial("2125551212")
+  end
+
+  # Behavior based test using a stub
+  expect stub.to.receive(:dial).with("2125551212").times(2) do |phone|
+    phone.dial("2125551212")
+    phone.dial("2125551212")
+  end
+
+  # Behavior based test using a stub_everything
+  expect stub_everything.to.receive(:dial).with("2125551212").times(2) do |phone|
     phone.dial("2125551212")
     phone.dial("2125551212")
   end
 
   # Behavior based test on a concrete mock
-  expect Object.to_receive(:deal) do
+  expect Object.to.receive(:deal) do
     Object.deal
   end
   
@@ -96,8 +108,26 @@ Expectations do
     end
   end
   # State based delegation test
-  expect klass.new.to_delegate(:save).to(:record) do |instance|
+  expect klass.new.to.delegate(:save).to(:record) do |instance|
     instance.save(1)
   end
   
+  # this is normally defined in the file specific to the class
+  klass = Class.new do
+    attr_accessor :started
+  end
+  # State based fluent interface boolean test using to be
+  expect klass.new.to.be.started do |process|
+    process.started = true
+  end
+  
+  # this is normally defined in the file specific to the class
+  klass = Class.new do
+    attr_accessor :finished
+  end
+  # State based fluent interface boolean test using to have
+  expect klass.new.to.have.finished do |process|
+    process.finished = true
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: expectations
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jay Fields
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-03 00:00:00 -08:00
+date: 2008-03-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,19 +30,17 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
-- lib/expectations/behavior_based_expectation.rb
-- lib/expectations/delegate_expectation.rb
 - lib/expectations/delegate_recorder.rb
 - lib/expectations/expectation.rb
 - lib/expectations/mock_recorder.rb
 - lib/expectations/module.rb
-- lib/expectations/negative_state_based_recorder.rb
 - lib/expectations/object.rb
-- lib/expectations/positive_state_based_recorder.rb
 - lib/expectations/range.rb
-- lib/expectations/recorded_state_based_expectation.rb
+- lib/expectations/recorded_expectation.rb
+- lib/expectations/recorder.rb
 - lib/expectations/regexp.rb
 - lib/expectations/results.rb
+- lib/expectations/reverse_result.rb
 - lib/expectations/state_based_expectation.rb
 - lib/expectations/state_based_recorder.rb
 - lib/expectations/string.rb

data/lib/expectations/behavior_based_expectation.rb

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

data/lib/expectations/delegate_expectation.rb

@@ -1,24 +0,0 @@
-module Expectations::DelegateExpectation
-  def execute
-    begin
-      mocha_setup
-      actual = instance_exec expected.mock, &block
-      if expected.verify(actual)
-        self.extend(Expectations::Results::Fulfilled)
-      else
-        self.extend(Expectations::Results::StateBasedFailure)
-        self.message = "Delegation may have occurred; however, the return value could not be verified. Did you specify something after the delegation method?"
-      end
-    rescue Mocha::ExpectationError => ex
-      self.extend(Expectations::Results::BehaviorBasedFailure)
-      self.message = "Expected #{expected.klass} to delegate #{expected.meth} to #{expected.subject}; however, #{expected.subject}.#{expected.meth} was never called"
-    rescue Exception => ex
-      self.extend(Expectations::Results::Error)
-      self.exception = ex
-    ensure
-      mocha_teardown
-    end
-    self
-  end
-
-end

data/lib/expectations/negative_state_based_recorder.rb

@@ -1,11 +0,0 @@
-module Expectations::NegativeStateBasedRecorder
-  
-  def verify
-    not method_stack.inject(subject) { |result, element| result.send element.first, *element.last }
-  end
-  
-  def message
-    "expected #{subject} not to #{@message_parts.join(" ")}"
-  end
-  
-end

data/lib/expectations/positive_state_based_recorder.rb

@@ -1,15 +0,0 @@
-module Expectations::PositiveStateBasedRecorder
-
-  def verify
-    method_stack.inject(subject) { |result, element| result.send element.first, *element.last }
-  end
-  
-  def __negate__
-    extend Expectations::NegativeStateBasedRecorder
-  end
-  
-  def message
-    "expected #{subject} to #{@message_parts.join(" ")}"
-  end
-
-end