slayer 0.5.0.beta → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc095dc4fad61e836560eb30851324c846f8a5a1b3fd51bdc48d692ab576d8a3
-  data.tar.gz: 9a77c6b602b544462311a897bb53685434a51dde783602274fce9d83096f3644
+  metadata.gz: 8afcb532ebe21d444e89baf763a76b20cf4ab19ad1bf51d45bfbd29042f3ec16
+  data.tar.gz: 5f77a3a44acf2cd3a2888f38e67963b22866c5c81a44a628be1c28128d128812
 SHA512:
-  metadata.gz: 3a95c4d4b95bffc5d4f129e07fae690fcccd3543c6f7f745471aeaa8093bbfd9e5b377ffc931d52c0bb0f4f3048330f7b9421233246f633dde19de52526a6851
-  data.tar.gz: 2de8ba806e4210a197ec87323f8a48777f6e024e9546170cee4ce15a651cfad2dc62134f3e4021003fde1ef378e57771778d98eec49a9747110955c675956926
+  metadata.gz: f383e130f4d8bef5d42f9de29db7890f585c8116f3f6ea093cb83fc3c8b29b608ee82b16e881130527adedaf36761e216985d8b13208abac93bfef74739d53c7
+  data.tar.gz: 2b96b3b9473ad470033138e8f201a6fc5cdc893c2724fa4e0de1a0c7e820af93256d91569fe67f2a36dc66191f0956cf5ba45c11394e6d7778d015ee2633e7cb

data/.github/workflows/release.yml

@@ -4,7 +4,6 @@ name: Release
 
 on:
   workflow_dispatch:
-  pull_request:
 
 jobs:
   release:

data/.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: Test & Lint
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
 
 jobs:

data/README.md

@@ -6,6 +6,8 @@
 
 Slayer is intended to operate as a minimal service layer for your ruby application. To achieve this, Slayer provides base classes for business logic.
 
+**Slayer is still under development, and not yet ready for production use. We are targetting a stable API with the 0.4.0 launch, so expect breaking changes until then.**
+
 ## Application Structure
 
 Slayer provides 2 base classes for organizing your business logic: `Forms` and `Commands`. These each have a distinct role in your application's structure.
@@ -259,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:
@@ -366,6 +401,24 @@ $ bin/rails g slayer:form foo_form
 $ bin/rails g slayer:command foo_command
 ```
 
+## Compatability
+
+Backwards compatability with previous versions requires additional includes.
+
+```ruby
+require 'slayer/compat/compat_040'
+```
+
+If you use test matchers, you will have to separately require the compatability layer for your test runner:
+
+```ruby
+require 'slayer/compat/minitest_compat_040'
+
+# OR
+
+require 'slayer/compat/rspec_compat_040'
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -389,3 +442,11 @@ Any PRs should be accompanied with documentation in `README.md`, and changes doc
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+---
+
+# Built by Apsis
+
+[![apsis](https://s3-us-west-2.amazonaws.com/apsiscdn/apsis.png)](https://www.apsis.io)
+
+`slayer` was built by Apsis Labs. We love sharing what we build! Check out our [other libraries on Github](https://github.com/apsislabs), and if you like our work you can [hire us](https://www.apsis.io/work-with-us/) to build your vision.

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)
@@ -30,6 +26,18 @@ module Slayer
         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

@@ -1,6 +1,4 @@
 # :nocov:
-require 'minitest/assertions'
-require 'rspec/expectations'
 
 module Slayer
   class Command
@@ -51,14 +49,4 @@ module Slayer
   end
 end
 
-module Minitest::Assertions
-  alias assert_success assert_ok
-  alias refute_failed assert_ok
-  alias assert_failed refute_ok
-  alias refute_success refute_ok
-end
-
-RSpec::Matchers.alias_matcher :be_failed_result, :be_err_result
-RSpec::Matchers.alias_matcher :be_success_result, :be_ok_result
-
 # :nocov:

data/lib/slayer/compat/minitest_compat_040.rb

@@ -0,0 +1,12 @@
+# :nocov:
+
+require 'minitest/assertions'
+
+module Minitest::Assertions
+  alias assert_success assert_ok
+  alias refute_failed assert_ok
+  alias assert_failed refute_ok
+  alias refute_success refute_ok
+end
+
+# :nocov:

data/lib/slayer/compat/rspec_compat_040.rb

@@ -0,0 +1,8 @@
+# :nocov:
+
+require 'rspec/expectations'
+
+RSpec::Matchers.alias_matcher :be_failed_result, :be_err_result
+RSpec::Matchers.alias_matcher :be_success_result, :be_ok_result
+
+# :nocov:

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.0.beta'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slayer
 version: !ruby/object:Gem::Version
-  version: 0.5.0.beta
+  version: 0.5.2
 platform: ruby
 authors:
 - Wyatt Kirby
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-20 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -183,6 +183,8 @@ files:
 - lib/slayer.rb
 - lib/slayer/command.rb
 - lib/slayer/compat/compat_040.rb
+- lib/slayer/compat/minitest_compat_040.rb
+- lib/slayer/compat/rspec_compat_040.rb
 - lib/slayer/cops/return_matcher.rb
 - lib/slayer/errors.rb
 - lib/slayer/form.rb
@@ -208,9 +210,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key: