slayer 0.4.0.beta3 → 0.5.0.beta

data/lib/slayer/result_matcher.rb

@@ -10,16 +10,16 @@ module Slayer
   #
   # == Matching based on success or failure
   #
-  # The ResultMatcher matches calls to {#pass} to a {Result} that returns +true+
-  # for {Result#success?}, calls to {#fail} to a {Result} that returns +true+
-  # for {Result#failure?}, and calls to {#all} to a {Result} in either state.
+  # The ResultMatcher matches calls to {#ok} to a {Result} that returns +true+
+  # for {Result#ok?}, calls to {#err} to a {Result} that returns +true+
+  # for {Result#err?}, and calls to {#all} to a {Result} in either state.
   #
-  # A matching call to {#pass} or {#fail} takes precedence over matching calls to {#all}
+  # A matching call to {#ok} or {#err} takes precedence over matching calls to {#all}
   #
   # == Matching based on status
   #
   # Additionally, the ResultMatcher can also match by the {Result#status}. If a status
-  # or statuses is passed to {#pass}, {#fail}, or {#all}, these will only be invoked if the
+  # or statuses is passed to {#ok}, {#err}, or {#all}, these will only be invoked if the
   # status of the {Result} matches the passed in status.
   #
   # If the default block is the same as the block for one of the statuses the status +:default+
@@ -29,11 +29,11 @@ module Slayer
   # == Both pass and fail must be handled
   #
   # If the block form of a {Command.call} is invoked, both the block must handle the default
-  # status for both a {Result#success?} and a {Result#failure?}. If both are not handled,
+  # status for both a {Result#ok?} and a {Result#err?}. If both are not handled,
   # the matching block will not be invoked and a {ResultNotHandledError} will be
   # raised.
   #
-  # @example Matcher invokes the matching pass block, with precedence given to {#pass} and {#fail}
+  # @example Matcher invokes the matching pass block, with precedence given to {#ok} and {#err}
   #   # Call produces a successful Result
   #   SuccessCommand.call do |m|
   #     m.pass { puts "Pass!" }
@@ -105,8 +105,8 @@ module Slayer
 
       @status = result.status || :default
 
-      @handled_default_pass = false
-      @handled_default_fail = false
+      @handled_default_ok = false
+      @handled_default_err = false
 
       # These are set to false if they are never set. If they are set to `nil` that
       # means the block intentionally passed `nil` as the block to be executed.
@@ -125,12 +125,12 @@ module Slayer
     #   not matched by other matchers.
     #
     #   If no value is provided for statuses it defaults to +:default+.
-    def pass(*statuses, &block)
+    def ok(*statuses, &block)
       statuses << :default if statuses.empty?
-      @handled_default_pass ||= statuses.include?(:default)
+      @handled_default_ok ||= statuses.include?(:default)
 
-      block_is_match   = @result.success? && statuses.include?(@status)
-      block_is_default = @result.success? && statuses.include?(:default)
+      block_is_match   = @result.ok? && statuses.include?(@status)
+      block_is_default = @result.ok? && statuses.include?(:default)
 
       @matching_block = block if block_is_match
       @default_block  = block if block_is_default
@@ -144,19 +144,19 @@ module Slayer
     #   not matched by other matchers.
     #
     #   If no value is provided for statuses it defaults to +:default+.
-    def fail(*statuses, &block)
+    def err(*statuses, &block)
       statuses << :default if statuses.empty?
-      @handled_default_fail ||= statuses.include?(:default)
+      @handled_default_err ||= statuses.include?(:default)
 
-      block_is_match   = @result.failure? && statuses.include?(@status)
-      block_is_default = @result.failure? && statuses.include?(:default)
+      block_is_match   = @result.err? && statuses.include?(@status)
+      block_is_default = @result.err? && statuses.include?(:default)
 
       @matching_block = block if block_is_match
       @default_block  = block if block_is_default
     end
 
     # Provide a block that should be invoked for any {Result}. This has a lower precedence that
-    # either {#pass} or {#fail}.
+    # either {#ok} or {#err}.
     #
     # @param statuses [Array<status>] Statuses that should be compared to the {Result}. If
     #   any of provided statuses match the {Result} this block will be considered a match.
@@ -166,8 +166,8 @@ module Slayer
     #   If no value is provided for statuses it defaults to +:default+.
     def all(*statuses, &block)
       statuses << :default if statuses.empty?
-      @handled_default_pass ||= statuses.include?(:default)
-      @handled_default_fail ||= statuses.include?(:default)
+      @handled_default_ok ||= statuses.include?(:default)
+      @handled_default_err ||= statuses.include?(:default)
 
       block_is_match   = statuses.include?(@status)
       block_is_default = statuses.include?(:default)
@@ -186,7 +186,7 @@ module Slayer
     #
     # @api private
     def handled_defaults?
-      return @handled_default_pass && @handled_default_fail
+      return @handled_default_ok && @handled_default_err
     end
 
     # Executes the provided block that best matched the {Result}. If no block matched
@@ -213,8 +213,8 @@ module Slayer
 
     private
 
-      def run_block(block)
-        block.call(@result.value, @result, @command) if block # explicit nil should fail this test
-      end
+    def run_block(block)
+      block&.call(@result.value, @result, @command) # explicit nil should fail this test
+    end
   end
 end

data/lib/slayer/rspec.rb

@@ -1,12 +1,13 @@
 require 'rspec/expectations'
+
 # rubocop:disable Metrics/BlockLength
-RSpec::Matchers.define :be_success_result do
+RSpec::Matchers.define :be_ok_result do
   match do |result|
     status_matches = @status.nil? || @status == result.status
     message_matches = @message.nil? || @message == result.message
     value_matches = @value.nil? || @value == result.value
 
-    result.success? && status_matches && message_matches && value_matches
+    result.ok? && status_matches && message_matches && value_matches
   end
 
   chain :with_status do |status|
@@ -21,6 +22,12 @@ RSpec::Matchers.define :be_success_result do
     @value = value
   end
 
+  chain :with do |args|
+    @status = args[:status] if args.key? :status
+    @message = args[:message] if args.key? :message
+    @value = args[:value] if args.key? :value
+  end
+
   # :nocov:
   failure_message do |result|
     return 'expected command to succeed' if @status.nil? && @value.nil? && @message.nil?
@@ -33,18 +40,19 @@ RSpec::Matchers.define :be_success_result do
     return "expected command not to have message: #{@message}" if !@message.nil? && result.message == @message
     return "expected command not to have value: #{@value}" if !@value.nil? && result.value == @value
     return "expected command not to have status :#{@status}" if !@status.nil? && result.status == @status
+
     return 'expected command to fail'
   end
   # :nocov:
 end
 
-RSpec::Matchers.define :be_failed_result do
+RSpec::Matchers.define :be_err_result do
   match do |result|
     status_matches = @status.nil? || @status == result.status
     message_matches = @message.nil? || @message == result.message
     value_matches = @value.nil? || @value == result.value
 
-    result.failure? && status_matches && message_matches && value_matches
+    result.err? && status_matches && message_matches && value_matches
   end
 
   chain :with_status do |status|
@@ -59,6 +67,12 @@ RSpec::Matchers.define :be_failed_result do
     @value = value
   end
 
+  chain :with do |args|
+    @status = args[:status] if args.key? :status
+    @message = args[:message] if args.key? :message
+    @value = args[:value] if args.key? :value
+  end
+
   # :nocov:
   failure_message do |result|
     return 'expected command to fail' if @status.nil? && @value.nil? && @message.nil?
@@ -71,8 +85,10 @@ RSpec::Matchers.define :be_failed_result do
     return "expected command to have message: #{@message}" if !@message.nil? && result.message == @message
     return "expected command to have value: #{@value}" if !@value.nil? && result.value == @value
     return "expected command to have status :#{@status}" if !@status.nil? && result.status == @status
+
     return 'expected command to succeed'
   end
   # :nocov:
 end
+
 # rubocop:enable Metrics/BlockLength

data/lib/slayer/version.rb

@@ -1,3 +1,3 @@
 module Slayer
-  VERSION = '0.4.0.beta3'
+  VERSION = '0.5.0.beta'
 end

data/lib/slayer.rb

@@ -2,9 +2,7 @@ require 'ext/string_ext' unless defined?(Rails)
 
 require 'slayer/version'
 require 'slayer/errors'
-require 'slayer/hook'
 require 'slayer/result'
 require 'slayer/result_matcher'
-require 'slayer/service'
 require 'slayer/command'
 require 'slayer/form'

data/slayer.gemspec

@@ -18,18 +18,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_dependency 'virtus', '~> 2.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'byebug', '~> 9.0'
-  spec.add_development_dependency 'chandler'
-  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
-  spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'mocha', '~> 1.2'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '= 0.57.2'
-  spec.add_development_dependency 'simplecov', '~> 0.13'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '= 1.38.0'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slayer
 version: !ruby/object:Gem::Version
-  version: 0.4.0.beta3
+  version: 0.5.0.beta
 platform: ruby
 authors:
 - Wyatt Kirby
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-30 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,34 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '9.0'
-- !ruby/object:Gem::Dependency
-  name: chandler
-  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: coveralls
-  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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -115,70 +87,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: 1.38.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.57.2
+        version: 1.38.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -202,13 +160,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".githooks/pre-push"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- CHANGELOG.md
 - Dockerfile
 - Gemfile
 - LICENSE.txt
@@ -226,14 +182,14 @@ files:
 - lib/ext/string_ext.rb
 - lib/slayer.rb
 - lib/slayer/command.rb
+- lib/slayer/compat/compat_040.rb
+- lib/slayer/cops/return_matcher.rb
 - lib/slayer/errors.rb
 - lib/slayer/form.rb
-- lib/slayer/hook.rb
 - lib/slayer/minitest.rb
 - lib/slayer/result.rb
 - lib/slayer/result_matcher.rb
 - lib/slayer/rspec.rb
-- lib/slayer/service.rb
 - lib/slayer/version.rb
 - slayer.gemspec
 - slayer_logo.png
@@ -256,8 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A killer service layer

data/.hound.yml

@@ -1,2 +0,0 @@
-ruby:
-  config_file: .rubocop.yml

data/.rubocop_todo.yml

@@ -1,48 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-02-13 09:02:04 -0800 using RuboCop version 0.47.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-Lint/HandleExceptions:
-  Exclude:
-    - 'lib/slayer/command.rb'
-    - 'test/lib/result_matcher_test.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'lib/slayer/form.rb'
-
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 19
-
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 9
-
-# Offense count: 5
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 18
-
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 10
-
-# Offense count: 6
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/ext/**/*'
-    - 'lib/slayer/command.rb'
-    - 'lib/slayer/errors.rb'
-    - 'lib/slayer/form.rb'
-    - 'lib/slayer/result.rb'

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-before_install: gem install bundler -v 1.16.1
-language: ruby
-rvm:
-  - 2.3.0
-  - 2.4.2

data/CHANGELOG.md

@@ -1,9 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-### Added
-- Added documentation for CHANGELOG to README

data/lib/slayer/hook.rb

@@ -1,154 +0,0 @@
-module Slayer
-  # Hook adds the ability to wrap all calls to a class in a wrapper method. The
-  # wrapper method is provided with a block that can be used to invoke the called
-  # method.
-  #
-  # The methods #skip_hook and #only_hook can be used to control which methods are
-  # and are not wrapped with the hook call.
-  #
-  # @example Including Hook on a class.
-  #   class MyHookedClass
-  #     include Hook
-  #
-  #     hook :say_hello_and_goodbye
-  #
-  #     def self.say_hello_and_goodbye
-  #       puts "hello!"
-  #
-  #       yield # calls hooked method
-  #
-  #       puts "goodbye!"
-  #     end
-  #
-  #     def self.say_something
-  #       puts "something"
-  #     end
-  #   end
-  #
-  #   MyHookedClass.say_something
-  #    # => "hello!"
-  #    #    "something"
-  #    #    "goodbye!"
-  #
-  # @example Skipping Hooks
-  #
-  # skip_hook :say_something, :do_something # the hook method will not be invoked for
-  #                                         # these methods. They will be called directly.
-  #
-  # @example Only hooking
-  #
-  # only_hook :see_something, :hear_something # These are the only methods that will be
-  #                                           # be hooked. All other methods will be
-  #                                           # called directly.
-  module Hook
-    def self.included(klass)
-      klass.extend ClassMethods
-    end
-
-    # Everything in Hook::ClassMethods automatically get extended onto the
-    # class that includes Hook.
-    module ClassMethods
-      # Define the method that will be invoked whenever another method is invoked.
-      # This should be a class method.
-      def hook(hook_method)
-        @__hook = hook_method
-      end
-
-      # Define the set of methods that should always be called directly, and should
-      # never be hooked
-      def skip_hook(*hook_skips)
-        @__hook_skips = hook_skips
-      end
-
-      def singleton_skip_hook(*hook_skips)
-        @__singleton_hook_skips = hook_skips
-      end
-
-      # If only_hook is called then only the methods provided will be hooked. All
-      # other methods will be called directly.
-      def only_hook(*hook_only)
-        @__hook_only = hook_only
-      end
-
-      private
-
-        def __hook
-          @__hook ||= nil
-        end
-
-        def __hook_skips
-          @__hook_skips ||= []
-        end
-
-        def __singleton_hook_skips
-          @__singleton_hook_skips ||= []
-        end
-
-        def __hook_only
-          @__hook_only ||= nil
-        end
-
-        def __current_methods
-          @__current_methods ||= nil
-        end
-
-        def run_hook(name, instance, passed_block, &block)
-          if __hook
-            send(__hook, name, instance, passed_block, &block)
-          else
-            # rubocop:disable Performance/RedundantBlockCall
-            block.call
-            # rubocop:enable Performance/RedundantBlockCall
-          end
-        end
-
-        def singleton_method_added(name)
-          insert_hook_for(name,
-                          define_method_fn: :define_singleton_method,
-                          hook_target: self,
-                          alias_target: singleton_class,
-                          skip_methods: blacklist(__singleton_hook_skips))
-        end
-
-        def method_added(name)
-          insert_hook_for(name,
-                          define_method_fn: :define_method,
-                          hook_target: self,
-                          alias_target: self,
-                          skip_methods: blacklist(__hook_skips))
-        end
-
-        def insert_hook_for(name, define_method_fn:, hook_target:, alias_target:, skip_methods: [])
-          return if __current_methods && __current_methods.include?(name)
-
-          with_hooks = :"__#{name}_with_hooks"
-          without_hooks = :"__#{name}_without_hooks"
-
-          return if __hook_only && !__hook_only.include?(name.to_sym)
-          return if skip_methods.include? name.to_sym
-
-          @__current_methods = [name, with_hooks, without_hooks]
-          send(define_method_fn, with_hooks) do |*args, &block|
-            hook_target.send(:run_hook, name, self, block) do
-              send(without_hooks, *args)
-            end
-          end
-
-          alias_target.send(:alias_method, without_hooks, name)
-          alias_target.send(:alias_method, name, with_hooks)
-
-          @__current_methods = nil
-        end
-
-        def blacklist(additional = [])
-          list = Object.methods(false) + Object.private_methods(false)
-          list += Slayer::Hook::ClassMethods.private_instance_methods(false)
-          list += Slayer::Hook::ClassMethods.instance_methods(false)
-          list += additional
-          list << __hook if __hook
-
-          list
-        end
-    end
-  end
-end