stendhal 0.1.4 → 0.1.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stendhal (0.1.3)
+    stendhal (0.1.4)
 
 GEM
   remote: http://rubygems.org/

data/Readme.md

@@ -10,9 +10,9 @@ development.
 
 * Pretty decent reporter with colors
 * Test doubles and stubs (no partial stubbing yet)
+* Mocks (message expectations)
 * Nested example groups (declare them with either describe or context)
 * Pending examples
-* Lame reporter (but will get better eventually)
 * Matchers (use with object.must or object.must_not)
 
     eq() / eql()
@@ -86,6 +86,22 @@ development.
         end
       end
 
+      describe "Message expectation" do
+        it "is declared with expects" do
+          string = "my string"
+          string.expects(:reverse)
+
+          string.reverse # Expectation fulfilled!
+        end
+
+        it "is declared with does_not_expect in case it is negative" do
+          string = "my string"
+          string.does_not_expect(:reverse)
+
+          string.reverse # Fails!
+        end
+      end
+
     end
 
 ###Running the specs!
@@ -114,7 +130,18 @@ development.
       * is declared with double as well
       * can be given stubs
 
-    11 examples, 2 failures, 2 pending
+    Message expectation
+      * is declared with expects
+      * is declared with does_not_expect in case it is negative
+
+    13 examples, 3 failures, 2 pending
+
+##Feedback
+
+Reporting issues, asking for new features and constructive criticizing can be
+done either through Github issues, the mailing list
+(http://librelist.com/browser/stendhal/) or you can always reach me on twitter
+(I am @txustice). Don't hesitate to tell me anything! :)
 
 ##Note on Patches/Pull Requests
  

data/features/mocks.feature

@@ -0,0 +1,71 @@
+Feature: Mocks (message expectations)
+
+  With mocks you can check whether objects receive certain messages.
+
+  Scenario: declare a message expectation
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      class MyClass
+
+        def foo
+        end
+
+        def bar
+          foo
+        end
+
+      end
+
+      describe "bar" do
+        it "calls foo" do
+          object = MyClass.new
+          object.expects(:foo)
+
+          object.bar
+        end
+        it "never calls foo" do
+          object = MyClass.new
+          object.expects(:foo)
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "2 examples, 1 failure"
+    And the output should contain "expected to be sent :foo 1 time, but received it 0 times"
+
+  Scenario: declare a negative message expectation
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      class MyClass
+
+        def foo
+        end
+
+        def bar
+          foo
+        end
+
+      end
+
+      describe "bar" do
+        it "calls foo" do
+          object = MyClass.new
+          object.does_not_expect(:foo)
+
+          object.bar
+        end
+        it "never calls foo" do
+          object = MyClass.new
+          object.does_not_expect(:foo)
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "2 examples, 1 failure"
+    And the output should contain "expected to be sent :foo 0 times, but received it 1 time"

data/lib/stendhal/core_ext/object.rb

@@ -0,0 +1,3 @@
+class Object
+  include Stendhal::Mocks::Mockable
+end

data/lib/stendhal/example.rb

@@ -19,7 +19,9 @@ module Stendhal
 
     def run
       begin
+        Stendhal::Mocks::MockVerifier.reset!
         self.instance_eval(&@block)
+        Stendhal::Mocks::MockVerifier.verify!
         return 0
       rescue Exceptions::ExpectationNotMet=>e
         @failed = true

data/lib/stendhal/mocks/mock_verifier.rb

@@ -0,0 +1,71 @@
+module Stendhal
+  module Mocks
+    class MockVerifier
+
+      @@verifiers = []
+
+      attr_reader :expectations
+
+      def initialize(object)
+        @expectations = []
+        @object = object
+        @@verifiers << self
+      end
+
+      def add_expectation(method)
+        @expectations << MessageExpectation.new(method)
+      end
+
+      def add_negative_expectation(method)
+        @expectations << MessageExpectation.new(method, :negative => true)
+      end
+
+      def fulfill_expectation(method)
+        @expectations.select{|e| e.method == method}.each(&:register_call)
+      end
+      
+      def verify!
+        expectations.each do |expectation|
+          begin
+            expectation.verify
+          rescue Stendhal::Exceptions::ExpectationNotMet=>e
+            raise Stendhal::Exceptions::ExpectationNotMet.new "#{@object} #{e.message}"
+          end
+        end
+      end
+
+      def self.verifiers
+        @@verifiers
+      end
+
+      def self.verify!
+        verifiers.each(&:verify!)
+      end
+
+      def self.reset!
+        @@verifiers = []
+      end
+
+      class MessageExpectation
+        attr_reader :method
+        attr_reader :times_called
+        attr_reader :times_expected
+
+        def initialize(method, options = {})
+          @method = method
+          @times_expected = options[:negative] ? 0 : 1
+          @times_called = 0
+        end
+
+        def register_call
+          @times_called += 1
+        end
+
+        def verify
+          raise Stendhal::Exceptions::ExpectationNotMet.new "expected to be sent :#{method} #{times_expected} time#{times_expected == 1 ? '' : 's'}, but received it #{times_called} time#{times_called == 1 ? '' : 's'}" unless times_expected == times_called
+        end
+      end
+
+    end
+  end
+end

data/lib/stendhal/mocks/mockable.rb

@@ -0,0 +1,34 @@
+module Stendhal
+  module Mocks
+    module Mockable
+
+      def expects(method, options = {})
+        if options[:negative]
+          __verifier.add_negative_expectation(method) 
+        else
+          __verifier.add_expectation(method) 
+        end
+        metaclass = (class << self;self;end)
+        metaclass.send(:alias_method, :"__original_#{method}", method.to_sym)
+        metaclass.send(:undef_method, method.to_sym)
+        metaclass.class_eval <<EOT
+          def #{method}(*args, &block)
+            @__verifier.fulfill_expectation(:#{method},*args,&block)
+            __original_#{method}(*args,&block)
+          end
+EOT
+      end
+
+      def does_not_expect(method)
+        expects(method, :negative => true)
+      end
+
+      private
+
+      def __verifier
+        @__verifier ||= MockVerifier.new(self)
+      end
+
+    end
+  end
+end

data/lib/stendhal/mocks.rb

@@ -1,4 +1,6 @@
 require 'stendhal/mocks/test_double'
+require 'stendhal/mocks/mock_verifier'
+require 'stendhal/mocks/mockable'
 
 module Stendhal
   module Mocks

data/lib/stendhal/version.rb

@@ -1,3 +1,3 @@
 module Stendhal
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/stendhal.rb

@@ -6,4 +6,5 @@ require 'stendhal/example'
 require 'stendhal/example_group'
 
 require 'stendhal/core_ext/kernel'
+require 'stendhal/core_ext/object'
 require 'stendhal/dsl'

data/spec/stendhal/example_spec.rb

@@ -60,6 +60,26 @@ module Stendhal
         example.should be_aborted
       end
 
+      it "verifies all message expectations after running the block" do
+        example = Example.new("docstring") do
+          
+        end
+        example.should_receive(:instance_eval).ordered
+        Stendhal::Mocks::MockVerifier.should_receive(:verify!).ordered
+
+        example.run
+      end
+
+      it "resets all message expectations before running the block" do
+        example = Example.new("docstring") do
+          
+        end
+        Stendhal::Mocks::MockVerifier.should_receive(:reset!)
+        example.should_receive(:instance_eval).ordered
+
+        example.run
+      end
+
     end
 
     describe "#fail" do

data/spec/stendhal/mocks/mock_verifier_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+module Stendhal
+  module Mocks
+    describe MockVerifier do
+
+      subject { verifier = MockVerifier.new('object') }
+
+      it 'includes itself in verifiers when created' do
+        subject
+        MockVerifier.should have(1).verifiers
+      end
+
+      describe "instance methods" do
+      
+        describe "#add_expectation" do
+          it 'adds an expectation for a given method' do
+            MockVerifier::MessageExpectation.should_receive(:new).with(:reverse)
+
+            subject.add_expectation(:reverse)
+          end
+        end
+
+        describe "#add_negative_expectation" do
+          it 'adds a negative expectation for a given method' do
+            MockVerifier::MessageExpectation.should_receive(:new).with(:reverse, :negative => true)
+
+            subject.add_negative_expectation(:reverse)
+          end
+        end
+
+        describe "#fulfill_expectation" do
+          it 'registers a call for a given method' do
+            subject.add_expectation(:reverse)
+            subject.expectations.first.should_receive(:register_call)
+
+            subject.fulfill_expectation(:reverse)
+          end
+        end
+
+        describe "#verify!" do
+          it 'verifies each of the expectations until one fails' do
+            expectations = [double, double, double]
+            expectations.each do |e|
+              e.should_receive(:verify)
+            end
+            subject.should_receive(:expectations).and_return(expectations)
+
+            subject.verify!
+          end
+          it 'adds the object inspect to the message if raised any ExpectationNotMet' do
+            expectations = [double, double, double]
+            expectations.first.should_receive(:verify).and_raise(Stendhal::Exceptions::ExpectationNotMet.new('expected foo to be bar'))
+
+            subject.should_receive(:expectations).and_return(expectations)
+
+            expect {
+              subject.verify!
+            }.to raise_error(Stendhal::Exceptions::ExpectationNotMet, "object expected foo to be bar")
+          end
+        end
+      
+      end
+
+      describe "class methods" do
+      
+        describe "#verify!" do
+          it 'verifies each of the verifiers' do
+            verifiers = [double, double, double] 
+            verifiers.each { |v| v.should_receive(:verify!) }
+            MockVerifier.should_receive(:verifiers).and_return verifiers
+
+            MockVerifier.verify!
+          end
+        end
+
+        describe "#reset!" do
+          it 'deletes all verifiers' do
+            MockVerifier.new('object')
+            MockVerifier.new('other object')
+
+            MockVerifier.reset!
+
+            MockVerifier.should have(0).verifiers
+          end
+        end
+      
+      end
+
+    end
+
+    describe MockVerifier::MessageExpectation do
+
+      subject { MockVerifier::MessageExpectation.new(:length) }
+
+      it "initializes with 0 times called" do
+        subject.times_called.should == 0
+      end
+
+      context "when given no options" do
+        it "initializes with 1 times expected" do
+          subject.times_expected.should == 1
+        end
+      end
+
+      context "when given :negative => true" do
+        it "initializes with 0 times expected" do
+          negative_expectation = MockVerifier::MessageExpectation.new(:length, :negative => true)
+          negative_expectation.times_expected.should == 0
+        end
+      end
+
+      describe "instance methods" do
+      
+        describe "#register_call" do
+          it 'registers a call for the given expectation' do
+            expect{
+              subject.register_call
+            }.to change(subject, :times_called).by(1)
+          end
+        end
+      
+        describe "#verify" do
+          it 'registers a call for the given expectation' do
+            subject.stub(:times_called).and_return 2
+            subject.stub(:times_expected).and_return 1
+
+            expect {
+              subject.verify
+            }.to raise_error(Stendhal::Exceptions::ExpectationNotMet, "expected to be sent :length 1 time, but received it 2 times")
+          end
+        end
+      
+      end
+
+    end
+  end
+end

data/spec/stendhal/mocks/mockable_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+class MyArray < Array
+  include Stendhal::Mocks::Mockable
+end
+
+module Stendhal
+  module Mocks
+    describe "a Mockable class" do
+
+      subject { MyArray.new([1,2,3]) }
+
+      describe "#expects" do
+        it 'creates a verifier' do
+          subject.expects(:length) 
+          subject.send(:__verifier).should be_a(MockVerifier)
+        end
+        it 'creates a message expectation on the given method' do
+          subject.expects(:length) 
+          subject.send(:__verifier).expectations.map(&:method).should include(:length)
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Josep M. Bach
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 +01:00
+date: 2010-11-09 00:00:00 +01:00
 default_executable: stendhal
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,12 +91,14 @@ files:
 - bin/stendhal
 - features/examples.feature
 - features/expectations.feature
+- features/mocks.feature
 - features/reporter.feature
 - features/support/env.rb
 - features/test_doubles_and_stubs.feature
 - lib/stendhal.rb
 - lib/stendhal/autorun.rb
 - lib/stendhal/core_ext/kernel.rb
+- lib/stendhal/core_ext/object.rb
 - lib/stendhal/dsl.rb
 - lib/stendhal/example.rb
 - lib/stendhal/example_group.rb
@@ -107,6 +109,8 @@ files:
 - lib/stendhal/matchers/kind.rb
 - lib/stendhal/matchers/predicate.rb
 - lib/stendhal/mocks.rb
+- lib/stendhal/mocks/mock_verifier.rb
+- lib/stendhal/mocks/mockable.rb
 - lib/stendhal/mocks/test_double.rb
 - lib/stendhal/reporter.rb
 - lib/stendhal/version.rb
@@ -120,8 +124,10 @@ files:
 - spec/stendhal/matchers/kind_spec.rb
 - spec/stendhal/matchers/predicate_spec.rb
 - spec/stendhal/matchers_spec.rb
+- spec/stendhal/mocks/mock_verifier_spec.rb
+- spec/stendhal/mocks/mockable_spec.rb
+- spec/stendhal/mocks/test_double_spec.rb
 - spec/stendhal/reporter_spec.rb
-- spec/stendhal/test_double_spec.rb
 - stendhal.gemspec
 has_rdoc: true
 homepage: http://rubygems.org/gems/stendhal
@@ -158,6 +164,7 @@ summary: Stendhal is a really simple test framework.
 test_files: 
 - features/examples.feature
 - features/expectations.feature
+- features/mocks.feature
 - features/reporter.feature
 - features/support/env.rb
 - features/test_doubles_and_stubs.feature
@@ -170,5 +177,7 @@ test_files:
 - spec/stendhal/matchers/kind_spec.rb
 - spec/stendhal/matchers/predicate_spec.rb
 - spec/stendhal/matchers_spec.rb
+- spec/stendhal/mocks/mock_verifier_spec.rb
+- spec/stendhal/mocks/mockable_spec.rb
+- spec/stendhal/mocks/test_double_spec.rb
 - spec/stendhal/reporter_spec.rb
-- spec/stendhal/test_double_spec.rb