stendhal 0.1.5 → 0.1.6

data/.gitignore

@@ -3,3 +3,4 @@ pkg/*
 .bundle
 coverage
 tmp/*
+*.rbc

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    stendhal (0.1.4)
+    stendhal (0.1.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
     aruba (0.2.2)
     builder (2.1.2)
+    configuration (1.1.0)
     cucumber (0.8.5)
       builder (~> 2.1.2)
       diff-lcs (~> 1.1.2)
@@ -17,7 +18,19 @@ GEM
     diff-lcs (1.1.2)
     gherkin (2.1.5)
       trollop (~> 1.16.2)
+    growl (1.0.3)
+    guard (0.2.2)
+      open_gem (~> 1.4.2)
+      thor (~> 0.14.3)
+    guard-rspec (0.1.8)
+      guard (>= 0.2.0)
     json_pure (1.4.6)
+    launchy (0.3.7)
+      configuration (>= 0.0.5)
+      rake (>= 0.8.1)
+    open_gem (1.4.2)
+      launchy (~> 0.3.5)
+    rake (0.8.7)
     rspec (2.0.1)
       rspec-core (~> 2.0.1)
       rspec-expectations (~> 2.0.1)
@@ -32,6 +45,7 @@ GEM
       simplecov-html (>= 0.3.7)
     simplecov-html (0.3.8)
     term-ansicolor (1.0.5)
+    thor (0.14.4)
     trollop (1.16.2)
 
 PLATFORMS
@@ -40,6 +54,9 @@ PLATFORMS
 DEPENDENCIES
   aruba
   cucumber (= 0.8.5)
+  growl
+  guard
+  guard-rspec
   rspec
   simplecov
   stendhal!

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at http://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :bundler => true do
+  watch('^spec/(.*)_spec.rb')
+  watch('^lib/(.*)\.rb')                              { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('^spec/spec_helper.rb')                       { "spec" }
+  
+  # Rails example
+  # watch('^app/(.*)\.rb')                              { |m| "spec/#{m[1]}_spec.rb" }
+  watch('^lib/(.*)\.rb')                              { |m| "spec/#{m[1]}_spec.rb" }
+  watch('^config/routes.rb')                          { "spec/routing" }
+  watch('^app/controllers/application_controller.rb') { "spec/controllers" }
+  watch('^spec/factories/(.*)\.rb')                         { "spec/models" }
+end

data/Readme.md

@@ -2,6 +2,8 @@
 
 A small test framework developed as a personal kata to improve my ruby.
 
+Tested with Ruby 1.8.7, 1.9.2, JRuby 1.5.3 and Rubinius 1.1.
+
 Currently under development, there is only basic functionality for now.
 Below I will be posting whatever features are available throughout the
 development.
@@ -10,7 +12,7 @@ development.
 
 * Pretty decent reporter with colors
 * Test doubles and stubs (no partial stubbing yet)
-* Mocks (message expectations)
+* Mocks (message expectations) with _optionally_ stubbable return values
 * Nested example groups (declare them with either describe or context)
 * Pending examples
 * Matchers (use with object.must or object.must_not)
@@ -94,6 +96,31 @@ development.
           string.reverse # Expectation fulfilled!
         end
 
+        it "can be told the number of times it is expected" do
+          string = "my string"
+          string.expects(:reverse).once # or
+          string.expects(:reverse).twice # or
+          string.expects(:reverse).exactly(3).times
+
+          string.reverse # Fails!
+        end
+
+        it "can return a stubbed value" do
+          string = "my string"
+          string.expects(:reverse).and_returns 'stubbed value'
+
+          string.reverse # => "stubbed value"
+        end
+
+        it "can return a stubbed proc" do
+          string = "my string"
+          string.expects(:reverse).and_returns do
+            3 + 4
+          end
+
+          string.reverse # => 7
+        end
+
         it "is declared with does_not_expect in case it is negative" do
           string = "my string"
           string.does_not_expect(:reverse)
@@ -132,9 +159,12 @@ development.
 
     Message expectation
       * is declared with expects
-      * is declared with does_not_expect in case it is negative
+      * can be told the number of times it is expected [FAILED]
+      * can return a stubbed value
+      * can return a stubbed proc
+      * is declared with does_not_expect in case it is negative [FAILED]
 
-    13 examples, 3 failures, 2 pending
+    16 examples, 4 failures, 2 pending
 
 ##Feedback
 

data/features/mocks.feature

@@ -10,6 +10,7 @@ Feature: Mocks (message expectations)
       class MyClass
 
         def foo
+          'called foo' 
         end
 
         def bar
@@ -20,10 +21,17 @@ Feature: Mocks (message expectations)
 
       describe "bar" do
         it "calls foo" do
+          object = MyClass.new
+          object.expects(:foo) # Defaults to .once
+
+          object.bar.must eq('called foo') # The return value is not stubbed
+        end
+        it "calls foo two times" do
           object = MyClass.new
           object.expects(:foo)
+          object.expects(:foo) # This makes two calls expected
 
-          object.bar
+          2.times { object.bar } 
         end
         it "never calls foo" do
           object = MyClass.new
@@ -33,7 +41,7 @@ Feature: Mocks (message expectations)
     """
     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 "3 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
@@ -69,3 +77,75 @@ Feature: Mocks (message expectations)
     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"
+
+  Scenario: declare a message expectation with a number of times
+    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 twice" do
+          object = MyClass.new
+          object.expects(:foo).twice
+
+          object.bar
+          object.bar
+        end
+        it "calls foo three times" do
+          object = MyClass.new
+          object.expects(:foo).exactly(3).times
+
+          3.times { object.bar } 
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "2 examples, 0 failures"
+
+  Scenario: declare a message expectation stubbing the return value
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      class MyClass
+
+        def foo
+          'called foo' 
+        end
+
+        def bar
+          foo
+        end
+
+      end
+
+      describe "bar" do
+        it "calls foo and returns a stubbed value" do
+          object = MyClass.new
+          object.expects(:foo).and_returns('stubbed foo')
+
+          object.bar.must eq('stubbed foo')
+        end
+        it "calls foo three times" do
+          object = MyClass.new
+          object.expects(:foo).exactly(3).times.and_returns('stubbed foo')
+
+          3.times { object.bar.must eq('stubbed foo') } 
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "2 examples, 0 failures"

data/lib/stendhal/dsl.rb

@@ -12,7 +12,8 @@ module Stendhal
         else
           options = {:pending => true}
         end
-        self.add_example Stendhal::Example.new(*args,options,&blk)
+        args << options
+        self.add_example Stendhal::Example.new(*args, &blk)
       end
     end
 

data/lib/stendhal/mocks/mock_verifier.rb

@@ -5,19 +5,32 @@ module Stendhal
       @@verifiers = []
 
       attr_reader :expectations
+      attr_reader :last_mocked_method
+      attr_reader :object
 
       def initialize(object)
         @expectations = []
         @object = object
+        @last_mocked_method = nil
         @@verifiers << self
       end
 
-      def add_expectation(method)
-        @expectations << MessageExpectation.new(method)
+      def expectation_for(method)
+        @expectations.detect {|e| e.method == method }
+      end
+
+      def add_expectation(method, options = {})
+        @last_mocked_method = method
+        expectation_for(method).tap do |expectation|
+          expectation and begin
+            options[:negative] ? expectation.times_expected = 0 :
+                                 expectation.times_expected += 1
+          end
+        end || @expectations << MessageExpectation.new(method, options)
       end
 
       def add_negative_expectation(method)
-        @expectations << MessageExpectation.new(method, :negative => true)
+        add_expectation(method, :negative => true)
       end
 
       def fulfill_expectation(method)
@@ -49,7 +62,7 @@ module Stendhal
       class MessageExpectation
         attr_reader :method
         attr_reader :times_called
-        attr_reader :times_expected
+        attr_accessor :times_expected
 
         def initialize(method, options = {})
           @method = method

data/lib/stendhal/mocks/mockable.rb

@@ -8,15 +8,55 @@ module Stendhal
         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
+        unless respond_to?(:"__original_#{method}")
+          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
+        self
+      end
+
+      def once
+        raise "This object has no mocks." unless @__verifier
+        __verifier.expectation_for(__verifier.last_mocked_method).times_expected = 1
+        self
+      end
+
+      def twice
+        raise "This object has no mocks." unless @__verifier
+        __verifier.expectation_for(__verifier.last_mocked_method).times_expected = 2
+        self
+      end
+
+      def exactly(times)
+        raise "This object has no mocks." unless @__verifier
+        __verifier.expectation_for(__verifier.last_mocked_method).times_expected = times
+        self
+      end
+
+      def times
+        raise "This object has no mocks." unless @__verifier
+        self
+      end
+
+      def and_returns(retval = nil, &block)
+        raise "This object has no mocks." unless @__verifier
+        method = __verifier.last_mocked_method
+        str = retval.to_s
+        unless respond_to?(:"__unstubbed_#{method}")
+          metaclass = (class << self;self;end)
+          metaclass.send(:alias_method, :"__unstubbed_#{method}", :"__original_#{method}")
+          metaclass.send(:undef_method, :"__original_#{method}")
+
+          return_value = block || Proc.new { retval }
+          metaclass.send(:define_method, :"__original_#{method}", return_value)
+        end
       end
 
       def does_not_expect(method)

data/lib/stendhal/mocks/test_double.rb

@@ -15,7 +15,6 @@ module Stendhal
             v 
           end
         end
-
       end
 
     end

data/lib/stendhal/version.rb

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

data/spec/stendhal/mocks/mock_verifier_spec.rb

@@ -12,18 +12,52 @@ module Stendhal
       end
 
       describe "instance methods" do
-      
+
+        describe "#expectation_for(method)" do
+          it 'returns the expectation for a given method' do
+            subject.add_expectation(:length)
+            subject.add_expectation(:class)
+
+            subject.expectation_for(:length).should be_a(MockVerifier::MessageExpectation)
+            subject.expectation_for(:length).method.should == :length
+          end
+        end
+
         describe "#add_expectation" do
           it 'adds an expectation for a given method' do
-            MockVerifier::MessageExpectation.should_receive(:new).with(:reverse)
+            MockVerifier::MessageExpectation.should_receive(:new).with(:reverse, {})
 
             subject.add_expectation(:reverse)
           end
+          it 'remembers last mocked method' do
+            subject.add_expectation(:reverse)
+            subject.last_mocked_method.should == :reverse
+          end
+          context "if an expectation for such method already exists" do
+            it 'adds an expected call to that expectation' do
+              subject.add_expectation(:reverse)
+              MockVerifier::MessageExpectation.should_not_receive(:new)
+
+              subject.add_expectation(:reverse)
+
+              subject.should have(1).expectations
+              subject.expectations.first.times_expected.should == 2
+            end
+          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_expectation(:reverse)
+            subject.add_expectation(:reverse)
+
+            subject.add_negative_expectation(:reverse)
+
+            subject.should have(1).expectations
+            subject.expectations.first.times_expected.should == 0
+          end
+          it 'overrides previous positive expectations on the same method' do
+            subject.should_receive(:add_expectation).with(:reverse, :negative => true)
 
             subject.add_negative_expectation(:reverse)
           end

data/spec/stendhal/mocks/mockable_spec.rb

@@ -19,8 +19,111 @@ module Stendhal
           subject.expects(:length) 
           subject.send(:__verifier).expectations.map(&:method).should include(:length)
         end
+        it 'saves the original method' do
+          subject.expects(:length) 
+          subject.should respond_to(:__original_length)
+          subject.send(:__original_length).should == 3
+        end
+        it 'makes the mocked method register a call and call the original method afterwards' do
+          subject.expects(:length) 
+          subject.send(:__verifier).should_receive(:fulfill_expectation).once.ordered
+          subject.should_receive(:__original_length).once.ordered
+
+          subject.length
+        end
+        context "when the method is already mocked" do
+          it 'does not redefine it' do
+            subject.stub(:__original_length)
+            metaclass = (class << subject; self; end)
+            metaclass.should_not_receive(:alias_method)
+            metaclass.should_not_receive(:undef_method)
+            metaclass.should_not_receive(:class_eval)
+
+            subject.expects(:length) 
+          end
+        end
+        it 'returns itself to allow chaining' do
+          subject.expects(:length).should be_a(MyArray)
+        end
       end
 
+      describe "times a method is expected to be received" do
+
+        {:once => 1,
+         :twice => 2}.each do |name,times|
+
+          describe "##{times}" do
+            it 'sets the times expected for the mocked method to one' do
+              expectation = double('expectation', :times_expected => 7)
+              subject.send(:__verifier).should_receive(:last_mocked_method).and_return :length
+              subject.send(:__verifier).should_receive(:expectation_for).with(:length).and_return expectation
+              expectation.should_receive(:times_expected=).with(times)
+
+              subject.send(name)
+            end
+            it 'returns itself to allow chaining' do
+              subject.send(:__verifier).stub(:last_mocked_method).and_return :length
+              subject.expects(:length).send(name).should be_a(MyArray)
+            end
+            it 'raises an error if called without a previous mock' do
+              expect {
+                subject.send(name)
+              }.to raise_error("This object has no mocks.")
+            end
+          end
+
+        end
+
+        describe "#exactly(number_of_times)" do
+          it 'sets the times expected for the mocked method to the given number' do
+            expectation = double('expectation', :times_expected => 7)
+            subject.send(:__verifier).should_receive(:last_mocked_method).and_return :length
+            subject.send(:__verifier).should_receive(:expectation_for).with(:length).and_return expectation
+            expectation.should_receive(:times_expected=).with(3)
+
+            subject.exactly(3)
+          end
+          it 'returns itself to allow chaining' do
+            subject.send(:__verifier).stub(:last_mocked_method).and_return :length
+            subject.expects(:length).twice.should be_a(MyArray)
+          end
+          it 'raises an error if called without a previous mock' do
+            expect {
+              subject.exactly(2)
+            }.to raise_error("This object has no mocks.")
+          end
+        end
+
+        describe "#times" do
+          it 'returns itself to allow chaining' do
+            subject.expects(:length).times.should be_a(MyArray)
+          end
+          it 'raises an error if called without a previous mock' do
+            expect {
+              subject.times
+            }.to raise_error("This object has no mocks.")
+          end
+        end
+
+      end
+
+      describe "#and_returns" do
+        it 'stubs the return value' do
+          subject.expects(:length).and_returns 5
+          subject.length.should == 5
+        end
+        it 'accepts a block as the return value' do
+          subject.expects(:length).and_returns do
+            3 + 4
+          end
+          subject.length.should == 7
+        end
+        it 'saves the unstubbed method' do
+          subject.expects(:length).and_returns(:foo)
+          subject.should respond_to(:__unstubbed_length)
+          subject.send(:__unstubbed_length).should == 3
+        end
+      end
     end
   end
 end

data/stendhal.gemspec

@@ -20,6 +20,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency "cucumber", "=0.8.5"
   s.add_development_dependency "aruba"
 
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "growl"
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Josep M. Bach
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-09 00:00:00 +01:00
+date: 2010-11-13 00:00:00 +01:00
 default_executable: stendhal
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,45 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: Stendhal is a really simple test framework.
 email: 
 - josep.m.bach@gmail.com
@@ -86,6 +125,7 @@ files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - Rakefile
 - Readme.md
 - bin/stendhal