spies 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bce479180515db93df27766da5049ae9752c616c
+  data.tar.gz: 963ef385fabc59bc17ab292b66bd495976b092cf
+SHA512:
+  metadata.gz: 88e3a9cd2ba728ef51ed4308add96e58085223d9ea831bd23758ca7fe113afa0a358f3009c0e7347e6f1e4291589724c4e932056660d598f22f4d03a19bb6dff
+  data.tar.gz: 8f261270a1589669fbbfcfec3d81dccc3f4eec2f3e63a17a98a0241db1a5387b840ba3c40de17acdfb60dd7731dc7b6d60327955fa66a35b37cd91720851f8c6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+Encoding:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+DoubleNegation:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - "bin/**/*"
+    - "Guardfile"

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'coveralls', require: false

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nick Giancola
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# 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)
+
+Test spies for Ruby. Why? For fun.
+
+## Installation
+
+```
+gem 'spies', require: 'spy'
+```
+
+## Usage
+
+Spy on all methods of an instance:
+
+```ruby
+spy = Spy.on(my_object)
+spy.some_method
+expect(spy.calls.count).to eq 1
+expect(spy.calls.last.method_name).to eq :some_method
+```
+
+Spy on arguments:
+
+```ruby
+spy = Spy.on(my_object)
+
+spy.some_method_with_args('foo', 'bar')
+expect(spy.calls.last.args).to eq %w(foo bar)
+
+block = -> {}
+spy.some_method_with_block(&block)
+expect(spy.calls.last.block).to eq block
+```
+
+Spy on one method:
+
+```ruby
+spy = Spy.on(my_object, :some_method)
+spy.some_method
+spy.another_method
+expect(spy.calls.count).to eq 1
+```
+
+Spy on a constant:
+
+```ruby
+spy = Spy.on(SomeClass)
+SomeClass.some_method
+expect(spy.calls.count).to eq 1
+```
+
+Spy on all instances of a class:
+
+```ruby
+spy = Spy.on_all_instances_of(SomeClass)
+
+instance_1 = SomeClass.new
+instance_1.some_method
+
+instance_2 = SomeClass.new
+instance_2.some_method
+
+expect(spy.calls.count).to eq 2
+expect(spy.calls[1].receiver).to eq instance_2
+```
+
+Clean up after yourself:
+
+```ruby
+Spy.clean
+```
+
+Or keep a block clean:
+
+```ruby
+Spy.clean do
+  Spy.on(my_object)
+end
+```
+
+Cleaning with RSpec:
+
+```ruby
+before(:each) { Spy.clean }
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/spy/call.rb

@@ -0,0 +1,10 @@
+class Spy::Call
+  attr_reader :receiver, :method_name, :args, :block
+
+  def initialize(receiver, method_name, args, block)
+    @receiver = receiver
+    @method_name = method_name
+    @args = args
+    @block = block
+  end
+end

data/lib/spy/version.rb

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

data/lib/spy.rb

@@ -0,0 +1,154 @@
+require 'spy/version'
+require 'securerandom'
+
+class Spy
+  autoload :Call, 'spy/call'
+
+  THREAD_LOCAL_ACTIVE_SPIES_KEY = 'ruby_spy_active_spies'.freeze
+
+  def self.active_spies
+    Thread.current[THREAD_LOCAL_ACTIVE_SPIES_KEY] ||= []
+  end
+
+  def self.register(spy)
+    active_spies << spy unless active_spies.include? spy
+  end
+
+  def self.unregister(spy)
+    active_spies.delete(spy)
+  end
+
+  def self.on(obj, method_name = nil)
+    spy_with_options(obj, method_name)
+  end
+
+  def self.on_all_instances_of(obj, method_name = nil)
+    spy_with_options(obj, method_name, all_instances: true)
+  end
+
+  def self.spy_with_options(obj, method_name, options = {})
+    new(obj, options).tap do |spy|
+      method_name ? spy.on(method_name) : spy.on_all
+      Spy.register(spy)
+    end
+  end
+
+  def self.clean
+    if block_given?
+      outer_active_spies = active_spies
+      Thread.current[THREAD_LOCAL_ACTIVE_SPIES_KEY] = nil
+
+      begin
+        yield
+      ensure
+        clean
+        Thread.current[THREAD_LOCAL_ACTIVE_SPIES_KEY] = outer_active_spies
+      end
+    else
+      active_spies.dup.each(&:clean)
+    end
+  end
+
+  attr_reader :obj
+
+  def initialize(obj, all_instances: false)
+    @obj = obj
+    @calls = []
+    @all_instances = all_instances
+    @spied_methods_map = {}
+  end
+
+  def on_all
+    all_methods.each { |m| spy_on(m) }
+    Spy.register(self)
+  end
+
+  def on(method_name)
+    spy_on(method_name)
+    Spy.register(self)
+  end
+
+  def calls(method_name = nil)
+    if method_name
+      @calls.select { |c| c.method_name == method_name }
+    else
+      @calls
+    end
+  end
+
+  def clean
+    spied_methods_map.keys.each { |m| remove_spy(m) }
+    Spy.unregister(self)
+  end
+
+  def dirty?
+    spied_methods_map.keys.any?
+  end
+
+  private
+
+  attr_reader :all_instances, :spied_methods_map
+
+  def all_methods
+    if spying_on_class?
+      obj.methods - Class.methods
+    elsif spying_on_all_instances?
+      obj.instance_methods - Class.instance_methods
+    else
+      obj.methods - Class.instance_methods
+    end
+  end
+
+  def singleton_class
+    class << obj; self; end
+  end
+
+  def target_obj
+    spying_on_all_instances? ? obj : singleton_class
+  end
+
+  def spy_on(method_name)
+    spy = self
+    aliased_original_method_name = original_method_name(method_name)
+
+    target_obj.send(
+      :alias_method,
+      aliased_original_method_name,
+      method_name
+    )
+
+    target_obj.send(:define_method, method_name) do |*args, &block|
+      spy.calls << Call.new(self, method_name, args, block)
+      send aliased_original_method_name, *args, &block
+    end
+  end
+
+  def remove_spy(method_name)
+    aliased_original_method_name = original_method_name(method_name)
+
+    target_obj.send(
+      :alias_method,
+      method_name,
+      aliased_original_method_name
+    )
+
+    target_obj.send(:remove_method, aliased_original_method_name)
+
+    spied_methods_map.delete method_name
+  end
+
+  def spying_on_class?
+    obj.class == Class && !spying_on_all_instances?
+  end
+
+  def spying_on_all_instances?
+    !!all_instances
+  end
+
+  def original_method_name(method_name)
+    spied_methods_map[method_name] ||= loop do
+      name_candidate = "#{method_name}_#{SecureRandom.hex(8)}".to_sym
+      break name_candidate unless all_methods.include? name_candidate
+    end
+  end
+end

data/spies.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spy/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'spies'
+  spec.version = Spy::VERSION
+  spec.authors = ['Nick Giancola']
+  spec.email = ['nick@philosophie.is']
+
+  spec.summary = 'Ruby test spies'
+  spec.description = 'Ruby test spies'
+  spec.homepage = 'https://github.com/patbenatar/ruby-spy'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`
+               .split("\x0")
+               .reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7', '>= 4.7.2'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.41.2'
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: spies
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Giancola
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.2
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.41.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spy.rb
+- lib/spy/call.rb
+- lib/spy/version.rb
+- spies.gemspec
+homepage: https://github.com/patbenatar/ruby-spy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby test spies
+test_files: []