porch 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9cef9297ff144b552ab8420b515835966552f80
-  data.tar.gz: 3af8a85e568ef39b7c7a8dcea322db10771e116b
+  metadata.gz: 3d75a6afe5bf346fc7d606bbbd64798a9fcae8bf
+  data.tar.gz: 1db71b1a31943f9ec633ba627e1f758d7afd8162
 SHA512:
-  metadata.gz: 1872d33f21dcae52e1a899201bf911511e4aeb09c891bbb109712567aa8ed93af03d4f24a2917cb80edbc1d80700066e8ff0005fe6bb106451bcc660954d9fec
-  data.tar.gz: acdc0dca275b84e6c27a2d2649f1a6ae706fe831fbf0d47354a4e9a2d8f1acc454eebfd598041cd2d84ae982f570bea9f31478580407ec78a10a0c3ba092ec3e
+  metadata.gz: f1ad2be642145f3e72c1d00a883020edcee579f92c568d64446db4a192fe3094af2cd33f204c9ddff6b548f3dd923ecf33f648fad87d05d0c6732ca8cdfb9466
+  data.tar.gz: 5745ce3d37f53abac0355f5a177dc98679e32cc1b727c5da9cebc366e484a9db6ee3d7e9bfa3ee914375eeab5c89e69c3f90657486e806b9dc8480450c9f860f

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    porch (0.3.0)
+    porch (0.3.1)
       dry-validation (~> 0.10.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.0.4)
+    concurrent-ruby (1.0.5)
     diff-lcs (1.2.5)
     dry-configurable (0.5.0)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -74,28 +74,6 @@ end
 
 ### Defining steps or actions
 
-You can define steps as classes and include some nice helper methods. (COMING SOON)
-
-```
-# app/services/steps/create_user.rb
-
-require "porch"
-
-class CreateUser
-  include Porch::Step
-
-  params do
-    required(:email).filled(type?: :str, format?: RegEx.email_address)
-    required(:password).filled(type?: :str, min_size?: 8)
-  end
-
-  def call(context)
-    context.user = User.create email: context.email, password: context.password
-    context.fail! context.user.errors unless context.user.valid?
-  end
-end
-```
-
 You can define steps as PORO classes that respond to a call method.
 
 ```
@@ -199,6 +177,40 @@ if result.failure?
 end
 ```
 
+### Handling/rescuing from errors
+
+Errors may be raised within your steps at any point and you may want to handle those errors gracefully.
+
+You can use the `rescue_from` error handlers to handle various errors gracefully. The error handler will be called for the type of error or a descendent of the type of error.
+
+You can `rescue_from` various errors with a method.
+
+```
+class RegistersUser
+  include Porch::Organizer
+
+  rescue_from [Net::SMTPAuthenticationError, Net::SMTPServerBusy], with: :smtp_error
+
+  private
+
+  def smtp_error(exception)
+    logger.error exception
+  end
+end
+```
+
+You can `rescue_from` various errors with a block.
+
+```
+class RegistersUser
+  include Porch::Organizer
+
+  rescue_from Net::SMTPAuthenticationError do |exception|
+    logger.error exception
+  end
+end
+```
+
 ### Skipping steps
 
 At any step, you can skip the remaining actions in the organizer. This stops the running of the remaining actions but the `Porch::Context` will still return a successful `Porch::Context`.

data/lib/porch.rb

@@ -5,6 +5,7 @@ require "porch/executable_step_decorator"
 require "porch/human_error"
 require "porch/guard_rail"
 require "porch/organizer"
+require "porch/rescuable"
 require "porch/step_chain"
 require "porch/version"
 

data/lib/porch/organizer.rb

@@ -1,3 +1,5 @@
+require_relative "rescuable"
+
 module Porch
   module Organizer
     attr_reader :context
@@ -5,10 +7,18 @@ module Porch
     def with(parameters={})
       @context = Context.new parameters
 
-      chain = StepChain.new(self)
-      yield chain if block_given?
+      handle_exceptions do
+        chain = StepChain.new(self)
+        yield chain if block_given?
+
+        chain.execute context
+      end
+    end
 
-      chain.execute context
+    def self.included(base)
+      base.class_eval do
+        include Rescuable
+      end
     end
   end
 end

data/lib/porch/rescuable.rb

@@ -0,0 +1,52 @@
+module Porch
+  module Rescuable
+    def handle_exceptions
+      yield if block_given?
+    rescue Exception => e
+      rescue_with_handler(e) || raise(e)
+    end
+
+    def handler_for_rescue(exception)
+      _, handler = self.class.rescue_handlers.detect do |exception_class, _|
+        exception_class === exception
+      end
+
+      handler
+    end
+
+    def rescue_with_handler(exception)
+      handler = handler_for_rescue(exception)
+      unless handler.nil?
+        case handler
+        when Symbol
+          self.method(handler).call exception
+        when Proc
+          self.instance_exec exception, &handler
+        end
+
+        exception
+      end
+    end
+
+    module ClassMethods
+      def rescue_from(*klasses, with: nil, &block)
+        handler = block_given? ? block : with
+        raise ArgumentError, \
+          "Requires a handler. Use the with keyword argument or supply a block." \
+          if handler.nil?
+
+        klasses.each do |klass|
+          rescue_handlers << [klass, handler]
+        end
+      end
+
+      def rescue_handlers
+        @rescue_handlers ||= []
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end

data/lib/porch/version.rb

@@ -1,3 +1,3 @@
 module Porch
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: porch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jamie Wright
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -93,6 +93,7 @@ files:
 - lib/porch/guard_rail/guard.rb
 - lib/porch/human_error.rb
 - lib/porch/organizer.rb
+- lib/porch/rescuable.rb
 - lib/porch/step_chain.rb
 - lib/porch/step_decorators/class_step_decorator.rb
 - lib/porch/step_decorators/method_step_decorator.rb
@@ -101,6 +102,8 @@ files:
 - pkg/porch-0.1.0.gem
 - pkg/porch-0.2.0.gem
 - pkg/porch-0.2.1.gem
+- pkg/porch-0.3.0.gem
+- pkg/porch-0.3.1.gem
 - porch.gemspec
 homepage: https://github.com/jwright/porch
 licenses:
@@ -122,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A simple service layer pattern for plain old Ruby objects.