direct 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 27fe15c82f220ce786dad7ac7fc5104ed0b8a94c
-  data.tar.gz: 8f9d2316648c6c4b16d4780f9d4468237ce2583d
+SHA256:
+  metadata.gz: fa39232af5f66ca2043ac1b5e258a26e6869b8c012ccaa0661080e89a7644ea8
+  data.tar.gz: 2d9ad86998c6903f6c3146258cf278ec0deac829ac96e8ffb85f47967e1e2c4c
 SHA512:
-  metadata.gz: f3b80b10949809a4d16dec4b7be942cfb51ca80b80fdae3420bf9ee69ec84ab12d3770ce965fa45269b6e88f16f6dabf242a478aa254ff124c302f220394e8cc
-  data.tar.gz: 792b7bdf1ea01b24d42f8f28151cc46264efa84115a99f3219b31c494ecbfd9c3c93e848be073dcc7030357acfea47dcfe7161723a81f03cc93d43350728e8e7
+  metadata.gz: 4afc48c61d7b189f49b016af2419f54f03a114d5ad5cfcfcfeaa12373e8787d655b651f223e1b9f45b3adef88124c701f452c6077fc3bdc76380d5a3597ed415
+  data.tar.gz: bef096a5f6212ca376b919ed1238da53571a9fea95631352686acfe49c6ea8b1b7ec071496dfebbdfd33537c81e7cafefad894eaf6d9e668fbc4cfb03ad3883b

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+coverage

data/.travis.yml

@@ -1,13 +1,14 @@
 sudo: false
 before_install:
-  - gem install bundler -v 1.16.1
+  - gem update --system
+  - gem install bundler
 language: ruby
 cache: bundler
 rvm:
-  - 2.2.9
   - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.4.4
+  - 2.5.3
+  - 2.6.1
   - ruby-head
   - jruby-head
 env:

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Version 1.1.0
+
+Use Direct module to build deferred object internals.
+
+## Version 1.0.0
+
+Initial release

data/Gemfile

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in direct.gemspec
 gemspec
+
+gem 'simplecov', require: false, group: :test

data/README.md

@@ -21,13 +21,15 @@ end
 
 # Somewhere else
 
-SomeClass.new.direct(:success){|*data|
+SomeClass.new.direct(:success){|something, *data|
   STDOUT.puts data
-}.direct(:failure){|*errors|
+}.direct(:failure){|something, *errors|
   STDERR.puts errors
 }.save
 ```
 
+Your blocks will always receive the object itself as the first argument.
+
 ## Why?
 
 You could easily write code that says `if` this `else` that.
@@ -63,7 +65,7 @@ if something.save!
   puts "yay! #{something}"
 elsif something.valid? && !something.persisted?
   puts "it sort of worked"
-elseif !something.valid? || something.need_some_other_thing_set?
+elsif !something.valid? || something.need_some_other_thing_set?
   puts "an alternative to it not working"
 else
   puts "boo! #{something}: #{something.errors}"
@@ -77,13 +79,13 @@ Instead, we can name these scenarios and allow the object to handle them; we
 merely provide the block of code to execute:
 
 ```ruby
-Something.new.direct(:success){|the_object|
-  puts "yay! #{the_object}"
-}.direct(:failure){ |the_object, errors|
-  puts "boo! #{the_object}: #{errors}"
-}.direct(:other_scenario){|the_object|
-  puts "here's what happened and what to do..."
-}
+Something.new.direct(:success){ |obj|
+    puts "yay! #{obj}"
+  }.direct(:failure){ |obj, errors|
+    puts "boo! #{obj}: #{errors}"
+  }.direct(:other_scenario){ |obj|
+    puts "here's what happened and what to do..."
+  }
 ```
 
 _Inside_ of the object is where we can handle these named scenarios. If the

data/direct.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "concurrent-ruby", ">= 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "minitest", "~> 5.11"
 end

data/lib/direct.rb

@@ -1,9 +1,30 @@
 require "direct/version"
-require "concurrent"
+require "direct/executable"
+require "direct/group"
 
 # Include this module in your classes to provide a way for
 # your objects to handle named scenarios with blocks of code.
 module Direct
+  class MissingProcedure < StandardError; end
+
+  # Wrap a block of code to return an object for handling
+  # success or failure.
+  #
+  # Example:
+  #
+  #   def do_it
+  #     Direct.defer{
+  #       [true, false].sample
+  #     }
+  #   end
+  #   do_it.
+  #     success{|result| puts "it worked!" }.
+  #     failure{|result| puts "it failed!" }
+  #
+  def self.defer(&block)
+    Executable.new(&block)
+  end
+
   # Tell the object what to do in a given scenario.
   #
   # object.direct(:success){|obj| puts "it worked!" }
@@ -11,16 +32,19 @@ module Direct
   #
   # You may also chain calls to this method
   #
-  # object.direct(:success){ |obj| 
+  # object.direct(:success){ |obj|
   #   puts "it worked!"
   # }.direct(:failure){ |obj|
   #   puts "it failed!"
   # }.do_it
-  # 
-  def direct(key, &block)
-    __direct_store(key, block)
+  #
+  # Your blocks will always receive the object itself as the first argument.
+  #
+  def direct(key, callable=nil, &block)
+    __directions.store(key, callable || block)
     self
   end
+  alias_method :when, :direct
 
   # Perform the named block of code
   #
@@ -33,21 +57,16 @@ module Direct
   #
   # This will raise an error if the provided key is not found
   def as_directed(key, *args)
-    __direct_store_fetch(key).each do |block|
+    __directions.fetch(key).map do |block|
       block.call(self, *args)
     end
+  rescue KeyError
+    raise MissingProcedure, "Procedure for :#{key} was reached but not specified."
   end
 
   private
 
-  def __direct_store(key, block)
-    @__direct_store ||= Concurrent::Map.new
-    @__direct_store.put_if_absent(key, Concurrent::Array.new)
-    @__direct_store.fetch(key) << block
-    @__direct_store
-  end
-
-  def __direct_store_fetch(key)
-    @__direct_store.fetch(key)
+  def __directions
+    @__directions ||= Direct::Group.new
   end
 end

data/lib/direct/executable.rb

@@ -0,0 +1,91 @@
+module Direct
+  class Executable
+    include Direct
+
+    # It is intended that you initialize objects via Direct.defer
+    # and not directly initializing this class.
+    #
+    # You may initialize this class and provide an object which
+    # responds to "call" or a block to execute.
+    #
+    # Example:
+    #
+    #   Direct.defer do
+    #     puts "see ya later!"
+    #   end
+    #
+    #   Direct.defer(->{ "call me, maybe" })
+    #
+    def initialize(callable=nil, &block)
+      @execution = callable || block
+      @exception_classes = [StandardError]
+    end
+    attr_reader :execution, :exception_classes
+
+    # 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.defer {
+    #      # something...
+    #   }.exception(NoMethodError) { |deferred, exception|
+    #      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)
+      else
+        as_directed(:failure, exception)
+      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.
+    #
+    def value
+      result = execution.()
+      if result
+        as_directed(:success, result)
+      else
+        as_directed(:failure, result)
+      end
+    rescue *exception_classes => exception
+      run_exception_block(exception)
+    end
+    alias execute value
+  end
+end

data/lib/direct/group.rb

@@ -0,0 +1,26 @@
+require 'concurrent'
+module Direct
+  class Group
+    def initialize
+      @map = Concurrent::Map.new{|collection, key|
+        collection.put(key, Concurrent::Array.new)
+      }
+    end
+
+    attr_reader :map
+    private :map
+
+    def store(key, callable=nil, &block)
+      map[key] << (callable || block)
+      self
+    end
+
+    def fetch(key)
+      map.fetch(key)
+    end
+
+    def key?(key)
+      map.key?(key)
+    end
+  end
+end

data/lib/direct/version.rb

@@ -1,3 +1,3 @@
 module Direct
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: direct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jim Gay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -84,6 +71,8 @@ files:
 - bin/setup
 - direct.gemspec
 - lib/direct.rb
+- lib/direct/executable.rb
+- lib/direct/group.rb
 - lib/direct/version.rb
 homepage: https://github.com/saturnflyer/direct
 licenses:
@@ -104,8 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Direct objects to perform arbitrary blocks by name