rspec-spy_on 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e00f959800eae480bcf133cba5491e7605aa7810
+  data.tar.gz: 5b8708b21f181545e36d4c9bc2e9858a5fd64e54
+SHA512:
+  metadata.gz: c8d61dca39e0f65511d5709951809ffff7ccff1ccb54606596e74293124bcfa7ea9b2bdd634132ccfdf4705658d460a135a30cefd81da6cbcb7a496ff73bbbba
+  data.tar.gz: d248fc9ec96dfa9fe08004e649dd8ad6305e5ff02c2feb44e872d0c84ccd87aec545c6d7c377cbd1a3568260ebffcc5cdc1240eadb975cb1d9f0a668da7f5efb

data/.gitignore

@@ -0,0 +1,18 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+doc
+tmp
+rerun.txt
+Gemfile.lock
+.bundle
+.idea
+*.rbc
+.yardoc
+bin
+Gemfile-custom
+bundle
+.rbx
+.rspec-local

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,16 @@
+script: "bin/rake --trace 2>&1"
+bundler_args: "--binstubs --without documentation"
+before_install:
+  - gem update --system 2.1.11
+  - gem --version
+  - gem install bundler
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+env:
+  - RSPEC_VERSION=2.14.1
+  - RSPEC_VERSION=2.99.0.beta1
+  - RSPEC_VERSION=3.0.0.beta1

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--exclude features
+--markup markdown
+--template-path yard/template
+-
+README.md

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-spy_on.gemspec
+gemspec
+
+group :documentation do
+  gem 'yard',           '0.8.7.3', :require => false
+  gem 'redcarpet',      '2.3.0'
+  gem 'github-markup',  '1.0.0'
+end
+
+case version = ENV['RSPEC_VERSION']
+when nil, false, ''
+  gem 'rspec', '3.0.0.beta1'
+else
+  gem 'rspec', version
+end
+
+# mime-types 2 is not compatible on ruby 1.8 so an old version is specified.
+gem 'mime-types', '~> 1.0'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thomas Holmes
+
+MIT License
+
+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,45 @@
+# Rspec::SpyOn [![Build Status](https://travis-ci.org/thomas-holmes/rspec-spy_on.png?branch=master)](https://travis-ci.org/thomas-holmes/rspec-spy_on)[![Coverage Status](https://coveralls.io/repos/thomas-holmes/rspec-spy_on/badge.png?branch=master)](https://coveralls.io/r/thomas-holmes/rspec-spy_on?branch=master)
+
+RSpec::SpyOn allows easier setup of test spies through the use of the `spy_on` method
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-spy_on'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-spy_on
+
+## Usage
+
+Instead of doing the following:
+
+    allow(dbl).to receive(:foo)
+    allow(dbl).to receive(:bar)
+
+    do_something_with(dbl)
+
+    expect(dbl).to have_received(:foo)
+    expect(dbl).to have_received(:bar)
+
+You can instead do:
+
+    spy_on(dbl, :foo, :bar)
+
+    do_something_with(dbl)
+
+    expect(dbl).to have_received(:foo)
+    expect(dbl).to have_received(:bar)
+
+Where this particularly comes in handy is when you need to spy with a real
+instance of an object (what is known as a partial double).
+
+When called on any ruby object that is not an `RSpec::Mocks::TestDouble` it
+will automatically call `and_call_original` if the passed in object responds
+to the desired message.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = %w[-w]
+  t.rspec_opts = %w[--color]
+end
+
+task :default => [:spec]

data/lib/rspec/spy_on/example_methods.rb

@@ -0,0 +1,46 @@
+module RSpec::SpyOn
+  module ExampleMethods
+    # Enables an RSpec::Mocks::TestDouble or any other object to act as
+    # a test spy. Delegates to RSpec::Mocks to configure the allowing of
+    # the messages
+    #
+    # In particular, `spy_on` makes this act of configuring real objects
+    # as spies easier by providing more concise syntax for configuring
+    # spying on multiple methods while forwarding the messages along
+    # to the original implementations.
+    #
+    # @example
+    #     person = Person.new("Ally", 22)
+    #     spy_on(person, :name, :age)
+    #     # use `person` in a test
+    #     expect(person).to have_received(:name)
+    #     expect(person).to have_received(:age)
+    #
+    # @param target [Object/RSpec::Mocks::TestDouble] The object to be spied on
+    # @param messages [Array] Array of symbols for messages that should configured for spying
+    # @return (target)
+    def spy_on(target, *messages)
+      if target.is_a?(RSpec::Mocks::TestDouble)
+        messages.each { |m| RSpec::Mocks.allow_message(target, m) }
+      else
+        messages.each { |m| allow_partial(target, m) }
+      end
+      target
+    end
+
+    private
+    # If a non RSpec::Mocks::TestDouble is to be a spy then it any messags
+    # sent should be forwarded to the original object
+    #
+    # @private
+    def allow_partial(target, message)
+      if target.respond_to?(message)
+        RSpec::Mocks.allow_message(target, message).and_call_original
+      else
+        RSpec::Mocks.allow_message(target, message)
+      end
+    end
+  end
+end
+
+RSpec.configuration.include RSpec::SpyOn::ExampleMethods

data/lib/rspec/spy_on/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module SpyOn
+    VERSION = "0.0.1.pre"
+  end
+end

data/lib/rspec/spy_on.rb

@@ -0,0 +1,9 @@
+require 'rspec/core'
+require 'rspec/mocks'
+
+RSpec::configure do |c|
+  c.backtrace_exclusion_patterns << /lib\/rspec\/spy_on/
+end
+
+require 'rspec/spy_on/version'
+require 'rspec/spy_on/example_methods'

data/rspec-spy_on.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/spy_on/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-spy_on"
+  spec.version       = Rspec::SpyOn::VERSION
+  spec.authors       = ["Thomas Holmes"]
+  spec.email         = ["thomas@holmes.io"]
+  spec.description   = %q{Use test spies more easily with the `spy_on` method}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.files        += %w[README.md LICENSE.txt .yardopts]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rspec", ">= 2.14"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+  spec.add_runtime_dependency "coveralls"
+end

data/spec/rspec/spy_on/spy_on_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe '#spy_on' do
+  context RSpec::Mocks::TestDouble do
+    let(:dbl) { double }
+
+    it 'creates an allowance' do
+      spy_on(dbl, :foo)
+      expect { dbl.foo }.to_not raise_error
+    end
+
+    it 'allows expectation of message to pass' do
+      spy_on(dbl, :foo)
+      dbl.foo
+      expect(dbl).to have_received(:foo)
+    end
+
+    it 'allows expectation of message to fail' do
+      spy_on(dbl, :foo)
+      expect do
+        expect(dbl).to have_received(:foo)
+      end.to raise_error(/received: 0/)
+    end
+  end
+
+  context RSpec::Mocks::Proxy do
+    let(:partial) { Widget.new('Floobit', :medium) }
+
+    it 'can create an allowance on non-existing method' do
+      spy_on(partial, :foo)
+      expect { partial.foo }.to_not raise_error
+    end
+
+    it 'calls original implementation if one exists' do
+      spy_on(partial, :name)
+      expect(partial.name).to eq 'Floobit'
+    end
+
+    it 'allows expectation on message to pass' do
+      spy_on(partial, :name)
+      partial.name
+      expect(partial).to have_received(:name)
+    end
+
+    it 'allows expectation on message to fail' do
+      spy_on(partial, :name)
+      expect do
+        expect(partial).to have_received(:name)
+      end.to raise_error(/received: 0/)
+    end
+
+    it 'does not observe calls to on methods not spied on' do
+      spy_on(partial, :name)
+      expect do
+        expect(partial).to have_received(:size)
+      end.to raise_error(/not been stubbed/)
+    end
+  end
+end
+
+class Widget
+  attr_accessor :name, :size
+  def initialize(name, size)
+    @name = name
+    @size = size
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+SimpleCov.start
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'rspec/spy_on'

data/yard/template/default/fulldoc/html/css/rspec.css

@@ -0,0 +1,20 @@
+.notetag {
+  background-color: #FFE5E5;
+}
+
+code {
+  background-color: #F0F0F0;
+  padding: 0 2px 0 2px;
+}
+
+.deprecated code {
+  background-color: #FFA8A8;
+}
+
+.summary_desc code {
+  background-color: #F0F0F0;
+}
+
+.notetag code {
+  background-color: #FFA8A8;
+}

data/yard/template/default/layout/html/setup.rb

@@ -0,0 +1,6 @@
+# Docs suggest I don't need this, but ...
+YARD::Server::Commands::StaticFileCommand::STATIC_PATHS << File.expand_path("../../../fulldoc/html/", __FILE__)
+
+def stylesheets
+  super + ['css/rspec.css']
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rspec-spy_on
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Thomas Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: simplecov
+  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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use test spies more easily with the `spy_on` method
+email:
+- thomas@holmes.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/spy_on.rb
+- lib/rspec/spy_on/example_methods.rb
+- lib/rspec/spy_on/version.rb
+- rspec-spy_on.gemspec
+- spec/rspec/spy_on/spy_on_spec.rb
+- spec/spec_helper.rb
+- yard/template/default/fulldoc/html/css/rspec.css
+- yard/template/default/layout/html/setup.rb
+homepage: ''
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Use test spies more easily with the `spy_on` method
+test_files:
+- spec/rspec/spy_on/spy_on_spec.rb
+- spec/spec_helper.rb
+has_rdoc: