slayer 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f88c862cf4596840150934c88372a6cda656557e34da5a3918e98f19b159c645
-  data.tar.gz: 84d431982bad263f5a8cad99e3cd7fdb62610b9b75a80621c8ad457d01f93600
+  metadata.gz: 2616136d45efa56080f52cc1e50c83234aef62ea9d17d3c710fdbda46640a4ab
+  data.tar.gz: 6662a50c7491c23c48b17835b0ab12ceeed09fa58fc9c450d7a0371f2e492154
 SHA512:
-  metadata.gz: e390d010a072ec169f4c8a776547a4e3d562599db94a11a91534c7f0a2cc0667ce10c94fcfe765de658edb1bd477f38a4ac14b1972cbc183c03c666391193fbf
-  data.tar.gz: 13adcd8d46c0e28e1f4c243426ca1ad628157ca056d8298932dbdbf946d288661358a1c6e2a6ebbcf2e497a9efea45811579cb6063c28e46e80410f1a6f6d0e4
+  metadata.gz: 768fac163259ffd9b3c81707f76293da2a5df147639558257a8703824c7605d30761668b670cf105639542f75b6e8f77b9b2b7dd741a9bc0460727c5e6b20d03
+  data.tar.gz: ffa8cee897239bedb5d1d0bbb19b57cd931c74aee55921e301c92cf557e2e9816c9705ef5d78ea1d4c84b91e55dff4eeac3c8b1a012688c47dcf8e159500cd56

data/README.md

@@ -261,6 +261,39 @@ RSpec.describe RSpecCommand do
 end
 ```
 
+#### Stubbing Command Results
+
+The RSpec helpers provide two utility functions for use in your tests which should simplify testing commands with stubbed results. This can be useful when you want
+test a Rails controller, and your command is already tested separately. In this case, you only really care about the logic in your matching blocks --- not in the command itself.
+
+Put another way: this is useful when you want to test the success or failure conditions of your commands.
+
+```ruby
+RSpec.describe FooController, type: :controller do do
+  context 'successful command' do
+    let(:foo) { create(:foo) }
+    let(:fake_res) { fake_result(ok: true, message: 'foo updated') }
+
+    describe '#update' do
+      # Foo will not be called, instead we will get back the stubbed response
+      # from the let block above, allowing us to bypass the command logic and
+      # test only the controller logic
+      stub_command_response(UpdateFooCommand, fake_res)
+      post :update, params: { id: foo.id }
+      expect(response).to have_http_status :ok
+    end
+  end
+end
+
+```
+
+This method --- `stub_command_response` --- can take the return value as either a second argument, or as a block:
+
+```ruby
+stub_command_response(UpdateFooCommand, fake_res)     # => fake result as an argument
+stub_command_response(UpdateFooCommand) { fake_res }  # => fake result as a block
+```
+
 ### Minitest
 
 To use with Minitest, update your 'test_helper' file to include:

data/lib/slayer/command.rb

@@ -4,15 +4,11 @@ module Slayer
       def call(*args, &block)
         instance = self.new
 
-        begin
-          res = instance.call(*args, &block)
-        rescue ResultFailureError => e
-          res = e.result
-        end
+        res = __get_result(instance, *args, &block)
+        handle_match(res, instance, block) if block_given?
 
         raise CommandNotImplementedError unless res.is_a? Result
 
-        handle_match(res, instance, block) if block_given?
         return res
       end
       ruby2_keywords :call if respond_to?(:ruby2_keywords, true)
@@ -26,10 +22,24 @@ module Slayer
       end
 
       def err!(value: nil, status: :default, message: nil)
-        warn '[DEPRECATION] `err!` is deprecated.  Please use `return err` instead.'
+        unless ENV['SUPPRESS_SLAYER_WARNINGS']
+          warn '[DEPRECATION] `err!` is deprecated.  Please use `return err` instead.'
+        end
         raise ResultFailureError, err(value: value, status: status, message: message)
       end
 
+      def __get_result(instance, *args, &block)
+        res = nil
+
+        begin
+          res = instance.call(*args, &block)
+        rescue ResultFailureError => e
+          res = e.result
+        end
+
+        res
+      end
+
       private
 
       def handle_match(res, instance, block)

data/lib/slayer/compat/compat_040.rb

@@ -4,17 +4,19 @@ module Slayer
   class Command
     class << self
       def pass(value: nil, status: :default, message: nil)
-        warn '[DEPRECATION] `pass` is deprecated.  Please use `ok` instead.'
+        warn '[DEPRECATION] `pass` is deprecated.  Please use `ok` instead.' unless ENV['SUPPRESS_SLAYER_WARNINGS']
         ok(value: value, status: status, message: message)
       end
 
       def flunk(value: nil, status: :default, message: nil)
-        warn '[DEPRECATION] `flunk` is deprecated.  Please use `err` instead.'
+        warn '[DEPRECATION] `flunk` is deprecated.  Please use `err` instead.' unless ENV['SUPPRESS_SLAYER_WARNINGS']
         err(value: value, status: status, message: message)
       end
 
       def flunk!(value: nil, status: :default, message: nil)
-        warn '[DEPRECATION] `flunk!` is deprecated.  Please use `return err` instead.'
+        unless ENV['SUPPRESS_SLAYER_WARNINGS']
+          warn '[DEPRECATION] `flunk!` is deprecated.  Please use `return err` instead.'
+        end
         err!(value: value, status: status, message: message)
       end
     end
@@ -26,24 +28,24 @@ module Slayer
 
   class Result
     def success?
-      warn '[DEPRECATION] `success?` is deprecated.  Please use `ok?` instead.'
+      warn '[DEPRECATION] `success?` is deprecated.  Please use `ok?` instead.' unless ENV['SUPPRESS_SLAYER_WARNINGS']
       ok?
     end
 
     def failure?
-      warn '[DEPRECATION] `failure?` is deprecated.  Please use `err?` instead.'
+      warn '[DEPRECATION] `failure?` is deprecated.  Please use `err?` instead.' unless ENV['SUPPRESS_SLAYER_WARNINGS']
       err?
     end
   end
 
   class ResultMatcher
     def pass(...)
-      warn '[DEPRECATION] `pass` is deprecated.  Please use `ok` instead.'
+      warn '[DEPRECATION] `pass` is deprecated.  Please use `ok` instead.' unless ENV['SUPPRESS_SLAYER_WARNINGS']
       ok(...)
     end
 
     def fail(...)
-      warn '[DEPRECATION] `fail` is deprecated.  Please use `err` instead.'
+      warn '[DEPRECATION] `fail` is deprecated.  Please use `err` instead.' unless ENV['SUPPRESS_SLAYER_WARNINGS']
       err(...)
     end
   end

data/lib/slayer/rspec.rb

@@ -1,3 +1,4 @@
+require 'rspec/mocks'
 require 'rspec/expectations'
 
 # rubocop:disable Metrics/BlockLength
@@ -92,3 +93,25 @@ RSpec::Matchers.define :be_err_result do
 end
 
 # rubocop:enable Metrics/BlockLength
+
+module Slayer
+  module RspecHelpers
+    def stub_command_response(klass, res = nil, &block)
+      res = block.call if block_given? && res.nil?
+
+      expect(klass).to receive(:__get_result).and_return(res)
+    end
+
+    # rubocop:disable Naming/MethodParameterName
+    def fake_result(ok: true, value: nil, message: nil, status: nil)
+      res = Slayer::Result.new(value, status, message)
+      res.fail unless ok == true
+
+      res
+    end
+
+    # rubocop:enable Naming/MethodParameterName
+  end
+end
+
+RSpec.configure { |config| config.include Slayer::RspecHelpers }

data/lib/slayer/version.rb

@@ -1,3 +1,3 @@
 module Slayer
-  VERSION = '0.5.1'
+  VERSION = '0.5.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slayer
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Wyatt Kirby
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus