orangutan 0.0.1 → 0.0.2

data/README

@@ -1,59 +1,59 @@
-Orangutan is a mocking library.
-
-It allows you to create stub objects and to setup methods with return, yield and raise behaviours.
-
-It can be used in testing .net code using ironruby.
-
-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.
-
-This means that orangutan can be used with any testing framework and in combination with other mock frameworks.
-
-Installation:
-
-gem install markryall-orangutan
-
-Usage:
-
-require 'orangutan'
-@o = Orangutan::Chantek.new
-
-# Creating a pure ruby stub
-@stub = @orangutan.stub :stub
-
-# Creating a stub that implements a clr interface
-@clr_stub = @orangutan.stub :clr_stub, :clr_interface => System::IDisposable
-
-# Setting up stub methods that return values
-@o.when(:stub).receives(:execute).with(7).return('baz')
-
-# Setting up stub methods that yield values
-@o.when(:stub).receives(:execute).with(7).yield('baz')
-
-# Setting up stub methods that raise errors
-@o.when(:stub).receives(:execute).with(7).raise('baz')
-
-# Checking recorded method calls
-# at this stage you need to scan the array of call structs recorded in @o.calls
-@o.calls[0].should == Orangutan::Call.new(:stub, :execute, [7])
-
-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 do I not need to register this as a mock framework?
-
+Orangutan is a mocking library.
+
+It allows you to create stub objects and to setup methods with return, yield and raise behaviours.
+
+It can be used in testing .net code using ironruby.
+
+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.
+
+This means that orangutan can be used with any testing framework and in combination with other mock frameworks.
+
+Installation:
+
+gem install markryall-orangutan
+
+Usage:
+
+require 'orangutan'
+@o = Orangutan::Chantek.new
+
+# Creating a pure ruby stub
+@stub = @orangutan.stub :stub
+
+# Creating a stub that implements a clr interface
+@clr_stub = @orangutan.stub :clr_stub, :clr_interface => System::IDisposable
+
+# Setting up stub methods that return values
+@o.when(:stub).receives(:execute).with(7).return('baz')
+
+# Setting up stub methods that yield values
+@o.when(:stub).receives(:execute).with(7).yield('baz')
+
+# Setting up stub methods that raise errors
+@o.when(:stub).receives(:execute).with(7).raise('baz')
+
+# Checking recorded method calls
+# at this stage you need to scan the array of call structs recorded in @o.calls
+@o.calls[0].should == Orangutan::Call.new(:stub, :execute, [7])
+
+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 do I not need to register this as a mock framework?
+
 Most frameworks such as rspec's mocks, mocha and stubba replace methods on existing classes.  Because this can't be done with this library - you can only create pure stub objects and setup method behaviours, there's nothing that needs to be undone at the end of a test/example.

data/Rakefile

@@ -1,34 +1,34 @@
-desc 'build necessary assemblies for tests'
-task 'spec/ClassLibrary.dll' => FileList["spec/**/*.cs"] do
-  system "csc /target:library /out:spec\\ClassLibrary.dll  spec\\*.cs"
-end
-
-task :compile => 'spec/ClassLibrary.dll'
-
-desc 'run specs with bacon on ironruby'
-task :bacon => :compile do
-  system "ibacon -Ispec -a"
-end
-
-(1..4).each do |i|
-  desc "run spike #{i}"
-  task "spike#{i}" do
-    system "ir -I spec -I spikes spikes\\experiment#{i}.rb"
-  end
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "orangutan"
-    gemspec.summary = "A mock objects library"
-    gemspec.email = "mark@ryall.name"
-    gemspec.homepage = "http://github.com/markryall/orangutan"
-    gemspec.description = "A mocking library that supports creation of ironruby mock objects (in addition to pure ruby ones)"
-    gemspec.files = FileList["[A-Z]*", "{lib,spec}/**/*.{rb,cs}"]
-    gemspec.authors = ["Mark Ryall"]
-    gemspec.rubyforge_project = 'orangutan'
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
+desc 'build necessary assemblies for tests'
+task 'spec/ClassLibrary.dll' => FileList["spec/**/*.cs"] do
+  system "csc /target:library /out:spec\\ClassLibrary.dll  spec\\clr\\*.cs"
+end
+
+task :compile => 'spec/ClassLibrary.dll'
+
+desc 'run specs with bacon on ironruby'
+task :bacon => :compile do
+  system "ibacon -Ispec -a"
+end
+
+(1..4).each do |i|
+  desc "run spike #{i}"
+  task "spike#{i}" do
+    system "ir -I spec -I spikes spikes\\experiment#{i}.rb"
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "orangutan"
+    gemspec.summary = "A mock objects library"
+    gemspec.email = "mark@ryall.name"
+    gemspec.homepage = "http://github.com/markryall/orangutan"
+    gemspec.description = "A mocking library that supports creation of ironruby mock objects (in addition to pure ruby ones)"
+    gemspec.files = FileList["[A-Z]*", "{lib,spec}/**/*.{rb,cs}"]
+    gemspec.authors = ["Mark Ryall"]
+    gemspec.rubyforge_project = 'orangutan'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 2
+:major: 0

data/lib/orangutan.rb

@@ -1,3 +1,3 @@
-module Orangutan
-end
+module Orangutan
+end
 require 'orangutan/chantek'

data/lib/orangutan/chantek.rb

@@ -1,68 +1,50 @@
-require 'orangutan/clean_slate'
-require 'orangutan/expectation'
-require 'orangutan/call'
-
-class Orangutan::Chantek
-  attr_reader :calls
-
-  def initialize
-    @calls = []
-    @expectations = {}
-  end
-
-  def stub name, params={}
-    c = Class.new(Orangutan::CleanSlate) do
-      if params[:clr_interface]
-        include params[:clr_interface]
-        params[:clr_interface].to_clr_type.get_methods.each do |m_info|
-          snake = m_info.name.scan(/[A-Z][a-z0-9]*/).map {|a|a.downcase}.join('_').to_sym
-          define_method snake do |*args|
-            yield_container, return_value, raiser = __react__ snake, args
-            raiser.execute if raiser
-            yield yield_container.value if yield_container && block_given?
-            return_value
-          end
-        end
-      end
-
-      def initialize name, parent
-        @name, @parent = name, parent
-      end
-
-      def method_missing method, *args
-        yield_container, return_value, raiser = __react__ method, args
-        raiser.execute if raiser
-        yield yield_container.value if yield_container && block_given?
-        return_value
-      end
-
-  private
-
-      def __react__ method, args
-        yield_container, return_value, raiser = nil, nil, nil
-        @parent.calls << Orangutan::Call.new(@name, method, args)
-        first_match = @parent.first_match(@name, method, args)
-        return first_match.yield_container, first_match.return_value, first_match.raiser if first_match
-        return yield_container, return_value, raiser
-      end
-    end
-    c.new name, self
-  end
-
-  def when name
-    expectations_for_name = @expectations[name]
-    @expectations[name] = expectations_for_name = [] unless expectations_for_name
-    expectation = Orangutan::Expectation.new
-    expectations_for_name << expectation
-    expectation
-  end
-
-  def first_match name, method, args
-    expectations_for_name = @expectations[name]
-    if expectations_for_name
-      expectations_for_name.each do |expectation|
-          return expectation if expectation.matches?(method, *args)
-      end
-    end
-  end
+require 'orangutan/stub_base'
+require 'orangutan/expectation'
+require 'orangutan/call'
+
+module Orangutan 
+  class Chantek
+    attr_reader :calls
+  
+    def initialize
+      @calls = []
+      @expectations = {}
+      @stubs= {}
+    end
+  
+    def stub name, params={}
+      return @stubs[name] if @stubs[name]
+      c = Class.new(StubBase) do
+        if params[:clr_interface]
+          include params[:clr_interface]
+          params[:clr_interface].to_clr_type.get_methods.each do |m_info|
+            snake = m_info.name.scan(/[A-Z][a-z0-9]*/).map {|a|a.downcase}.join('_').to_sym
+            define_method snake do |*args|
+              yield_container, return_container = __react__(snake, args)
+              yield yield_container.value if yield_container && block_given?
+              __return__(method, return_container)
+            end
+          end
+        end
+      end
+      @stubs[name] = c.new(name, self, params[:recursive])
+    end
+  
+    def when name
+      expectations_for_name = @expectations[name]
+      @expectations[name] = expectations_for_name = [] unless expectations_for_name
+      expectation = Orangutan::Expectation.new
+      expectations_for_name << expectation
+      expectation
+    end
+  
+    def first_match name, method, args
+      expectations_for_name = @expectations[name]
+      if expectations_for_name
+        expectations_for_name.each do |expectation|
+            return expectation if expectation.matches?(method, *args)
+        end
+      end
+    end
+  end
 end

data/lib/orangutan/clean_slate.rb

@@ -1,3 +1,32 @@
-class Orangutan::CleanSlate
-  instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+module Orangutan
+  class CleanSlate
+    instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+
+    def initialize name, parent, recursive
+      @name, @parent, @recursive = name, parent, recursive
+    end
+
+    def method_missing method, *args
+      yield_container, return_container = __react__(method, args)
+      yield yield_container.value if yield_container && block_given?
+      __return__(method, return_container)
+    end
+  private
+    def __return__ method, return_container
+      return return_container.value if return_container
+      return @parent.stub(:"@name/method") if @recursive
+      nil
+    end
+  
+    def __react__ method, args
+      yield_container, return_value = nil, nil
+      @parent.calls << Orangutan::Call.new(@name, method, args)
+      first_match = @parent.first_match(@name, method, args)
+      if first_match
+        first_match.raiser.execute if first_match.raiser
+        yield_container, return_value =  first_match.yield_container, first_match.return_value 
+      end
+      return yield_container, return_value
+    end
+  end
 end

data/lib/orangutan/container.rb

@@ -1 +1,3 @@
-Orangutan::Container = Struct.new(:value)
+module Orangutan 
+  Container = Struct.new(:value)
+end

data/lib/orangutan/expectation.rb

@@ -1,37 +1,39 @@
-require 'orangutan/raiser'
-require 'orangutan/container'
-
-class Orangutan::Expectation
-  attr_reader :return_value, :yield_container, :raiser
-  
-  def receives method
-    @method = method
-    self
-  end
-  
-  def with *args
-    @args = args
-    self
-  end
-
-  def return value
-    @return_value = value
-    self
-  end
-  
-  def yield value
-    @yield_container = Orangutan::Container.new value
-    self
-  end
-  
-  def raise *args
-    @raiser = Orangutan::Raiser.new args
-    self
-  end
-
-  def matches? method, *args
-    return false unless method == @method
-    return true unless @args
-    @args == args
-  end
+require 'orangutan/raiser'
+require 'orangutan/container'
+
+module Orangutan
+  class Expectation
+    attr_reader :return_container, :yield_container, :raiser
+    
+    def receives method
+      @method = method
+      self
+    end
+    
+    def with *args
+      @args = args
+      self
+    end
+  
+    def return value
+      @return_container = Container.new value
+      self
+    end
+    
+    def yield value
+      @yield_container = Container.new value
+      self
+    end
+    
+    def raise *args
+      @raiser = Raiser.new args
+      self
+    end
+  
+    def matches? method, *args
+      return false unless method == @method
+      return true unless @args
+      @args == args
+    end
+  end
 end

data/lib/orangutan/raiser.rb

@@ -1,10 +1,10 @@
-class Orangutan::Raiser
-  def initialize args
-    @args = args
-  end
-
-  def execute
-    puts 'RAISING ' + @args.inspect
-    raise *@args
-  end
+class Orangutan::Raiser
+  def initialize args
+    @args = args
+  end
+
+  def execute
+    puts 'RAISING ' + @args.inspect
+    raise *@args
+  end
 end