tzu_mock 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a623fe290d3bf0e2ecaeda8f7891272261115576
-  data.tar.gz: 5408759d91670c24cd7e3660f60ea83ac7fd9b5f
+SHA256:
+  metadata.gz: bfeba27435b14487d4f44b1a34dff18bab63068684ec8f29eab3bfc9fc8a613d
+  data.tar.gz: 0340ffa48976774ba9472fc1564e490e753060bd674b2f69868b7e493aab04c6
 SHA512:
-  metadata.gz: ec7f5e5796be2ec05e37b94138d8e9cf66712e9fe989727dedb4da04688d7d2cc8477c35b3321216c71ba2c71fd7671c478db406bdd822f844ee783680d95e96
-  data.tar.gz: 85e762fa6f101ae45d7fbcf540cb3ed0ea7f08a8d4bcc2f305ac36bb68b73a39e9bf2bab705c89d7ca3d6e8f0944d2fd73c0317aed6b2e3153f431df2bd89f3f
+  metadata.gz: 57f6e5f426dbd6b9b109a032d27fc139b9dde8493b5e9677b39726add3f33428d5dc5f3e33c5b3d5a042204938331220877fd690fa663b1abb87e74e54539e4b
+  data.tar.gz: bfdc27287313694416b94c56a6d787ec177fbc9abf1bab142dc94121c8fc945cb8e0b6722beb796236b3fdb72aeeade81967d4a65f84766ff823583b50302b01

data/README.md

@@ -144,6 +144,27 @@ end
 
 TzuMock effortlessly passes your desired outcome to the appropriate block.
 
+## Hash Result
+
+TzuMock converts your result hash attributes into methods by default.
+
+```ruby
+# if you return this result
+before { TzuMock.success(UpdateUser).returns({name: 'me'}) }
+
+# you can access it on this way
+outcome = UpdateUser.run(params)
+outcome.result.name
+
+# even if you have result as array contains hashs
+before { TzuMock.success(UpdateUser).returns([{name: 'me'}]) }
+
+# you can access it on this way
+outcome = UpdateUser.run(params)
+outcome.result.first.name
+
+```
+
 ## Configuration
 
 By default, TzuMock mocks the `run` and `run!` methods,

data/lib/tzu_mock/class_methods.rb

@@ -10,7 +10,7 @@ module TzuMock
       # Call TzuMock#success, TzuMock#invalid, or TzuMock#failure instead
       rspec_context = binding.of_caller(2).eval('self')
 
-      Mocker.new(type, klass, rspec_context, method)
+      Mocker.new(type, klass, rspec_context, method).mock
     end
   end
 end

data/lib/tzu_mock/mocker.rb

@@ -6,11 +6,13 @@ module TzuMock
 
     def mock
       @rspec_context.instance_eval(&mock_proc(@klass, mock_methods, success?, @result, error_type))
+      self
     end
 
     def returns(result)
-      @result = result
+      @result = ResultBuilder.build(result)
       mock
+      self
     end
 
     private

data/lib/tzu_mock/result_builder.rb

@@ -0,0 +1,34 @@
+require 'hashie'
+
+module TzuMock
+  class HashResult < Hash
+    include Hashie::Extensions::MethodAccess
+
+    def initialize(attributes)
+      update(attributes)
+    end
+  end
+
+  class ResultBuilder
+    class << self
+      def build(result)
+        name = "build_#{result.class.name.downcase}".to_sym
+        if respond_to?(name, true)
+          send(name, result)
+        else
+          result
+        end
+      end
+
+      private
+
+      def build_hash(result)
+        HashResult.new(result)
+      end
+
+      def build_array(result)
+        result.map { |r| r.is_a?(Hash) ? build_hash(r) : r}
+      end
+    end
+  end
+end

data/lib/tzu_mock.rb

@@ -1,5 +1,6 @@
 require 'binding_of_caller'
 require 'tzu_mock/class_methods'
+require 'tzu_mock/result_builder'
 require 'tzu_mock/mocker'
 require 'tzu_mock/configuration'
 

data/spec/spec_helper.rb

@@ -1,8 +1,15 @@
-require 'rubygems'
-require 'byebug'
-require 'tzu'
-require 'rspec'
-require 'bundler/setup'
-Bundler.setup
+# frozen_string_literal: true
 
 require 'tzu_mock'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/tzu_mock_spec.rb

@@ -1,6 +1,6 @@
-require 'spec_helper'
+require 'tzu'
 
-describe TzuMock do
+RSpec.describe TzuMock do
   let(:result) { 'Desired Result' }
   let(:error) { { error: 'ERROR' } }
   let(:params) { { last_name: 'Turner' } }
@@ -54,6 +54,43 @@ describe TzuMock do
     end
   end
 
+  context 'result builder' do
+    let(:outcome) { UpdateUser.run!(params) }
+
+    before { TzuMock.success(UpdateUser).returns(result) }
+
+    context 'hash' do
+      let(:result) { {name: 'me!'} }
+      it 'returns hash attributes as methods' do
+        expect(outcome.result.is_a?(Hash)).to be_truthy
+        expect(outcome.result.name).to eq(result[:name])
+      end
+    end
+    context 'array' do
+      context 'contains hash' do
+        let(:result) { [{name: 'other'}] }
+        it 'responds to name' do
+          expect(outcome.result.first.is_a?(Hash)).to be_truthy
+          expect(outcome.result.first.name).to eq(result.first[:name])
+        end
+      end
+      context 'does not ctonain hash' do
+        let(:result) { ['me'] }
+        it 'responds to name' do
+          expect(outcome.result.first.is_a?(String)).to be_truthy
+          expect(outcome.result).to eq(result)
+        end
+      end
+    end
+    context 'string' do
+      let(:result) { 'me!' }
+      it 'responds to name' do
+        expect(outcome.result.is_a?(String)).to be_truthy
+        expect(outcome.result).to eq(result)
+      end
+    end
+  end
+
   context 'when invocation does not have a block' do
     context 'success' do
       before { TzuMock.success(UpdateUser).returns(result) }
@@ -132,4 +169,42 @@ describe TzuMock do
       end
     end
   end
+
+  context 'TzuMock receive no return result' do
+    context 'success' do
+      before { TzuMock.success(UpdateUser) }
+
+      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.type).to be nil
+        expect(UpdateUser).to have_received(:run!).with(params)
+      end
+    end
+
+    context 'invalid' do
+      before { TzuMock.invalid(UpdateUser) }
+
+      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.type).to eq :validation
+        expect(UpdateUser).to have_received(:run!).with(params)
+      end
+    end
+
+    context 'failure' do
+      before { TzuMock.failure(UpdateUser) }
+
+      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.type).to eq :execution
+        expect(UpdateUser).to have_received(:run).with(params)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tzu_mock
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Blake Turner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-12 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -25,33 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: tzu
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1.0
-  type: :development
+        version: '3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1.0
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: tzu
+  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: 2.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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'
 description: Simple library for mocking Tzu in RSpec
 email: mail@blakewilliamturner.com
 executables: []
@@ -78,13 +106,14 @@ files:
 - lib/tzu_mock/class_methods.rb
 - lib/tzu_mock/configuration.rb
 - lib/tzu_mock/mocker.rb
+- lib/tzu_mock/result_builder.rb
 - spec/spec_helper.rb
 - spec/tzu_mock_spec.rb
 homepage: https://github.com/onfido/tzu_mock
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,12 +128,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: TDD with Tzu!
 test_files:
 - spec/spec_helper.rb
 - spec/tzu_mock_spec.rb
-has_rdoc: