surrogate 0.1.0

data/spec/rspec/substitute_for_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'substitute_for' do
+
+  context "returns true iff api methods and inherited methods match exactly to the other object's methods. Examples:" do
+    context "a surrogate with no api methods" do
+      let(:surrogate) { Surrogate.endow Class.new }
+
+      example "is substitutable for a class with no methods" do
+        surrogate.should substitute_for Class.new
+      end
+
+      example "is not substitutable for a class with instance methods" do
+        surrogate.should_not substitute_for Class.new { def foo()end }
+      end
+
+      example "is not substitutable for a class with class methods" do
+        surrogate.should_not substitute_for Class.new { def self.foo()end }
+      end
+
+      example "is not substitutable for a class with inherited instance methods" do
+        parent = Class.new { def foo()end }
+        surrogate.should_not substitute_for Class.new(parent)
+      end
+
+      example "is not substitutable for a class with inherited class methods" do
+        parent = Class.new { def self.foo()end }
+        surrogate.should_not substitute_for Class.new(parent)
+      end
+    end
+
+
+    context "a surrogate with an instance level api method" do
+      let(:surrogate) { Class.new { Surrogate.endow self; define :foo } }
+
+      example "is substitutable for a class with the same method" do
+        surrogate.should substitute_for Class.new { def foo()end }
+      end
+
+      example "is substitutable for a class that inherits the method" do
+        parent = Class.new { def foo()end }
+        surrogate.should substitute_for Class.new(parent)
+      end
+
+      example "is not substitutable for a class without the method" do
+        surrogate.should_not substitute_for Class.new
+      end
+
+      example "is not substitutable for a class with a different method" do
+        surrogate.should_not substitute_for Class.new { def bar()end }
+      end
+
+      example "is not substitutable for a class with additional methods" do
+        other = Class.new { def foo()end; def bar()end }
+        surrogate.should_not substitute_for other
+      end
+
+      example "is not substitutable for a class with the method and inerited additional methods" do
+        parent = Class.new { def bar()end }
+        surrogate.should_not substitute_for Class.new(parent) { def foo()end }
+      end
+
+      example "is not substitutable for a class with the method and additional class methods" do
+        surrogate.should_not substitute_for Class.new { def foo()end; def self.bar()end }
+      end
+
+      example "is not substitutable for a class with the method and inherited additional class methods" do
+        parent = Class.new { def self.bar()end }
+        surrogate.should_not substitute_for Class.new(parent) { def foo()end }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'surrogate'
+require 'surrogate/rspec'

data/spec/unit/api_comparer_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe Surrogate::ApiComparer do
+
+  def set_assertion(set, expectations)
+    expectations[:include].each { |meth| set.should include meth }
+    expectations[:exclude].each { |meth| set.should_not include meth }
+  end
+
+
+  describe 'its knowlege about the surrogate' do
+
+    let :surrogate do
+      parent = Class.new do
+        def inherited_instance_meth()end
+        def self.inherited_class_meth()end
+      end
+
+      Class.new parent do
+        Surrogate.endow self do
+          define :api_class_meth
+          def class_meth()end
+        end
+        define :api_instance_meth
+        def instance_meth()end
+      end
+    end
+
+    let(:comparer) { described_class.new surrogate, Class.new }
+
+    it "knows the surrogate's instance level api methods" do
+      comparer.surrogate_methods[:instance][:api].should == Set[:api_instance_meth]
+    end
+
+    it "knows the surrogate's inherited instance methods" do
+      set_assertion comparer.surrogate_methods[:instance][:inherited],
+        include: [:inherited_instance_meth],
+        exclude: [:api_instance_meth, :instance_meth, :class_meth, :inherited_class_meth, :api_class_meth]
+    end
+
+    it "knows the surrogate's other instance methods" do
+      set_assertion comparer.surrogate_methods[:instance][:other],
+        include: [:instance_meth],
+        exclude: [:inherited_instance_meth, :api_instance_meth, :class_meth, :inherited_class_meth, :api_class_meth]
+    end
+
+    it "knows the surrogate's class level api methods" do
+      comparer.surrogate_methods[:class][:api].should == Set[:api_class_meth]
+    end
+
+    it "knows the surrogate's inherited class methods" do
+      # show new explicitly as we override it in lib
+      set_assertion comparer.surrogate_methods[:class][:inherited],
+        include: [:inherited_class_meth, :new],
+        exclude: [:api_instance_meth, :instance_meth, :class_meth, :inherited_instance_meth, :api_class_meth]
+    end
+
+    it "knows the surrogate's other class methods" do
+      # show new explicitly as we override it in lib
+      set_assertion comparer.surrogate_methods[:class][:other],
+        include: [:class_meth],
+        exclude: [:new, :api_instance_meth, :instance_meth, :inherited_instance_meth, :api_class_meth, :inherited_class_meth]
+    end
+  end
+
+
+  describe 'its knowledge about the other object' do
+    let(:surrogate) { Surrogate.endow Class.new }
+
+    let :actual do
+      parent = Class.new { def self.inherited_class_meth()end; def inherited_instance_meth()end }
+      Class.new(parent) { def self.class_meth()end; def instance_meth()end }
+    end
+
+    let(:comparer) { described_class.new surrogate, actual }
+
+    it "knows the object's inherited instance methods" do
+      set_assertion comparer.actual_methods[:instance][:inherited],
+        include: [:inherited_instance_meth],
+        exclude: [:inherited_class_meth, :class_meth, :instance_meth]
+    end
+
+    it "knows the objects other instance methods" do
+      comparer.actual_methods[:instance][:other].should == Set[:instance_meth]
+    end
+
+    it "knows the object's inherited class methods" do
+      set_assertion comparer.actual_methods[:class][:inherited],
+        include: [:inherited_class_meth],
+        exclude: [:inherited_instance_meth, :class_meth, :instance_meth]
+    end
+
+    it "knows the object's other class methods" do
+      comparer.actual_methods[:class][:other].should == Set[:class_meth]
+    end
+  end
+
+
+  describe '#compare' do
+    let(:parent) { Class.new { def inherited_instance_not_on_surrogate()end; def self.inherited_class_not_on_surrogate()end } }
+
+    let :actual do
+      Class.new parent do
+        def instance_not_on_surrogate()end
+        def self.class_not_on_surrogate()end
+        def instance_meth_on_both()end
+        def self.class_meth_on_both()end
+      end
+    end
+
+    let :surrogate do
+      Class.new do
+        Surrogate.endow(self) { define :class_not_on_actual }
+        define :instance_not_on_actual
+        def instance_meth_on_both()end
+        def self.class_meth_on_both()end
+      end
+    end
+
+    let(:comparer) { described_class.new surrogate, actual }
+
+    it 'tells me about instance methods on actual that are not on surrogate' do
+      comparer.compare[:instance][:not_on_surrogate].should == Set[:instance_not_on_surrogate, :inherited_instance_not_on_surrogate, :instance_meth_on_both]
+    end
+
+    it 'tells me about class methods on actual that are not on surrogate' do
+      comparer.compare[:class][:not_on_surrogate].should == Set[:class_not_on_surrogate, :inherited_class_not_on_surrogate, :class_meth_on_both]
+    end
+
+    it 'tells me about api instance methods on surrogate that are not on actual' do
+      comparer.compare[:instance][:not_on_actual].should == Set[:instance_not_on_actual]
+    end
+
+    it 'tells me about api class methods on surrogate that are not on actual' do
+      comparer.compare[:class][:not_on_actual].should == Set[:class_not_on_actual]
+    end
+  end
+end

data/surrogate.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "surrogate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "surrogate"
+  s.version     = Surrogate::VERSION
+  s.authors     = ["Josh Cheek"]
+  s.email       = ["josh.cheek@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Framework to aid in handrolling mock/spy objects.}
+  s.description = %q{Framework to aid in handrolling mock/spy objects.}
+
+  s.rubyforge_project = "surrogate"
+
+  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) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec", '~> 2.8.0' # TODO: Figure out how far back we can work with
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: surrogate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Cheek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70192551591960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70192551591960
+description: Framework to aid in handrolling mock/spy objects.
+email:
+- josh.cheek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Rakefile
+- Readme.md
+- lib/surrogate.rb
+- lib/surrogate/api_comparer.rb
+- lib/surrogate/endower.rb
+- lib/surrogate/hatchery.rb
+- lib/surrogate/hatchling.rb
+- lib/surrogate/method_queue.rb
+- lib/surrogate/options.rb
+- lib/surrogate/rspec.rb
+- lib/surrogate/rspec/api_method_matchers.rb
+- lib/surrogate/rspec/substitutability_matchers.rb
+- lib/surrogate/version.rb
+- spec/acceptance_spec.rb
+- spec/defining_api_methods_spec.rb
+- spec/rspec/have_been_asked_for_its_spec.rb
+- spec/rspec/have_been_initialized_with_spec.rb
+- spec/rspec/have_been_told_to_spec.rb
+- spec/rspec/messages_spec.rb
+- spec/rspec/substitute_for_spec.rb
+- spec/spec_helper.rb
+- spec/unit/api_comparer_spec.rb
+- surrogate.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: surrogate
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Framework to aid in handrolling mock/spy objects.
+test_files:
+- spec/acceptance_spec.rb
+- spec/defining_api_methods_spec.rb
+- spec/rspec/have_been_asked_for_its_spec.rb
+- spec/rspec/have_been_initialized_with_spec.rb
+- spec/rspec/have_been_told_to_spec.rb
+- spec/rspec/messages_spec.rb
+- spec/rspec/substitute_for_spec.rb
+- spec/spec_helper.rb
+- spec/unit/api_comparer_spec.rb
+has_rdoc: