piper-rb 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 187f1b8d52a186cffd6c89657c0521ef8f6c6e645b6d37d522c49ef4c89a5e8e
-  data.tar.gz: a33dcc6e4900a897d6b35bf9b4f11e1d0076e622d62568b4b5455d639c392ea8
+  metadata.gz: 5b0d0ee76dc848c05fa9836adee64daaf9bc8d7397e7da2124d666b00b5af36f
+  data.tar.gz: 2e24b4e3d12b005b74a7da2babe135df101cd6c29fe698b97c1c2f5f1e7e53c3
 SHA512:
-  metadata.gz: e564290a072a282ac5cef63e42b1fb9449968ecab94f72d6ad9112bba9c8c1e44295703a09e96679b36642ee60632e44385f24b1760470b74a41d6672907a453
-  data.tar.gz: be8b7f693a219e707a4f092b7d2dfff7cd7ef8288f52ea506c0a376d75a78cc0a07bde32f3a7a1796a85b5c57803f9394bbe82211614e3f4acdda7d1ec8a329c
+  metadata.gz: 5b6bf69c81b2bc7f347bdb4082a0ed06faee2e207d13cd366e3d46e89c4a76754a52b284469ea33a2f338bec4241157420bf87ca00ea79769e30a08f803a7e0b
+  data.tar.gz: 0b1a5106dd21e07816772c7309c46c76cd5ded08845522483503563b0dfdc25cf5ab3c1e4800602c57cf8345f2905e651ca46ac47828b43cc822043c01ce471d

data/README.md

@@ -10,7 +10,7 @@ gem "piper-rb"
 
 ## Usage
 
-### super basic
+### Super basic
 
 The most basic element of `Piper` is a `pipe`.
 Just think of it as a condition step. If no keywords are used, then (in accordance to Ruby
@@ -47,7 +47,7 @@ YourSuperbService.new(input: "asd").call
 
 ```
 
-### keywords for more control
+### Keywords for more control
 
 If you want to specify the condition, object to be returned and the error message, there are
 keywords for this:
@@ -90,7 +90,7 @@ YourFineService.new(input: "asd").call
 
 ```
 
-### you can access last step's object with `last_result`:
+### You can access last step's object with `last_result`:
 
 ```ruby
 require "piper-rb"
@@ -112,7 +112,7 @@ YourGreatService.new(input: 20).call
 #=> Success(600)
 ```
 
-### you can nest services, calling them in a pipe passes their result:
+### You can nest services, calling them in a pipe passes their result:
 
 ```ruby
 require "piper-rb"
@@ -145,3 +145,25 @@ YourMajesticService.new(input: 20).call
 YourMajesticService.new(input: 2).call
 #=> Failure({:service=>#<YourFlamboyantService nested_input=40>, :object=>false, :message=>"I am the one who knocks!"})
 ```
+
+---
+
+### You can configure default `nil` behavior.
+
+By default, pipes fail when they end in `nil` and do not handle exceptions.
+You can, of course, explicitly return `true` in order to make sure a pipe is successful, even if it ended in `nil`.
+
+
+But in 0.4 you now have an option to tweak the default behavior, by using `pass_nil`. Bear in mind this option is inherited, so if your services inherit from, say, `BaseService`, then this - unless overwritten in a given service – will affect all services:
+
+Refer to [specs](https://github.com/ellmo/piper-rb/blob/master/spec/service/configured_service_spec.rb) for more info.
+
+```ruby
+require "piper-rb"
+
+class BaseService < PiperService
+  pass_nil true
+
+  # [...]
+end
+```

data/lib/piper/dsl/piper_config.rb

@@ -1,7 +1,7 @@
 module PiperDSL
   module PiperConfig
-    DEFAULT__PASS_NIL       = false
-    DEFAULT__PASS_EXCEPTION = false
+    DEFAULT__PASS_NIL         = false
+    DEFAULT__HANDLE_EXCEPTION = false
 
     def self.included(base)
       base.extend(ClassMethods)
@@ -22,18 +22,26 @@ module PiperDSL
                         end
       end
 
-      def pass_exception(val)
-        @__pass_exception = val
+      def handle_exception(val)
+        @__handle_exception = val
       end
 
-      def pass_exception?
-        @__pass_exception ||= if defined?(@__pass_exception)
-                                @__pass_exception
-                              elsif superclass < PiperService
-                                superclass.pass_exception?
-                              else
-                                DEFAULT__PASS_EXCEPTION
-                              end
+      def handle_exception?
+        @__handle_exception ||= if defined?(@__handle_exception)
+                                  @__handle_exception
+                                elsif superclass < PiperService
+                                  superclass.handle_exception?
+                                else
+                                  DEFAULT__HANDLE_EXCEPTION
+                                end
+      end
+
+      def skip_transaction!
+        @__skip_transaction = true
+      end
+
+      def skip_transaction?
+        !@__skip_transaction.nil?
       end
 
       def debug_steps
@@ -49,8 +57,12 @@ module PiperDSL
       self.class.pass_nil?
     end
 
-    def pass_exception?
-      self.class.pass_exception?
+    def handle_exception?
+      self.class.handle_exception?
+    end
+
+    def skip_transaction?
+      self.class.skip_transaction?
     end
 
     def debug_steps?

data/lib/piper/dsl/piper_pipe.rb

@@ -4,9 +4,11 @@ module PiperDSL
 
     attr_reader :service
 
-    def initialize(step_name, &block)
-      @step_name  = step_name
-      @block      = block
+    def initialize(step_name, **options, &block)
+      @step_name        = step_name
+      @block            = block
+      @pass_nil         = options[:pass_nil]
+      @handle_exception = options[:handle_exception]
     end
 
     def perform(service, last_result = nil)
@@ -30,7 +32,7 @@ module PiperDSL
     def prepare_response!(condition)
       if condition
         Success(@result_object || true)
-      elsif condition.nil? && service.pass_nil?
+      elsif condition.nil? && pass_nil?
         Success(nil)
       else
         failure_object = { service: service, object: @fail_object, message: service.message }
@@ -41,9 +43,17 @@ module PiperDSL
     end
 
     def pass_exception!(exception)
-      raise exception unless service.pass_exception?
+      raise exception unless handle_exception?
 
       Failure(service: service, object: exception, message: exception.message)
     end
+
+    def pass_nil?
+      @pass_nil.nil? ? service.pass_nil? : @pass_nil
+    end
+
+    def handle_exception?
+      @handle_exception.nil? ? service.handle_exception? : @handle_exception
+    end
   end
 end

data/lib/piper/piper_service.rb

@@ -26,7 +26,7 @@ class PiperService < Dry::Struct
   def call
     result = nil
 
-    if defined? ActiveRecord::Base
+    if defined?(ActiveRecord::Base) && !skip_transaction?
       ActiveRecord::Base.transaction do
         result = perform_steps
 
@@ -39,10 +39,10 @@ class PiperService < Dry::Struct
     result
   end
 
-  def self.pipe(desc, &block)
+  def self.pipe(desc, **options, &block)
     raise ArgumentError, "missing block" unless block_given?
 
-    pipepart = PiperDSL::Pipe.new(desc, &block)
+    pipepart = PiperDSL::Pipe.new(desc, options, &block)
 
     service_steps << pipepart
   end

data/lib/piper/version.rb

@@ -1,3 +1,3 @@
 module PiperGem
-  VERSION = "0.4.0".freeze
+  VERSION = "0.4.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piper-rb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jakub Żuchowski