pathway 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10f9020a8388d7f7aa7f4f321d506d98f2ce59ec
-  data.tar.gz: a7d8dc64b79bf6a19f52f5cf78e59e0f9e9faae3
+  metadata.gz: 18bbd2169b9b1ce06075cb6b44ba3785f5853019
+  data.tar.gz: 6d94d279e070945bffd59a23e20a4fbcf7a90219
 SHA512:
-  metadata.gz: 9a0cb43cf90894f6c9f19692bc33eca3ee6eaf6dd834d88ebbee0261447c70a7f0f96a3f05098d6339561de34fb65393708529c713b383b31779738c79748d50
-  data.tar.gz: 9c66e74dafc09384a8d2f06df57490206a8e5e9cf756765085fd4b56353a498a388eedd2abc4d03c8d4d997ac1ba284e74feb087d77bce67a800c6ede04cad5b
+  metadata.gz: '095c9f17c4484b2dd8da4d9d98ac37e41845b4493c703cb98704bf2523f5cd14656528dd162f47cda8d4ea940e53861c351d1b9f7888c0589a36f562c7fa1bb8'
+  data.tar.gz: 5213eb74c0080d343f9e52a6f805101cd5a4052e7bd7dbad3d83fa01f4b15e502fcf212b2a8e1d666d41af8d6449cd15cbc2c78b2f363dab41fd947d32c13204

data/CHANGELOG.md

@@ -1,7 +1,15 @@
+## [0.8.0] - 2018-10-01
+### Changed
+- Added support for `dry-validation` 0.12.x
+- Renamed DSL method `sequence` to `around`. Keep `sequence` as an alias although, it may be deprecated on a future mayor release.
+- Renamed DSL method `guard` to `if_true`. Keep `guard` as an alias, although it may be deprecated on a future mayor release.
+- Added DSL method `if_false`, which behaves like `if_true` but checks the passed predicate is false instead.
+- Moved `Responder` class inside the `responder` plugin module.
+
 ## [0.7.0] - 2018-09-25
 ### Changed
 - `sequel_models` plugin now automatically adds an optional context parameter to preload the model and avoid hitting the db on `:fetch_model` when the model is already available.
-- Add `:set_context_param` option for `sequel_models` plugin to prevent adding the context parameter to preload the model into the context.
+- Added `:set_context_param` option for `sequel_models` plugin to prevent trying to preload the model from the context.
 - Allow `authorization` block to take multiple parameters on `simple_auth` plugin.
 
 ## [0.6.2] - 2018-05-19
@@ -10,22 +18,22 @@
 
 ## [0.6.1] - 2018-03-16
 ### Changed
-- Update default error message for `:fetch_model` step, at `sequel_models` plugin, to indicate the model's name
-- Add `:error_message` option for `sequel_models` plugin initializer to set the default error message
-- Add `:error_message` option for `:fetch_model` step to override the default error message
+- Updated default error message for `:fetch_model` step, at `sequel_models` plugin, to indicate the model's name
+- Added `:error_message` option for `sequel_models` plugin initializer to set the default error message
+- Added `:error_message` option for `:fetch_model` step to override the default error message
 
 ## [0.6.0] - 2018-03-01
 ### Changed
-- Replace unmaintained `inflecto` gem with `dry-inflector`
+- Replaced unmaintained `inflecto` gem with `dry-inflector`
 
 ## [0.5.1] - 2017-12-18
 ### Changed
-- Change behavior for `:fetch_model` step option `search_by:` to override both the search column and the input key (combine it with `using:` if you need a different value for the input key as well)
+- Changed behavior for `:fetch_model` step option `search_by:` to override both the search column and the input key (combine it with `using:` if you need a different value for the input key as well)
 - `:fetch_model` step will no longer hit the database if the input key is nil and just return a `:not_found` error instead
 
 ## [0.5.0] - 2017-11-06
 ### Changed
-- Change base class for `Pathway::Error` from `StandardError` to `Object`
+- Changed base class for `Pathway::Error` from `StandardError` to `Object`
 
 ## [0.4.0] - 2017-10-31
 ### Changed

data/README.md

@@ -385,7 +385,7 @@ class CreateNugget < Pathway::Operation
   context :user_name
 
   form do
-    configure { options :user_name }
+    configure { option :user_name }
 
     required(:owner).filled(:str?, :eql?: user_name)
     required(:price).filled(:int?)
@@ -411,7 +411,7 @@ class CreateNugget < Pathway::Operation
   context :current_user_name
 
   form do
-    configure { options :user_name }
+    configure { option :user_name }
 
     required(:owner).filled(:str?, :eql?: user_name)
     required(:price).filled(:int?)
@@ -621,7 +621,7 @@ module Pathway
             end
           end
 
-          sequence(transactional_seq, &steps)
+          around(transactional_seq, &steps)
         end
       end
 
@@ -655,9 +655,9 @@ Let's now examine the `fetch_model` step body, is not really that much different
 
 We finally see a `DSLMethods` module defined to extend the process DSL.
 For this plugin we'll define a way to group steps within an `ActiveRecord` transaction, much in the same way the `:sequel_models` plugin already does for `Sequel`.
-To this end we define a `transaction` method to expect a steps block and pass it down to the `sequence` helper below which expects a callable (like a `Proc`) and a step list block. As you can see the lambda we pass on the first parameter is the one that makes sure the steps are being run inside a transaction and to abort the transaction if the intermediate result is a failure.
+To this end we define a `transaction` method to expect a steps block and pass it down to the `around` helper below which expects a callable (like a `Proc`) and a step list block. As you can see the lambda we pass on the first parameter is the one that makes sure the steps are being run inside a transaction and to abort the transaction if the intermediate result is a failure.
 
-The `sequence` method is a low level tool available to help extending the process DSL and it may seem a bit daunting at first glance but it usage is quite simple, the block is just a step list like the ones we find inside the `process` call; and the parameter is a callable (usually a lambda), that will take 2 arguments, an object from which we can run the step list by invoking `call` (and is the only thing it can do), and the current state. From here we can examine the state and decide upon whether to run the steps, how many times (if any) or run some code before and/or after doing so, like what we need to do in our example to surround the steps within a DB transaction.
+The `around` method is a low level tool available to help extending the process DSL and it may seem a bit daunting at first glance but it usage is quite simple, the block is just a step list like the ones we find inside the `process` call; and the parameter is a callable (usually a lambda), that will take 2 arguments, an object from which we can run the step list by invoking `call` (and is the only thing it can do), and the current state. From here we can examine the state and decide upon whether to run the steps, how many times (if any) or run some code before and/or after doing so, like what we need to do in our example to surround the steps within a DB transaction.
 
 ### Testing tools
 

data/lib/pathway.rb

@@ -153,20 +153,28 @@ module Pathway
           @result = @result.then(bl)
         end
 
-        def sequence(steps_wrapper, &steps)
+        def around(wrapper, &steps)
           @result.then do |state|
             seq = -> { @result = dup.run(&steps) }
-            _callable(steps_wrapper).call(seq, state)
+            _callable(wrapper).call(seq, state)
           end
         end
 
-        def guard(cond, &steps)
+        def if_true(cond, &steps)
           cond = _callable(cond)
-          sequence(-> seq, state {
+          around(-> seq, state {
             seq.call if cond.call(state)
           }, &steps)
         end
 
+        def if_false(cond, &steps)
+          cond = _callable(cond)
+          if_true(-> state { !cond.call(state) }, &steps)
+        end
+
+        alias_method :sequence, :around
+        alias_method :guard, :if_true
+
         private
 
         def wrap(obj)

data/lib/pathway/plugins/dry_validation.rb

@@ -10,7 +10,7 @@ module Pathway
         def form(base = nil, **opts, &block)
           if block_given?
             base ||= _base_form
-            self.form_class = Dry::Validation.Form(_form_class(base), _form_opts(opts), &block)
+            self.form_class = _block_definition(base, opts, &block)
           elsif base
             self.form_class = _form_class(base)
           else
@@ -37,7 +37,7 @@ module Pathway
         private
 
         def _base_form
-          superclass.respond_to?(:form_class) ? superclass.form_class : Dry::Validation::Schema::Form
+          superclass.respond_to?(:form_class) ? superclass.form_class : DefaultFormClass
         end
 
         def _form_class(form)
@@ -72,9 +72,29 @@ module Pathway
       end
 
       def self.apply(operation, auto_wire_options: false)
-        operation.form_class = Dry::Validation::Schema::Form
+        operation.form_class = DefaultFormClass
         operation.auto_wire_options = auto_wire_options
       end
+
+      if Dry::Validation::VERSION[/\A0\.(\d+).\d+\Z/, 1].to_i >= 12
+        DefaultFormClass = Dry::Validation::Schema::Params
+
+        module ClassMethods
+          private
+          def _block_definition(base, opts, &block)
+            Dry::Validation.Params(_form_class(base), _form_opts(opts), &block)
+          end
+        end
+      else
+        DefaultFormClass = Dry::Validation::Schema::Form
+
+        module ClassMethods
+          private
+          def _block_definition(base, opts, &block)
+            Dry::Validation.Form(_form_class(base), _form_opts(opts), &block)
+          end
+        end
+      end
     end
   end
 end

data/lib/pathway/plugins/responder.rb

@@ -1,12 +1,44 @@
-require 'pathway/responder'
-
 module Pathway
   module Plugins
     module Responder
       module ClassMethods
         def call(ctx, *params, &bl)
           result = new(ctx).call(*params)
-          block_given? ? Pathway::Responder.respond(result, &bl) : result
+          block_given? ? Responder.respond(result, &bl) : result
+        end
+      end
+
+      class Responder
+        def self.respond(result, &bl)
+          r = new(result, &bl)
+          r.respond
+        end
+
+        def initialize(result, &bl)
+          @result, @context, @fails = result, bl.binding.receiver, {}
+          instance_eval(&bl)
+        end
+
+        def success(&bl)
+          @ok = bl
+        end
+
+        def failure(type = nil, &bl)
+          if type.nil?
+            @fail_default = bl
+          else
+            @fails[type] = bl
+          end
+        end
+
+        def respond
+          if @result.success?
+            @context.instance_exec(@result.value, &@ok)
+          elsif Error === @result.error && fail_block = @fails[@result.error.type]
+            @context.instance_exec(@result.error, &fail_block)
+          else
+            @context.instance_exec(@result.error, &@fail_default)
+          end
         end
       end
     end

data/lib/pathway/plugins/sequel_models.rb

@@ -5,17 +5,17 @@ module Pathway
     module SequelModels
       module DSLMethods
         def transaction(&bl)
-          sequence(-> seq, _ {
+          around(-> steps, _ {
             db.transaction(savepoint: true) do
-              raise Sequel::Rollback if seq.call.failure?
+              raise Sequel::Rollback if steps.call.failure?
             end
           }, &bl)
         end
 
         def after_commit(&bl)
-          sequence(-> seq, _ {
+          around(-> steps, _ {
             db.after_commit do
-              seq.call
+              steps.call
             end
           }, &bl)
         end

data/lib/pathway/version.rb

@@ -1,3 +1,3 @@
 module Pathway
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/pathway.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-inflector", ">= 0.1.0"
   spec.add_dependency "contextualizer", "~> 0.0.4"
 
-  spec.add_development_dependency "dry-validation", "~> 0.11.0"
+  spec.add_development_dependency "dry-validation", "~> 0.11"
   spec.add_development_dependency "bundler", ">= 1.14.0"
   spec.add_development_dependency "sequel", "~> 4.46.0"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pathway
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Pablo Herrero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2018-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +174,6 @@ files:
 - lib/pathway/plugins/responder.rb
 - lib/pathway/plugins/sequel_models.rb
 - lib/pathway/plugins/simple_auth.rb
-- lib/pathway/responder.rb
 - lib/pathway/result.rb
 - lib/pathway/rspec.rb
 - lib/pathway/rspec/matchers.rb

data/lib/pathway/responder.rb

@@ -1,35 +0,0 @@
-module Pathway
-  class Responder
-    def self.respond(result, &bl)
-      r = new(result, &bl)
-      r.respond
-    end
-
-    def initialize(result, &bl)
-      @result, @context, @fails = result, bl.binding.receiver, {}
-      instance_eval(&bl)
-    end
-
-    def success(&bl)
-      @ok = bl
-    end
-
-    def failure(type = nil, &bl)
-      if type.nil?
-        @fail_default = bl
-      else
-        @fails[type] = bl
-      end
-    end
-
-    def respond
-      if @result.success?
-        @context.instance_exec(@result.value, &@ok)
-      elsif Error === @result.error && fail_block = @fails[@result.error.type]
-        @context.instance_exec(@result.error, &fail_block)
-      else
-        @context.instance_exec(@result.error, &@fail_default)
-      end
-    end
-  end
-end