spy 0.0.1 → 0.1.0

data/test/integration/test_subroutine_spying.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class TestSpy < MiniTest::Unit::TestCase
+  def setup
+    Spy::Agency.instance.dissolve!
+    @pen = Pen.new
+  end
+
+  def test_spy_on_hooks_and_saves_spy_with_array
+    pen_write_spy, pen_write_hello_spy = Spy::Subroutine.on(@pen, :write, :write_hello)
+    assert_nil @pen.write(nil)
+    assert_nil @pen.write_hello
+
+    assert_kind_of Spy::Subroutine, pen_write_spy
+    assert_kind_of Spy::Subroutine, pen_write_hello_spy
+    assert_equal [pen_write_spy, pen_write_hello_spy], Spy::Agency.instance.subroutines
+    assert pen_write_spy.has_been_called?
+    assert pen_write_hello_spy.has_been_called?
+  end
+
+  def test_spy_on_hooks_and_saves_spy_with_array
+    pen_write_spy, pen_write_hello_spy = Spy.on(@pen, write: "hello", write_hello: "world")
+    assert_equal "hello", @pen.write(nil)
+    assert_equal "world", @pen.write_hello
+
+    assert_kind_of Spy::Subroutine, pen_write_spy
+    assert_kind_of Spy::Subroutine, pen_write_hello_spy
+    assert_equal [pen_write_spy, pen_write_hello_spy], Spy::Agency.instance.subroutines
+    assert pen_write_spy.has_been_called?
+    assert pen_write_hello_spy.has_been_called?
+  end
+
+  def test_spy_off_unhooks_a_method
+    pen_write_spy = Spy.on(@pen, :write)
+    Spy.off(@pen,:write)
+    assert_equal "hello world", @pen.write("hello world")
+    refute pen_write_spy.has_been_called?
+  end
+
+end

data/test/spy/test_double.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class Spy
+module Spy
   class TestDouble < MiniTest::Unit::TestCase
     def test_double_creation
       double = Double.new("NewDouble", :meth_1, :meth_2)

data/test/spy/test_subroutine.rb

@@ -0,0 +1,191 @@
+require 'test_helper'
+
+module Spy
+  class TestSubroutine < MiniTest::Unit::TestCase
+    def spy_on(base_object, method_name)
+      Subroutine.new(base_object, method_name).hook
+    end
+
+    def setup
+      Agency.instance.dissolve!
+      @pen = Pen.new
+    end
+
+    def test_spy_on_hook_and_saves_spy
+      pen_write_spy = spy_on(@pen, :write).and_return("hello")
+      assert_equal "hello", @pen.write(nil)
+      assert_kind_of Subroutine, pen_write_spy
+      assert_equal [pen_write_spy], Agency.instance.subroutines
+      assert pen_write_spy.has_been_called?
+    end
+
+    def test_spy_can_hook_and_record_a_method_call
+      pen_write_spy = spy_on(@pen, :write)
+      refute pen_write_spy.has_been_called?
+      @pen.write("hello")
+      assert pen_write_spy.has_been_called?
+      assert_empty @pen.written
+    end
+
+    def test_spy_can_hook_and_record_a_method_call_on_a_constant
+      another_spy = spy_on(Pen, :another)
+      refute another_spy.has_been_called?
+      assert_nil Pen.another
+      assert another_spy.has_been_called?
+      another_spy.unhook
+      assert_equal "another", Pen.another
+    end
+
+    def test_spy_can_unhook_a_method
+      pen_write_spy = spy_on(@pen, :write)
+      pen_write_spy.unhook
+      @pen.write("hello")
+      refute pen_write_spy.has_been_called?
+    end
+
+    def test_spy_cannot_hook_a_non_existent_method
+      spy = Subroutine.new(@pen, :no_method)
+      assert_raises NameError do
+        spy.hook
+      end
+    end
+
+    def test_spy_can_hook_a_non_existent_method_if_param_set
+      spy = Subroutine.new(@pen, :no_method).and_return(:yep)
+      spy.hook(force: true)
+      assert_equal :yep, @pen.no_method
+    end
+
+    def test_spy_and_return_returns_the_set_value
+      result = "hello world"
+
+      spy_on(@pen, :write).and_return(result)
+
+      assert_equal result, @pen.write(nil)
+    end
+
+    def test_spy_and_return_can_call_a_block
+      result = "hello world"
+
+      spy_on(@pen, :write).and_return {}.and_return do |string|
+        string.reverse
+      end
+
+      assert_equal result.reverse, @pen.write(result)
+      assert_empty @pen.written
+    end
+
+    def test_spy_and_return_can_call_a_block_raises_when_there_is_an_arity_mismatch
+      write_spy = spy_on(@pen, :write)
+      write_spy.and_return do |*args|
+      end
+      write_spy.and_return do |string, *args|
+      end
+      assert_raises ArgumentError do
+        write_spy.and_return do |string, b|
+        end
+      end
+    end
+
+    def test_spy_and_return_can_call_a_block_that_recieves_a_block
+      string = "hello world"
+
+      spy_on(@pen, :write_block).and_return do |&block|
+        block.call
+      end
+
+      result = @pen.write_block do
+        string
+      end
+      assert_equal string, result
+    end
+
+    def test_spy_hook_records_number_of_calls
+      pen_write_spy = spy_on(@pen, :write)
+      assert_equal 0, pen_write_spy.calls.size
+      5.times do |i|
+        @pen.write("hello world")
+        assert_equal i + 1, pen_write_spy.calls.size
+      end
+    end
+
+    def test_has_been_called_with?
+      pen_write_spy = spy_on(@pen, :write)
+      refute pen_write_spy.has_been_called_with?("hello")
+      @pen.write("hello")
+      assert pen_write_spy.has_been_called_with?("hello")
+      @pen.write("world")
+      assert pen_write_spy.has_been_called_with?("hello")
+      @pen.write("hello world")
+      assert pen_write_spy.has_been_called_with?("hello")
+    end
+
+    def test_spy_hook_records_number_of_calls
+      args = ["hello world"]
+      block = Proc.new {}
+      pen_write_spy = spy_on(@pen, :write)
+      @pen.write(*args, &block)
+      call_log = pen_write_spy.calls.first
+      assert_equal @pen, call_log.object
+      assert_equal args, call_log.args
+      assert_equal block, call_log.block
+    end
+
+    def test_that_method_spy_keeps_arity
+      spy_on(@pen, :write)
+      @pen.write("hello world")
+      assert_raises ArgumentError do
+        @pen.write("hello", "world")
+      end
+
+      spy_on(@pen, :write_hello)
+      @pen.write_hello
+      assert_raises ArgumentError do
+        @pen.write_hello("hello")
+      end
+
+      spy_on(@pen, :write_array)
+      @pen.write_hello
+      assert_raises ArgumentError do
+        @pen.write_hello("hello")
+      end
+
+      spy_on(@pen, :greet)
+      @pen.greet("bob")
+      assert_raises ArgumentError do
+        @pen.greet
+      end
+      assert_raises ArgumentError do
+        @pen.greet("hello", "bob", "error")
+      end
+    end
+
+    def test_hook_mimics_public_visibility
+      spy_on(@pen, :public_method)
+      assert @pen.singleton_class.public_method_defined? :public_method
+      refute @pen.singleton_class.protected_method_defined? :public_method
+      refute @pen.singleton_class.private_method_defined? :public_method
+    end
+
+    def test_hook_mimics_protected_visibility
+      spy_on(@pen, :protected_method)
+      refute @pen.singleton_class.public_method_defined? :protected_method
+      assert @pen.singleton_class.protected_method_defined? :protected_method
+      refute @pen.singleton_class.private_method_defined? :protected_method
+    end
+
+    def test_hook_mimics_private_visibility
+      spy_on(@pen, :private_method)
+      refute @pen.singleton_class.public_method_defined? :private_method
+      refute @pen.singleton_class.protected_method_defined? :private_method
+      assert @pen.singleton_class.private_method_defined? :private_method
+    end
+
+    def test_spy_get_can_retrieve_a_spy
+      pen_write_spy = spy_on(@pen, :write).and_return(:hello)
+      assert_equal :hello, @pen.write(:world)
+      assert_equal pen_write_spy, Subroutine.get(@pen, :write)
+      assert Subroutine.get(@pen, :write).has_been_called?
+    end
+  end
+end

data/test/support/pen.rb

@@ -0,0 +1,50 @@
+class Pen
+  attr_reader :written, :color
+
+  def initialize(color = :black)
+    @color = color
+    @written = []
+  end
+
+  def write(string)
+    @written << string
+    string
+  end
+
+  def write_block(&block)
+    string = yield
+    @written << string
+    string
+  end
+
+  def write_hello
+    write("hello")
+  end
+
+  def write_array(*args)
+    args.each do |arg|
+      write(arg)
+    end
+  end
+
+  def greet(hello = "hello", name)
+    write("#{hello} #{name}")
+  end
+
+  def public_method
+  end
+
+  protected
+  def protected_method
+  end
+
+  private
+  def private_method
+  end
+
+  class << self
+    def another
+      "another"
+    end
+  end
+end

data/test/test_helper.rb

@@ -4,3 +4,7 @@ require 'pry'
 require 'pry-nav'
 
 require 'spy'
+
+Dir.glob(File.expand_path("../support/*", __FILE__)).each do |file|
+  require file
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -28,7 +28,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.5.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -51,14 +67,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO.md
 - lib/spy.rb
+- lib/spy/agency.rb
+- lib/spy/constant.rb
+- lib/spy/core_ext/marshal.rb
 - lib/spy/double.rb
-- lib/spy/dsl.rb
+- lib/spy/nest.rb
+- lib/spy/subroutine.rb
 - lib/spy/version.rb
 - spec/spec_helper.rb
 - spec/spy/and_call_original_spec.rb
@@ -76,7 +96,6 @@ files:
 - spec/spy/hash_excluding_matcher_spec.rb
 - spec/spy/hash_including_matcher_spec.rb
 - spec/spy/mock_spec.rb
-- spec/spy/multiple_return_value_spec.rb
 - spec/spy/mutate_const_spec.rb
 - spec/spy/nil_expectation_warning_spec.rb
 - spec/spy/null_object_mock_spec.rb
@@ -92,9 +111,12 @@ files:
 - spec/spy/test_double_spec.rb
 - spec/spy/to_ary_spec.rb
 - spy.gemspec
+- test/integration/test_constant_spying.rb
+- test/integration/test_subroutine_spying.rb
 - test/spy/test_double.rb
+- test/spy/test_subroutine.rb
+- test/support/pen.rb
 - test/test_helper.rb
-- test/test_spy.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -136,7 +158,6 @@ test_files:
 - spec/spy/hash_excluding_matcher_spec.rb
 - spec/spy/hash_including_matcher_spec.rb
 - spec/spy/mock_spec.rb
-- spec/spy/multiple_return_value_spec.rb
 - spec/spy/mutate_const_spec.rb
 - spec/spy/nil_expectation_warning_spec.rb
 - spec/spy/null_object_mock_spec.rb
@@ -151,7 +172,10 @@ test_files:
 - spec/spy/stubbed_message_expectations_spec.rb
 - spec/spy/test_double_spec.rb
 - spec/spy/to_ary_spec.rb
+- test/integration/test_constant_spying.rb
+- test/integration/test_subroutine_spying.rb
 - test/spy/test_double.rb
+- test/spy/test_subroutine.rb
+- test/support/pen.rb
 - test/test_helper.rb
-- test/test_spy.rb
 has_rdoc: 

data/TODO.md

@@ -1,8 +0,0 @@
-# Todo
-
-* and_yield
-* and_raise
-* spy on CONSTANTS
-* argument matchers
-* count matchers
-* watch all calls to an object

data/lib/spy/dsl.rb

@@ -1,7 +0,0 @@
-class Spy
-  module Dsl
-    def spy
-      Spy
-    end
-  end
-end

data/spec/spy/multiple_return_value_spec.rb

@@ -1,119 +0,0 @@
-require 'spec_helper'
-
-module RSpec
-  module Mocks
-    describe "a message expectation with multiple return values and no specified count" do
-      before(:each) do
-        @double = double
-        @return_values = [1,2,3]
-        @double.should_receive(:do_something).and_return(@return_values[0],@return_values[1],@return_values[2])
-      end
-
-      it "returns values in order" do
-        expect(@double.do_something).to eq @return_values[0]
-        expect(@double.do_something).to eq @return_values[1]
-        expect(@double.do_something).to eq @return_values[2]
-        @double.rspec_verify
-      end
-
-      it "falls back to a previously stubbed value" do
-        @double.stub :do_something => :stub_result
-        expect(@double.do_something).to eq @return_values[0]
-        expect(@double.do_something).to eq @return_values[1]
-        expect(@double.do_something).to eq @return_values[2]
-        expect(@double.do_something).to eq :stub_result
-      end
-
-      it "fails when there are too few calls (if there is no stub)" do
-        @double.do_something
-        @double.do_something
-        expect { @double.rspec_verify }.to raise_error
-      end
-
-      it "fails when there are too many calls (if there is no stub)" do
-        @double.do_something
-        @double.do_something
-        @double.do_something
-        @double.do_something
-        expect { @double.rspec_verify }.to raise_error
-      end
-    end
-
-    describe "a message expectation with multiple return values with a specified count equal to the number of values" do
-      before(:each) do
-        @double = double
-        @return_values = [1,2,3]
-        @double.should_receive(:do_something).exactly(3).times.and_return(@return_values[0],@return_values[1],@return_values[2])
-      end
-
-      it "returns values in order to consecutive calls" do
-        expect(@double.do_something).to eq @return_values[0]
-        expect(@double.do_something).to eq @return_values[1]
-        expect(@double.do_something).to eq @return_values[2]
-        @double.rspec_verify
-      end
-    end
-
-    describe "a message expectation with multiple return values specifying at_least less than the number of values" do
-      before(:each) do
-        @double = double
-        @double.should_receive(:do_something).at_least(:twice).with(no_args).and_return(11, 22)
-      end
-
-      it "uses the last return value for subsequent calls" do
-        expect(@double.do_something).to equal(11)
-        expect(@double.do_something).to equal(22)
-        expect(@double.do_something).to equal(22)
-        @double.rspec_verify
-      end
-
-      it "fails when called less than the specified number" do
-        expect(@double.do_something).to equal(11)
-        expect { @double.rspec_verify }.to raise_error(RSpec::Mocks::MockExpectationError)
-      end
-
-      context "when method is stubbed too" do
-        before { Spy.on(@double, :do_something).and_return :stub_result }
-
-        it "uses the last value for subsequent calls" do
-          expect(@double.do_something).to equal(11)
-          expect(@double.do_something).to equal(22)
-          expect(@double.do_something).to equal(22)
-          @double.rspec_verify
-        end
-
-        it "fails when called less than the specified number" do
-          expect(@double.do_something).to equal(11)
-          expect { @double.rspec_verify }.to raise_error(RSpec::Mocks::MockExpectationError)
-        end
-      end
-    end
-
-    describe "a message expectation with multiple return values with a specified count larger than the number of values" do
-      before(:each) do
-        @double = RSpec::Mocks::Mock.new("double")
-        @double.should_receive(:do_something).exactly(3).times.and_return(11, 22)
-      end
-
-      it "uses the last return value for subsequent calls" do
-        expect(@double.do_something).to equal(11)
-        expect(@double.do_something).to equal(22)
-        expect(@double.do_something).to equal(22)
-        @double.rspec_verify
-      end
-
-      it "fails when called less than the specified number" do
-        @double.do_something
-        @double.do_something
-        expect { @double.rspec_verify }.to raise_error
-      end
-
-      it "fails fast when called greater than the specified number" do
-        @double.do_something
-        @double.do_something
-        @double.do_something
-        expect { @double.do_something }.to raise_error
-      end
-    end
-  end
-end