spies 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bce479180515db93df27766da5049ae9752c616c
-  data.tar.gz: 963ef385fabc59bc17ab292b66bd495976b092cf
+  metadata.gz: 89291a4e20caa35e1a7315e244bf97f8c24912e0
+  data.tar.gz: 6a695fbb4d361366d3bff0d05abfb49841c77a1b
 SHA512:
-  metadata.gz: 88e3a9cd2ba728ef51ed4308add96e58085223d9ea831bd23758ca7fe113afa0a358f3009c0e7347e6f1e4291589724c4e932056660d598f22f4d03a19bb6dff
-  data.tar.gz: 8f261270a1589669fbbfcfec3d81dccc3f4eec2f3e63a17a98a0241db1a5387b840ba3c40de17acdfb60dd7731dc7b6d60327955fa66a35b37cd91720851f8c6
+  metadata.gz: 5e69fa38537a2d76b70b6ba66b2db62d5f0b83b4035db86bbbf543ae6d5a25f2105d0e042c637c6960a73dd54897c67ef43004045c947d1356935df6b4084ac0
+  data.tar.gz: 40e7ef09c780259cb68cfbebe6ca59a2d8bec128f139c4957c452730b6cbf233e36d80f1332bc97d7ea43ce206641b41bee57ab72c6c113018ffd0dfea915709

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -1,10 +1,10 @@
-# Ruby Spy [![Build Status](https://travis-ci.org/patbenatar/ruby-spy.svg?branch=master)](https://travis-ci.org/patbenatar/ruby-spy) [![Coverage Status](https://coveralls.io/repos/github/patbenatar/ruby-spy/badge.svg?branch=master)](https://coveralls.io/github/patbenatar/ruby-spy?branch=master)
+# Ruby Spy [![Build Status](https://travis-ci.org/patbenatar/ruby-spy.svg?branch=master)](https://travis-ci.org/patbenatar/ruby-spy) [![Coverage Status](https://coveralls.io/repos/github/patbenatar/ruby-spy/badge.svg?branch=master)](https://coveralls.io/github/patbenatar/ruby-spy?branch=master) [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/patbenatar/ruby-spy/master)
 
 Test spies for Ruby. Why? For fun.
 
 ## Installation
 
-```
+```ruby
 gem 'spies', require: 'spy'
 ```
 

data/lib/spy.rb

@@ -6,6 +6,12 @@ class Spy
 
   THREAD_LOCAL_ACTIVE_SPIES_KEY = 'ruby_spy_active_spies'.freeze
 
+  ##
+  # Active spies in the current thread.
+  #
+  # @return [Array<Spy>] instances of `Spy` that have active method spies on
+  #                      their target obj
+  #
   def self.active_spies
     Thread.current[THREAD_LOCAL_ACTIVE_SPIES_KEY] ||= []
   end
@@ -18,10 +24,32 @@ class Spy
     active_spies.delete(spy)
   end
 
+  ##
+  # Spy on an instance, class, or module.
+  #
+  # By default, this will spy on all user-defined methods (not methods defined
+  # on Ruby's base Class).
+  #
+  # @param obj [Object] the instance, class, or module to spy on
+  # @param method_name [Symbol] optionally limit spying to a single method
+  #
+  # @return [Spy] an active instance of `Spy` for the given `obj`
+  #
   def self.on(obj, method_name = nil)
     spy_with_options(obj, method_name)
   end
 
+  ##
+  # Spy on all instances of a class.
+  #
+  # By default, this will spy on all user-defined methods (not methods defined
+  # on Ruby's base Class).
+  #
+  # @param obj [Object] the class to spy on
+  # @param method_name [Symbol] optionally limit spying to a single method
+  #
+  # @return [Spy] an active instance of `Spy` for the given `obj`
+  #
   def self.on_all_instances_of(obj, method_name = nil)
     spy_with_options(obj, method_name, all_instances: true)
   end
@@ -33,6 +61,13 @@ class Spy
     end
   end
 
+  ##
+  # Remove all active Spy instances in the current thread and restore their
+  # spied methods to the original state.
+  #
+  # @yield Optionally provide a block, and spies created within the block will
+  #        be cleaned, leaving the outer scope untouched. Blocks can be nested.
+  #
   def self.clean
     if block_given?
       outer_active_spies = active_spies
@@ -45,10 +80,17 @@ class Spy
         Thread.current[THREAD_LOCAL_ACTIVE_SPIES_KEY] = outer_active_spies
       end
     else
-      active_spies.dup.each(&:clean)
+      active_spies.dup.each do |spy|
+        rspec_mock?(spy) ? unregister(spy) : spy.clean
+      end
     end
   end
 
+  def self.rspec_mock?(obj)
+    defined?(RSpec::Mocks::Double) && obj.is_a?(RSpec::Mocks::Double)
+  end
+
+  # @return [Object] the instance, class, or module being spied on by this spy
   attr_reader :obj
 
   def initialize(obj, all_instances: false)
@@ -58,16 +100,38 @@ class Spy
     @spied_methods_map = {}
   end
 
+  ##
+  # Spy on all user-defined methods on `obj`
+  #
+  # @return [Spy] self
+  #
   def on_all
     all_methods.each { |m| spy_on(m) }
     Spy.register(self)
+    self
   end
 
+  ##
+  # Spy on a single method on `obj`
+  #
+  # @param method_name [Symbol] the method to spy on
+  #
+  # @return [Spy] self
+  #
   def on(method_name)
     spy_on(method_name)
     Spy.register(self)
+    self
   end
 
+  ##
+  # Information about the calls received by this spy
+  #
+  # @param method_name [Symbol] optionally filter results to the given method
+  #
+  # @return [Array<Call>] set of `Call` objects containing information about
+  #                       each method call since the spy was activated.
+  #
   def calls(method_name = nil)
     if method_name
       @calls.select { |c| c.method_name == method_name }
@@ -76,11 +140,22 @@ class Spy
     end
   end
 
+  ##
+  # Remove spy and return spied methods on `obj` to the original state.
+  #
+  # @return [Spy] self
+  #
   def clean
     spied_methods_map.keys.each { |m| remove_spy(m) }
     Spy.unregister(self)
+    self
   end
 
+  ##
+  # Check if spy is actively spying on any methods on `obj`
+  #
+  # @return [Boolean] dirty state
+  #
   def dirty?
     spied_methods_map.keys.any?
   end

data/lib/spy/call.rb

@@ -1,5 +1,15 @@
 class Spy::Call
-  attr_reader :receiver, :method_name, :args, :block
+  # @return [Object] object that received the method call
+  attr_reader :receiver
+
+  # @return [Symbol] name of the method called
+  attr_reader :method_name
+
+  # @return [Array<Object>] arguments given to the method call
+  attr_reader :args
+
+  # @return [Proc] block given to the method call, if present
+  attr_reader :block
 
   def initialize(receiver, method_name, args, block)
     @receiver = receiver

data/lib/spy/version.rb

@@ -1,3 +1,3 @@
 class Spy
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/spies.gemspec

@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
   spec.add_development_dependency 'rubocop', '~> 0.41.2'
   spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'redcarpet'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spies
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Giancola
@@ -114,6 +114,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby test spies
 email:
 - nick@philosophie.is
@@ -125,6 +153,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Guardfile
 - LICENSE.txt