tzu_mock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73cf86478ade4e9c17bd3d3d4b89df92d2a9aeea
+  data.tar.gz: 294c4be784376b59e80d73510baf6dc3441015f0
+SHA512:
+  metadata.gz: c6d4bc1e6231b7aa831406a8ed3a15015286322596672e9597bfb0aa13c3fdc051f89fa881528870ab0071964d6fcacac899c33e5dbef16851584488991cdee3
+  data.tar.gz: d0e1e248bfb380e251585db30c96967a71f89e0e81b312ece69f98d2c5b85462844afcf537b60bbfb77c6c26e98824a595958bcaf19c96bd9998c9a3fc89051a

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Blake Turner
+
+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,145 @@
+# Tzu Mock
+
+A very simple library for mocking Tzu in RSpec
+
+## Usage
+
+```ruby
+TzuMock.success(klass, result) #=> Successful Outcome
+TzuMock.invalid(klass, error) #=> Invalid Outcome
+TzuMock.failure(klass, error) #=> Failed Outcome
+```
+
+Consider this Tzu command:
+
+```ruby
+class UpdateUser
+  include Tzu
+  include Tzu::Validation
+
+  def call(params)
+    raise ArgumentError.new('I should be mocked!')
+  end
+end
+```
+
+There are two ways this might need to be mocked. The first happens when the Tzu command is invoked without a block:
+```ruby
+outcome = UpdateUser.run(params)
+```
+
+The second is when the command is invoked with a block, as in this mock controller:
+```ruby
+class MockController
+  attr_reader :method_called
+
+  def update(params = {})
+    UpdateUser.run(params) do
+      success do |result|
+        @method_called = :success
+      end
+
+      invalid do |error|
+        @method_called = :invalid
+      end
+
+      failure do |error|
+        @method_called = :failure
+      end
+    end
+  end
+end
+```
+
+In both cases, the use of TzuMock is the same. First, we'll mock at the simple invocation:
+```ruby
+describe UpdateUser do
+  let(:result) { 'Desired Result' }
+  let(:error) { { error: 'ERROR' } }
+  let(:params) { { last_name: 'Turner' } }
+
+  context 'success' do
+    before { TzuMock.success(UpdateUser, result) }
+
+    let(:outcome) { UpdateUser.run(params) }
+
+    it 'mocks a successful outcome and allows parameters to be verified' do
+      expect(outcome.success?).to be true
+      expect(outcome.result).to eq result
+      expect(outcome.type).to be nil
+      expect(UpdateUser).to have_received(:run).with(params)
+    end
+  end
+
+  context 'invalid' do
+    before { TzuMock.invalid(UpdateUser, error) }
+
+    let(:outcome) { UpdateUser.run(params) }
+
+    it 'mocks an invalid outcome and allows parameters to be verified' do
+      expect(outcome.success?).to be false
+      expect(outcome.result).to eq error
+      expect(outcome.type).to eq :validation
+      expect(UpdateUser).to have_received(:run).with(params)
+    end
+  end
+
+  context 'failure' do
+    before { TzuMock.failure(UpdateUser, error) }
+
+    let(:outcome) { UpdateUser.run!(params) }
+
+    it 'mocks a failed outcome and allows parameters to be verified' do
+      expect(outcome.success?).to be false
+      expect(outcome.result).to eq error
+      expect(outcome.type).to eq :execution
+      expect(UpdateUser).to have_received(:run!).with(params)
+    end
+  end
+end
+```
+
+TzuMock mocks both `run` and `run!`, and spies on the class so that you can verify the parameters that were passed.
+
+Next, we'll mock the controller:
+```ruby
+describe UpdateUser do
+  let(:result) { 'Desired Result' }
+  let(:error) { { error: 'ERROR' } }
+  let(:params) { { last_name: 'Turner' } }
+
+  let(:controller) { MockController.new }
+
+  context 'success' do
+    before { TzuMock.success(UpdateUser, result) }
+
+    it 'mocks a successful outcome and allows parameters to be verified' do
+      controller.update(params)
+      expect(UpdateUser).to have_received(:run).with(params)
+      expect(controller.method_called).to eq :success
+    end
+  end
+
+  context 'invalid' do
+    before { TzuMock.invalid(UpdateUser, error) }
+
+    it 'mocks a successful outcome and allows parameters to be verified' do
+      controller.update(params)
+      expect(UpdateUser).to have_received(:run).with(params)
+      expect(controller.method_called).to eq :invalid
+    end
+  end
+
+  context 'failure' do
+    before { TzuMock.failure(UpdateUser, error) }
+
+    it 'mocks a successful outcome and allows parameters to be verified' do
+      controller.update(params)
+      expect(UpdateUser).to have_received(:run).with(params)
+      expect(controller.method_called).to eq :failure
+    end
+  end
+end
+```
+
+TzuMock effortlessly passes your desired outcome to the appropriate block.

data/lib/tzu_mock.rb

@@ -0,0 +1,65 @@
+require 'binding_of_caller'
+
+class TzuMock
+  MOCK_METHODS = [:run, :run!]
+
+  class << self
+    def method_missing(method, *args)
+      return super(method) unless [:success, :invalid, :failure].include? method
+      prepare(method, *args)
+    end
+
+    def prepare(type, klass, result, method = nil)
+      # Get the rspec block context. Will not work if you call TzuMock#prepare directly.
+      # Call TzuMock#success, TzuMock#invalid, or TzuMock#failure instead
+      rspec_context = binding.of_caller(2).eval('self')
+
+      new(type, klass, result, rspec_context, method).mock
+    end
+  end
+
+  def initialize(type, klass, result, rspec_context, method)
+    @type, @klass, @result, @rspec_context, @method = type, klass, result, rspec_context, method
+  end
+
+  def mock
+    @rspec_context.instance_eval(&mock_proc(@klass, mock_methods, success?, @result, error_type))
+  end
+
+  private
+
+  # Need to pass variables in explicity to give the Proc access to them
+  def mock_proc(klass, methods, success, result, type)
+    Proc.new do
+      methods.each do |method|
+        allow(klass).to receive(method) do |&block|
+          outcome = Tzu::Outcome.new(success, result, type)
+          outcome.handle(&block) if block
+          outcome
+        end
+      end
+    end
+  end
+
+  def mock_methods
+    return [@method] if @method
+    MOCK_METHODS
+  end
+
+  def success?
+    @type == :success
+  end
+
+  def error_type
+    case @type
+    when :success
+      nil
+    when :invalid
+      :validation
+    when :failure
+      :execution
+    else
+      raise ArgumentError.new('Invalid type, must be :success, :invalid, or :failure')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'byebug'
+require 'tzu'
+require 'rspec'
+require 'bundler/setup'
+Bundler.setup
+
+require 'tzu_mock'

data/spec/tzu_mock_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe TzuMock do
+  let(:result) { 'Desired Result' }
+  let(:error) { { error: 'ERROR' } }
+  let(:params) { { last_name: 'Turner' } }
+
+  class UpdateUser
+    include Tzu
+    include Tzu::Validation
+
+    def call(params)
+      raise ArgumentError.new('I should be mocked!')
+    end
+  end
+
+  class MockController
+    attr_reader :method_called
+
+    def update(params = {})
+      UpdateUser.run(params) do
+        success do |result|
+          @method_called = :success
+        end
+
+        invalid do |error|
+          @method_called = :invalid
+        end
+
+        failure do |error|
+          @method_called = :failure
+        end
+      end
+    end
+  end
+
+  context 'when invocation does not have a block' do
+    context 'success' do
+      before { TzuMock.success(UpdateUser, result) }
+
+      let(:outcome) { UpdateUser.run!(params) }
+
+      it 'mocks a successful outcome and allows parameters to be verified' do
+        expect(outcome.success?).to be true
+        expect(outcome.result).to eq result
+        expect(outcome.type).to be nil
+        expect(UpdateUser).to have_received(:run!).with(params)
+      end
+    end
+
+    context 'invalid' do
+      before { TzuMock.invalid(UpdateUser, error) }
+
+      let(:outcome) { UpdateUser.run!(params) }
+
+      it 'mocks an invalid outcome and allows parameters to be verified' do
+        expect(outcome.success?).to be false
+        expect(outcome.result).to eq error
+        expect(outcome.type).to eq :validation
+        expect(UpdateUser).to have_received(:run!).with(params)
+      end
+    end
+
+    context 'failure' do
+      before { TzuMock.failure(UpdateUser, error) }
+
+      let(:outcome) { UpdateUser.run(params) }
+
+      it 'mocks a failed outcome and allows parameters to be verified' do
+        expect(outcome.success?).to be false
+        expect(outcome.result).to eq error
+        expect(outcome.type).to eq :execution
+        expect(UpdateUser).to have_received(:run).with(params)
+      end
+    end
+  end
+
+  context 'when invocation has a block' do
+    context 'success' do
+      before { TzuMock.success(UpdateUser, result) }
+
+      let(:controller) { MockController.new }
+
+      it 'mocks a successful outcome and allows parameters to be verified' do
+        controller.update(params)
+        expect(UpdateUser).to have_received(:run).with(params)
+        expect(controller.method_called).to eq :success
+      end
+    end
+
+    context 'invalid' do
+      before { TzuMock.invalid(UpdateUser, error) }
+
+      let(:controller) { MockController.new }
+
+      it 'mocks a successful outcome and allows parameters to be verified' do
+        controller.update(params)
+        expect(UpdateUser).to have_received(:run).with(params)
+        expect(controller.method_called).to eq :invalid
+      end
+    end
+
+    context 'failure' do
+      before { TzuMock.failure(UpdateUser, error) }
+
+      let(:controller) { MockController.new }
+
+      it 'mocks a successful outcome and allows parameters to be verified' do
+        controller.update(params)
+        expect(UpdateUser).to have_received(:run).with(params)
+        expect(controller.method_called).to eq :failure
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: tzu_mock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Blake Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3.pre1
+- !ruby/object:Gem::Dependency
+  name: tzu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Simple library for mocking Tzu in RSpec
+email: mail@blakewilliamturner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/tzu_mock.rb
+- spec/spec_helper.rb
+- spec/tzu_mock_spec.rb
+homepage: https://github.com/onfido/tzu_mock
+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.2.2
+signing_key: 
+specification_version: 4
+summary: TDD with Tzu!
+test_files:
+- spec/spec_helper.rb
+- spec/tzu_mock_spec.rb
+has_rdoc: