spy 0.2.2 → 0.2.3

data/Gemfile

@@ -2,8 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in spies.gemspec
 gemspec
-gem 'pry'
-gem 'pry-nav'
 gem 'yard'
 gem 'redcarpet', platforms: :mri
 gem 'rake'

data/README.md

@@ -1,4 +1,6 @@
-# Spy
+# Spy [![Build Status](https://travis-ci.org/ryanong/spy.png?branch=master)](https://travis-ci.org/ryanong/spy) [![Gem Version](https://badge.fury.io/rb/spy.png)](http://badge.fury.io/rb/spy)
+
+[Docs](http://rdoc.info/gems/spy/frames)
 
 Spy is a lightweight stubbing framework with support for method spies, constant stubs, and object doubles.
 
@@ -35,8 +37,9 @@ Fail faster, code faster.
 * cannot transfer nested constants when stubbing a constant
   * i don't think anybody uses this anyway
   * nobody on github does
-* #with is not supported yet
-  * this is probably a code smell. You either need to abstract your method more or add separate tests.
+* #with is not supported
+  * you can usually just check the call logs.
+  * if you do need to use this. It is probably a code smell. You either need to abstract your method more or add separate tests.
 
 ## Installation
 
@@ -69,7 +72,7 @@ book.title  #=> "East of Eden"
 ```
 
 Spy will raise an error if you try to stub on a method that doesn't exist.
-You can force the creation of a sstub on method that didn't exist but it really isn't suggested.
+You can force the creation of a stub on method that didn't exist but it really isn't suggested.
 
 ```ruby
 Spy.new(book, :flamethrower).hook(force:true).and_return("burnninante")
@@ -126,9 +129,16 @@ When you stub a method it returns a spy. A spy records what calls have been made
 validator = Spy.double("validator")
 validate_spy = Spy.on(validator, :validate)
 validate_spy.has_been_called? #=> false
+
 validator.validate("01234")   #=> nil
 validate_spy.has_been_called? #=> true
-validate_spy.has_been_called_with?("01234) #=> true
+validate_spy.has_been_called_with?("01234") #=> true
+```
+
+You can also retrieve a method spy on demand
+
+```ruby
+Spy.get(validator, :validate)
 ```
 
 ### Calling through
@@ -138,6 +148,8 @@ If you just want to make sure if a method is called and not override the output
 Spy.on(book, :read_page).and_call_through
 ```
 
+By if the original method never existed it will call #method\_missing on the spied object.
+
 ### Call Logs
 
 When a spy is called on it records a call log. A call log contains the object it was called on, the arguments and block that were sent to method and what it returned.
@@ -153,6 +165,7 @@ first_call.object #=> book
 first_call.args   #=> [5]
 first_call.block  #=> Proc.new { "this is a block" }
 first_call.result #=> "hello world"
+first_call.called_from #=> "file_name.rb:line_number"
 ```
 
 ### MiniTest
@@ -171,6 +184,7 @@ require "rspec/autorun"
 require "spy"
 RSpec.configure do |c|
   c.after { Spy.teardown  }
+  c.mock_with :absolutely_nothing # this is completely optional.
 end
 ```
 
@@ -180,6 +194,8 @@ end
 require "spy"
 class Test::Unit::TestCase
   def teardown
+    # if you don't add super to every teardown then you will have to add this
+    # line to every file.
     Spy.teardown
   end
 end

data/lib/spy.rb

@@ -32,7 +32,7 @@ module Spy
         if spy
           spy.unhook
         else
-          raise "Spy was not found"
+          raise "#{spy.inspect} was not found to be hooked"
         end
       end
 
@@ -54,7 +54,7 @@ module Spy
         if spy
           spy.unhook
         else
-          raise "Spy was not found"
+          raise "#{spy.inspect} was not found to be hooked"
         end
       end
 
@@ -72,14 +72,14 @@ module Spy
       end
       spies = constant_names.map do |constant_name|
         case constant_name
-        when String, Symbol
+        when Symbol
           Constant.on(base_module, constant_name)
         when Hash
           constant_name.map do |name, result|
-            on_const(base_module, name).and_return(result)
+            Constant.on(base_module, name).and_return(result)
           end
         else
-          raise ArgumentError.new "#{constant_name.class} is an invalid input, #on only accepts String, Symbol, and Hash"
+          raise ArgumentError.new "#{constant_name.class} is an invalid input, #on only accepts Symbol, and Hash"
         end
       end.flatten
 
@@ -91,23 +91,17 @@ module Spy
     # @param constant_names *[Symbol]
     # @return [Constant, Array<Constant>]
     def off_const(base_module, *constant_names)
-      if base_module.is_a?(Hash) || base_module.is_a?(Symbol)
+      if base_module.is_a?(Symbol)
         constant_names.unshift(base_module)
         base_module = Object
       end
 
       spies = constant_names.map do |constant_name|
-        case constant_name
-        when String, Symbol
-          Constant.off(base_module, constant_name)
-        when Hash
-          constant_name.map do |name, result|
-            off_const(base_module, name).and_return(result)
-          end
-        else
-          raise ArgumentError.new "#{constant_name.class} is an invalid input, #on only accepts String, Symbol, and Hash"
+        unless constant_name.is_a?(Symbol)
+          raise ArgumentError.new "#{constant_name.class} is an invalid input, #on only accepts Symbol, and Hash"
         end
-      end.flatten
+        Constant.off(base_module, constant_name)
+      end
 
       spies.size > 1 ? spies : spies.first
     end
@@ -140,7 +134,7 @@ module Spy
     # @param constant_names *[Symbol]
     # @return [Constant, Array<Constant>]
     def get_const(base_module, *constant_names)
-      if base_module.is_a?(Hash) || base_module.is_a?(Symbol)
+      if base_module.is_a?(Symbol)
         constant_names.unshift(base_module)
         base_module = Object
       end

data/lib/spy/core_ext/marshal.rb

@@ -9,15 +9,14 @@ module Marshal
       end
 
       spy_hook_options = spies.map do |spy|
-        opts = spy.opts
-        [spy.unhook, opts]
+        [spy.hook_opts, spy.unhook]
       end
 
       begin
         dump_without_mocks(*args.unshift(object.dup))
       ensure
-        spy_hook_options.each do |spy, opts|
-          spy.hook(opts)
+        spy_hook_options.each do |hook_opts, spy|
+          spy.hook(hook_opts)
         end
       end
     end

data/lib/spy/subroutine.rb

@@ -305,14 +305,16 @@ module Spy
       # @param singleton_method [Boolean] (true) only get singleton_method_spies
       # @return [Array<Subroutine>]
       def get_spies(base_object, singleton_methods = true)
-        if singleton_methods
-        all_methods = base_object.public_methods(false) +
-          base_object.protected_methods(false) +
-          base_object.private_methods(false)
-        else
-          all_methods = base_object.instance_methods(false) +
-            base_object.private_instance_methods(false)
-        end
+        all_methods =
+          if singleton_methods
+            base_object.public_methods(false) +
+              base_object.protected_methods(false) +
+              base_object.private_methods(false)
+          else
+            base_object.public_instance_methods(false) +
+              base_object.protected_instance_methods(false) +
+              base_object.private_instance_methods(false)
+          end
 
         all_methods.map do |method_name|
           Agency.instance.find(get_spy_id(base_object.method(method_name)))

data/lib/spy/version.rb

@@ -1,3 +1,3 @@
 module Spy
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spy.gemspec

@@ -6,16 +6,20 @@ require 'spy/version'
 Gem::Specification.new do |gem|
   gem.name          = "spy"
   gem.version       = Spy::VERSION
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.license       = 'MIT'
   gem.authors       = ["Ryan Ong"]
   gem.email         = ["ryanong@gmail.com"]
-  gem.description   = %q{A simple mocking library that doesn't spies your intelligence.}
-  gem.summary       = %q{A simple non destructive mocking library.}
-  gem.homepage      = ""
+  gem.description   = %q{A simple modern mocking library that uses the spy pattern and checks method's existence and arity.}
+  gem.summary       = %q{Spy is a mocking library that was made for the modern age. It supports only 1.9.3+. Spy by default will raise an error if you attempt to stub a method that doesn't exist or call the stubbed method with the wrong arity.}
+  gem.homepage      = "https://github.com/ryanong/spy"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('pry-nav')
   gem.add_development_dependency('minitest', '>= 4.5.0')
   gem.add_development_dependency('rspec-core')
   gem.add_development_dependency('rspec-expectations')

metadata

@@ -1,58 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: spy
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
+  prerelease: 
 platform: ruby
 authors:
 - Ryan Ong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-nav
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 4.5.0
 - !ruby/object:Gem::Dependency
   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:
-    - - '>='
+    - - ! '>='
       - !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'
-description: A simple mocking library that doesn't spies your intelligence.
+description: A simple modern mocking library that uses the spy pattern and checks
+  method's existence and arity.
 email:
 - ryanong@gmail.com
 executables: []
@@ -100,29 +140,33 @@ files:
 - test/spy/test_subroutine.rb
 - test/support/pen.rb
 - test/test_helper.rb
-homepage: ''
-licenses: []
-metadata: {}
+homepage: https://github.com/ryanong/spy
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
-summary: A simple non destructive mocking library.
+specification_version: 3
+summary: Spy is a mocking library that was made for the modern age. It supports only
+  1.9.3+. Spy by default will raise an error if you attempt to stub a method that
+  doesn't exist or call the stubbed method with the wrong arity.
 test_files:
 - spec/spec_helper.rb
 - spec/spy/and_call_original_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 25f96e1254110c34d4b25ace27db39cf4933cc2a
-  data.tar.gz: 84320005a4c47158b70dc86fca661f6ae95f6ad6
-SHA512:
-  metadata.gz: 340277d830dfb87085d61fb443b834cb6636e8dda7b5d2af0166aab6835918747343849efed3b56032071d5d44b49cebaca0edb04df0c7997c10006cdb6cc897
-  data.tar.gz: 2b147cc08e3612270d8f18789bc4116621334e6da864bb3299b79ce857247513c467e4bf7f27e8c0354b064801445b392856489758fd6456015d44000dad987d