orangutan 0.0.1

data/README

@@ -0,0 +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?
+
+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

@@ -0,0 +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

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/orangutan.rb

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

data/lib/orangutan/call.rb

@@ -0,0 +1 @@
+Orangutan::Call = Struct.new(:name, :method, :args)

data/lib/orangutan/chantek.rb

@@ -0,0 +1,68 @@
+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
+end

data/lib/orangutan/clean_slate.rb

@@ -0,0 +1,3 @@
+class Orangutan::CleanSlate
+  instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+end

data/lib/orangutan/container.rb

@@ -0,0 +1 @@
+Orangutan::Container = Struct.new(:value)

data/lib/orangutan/expectation.rb

@@ -0,0 +1,37 @@
+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
+end

data/lib/orangutan/raiser.rb

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

data/orangutan.gemspec

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{orangutan}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Ryall"]
+  s.date = %q{2009-05-09}
+  s.description = %q{A mocking library that supports creation of ironruby mock objects (in addition to pure ruby ones)}
+  s.email = %q{mark@ryall.name}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "README",
+     "Rakefile",
+     "VERSION",
+     "lib/orangutan.rb",
+     "lib/orangutan/call.rb",
+     "lib/orangutan/chantek.rb",
+     "lib/orangutan/clean_slate.rb",
+     "lib/orangutan/container.rb",
+     "lib/orangutan/expectation.rb",
+     "lib/orangutan/raiser.rb",
+     "orangutan.gemspec",
+     "prepare.cmd",
+     "spec/ClassWithANonVirtualMethod.cs",
+     "spec/ClassWithANonVirtualProperty.cs",
+     "spec/ClassWithAVirtualMethod.cs",
+     "spec/ClassWithAVirtualProperty.cs",
+     "spec/Consumer.cs",
+     "spec/IHaveAMethod.cs",
+     "spec/IHaveAProperty.cs",
+     "spec/IHaveAnEvent.cs",
+     "spec/spec_chantek.rb",
+     "spec/spec_chantek_clr.rb",
+     "spec/spec_expectation.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/markryall/orangutan}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{orangutan}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A mock objects library}
+  s.test_files = [
+    "spec/spec_chantek.rb",
+     "spec/spec_chantek_clr.rb",
+     "spec/spec_expectation.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/prepare.cmd

@@ -0,0 +1,11 @@
+call path_git
+call path_bacon
+call path_ironruby
+call path_msbuild
+pushd %BACON_HOME%
+git pull
+popd
+pushd %IRONRUBY_HOME%
+git pull
+msbuild Merlin\Main\Languages\Ruby\Ruby.sln
+popd

data/spec/ClassWithANonVirtualMethod.cs

@@ -0,0 +1,13 @@
+using System;
+
+namespace ClassLibrary
+{
+	public class ClassWithANonVirtualMethod : IHaveAMethod
+	{		
+		public bool MyMethod(string parameter)
+		{
+			Console.WriteLine("clr method was called with " + parameter);
+			return true;
+		}
+	}
+}

data/spec/ClassWithANonVirtualProperty.cs

@@ -0,0 +1,22 @@
+using System;
+
+namespace ClassLibrary
+{
+	public class ClassWithANonVirtualProperty : IHaveAProperty
+	{
+		private string _MyProperty;
+		public string MyProperty
+		{
+			get
+			{
+				Console.WriteLine("clr getter called");
+				return _MyProperty;
+			}
+			set
+			{
+				Console.WriteLine("clr setter called");
+				_MyProperty = value;
+			}
+		}
+	}
+}

data/spec/ClassWithAVirtualMethod.cs

@@ -0,0 +1,13 @@
+using System;
+
+namespace ClassLibrary
+{
+	public class ClassWithAnVirtualMethod : IHaveAMethod
+	{		
+		public virtual bool MyMethod(string parameter)
+		{
+			Console.WriteLine("clr method was called with " + parameter);
+			return true;
+		}
+	}
+}

data/spec/ClassWithAVirtualProperty.cs

@@ -0,0 +1,22 @@
+using System;
+
+namespace ClassLibrary
+{
+	public class ClassWithAVirtualProperty : IHaveAProperty
+	{
+		private string _MyProperty;
+		public virtual string MyProperty
+		{
+			get
+			{
+				Console.WriteLine("clr getter called");
+				return _MyProperty;
+			}
+			set
+			{
+				Console.WriteLine("clr setter called");
+				_MyProperty = value;
+			}
+		}
+	}
+}

data/spec/Consumer.cs

@@ -0,0 +1,30 @@
+using System;
+
+namespace ClassLibrary
+{
+	public class Consumer 
+	{
+		private int count = 0;
+		
+		public void CallMethod(IHaveAMethod consumable)
+		{
+			consumable.MyMethod("thing");
+		}
+		
+		public void RegisterEvent(IHaveAnEvent e)
+		{
+			e.MyEvent += (s,ev) => Console.WriteLine(s);
+		}
+		
+		public void CallSetter(IHaveAProperty p)
+		{
+			p.MyProperty = ""+count;
+			count++;
+		}
+
+		public void CallGetter(IHaveAProperty p)
+		{
+			Console.WriteLine(p.MyProperty);
+		}
+	}
+}

data/spec/IHaveAMethod.cs

@@ -0,0 +1,9 @@
+using System;
+
+namespace ClassLibrary
+{
+	public interface IHaveAMethod
+	{
+		bool MyMethod(string parameter);
+	}
+}

data/spec/IHaveAProperty.cs

@@ -0,0 +1,9 @@
+using System;
+
+namespace ClassLibrary
+{
+	public interface IHaveAProperty
+	{
+		String MyProperty { get; set; }
+	}
+}

data/spec/IHaveAnEvent.cs

@@ -0,0 +1,9 @@
+using System;
+
+namespace ClassLibrary
+{
+	public interface IHaveAnEvent
+	{
+		event EventHandler<EventArgs> MyEvent;
+	}
+}

data/spec/spec_chantek.rb

@@ -0,0 +1,61 @@
+require 'orangutan'
+
+describe Orangutan::Chantek, 'creating ruby stubs' do
+  before do
+    @o = Orangutan::Chantek.new
+    @foo = @o.stub :foo
+  end
+
+  it 'should record method calls and their parameters on a stub' do
+    @foo.method1(1,2,3)
+    @o.calls[0].should == Orangutan::Call.new(:foo, :method1, [1,2,3])
+  end
+
+  it 'should record all ordinary object methods calls (except __send__ and __id__)' do
+    methods = Object.new.methods
+    methods.each { |m| @foo.__send__(m.to_sym) unless m =~ /^__/ }
+    @o.calls.length.should == (methods.length-2)
+  end
+
+  it 'should allow method return values to be stubbed' do
+    @o.when(:foo).receives(:bar).return('baz')
+    @foo.bar.should == 'baz'
+  end
+
+  it 'should allow method return values to be stubbed for method invocations with specific arguments' do
+    @o.when(:foo).receives(:bar).with(7).return('baz')
+    @foo.bar(7).should == 'baz'
+  end
+  
+  it 'should allow stubbed methods to yield' do
+    @o.when(:foo).receives(:bar).with(7).yield('baz')
+    a = nil
+    @foo.bar(7) {|s| a = s}
+    a.should == 'baz'
+  end
+
+  it 'should allow stubbed methods to yield nils' do
+    @o.when(:foo).receives(:bar).yield(nil)
+    called = false
+    @foo.bar {|s| called = true}
+    called.should == true
+  end
+
+  it 'should allow stubbed methods to raise error from string' do
+    @o.when(:foo).receives(:bar).raise("you can't be serious")
+    begin
+      @foo.bar
+    rescue RuntimeError => e
+      e.message.should == "you can't be serious"
+    end
+  end
+  
+  it 'should allow stubbed methods to raise error from string' do
+    @o.when(:foo).receives(:bar).raise(RuntimeError, "you can't be serious")
+    begin
+      @foo.bar
+    rescue RuntimeError => e
+      e.message.should == "you can't be serious"
+    end
+  end
+end

data/spec/spec_chantek_clr.rb

@@ -0,0 +1,12 @@
+require 'orangutan'
+require 'ClassLibrary.dll'
+
+describe Orangutan::Chantek, 'creating clr stubs' do
+  it 'should create stub implementations of a clr interface with a method' do
+    o = Orangutan::Chantek.new
+    s = o.stub :foo, :clr_interface => ClassLibrary::IHaveAMethod
+    c = ClassLibrary::Consumer.new
+    c.call_method(s) 
+    o.calls[0].should == Orangutan::Call.new(:foo, :my_method, ['thing'])
+  end
+end

data/spec/spec_expectation.rb

@@ -0,0 +1,51 @@
+require 'orangutan'
+
+describe Orangutan::Expectation do
+  before do
+    @e = Orangutan::Expectation.new.receives(:foo)
+  end
+
+  it 'should not match when method is different' do
+    @e.matches?(:bar).should == false
+  end
+
+  it 'should match when method matches and args are unspecified' do
+    @e.matches?(:foo).should == true
+  end
+  
+  it 'should match when method matches and args match' do
+    @e.with(7).matches?(:foo, 7).should == true
+  end
+  
+  it 'should not match when method matches but args do not match' do
+    @e.with(7).matches?(:foo, 8).should == false
+  end
+
+  it 'should not yield by default' do
+    @e.yield_container.should == nil
+  end
+
+  it 'should yield when given a value to yield' do
+    @e.yield(1).yield_container.should.not == nil
+  end
+
+  it 'should yield when given a nil value to yield' do
+    @e.yield(nil).yield_container.should.not == nil
+  end
+
+  it 'should store yield_value' do
+    @e.yield(1).yield_container.value.should == 1
+  end
+  
+  it 'should store return value' do
+    @e.return(1).return_value.should == 1
+  end
+  
+  it 'should not raise by default' do
+    @e.raiser.should == nil
+  end
+  
+  it 'should store raiser' do
+    @e.raise('description').raiser.should.not == nil
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: orangutan
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark Ryall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-09 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: A mocking library that supports creation of ironruby mock objects (in addition to pure ruby ones)
+email: mark@ryall.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- VERSION
+- lib/orangutan.rb
+- lib/orangutan/call.rb
+- lib/orangutan/chantek.rb
+- lib/orangutan/clean_slate.rb
+- lib/orangutan/container.rb
+- lib/orangutan/expectation.rb
+- lib/orangutan/raiser.rb
+- orangutan.gemspec
+- prepare.cmd
+- spec/ClassWithANonVirtualMethod.cs
+- spec/ClassWithANonVirtualProperty.cs
+- spec/ClassWithAVirtualMethod.cs
+- spec/ClassWithAVirtualProperty.cs
+- spec/Consumer.cs
+- spec/IHaveAMethod.cs
+- spec/IHaveAProperty.cs
+- spec/IHaveAnEvent.cs
+- spec/spec_chantek.rb
+- spec/spec_chantek_clr.rb
+- spec/spec_expectation.rb
+has_rdoc: true
+homepage: http://github.com/markryall/orangutan
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: orangutan
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 2
+summary: A mock objects library
+test_files: 
+- spec/spec_chantek.rb
+- spec/spec_chantek_clr.rb
+- spec/spec_expectation.rb