rspec-hollerback-mocks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eed0783475a82c560add2cc33847fba5a78a5cdd
+  data.tar.gz: 1983d97e4e2baa2bf3403280cf39bc0634ec9ebb
+SHA512:
+  metadata.gz: 2357ae5a903126d420f5022cf64484ccaac29fa4777e1531f4a27cc045f08288140a6842c97f12ebf9e4253ebd320ad100d68af90d5ecf4e03fa31cb3d3ae9b9
+  data.tar.gz: 8e00351747a32d5630697ce5cc4039b9fd546f26fd7eb87e21a03e6ada2a3dd9953ac15d8eeb5c67ef07c5952caaa70663140d1788bee92765cf5252d3b5d27a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+rvm:
+  - ruby-head
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Get local or master 'hollerback' gem
+library_path = File.expand_path("../../hollerback", __FILE__)
+if File.exist?(library_path)
+  gem 'hollerback', path: library_path
+else
+  gem 'hollerback', git: "git://github.com/delner/hollerback.git",
+                    branch: ENV.fetch('BRANCH',"master")
+end
+
+gem "rspec", :git => "git://github.com/rspec/rspec.git"
+gem "rspec-core", :git => "git://github.com/rspec/rspec-core.git"
+gem "rspec-expectations", :git => "git://github.com/rspec/rspec-expectations.git"
+gem "rspec-mocks", :git => "git://github.com/rspec/rspec-mocks.git"
+gem "rspec-support", :git => "git://github.com/rspec/rspec-support.git"
+
+gem "pry-stack_explorer"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Elner
+
+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,189 @@
+RSpec Hollerback Mocks
+==========
+
+[![Build Status](https://travis-ci.org/delner/rspec-hollerback-mocks.svg?branch=master)](https://travis-ci.org/delner/rspec-hollerback-mocks) ![Gem Version](https://badge.fury.io/rb/rspec-hollerback-mocks.svg)
+###### *For Ruby 2+, RSpec 3+*
+
+### Introduction
+
+Adds mocking extensions to RSpec for testing code that implements Hollerback.
+
+### Installation
+
+##### If you're not using Bundler...
+
+Install the gem via:
+
+```
+gem install rspec-hollerback-mocks
+```
+
+Then require it in your `spec_helper.rb` with:
+
+```
+require 'rspec/hollerback/mocks'
+```
+
+##### If you're using Bundler...
+
+Add the gem to your Gemfile:
+
+```
+gem 'rspec-hollerback-mocks'
+```
+
+Then `bundle install` to install the gem and its dependencies.
+
+Finally require it in your `spec_helper.rb` with:
+
+```
+require 'rspec/hollerback/mocks'
+```
+
+### Usage
+
+##### Triggering a callback using and_callback
+
+Given a class that implements Hollerback, e.g:
+
+```ruby
+class NoteApi
+  include Hollerback
+
+  # Callback-enabled function
+  def get_note(&block)
+    # ...
+  end
+end
+```
+
+You can mock callbacks on the class, or objects of the class using the `and_callback` condition.
+
+```ruby
+context "for a class" do
+  subject do
+    NoteApi.get_note do |on|
+      on.success { "Success!" }
+    end
+  end
+  it do
+    expect(NoteApi).to receive(:get_note).and_callback(:success)
+    expect(subject).to eq("Success!")
+  end
+end
+
+context "for an object" do
+  let(:client) { NoteApi.new }
+  subject do
+    client.get_note do |on|
+      on.success { "Success!" }
+    end
+  end
+  it do
+    expect(client).to receive(:get_note).and_callback(:success)
+    expect(subject).to eq("Success!")
+  end
+end
+```
+
+The mocked function will return the output of the callback block you invoke.
+
+##### Chaining callbacks
+
+You can also chain multiple callbacks, in which case the last callback will be the return value.
+
+```ruby
+context "for an object that invokes multiple callbacks" do
+  let(:client) { NoteApi.new }
+  subject do
+    client.get_note do |on|
+      on.created { "Created new note!" }
+      on.success { "Success!" }
+    end
+  end
+  it do
+    expect(client).to receive(:get_note).and_callback(:created).and_callback(:success)
+    expect(subject).to eq("Success!")
+  end
+end
+```
+
+##### Returning a value after callbacks
+
+If you want the mocked function to return a different value, then you can add RSpec's `and_return` to the end of the call.
+
+```ruby
+context "for an object that invokes a callback and returns a value" do
+  let(:note) { Note.new }
+  let(:client) { NoteApi.new }
+  subject do
+    client.get_note do |on|
+      on.success { "Success!" }
+    end
+  end
+  it do
+    expect(client).to receive(:get_note).and_callback(:success).and_return(note)
+    expect(subject).to eq(note)
+  end
+end
+```
+
+##### Mocking a class that uses a callback
+
+This feature is most useful when you want to mock behavior on a class that consumes the callback-enabled class.
+
+For example, let's say there is a `NoteApi#get_note` function that makes HTTP requests and triggers callbacks. Let's also say we wanted to use this `NoteApi` to power a feature that adds signatures to our notes.
+
+```ruby
+class Autopen
+  def self.get_signed_note(note_id, signature)
+    note = NoteApi.get_note note_id do |on|
+      # If the note exists, add a signature to it and return it
+      on.found { |note| note.tap { |n| n.append(signature) } }
+
+      # Otherwise just return a new note without a signature
+      on.not_found { |note_id| Note.new(note_id) }
+    end
+  end
+end
+```
+
+If we are writing specs for `Autopen` to test the `get_signed_note` method, we aren't interested in testing `NoteApi`. More importantly, we might not want that `NoteApi` class making actual HTTP calls that might make our test suite brittle, or otherwise slow it down.
+
+This is where a mock is appropriate and the `and_callback` condition is most useful. Using it, we can implement a test that allows us to make the `NoteApi` trigger any callbacks we need to test the code we care about inside `get_signed_note`.
+
+```ruby
+describe Autopen do
+  describe "#get_signed_note" do
+    subject { Autopen.get_signed_note(note_id, signature) }
+    let(:note_id) { "TPS Report" }
+    let(:signature) { "Peter Gibbons\nSoftware Engineer\nInitech" }
+
+    context "for a note that exists" do
+      let(:note) { Note.new("Yes, I already got the memo.") }
+      before(:each) { expect_any_instance_of(NoteApi).to receive(:get_signed_note).with(note_id).and_callback(:found, note) }
+      it { is_expected.to eq(note) }
+      it { expect(subject.body).to end_with(signature) }
+    end
+    context "when given a note that does not exist" do
+      before(:each) { expect_any_instance_of(NoteApi).to receive(:get_signed_note).with(note_id).and_callback(:not_found, note_id) }
+      it { expect(subject.body).to_not end_with(signature) }
+    end
+  end
+end
+```
+
+## Development
+
+Install dependencies using `bundle install`. Run tests using `bundle exec rspec`
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/delner/rspec-hollerback-mocks.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/hollerback/mocks"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/hollerback/mocks.rb

@@ -0,0 +1,8 @@
+require 'rspec/mocks'
+require 'hollerback'
+require "rspec/hollerback/mocks/version"
+
+require "rspec/hollerback/mocks/and_callback_implementation"
+require "rspec/hollerback/mocks/callback_message_expectation"
+require "rspec/hollerback/mocks/receive_callback_message_expectation"
+require "rspec/hollerback/mocks/callback_actions"

data/lib/rspec/hollerback/mocks/and_callback_implementation.rb

@@ -0,0 +1,23 @@
+module RSpec
+  module Hollerback
+    module Mocks
+      class AndCallbackImplementation
+        def initialize(callback_class, callback_name, *callback_args, &callback_block)
+          @callback_class = callback_class
+          @callback_name = callback_name
+          @callback_args = callback_args
+          @callback_block = callback_block if callback_block
+        end
+
+        def call(*args, &block)
+          callback_instance = @callback_class.new(block)
+          if @callback_block
+            callback_instance.respond_with(@callback_name, *@callback_args, &@callback_block)
+          else
+            callback_instance.respond_with(@callback_name, *@callback_args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/hollerback/mocks/callback_actions.rb

@@ -0,0 +1,16 @@
+module RSpec
+  module Hollerback
+    module Mocks
+      module CallbackActions
+        attr_accessor :callback_actions
+        def actions
+          actions_array = super
+          actions_array.insert(actions_array.size - 1, callback_actions).flatten.compact
+        end
+      end
+    end
+  end
+end
+
+# Inject into RSpec
+RSpec::Mocks::Implementation.send(:prepend, RSpec::Hollerback::Mocks::CallbackActions)

data/lib/rspec/hollerback/mocks/callback_message_expectation.rb

@@ -0,0 +1,27 @@
+module RSpec
+  module Hollerback
+    module Mocks
+      module CallbackMessageExpectation
+        def and_callback(callback_name, *callback_args, &callback_block)
+          # Lookup callback class
+          target_class = @method_double.object.is_a?(Module) ? @method_double.object : @method_double.object.class
+          raise ArgumentError.new("Target class #{target_class.name.to_s} does not implement Hollerback!") if !(target_class < ::Hollerback)
+          callback_class = target_class.const_get("Callbacks")
+
+          # Add callback action
+          self.callback_implementation_action(RSpec::Hollerback::Mocks::AndCallbackImplementation.new(callback_class, callback_name, *callback_args, &callback_block))
+
+          self
+        end
+
+        def callback_implementation_action(action)
+          return unless action
+          (implementation.callback_actions ||= []).push(action)
+        end
+      end
+    end
+  end
+end
+
+# Inject into RSpec
+RSpec::Mocks::MessageExpectation.send(:include, RSpec::Hollerback::Mocks::CallbackMessageExpectation)

data/lib/rspec/hollerback/mocks/receive_callback_message_expectation.rb

@@ -0,0 +1,21 @@
+module RSpec
+  module Hollerback
+    module Mocks
+      module ReceiveCallbackMessageExpectation
+        def self.included(mod)
+          RSpec::Hollerback::Mocks::CallbackMessageExpectation.public_instance_methods(false).each do |method|
+            next if method_defined?(method)
+
+            define_method(method) do |*args, &block|
+              @recorded_customizations << RSpec::Mocks::Matchers::ExpectationCustomization.new(method, args, block)
+              self
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# Inject into RSpec
+RSpec::Mocks::Matchers::Receive.send(:include, RSpec::Hollerback::Mocks::ReceiveCallbackMessageExpectation)

data/lib/rspec/hollerback/mocks/version.rb

@@ -0,0 +1,7 @@
+module RSpec
+  module Hollerback
+    module Mocks
+      VERSION = "0.1.0"
+    end
+  end
+end

data/rspec-hollerback-mocks.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/hollerback/mocks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-hollerback-mocks"
+  spec.version       = RSpec::Hollerback::Mocks::VERSION
+  spec.authors       = ["David Elner"]
+  spec.email         = ["david@davidelner.com"]
+
+  spec.summary       = %q{RSpec mocks for the Hollerback gem.}
+  spec.homepage      = "https://github.com/delner/rspec-hollerback-mocks"
+  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_runtime_dependency     "rspec-mocks", "~> 3.0"
+  spec.add_runtime_dependency     "hollerback", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: rspec-hollerback-mocks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Elner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: hollerback
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: pry
+  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: 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'
+description: 
+email:
+- david@davidelner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/hollerback/mocks.rb
+- lib/rspec/hollerback/mocks/and_callback_implementation.rb
+- lib/rspec/hollerback/mocks/callback_actions.rb
+- lib/rspec/hollerback/mocks/callback_message_expectation.rb
+- lib/rspec/hollerback/mocks/receive_callback_message_expectation.rb
+- lib/rspec/hollerback/mocks/version.rb
+- rspec-hollerback-mocks.gemspec
+homepage: https://github.com/delner/rspec-hollerback-mocks
+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: RSpec mocks for the Hollerback gem.
+test_files: []