orangutan 0.0.6 → 0.0.7

data/README.rdoc

@@ -0,0 +1,135 @@
+= Orangutan
+
+Orangutan is a library for creating stubs.
+
+It allows you to create stub objects and to specify methods to return and yield values as well as to raise errors.
+
+Originally it was intended for use in testing .net code using ironruby.  I'm now using it to test pure ruby code as I prefer the syntax over the alternatives.
+
+At this stage only the simplest of .net clr interfaces can be stubbed.  Eventually you should be able to test java classes (with jruby) in exactly the same way.
+
+Pure stub objects can be created which have no methods - they simply record any method invocations.  Methods of existing objects (including classes) can also be stubbed.
+
+It works by recording all method calls so that assertions can be made about them after the fact and providing a simple
+dsl for setting up stubbed methods (which can be used as expectations to assert on later).
+
+All method invocations are reported to the one central array so you can assert method invocations occur across different objects (not that you should want to).
+
+Installation:
+
+  gem install orangutan
+
+Some examples of usage (note that these are not in the context of any testing framework and are intended only to indicate how to use the api):
+
+  require 'orangutan'
+
+  include Orangutan::Chantek
+
+  reset_stubs
+
+==  Creating a pure ruby stub
+
+  @stub = stub :stub
+
+== Creating a stub that implements a clr interface
+
+  @clr_stub = stub :clr_stub, :clr_interface => System::IDisposable
+
+== Setting up stub methods that return values
+
+  so_when(:stub).receives(:execute).with(7).return('baz')
+
+== Setting up stub methods that yield values
+
+  so_when(:stub).receives(:execute).with(7).yield('baz')
+
+== Setting up stub methods that raise errors
+
+  so_when(:stub).receives(:execute).with(7).raise('baz')
+
+== checking whether an expectation was met
+
+  expectation = so_when(:stub).receives(:execute).with(7)
+  puts expectation.matched? (=> false)
+  @stub.execute(7)
+  puts expectation.matched? (=> false)
+
+== setting limits on expectations
+
+  so_when(:stub).receives(:execute).with(7).once
+  so_when(:stub).receives(:execute).with(7).twice
+  so_when(:stub).receives(:execute).with(7).exactly(4).times
+
+Note that once an expectation has reached its limit, it will no longer match.
+Expections will match in the order they are specified.
+This mechanism can be used to set up more complex expected call sequences:
+
+  e1 = so_when(:stub).receives(:execute).with(7).return('ok').once
+  e2 = so_when(:stub).receives(:execute).return('hmm').twice
+
+  puts e1.count (=> nil)
+  puts e2.count (=> nil)
+  @stub.execute(7) (=> 'ok')
+  puts e1.count (=> 1)
+  puts e2.count (=> nil)
+  @stub.execute(7) (=> 'hmm')
+  puts e1.count (=> 1)
+  puts e2.count (=> 1)
+  @stub.execute(7) (=> 'hmm')
+  puts e1.count (=> 1)
+  puts e2.count (=> 2)
+  @stub.execute(7) (=> nil)
+  puts e1.count (=> 1)
+  puts e2.count (=> 2)
+  puts e1.matched? (=> true)
+  puts e2.matched? (=> true)
+
+== Checking all expectations
+  expectations.any? {|e| !e.matched? }
+
+== Naming expectations
+
+Sometimes you'll just want to verify that a stub expectation was actually matched:
+
+  so_when(:stub, :as => :execute_with_seven).receives(:execute).with(7).return('ok').once
+  raise "wasn't matched" unless expectation(:execute_with_seven).matched? # verifying explicitly
+  expectation(:execute_with_seven).should be_matched # verifying expectation (using rspec matchers)
+
+== Examining recorded method calls
+
+  calls.each {|call| puts "#{call.name}.#{call.method}(#{call.args.join(',')})" }
+
+Recorded call sequences can also be used for assertions in combination with or instead of checking expectations.
+
+== Stubbing methods on object instances
+
+  register_object :math, Math   # registers the object (this just gives the object a name for referencing in calls)
+  stub_method :math, :cos       # replaces the implementation of the cos method with a recorder
+  so_when(:math).receives(:cos).with(0).return("i just can't take it anymore")
+
+  restore_methods # restores any changes made to methods (essential for any class methods that have been stubbed)
+
+== Registering as a mock framework with rspec
+
+  require 'orangutan/mock_adapter'
+  Spec::Runner.configure do |config|
+    config.mock_with Orangutan::MockAdapter
+  end
+
+= Questions:
+
+== Why Orangutan?
+
+My daughter likes orangutans and I couldn't think of a better name.  Both Sumatran and Bornean orangutans are endangered species so even if you intensely dislike this project or its implementation, at least you can be made aware of the plight of these spectacular creatures.
+
+== Did it have anything to do with Clyde in "Every Which Way But Loose"
+
+Definately not.  What a ridiculous question.  I'm appalled.
+
+== What's Chantek?
+
+Chantek is a famous orangutan that can solve sudokus and the rubik's cube - http://en.wikipedia.org/wiki/Chantek
+
+== Why would you create yet another mocking framework?
+
+Pretty much for the sake of it.  Originally it was an IronRuby contribution but Ivan Porto Carrera has provided a much better mocking solution for that in caricature (see http://github.com/casualjim/caricature).  Now it's just an extremely interesting exercise in learning about metaprogramming in ruby.

data/lib/orangutan/chantek.rb

@@ -7,7 +7,7 @@ require 'orangutan/stub_include'
 
 module Orangutan 
   module Chantek
-    attr_reader :calls, :stubs, :expectations
+    attr_reader :calls, :expectations
 
     def call name, method, *args
       Call.new(name, method, args)
@@ -16,6 +16,7 @@ module Orangutan
     def reset_stubs
       @calls = []
       @expectations = {}
+      @named_expectations = {}
       @stubs= {}
       @events = {}
       @stubbed_methods = []
@@ -92,10 +93,14 @@ module Orangutan
       end
     end
 
-    def so_when name
+    def so_when name, params={}
       expectations_for_name = @expectations[name]
       @expectations[name] = expectations_for_name = [] unless expectations_for_name
       expectation = Orangutan::Expectation.new
+      if params[:as]
+        raise "An expectation called foo_expection was already registered" if @named_expectations[params[:as]]
+        @named_expectations[params[:as]] = expectation
+      end
       expectations_for_name << expectation
       expectation
     end
@@ -118,5 +123,13 @@ module Orangutan
         delegates.each { |delegate| delegate.invoke *args } if event_name == event
       end
     end
+    
+    def expectation name
+      @named_expectations[name]
+    end
+    
+    def stub_names
+      @stubs.keys
+    end
   end
 end

data/lib/orangutan/mock_adapter.rb

@@ -14,4 +14,9 @@ module Orangutan
       restore_methods
     end
   end
+end
+
+Spec::Runner.configure do |config|
+  # turn off mocking
+  config.mock_with Orangutan::MockAdapter
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: orangutan
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Mark Ryall
@@ -9,12 +14,67 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-06 00:00:00 +11:00
+date: 2010-05-19 00:00:00 +10:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: gemesis
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: splat
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :development
+  version_requirements: *id004
 description: |
-  A mocking library that supports creation of ironruby mock objects (in addition to pure ruby ones)
+  Yet another test spy style mocking library that happens to support clr testing via ironruby
 
 email: mark@ryall.name
 executables: []
@@ -35,7 +95,7 @@ files:
 - lib/orangutan/stub_base.rb
 - lib/orangutan/stub_include.rb
 - lib/orangutan.rb
-- README
+- README.rdoc
 - MIT-LICENSE
 has_rdoc: true
 homepage: http://github.com/markryall/orangutan
@@ -50,18 +110,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A mock objects library

data/README

@@ -1,111 +0,0 @@
-Orangutan is a library for creating stubs.
-
-It allows you to create stub objects and to specify methods to return and yield values as well as to raise errors.
-
-It can be used in testing .net code using ironruby although at this stage only the simplest of clr interfaces can be stubbed.
-
-Note that only stub instances of objects are created.  It can not create mocks of class methods.
-
-It works by recording all method calls so that assertions can be made about them after the fact and providing a simple
-dsl for setting up stubbed methods (which can be used as expectations to assert on later).
-
-Orangutan can be used with any testing framework and in combination with other mock frameworks.
-
-Installation:
-
-gem install orangutan
-
-Some examples of usage (note that these are not in the context of any testing framework and are intended only to indicate how to use the api):
-
-require 'orangutan'
-
-include Orangutan::Chantek
-
-reset_stubs
-
-# Creating a pure ruby stub
-@stub = stub :stub
-
-# Creating a stub that implements a clr interface
-@clr_stub = stub :clr_stub, :clr_interface => System::IDisposable
-
-# Setting up stub methods that return values
-so_when(:stub).receives(:execute).with(7).return('baz')
-
-# Setting up stub methods that yield values
-so_when(:stub).receives(:execute).with(7).yield('baz')
-
-# Setting up stub methods that raise errors
-so_when(:stub).receives(:execute).with(7).raise('baz')
-
-# checking whether an expectation was met
-expectation = so_when(:stub).receives(:execute).with(7)
-puts expectation.matched? (=> false)
-@stub.execute(7)
-puts expectation.matched? (=> false)
-
-# setting limits on expectations
-
-so_when(:stub).receives(:execute).with(7).once
-so_when(:stub).receives(:execute).with(7).twice
-so_when(:stub).receives(:execute).with(7).exactly(4).times
-
-# Note that once an expectation has reached its limit, it will no longer match.
-# Expections will match in the order they are specified.
-# This mechanism can be used to set up more complex expected call sequences:
-
-e1 = so_when(:stub).receives(:execute).with(7).return('ok').once
-e2 = so_when(:stub).receives(:execute).return('hmm').twice
-
-puts e1.count (=> nil)
-puts e2.count (=> nil)
-@stub.execute(7) (=> 'ok')
-puts e1.count (=> 1)
-puts e2.count (=> nil)
-@stub.execute(7) (=> 'hmm')
-puts e1.count (=> 1)
-puts e2.count (=> 1)
-@stub.execute(7) (=> 'hmm')
-puts e1.count (=> 1)
-puts e2.count (=> 2)
-@stub.execute(7) (=> nil)
-puts e1.count (=> 1)
-puts e2.count (=> 2)
-puts e1.matched? (=> true)
-puts e2.matched? (=> true)
-
-# Checking all expectations
-expectations.any? {|e| !e.matched? }
-
-# Examining recorded method calls
-calls.each {|call| puts "#{call.name}.#{call.method}(#{call.args.join(',')})" }
-
-# Recorded call sequences can also be used for assertions in combination with or instead of checking expectations.
-
-# Stubbing methods on object instances
-
-register_object :math, Math   # registers the object (this just gives the object a name for referencing in calls)
-stub_method :math, :cos       # replaces the implementation of the cos method with a recorder
-so_when(:math).receives(:cos).with(0).return("i just can't take it anymore")
-
-# Registering as a mock framework with rspec
-
-require 'orangutan/mock_adapter'
-Spec::Runner.configure do |config|
-  # turn off mocking
-  config.mock_with Orangutan::MockAdapter
-end
-
-Questions:
-
-* Why Orangutan?
-
-My daughter likes orangutans and I couldn't think of a better name.  Both Sumatran and Bornean orangutans are endangered species so even if you intensely dislike this project or its implementation, at least you can be made aware of the plight of these spectacular creatures.
-
-* Did it have anything to do with Clyde in "Every Which Way But Loose"
-
-Definately not.  What a ridiculous question.  I'm appalled.
-
-* What's Chantek?
-
-Chantek is a famous orangutan that can solve sudokus and the rubik's cube - http://en.wikipedia.org/wiki/Chantek