direct 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 812ea6d0360b4161fba6c6fcd38d409715900ff08cdd57f3d4cf4df5df2de900
-  data.tar.gz: b3b95cafabb8381687d8a033f4c14b9d57164b101236c61a4faa960a5b73890b
+  metadata.gz: 0c4b78452caed73b8ce6c197b9825690120664cfedf0a695e0b8dee7d3f93e9e
+  data.tar.gz: d16639349d3041cc46fd0aa8edf6cc6565e24ff70b97dd275bc6c4dbeba1c853
 SHA512:
-  metadata.gz: 737c8f8dfd54bef81cb284c5bf0fceb02b8ff53df4b9fa31231bbd78d1b9f86bcf83f34e60befce7ed87d368843b63e35de73de16a6578aae5f09cc1a60d5f56
-  data.tar.gz: fffe7ce4459bd5ea399d4103a19ed561955b4e5c241a407c772d4f03669cf9328f108e5fbf704c664dcafd06ccbcdf826b50235e870e7f8522a40f0004ef3e2e
+  metadata.gz: 2193d4a0199deb76f94bdcb22fe6042d393a32a0a23581f6957f066d6609ad51e8590436a284fa818a939b3fcd00aa495724d229d9af65c18e9dd86bc0e670ff
+  data.tar.gz: cd31472b4a110ceeab0cff5af7700314b71e10f911b12a426491acc94019879d92374cefdc301cc258cf3c5197f097bc9d32ae8e5209569dd7102f26131a6fe8

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Version 2.0.1
+
+Introduce an ExceptionHandler to allow for multiple exception blocks
+Drop Ruby 2.6 support
+Fix bug where strict_defer was not accepting callable and object arguments.
+Drop Ruby 2.5 and below
+
 ## Version 2.0.0
 
 A bug in deferred execution did not return the success/failure results. Fixes test names that cause a collision and incorrect test scenarios.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Jim Gay
+Copyright (c) 2018-2022 Jim Gay
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -34,7 +34,7 @@ SomeClass.new.procedure.success{ |deferred_object, result, object|
   puts "it worked!"
 }.failure { |deferred_object, result, object|
   puts "it failed :-("
-}.exception{ |deferred_object, exception, object|
+}.exception { |deferred_object, exception, object|
   puts "Oh no! An exception was raised!"
 }.execute
 ```
@@ -51,6 +51,16 @@ SomeClass.new.procedure.success{ |deferred_object, result, object|
 }.execute
 ```
 
+You can also handle different exceptions with different blocks:
+
+```ruby
+SomeClass.new.procedure.exception(SomeLibrary::SomeSpecialError){ |deferred_object, exception, object|
+  puts "Oh no! A Special Error!"
+}.exception(ArgumentError){ |deferred_object, exception, object|
+  puts "Oops! The arguments are wrong!"
+}.execute
+```
+
 The `defer` method uses built-in classes but you can build your own to manage executing named blocks
 
 ```ruby

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/lib/direct/exception_handler.rb

@@ -0,0 +1,31 @@
+module Direct
+  # This class monitors exception types with related blocks.
+  class ExceptionHandler
+    def initialize
+      @handlers = {}
+    end
+
+    # All classes, including StandardError, for which this object
+    # maintains a block to execute.
+    def classes
+      [StandardError, @handlers.keys.flatten].flatten
+    end
+
+    # Pass a single or multiple exception classes and the block
+    # to be used to handle them.
+    def monitor(*classes, &block)
+      @handlers[classes.flatten] = block
+    end
+
+    # This will find the first handler given to `monitor` which matches
+    # the provided exception's class and will execute it with the
+    # deferred object, the exception object, and any given object to the
+    # deferred object.
+    def call(deferred, exception, object)
+      if_none = proc { raise "No handler for this exception: #{exception.class}!" }
+      result = @handlers.find(if_none) { |key, val| key.include?(exception.class) }
+
+      result.last.call(deferred, exception, object)
+    end
+  end
+end

data/lib/direct/executable.rb

@@ -1,3 +1,5 @@
+require "direct/exception_handler"
+
 module Direct
   class Executable
     include Direct.allow_missing_directions
@@ -40,18 +42,20 @@ module Direct
     #      puts "The #{thing} did something!"
     #   }.execute
     #
-    def initialize(callable=nil, object: nil, &block)
-      @object = object
+    def initialize(callable = nil, *args, **kwargs, &block)
+      @object = kwargs.delete(:object)
+      @args = args
+      @kwargs = kwargs
+      @exception_handler = kwargs.delete(:exception_handler) || ExceptionHandler.new
       @execution = callable || block
-      @exception_classes = [StandardError]
     end
-    attr_reader :execution, :exception_classes, :object
+    attr_reader :execution, :exception_handler, :object, :args, :kwargs
 
     # Tell the object what to do for a success path
     #
     # Returns itself
     #
-    def success(callable=nil, &block)
+    def success(callable = nil, &block)
       direct(:success, (callable || block))
       self
     end
@@ -60,7 +64,7 @@ module Direct
     #
     # Returns itself
     #
-    def failure(callable=nil, &block)
+    def failure(callable = nil, &block)
       direct(:failure, (callable || block))
       self
     end
@@ -81,18 +85,22 @@ module Direct
     #   }
     #
     def exception(*classes, &block)
-      unless classes.empty?
-        @exception_classes = classes
-      end
-      direct(:exception, block)
+      classes = [StandardError] if classes.empty?
+      exception_handler.monitor(classes, &block)
+
+      direct(:exception, exception_handler)
       self
     end
 
+    def exception_classes
+      exception_handler.classes
+    end
+
     def run_exception_block(exception)
       if __directions.key?(:exception)
-        as_directed(:exception, exception, object)
+        as_directed(:exception, exception, object, *args, **kwargs)
       else
-        as_directed(:failure, exception, object)
+        as_directed(:failure, exception, object, *args, **kwargs)
       end
     end
     private :run_exception_block
@@ -102,15 +110,23 @@ module Direct
     # provided to the exception path.
     #
     def value
-      result = execution.()
-      if result
-        as_directed(:success, result, object) || result
-      else
-        as_directed(:failure, result, object) || result
-      end
+      trigger_directions
     rescue *exception_classes => exception
       run_exception_block(exception)
     end
-    alias execute value
+    alias_method :execute, :value
+
+    def trigger_directions
+      result = execution.call
+      if result
+        as_directed(:success, result, object, *args, **kwargs)
+      else
+        as_directed(:failure, result, object, *args, **kwargs)
+      end || result
+    end
+    private :trigger_directions
+
   end
+
+  private_constant :Executable
 end

data/lib/direct/group.rb

@@ -1,16 +1,16 @@
-require 'concurrent'
+require "concurrent"
 module Direct
   class Group
     def initialize
-      @map = Concurrent::Map.new{|collection, key|
-        collection.put(key, Concurrent::Array.new)
+      @map = Concurrent::Map.new { |collection, key|
+        collection.put(key, Concurrent::Set.new)
       }
     end
 
     attr_reader :map
     private :map
 
-    def store(key, callable=nil, &block)
+    def store(key, callable = nil, &block)
       map[key] << (callable || block)
       self
     end
@@ -31,4 +31,6 @@ module Direct
       map.keys.inspect
     end
   end
+
+  private_constant :Group
 end

data/lib/direct/strict_executable.rb

@@ -1,5 +1,5 @@
 module Direct
-  class StrictExecutable
+  class StrictExecutable < Executable
     include Direct
 
     # It is intended that you initialize objects via Direct.strict_defer
@@ -42,77 +42,20 @@ module Direct
     #      puts "#{thing} failed!"
     #   }.execute
     #
-    def initialize(callable=nil, object: nil, &block)
-      @object = object
-      @execution = callable || block
-      @exception_classes = [StandardError]
-    end
-    attr_reader :execution, :exception_classes, :object
-
-    # Tell the object what to do for a success path
-    #
-    # Returns itself
-    #
-    def success(callable=nil, &block)
-      direct(:success, (callable || block))
-      self
-    end
-
-    # Tell the object what to do for a failure path
-    #
-    # Returns itself
-    #
-    def failure(callable=nil, &block)
-      direct(:failure, (callable || block))
-      self
-    end
-
-    # Tell the object what to do for an exception path.
-    #
-    # You may optionally provide a list of modules rescued by
-    # the value method in the case of an exception.
-    #
-    # Returns itself
-    #
-    # Example:
-    #
-    #   Direct.strict_defer {
-    #      # something...
-    #   }.exception(NoMethodError) { |deferred, exception, object|
-    #      ExceptionNotifier.notify(exception)
-    #   }
-    #
-    def exception(*classes, &block)
-      unless classes.empty?
-        @exception_classes = classes
-      end
-      direct(:exception, block)
-      self
-    end
-
-    def run_exception_block(exception)
-      if __directions.key?(:exception)
-        as_directed(:exception, exception, object)
-      else
-        as_directed(:failure, exception, object)
-      end
-    end
-    private :run_exception_block
 
-    # Return the value of the success or failure path
-    # and rescue from StandardError or from the modules
-    # provided to the exception path.
+    # Override the behavior of the parent class to *not* fall back to the
+    # result.
     #
-    def value
-      result = execution.()
+    def trigger_directions
+      result = execution.call
       if result
-        as_directed(:success, result)
+        as_directed(:success, result, object, *args, **kwargs)
       else
-        as_directed(:failure, result)
+        as_directed(:failure, result, object, *args, **kwargs)
       end
-    rescue *exception_classes => exception
-      run_exception_block(exception)
     end
-    alias execute value
+    private :trigger_directions
   end
+
+  private_constant :StrictExecutable
 end

data/lib/direct/version.rb

@@ -1,3 +1,3 @@
 module Direct
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/lib/direct.rb

@@ -52,8 +52,8 @@ module Direct
   #     failure{|result| puts "it failed!" }.
   #     value
   #
-  def self.strict_defer(&block)
-    StrictExecutable.new(&block)
+  def self.strict_defer(callable = nil, *args, object: nil, **kwargs, &block)
+    StrictExecutable.new(callable, *args, object: object, **kwargs, &block)
   end
 
   # Wrap a block of code to return an object for handling
@@ -68,8 +68,8 @@ module Direct
   #   end
   #   do_it.value
   #
-  def self.defer(*args, object: nil, &block)
-    Executable.new(*args, object: object, &block)
+  def self.defer(callable = nil, *args, object: nil, **kwargs, &block)
+    Executable.new(callable, *args, object: object, **kwargs, &block)
   end
 
   # Tell the object what to do in a given scenario.
@@ -85,9 +85,9 @@ module Direct
   #   puts "it failed!"
   # }.do_it
   #
-  # Your blocks will always receive the object itself as the first argument.
+  # Your blocks will *always* receive the object itself as the first argument.
   #
-  def direct(key, callable=nil, &block)
+  def direct(key, callable = nil, &block)
     __directions.store(key, callable || block)
     self
   end
@@ -103,10 +103,12 @@ module Direct
   # end
   #
   # This will raise an error if the provided key is not found
-  def as_directed(key, *args)
+  #
+  # The current value for self will be sent as the first argument to the block
+  def as_directed(key, ...)
     return if allow_missing_directions? && __directions.empty?
     __directions.fetch(key).map do |block|
-      block.call(self, *args)
+      block.call(self, ...)
     end
   rescue KeyError
     return if allow_missing_directions?
@@ -120,6 +122,6 @@ module Direct
   end
 
   def __directions
-    @__directions ||= Direct::Group.new
+    @__directions ||= Group.new
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: direct
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -31,18 +31,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
-- direct.gemspec
 - lib/direct.rb
+- lib/direct/exception_handler.rb
 - lib/direct/executable.rb
 - lib/direct/group.rb
 - lib/direct/strict_executable.rb
@@ -59,14 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Direct objects to perform arbitrary blocks by name

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock
-coverage

data/.travis.yml

@@ -1,28 +0,0 @@
-sudo: false
-before_install:
-  - gem update --system
-  - gem install bundler
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.6
-  - 2.4.4
-  - 2.5.3
-  - 2.6.1
-  - ruby-head
-  - jruby-head
-env:
-  global:
-    - CC_TEST_REPORTER_ID=3c4cb48bcc4e29bb3292e99b7736c6dd7c13d0f6a908785e164d03666f5070cc
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rake
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem "rake", "~> 12.3"
-gem "minitest", "~> 5.11"
-gem "pry-byebug"
-gem "simplecov", require: false, group: :test

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "direct"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/direct.gemspec

@@ -1,25 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "direct/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "direct"
-  spec.version       = Direct::VERSION
-  spec.authors       = ["Jim Gay"]
-  spec.email         = ["jim@saturnflyer.com"]
-
-  spec.summary       = %q{Direct objects to perform arbitrary blocks by name}
-  spec.description   = %q{Direct objects to perform arbitrary blocks by name}
-  spec.homepage      = "https://github.com/saturnflyer/direct"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "concurrent-ruby", ">= 1.0"
-end