dried_interaction 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb3c6571b1286ed2e0f2b327efb07eacb17bb0f6e6edca8355d6081de014bae
-  data.tar.gz: 44c570ac8b377f963bcde0d78de4bf67e3fbe57bd39ef4216e15c31b686909b5
+  metadata.gz: fc03f8cdd296c8e6d4e02569d36c852230788f2e3fcdbfea27190e9dc7b4ceac
+  data.tar.gz: 43c97474d74f55612a51bb37b30e6a378b80d1a983d90662efb9fd74f04a67ab
 SHA512:
-  metadata.gz: 19f0b433ebed93ee5d903cdf794af2827582642445ea7a21bdb0410915a54807cb9011c42b26ea131c4a3b3fc2e0df5568a63ce93a6e60b0de8fab3a246767bb
-  data.tar.gz: ddbf74d37d6e4d8cacb5a56d6e6833362122f0b3f3250ea3ddedae6835221a9b016d932b18e70bb3bcdafe6e116b6729f36b329c6912cfdaef9733459e0727cc
+  metadata.gz: 174a2ad3439cb18b6e9e929ac2b838daa914d12dbb42c98360bf31bc5b66d79bba0e3fd01d883b73833e8c5ab43a6d431ea59ddf67155ca162ff15489409c76c
+  data.tar.gz: 24548abcd09e1b2ee14ca632eb559815fbdb4477982ac2ee890d7c72430bb7155e6cb038bc803976108e2c313a44e07778a29d622f812840a1ab5abd79b162ec

data/.gitignore

@@ -6,6 +6,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+dried_interaction-*.gem
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -18,11 +18,6 @@ Or install it yourself as:
 
     $ gem install dried_interaction
 
-## Why it may be useful to you
-1. Keeps your business logic typed
-2. Validates interactor input data by default
-3. Includes incredible DRY stack gems by default for yours interactors
-
 ## Usage
 ### Setting up an interactor
 For setting up an interactor you need to include DriedInteraction into your class.
@@ -63,10 +58,34 @@ class PublishPost
 end
 ```
 
+### Contract options
+You can pass to contract some options which will customize contract logic.
+1. `kind`. Explains which type of validator you will use.
+Available values: `simple` (By default) and `extended`
+`simple` kind uses simple `Dry::Schema.Params`
+`extended` kind uses more complex `Dry::Validation.Contract`
+
+```rb
+  contract(kind: :simple) do ... end
+  # or
+  contract(kind: :extended) do ... end
+```
+
+2. `mode`. Explains how to handle contract validation errors.
+Available values: `strict` (By default) and `soft`
+`strict` mode raises exception when contract check fails.
+`soft`  mode returns Failure monad with error info when contract check fails.
+
+```rb
+  contract(mode: :strict) do ... end # => raise DriedInteractionError
+  # or
+  contract(mode: :soft) do ... end # => returns Failure(DriedInteractionError)
+```
+
 ### Interactor calling
 
 ```rb
-PublishPost.new.call(user, params) do |interactor|
+PublishPost.new.call({ user: user, params: params }) do |interactor|
   interactor.success do |post|
     # handle success
   end
@@ -77,10 +96,22 @@ PublishPost.new.call(user, params) do |interactor|
 end
 ```
 
-## Additional info
+When you use `soft` mode you can handle contract failure as divided failure case:
+```rb
+  PublishPost.new.call({ user: user, params: params }) do |interactor|
+  interactor.success do |post|
+    # handle success
+  end
+
+  interactor.failure(DriedInteractionError) do |error|
+    #  handle contract validation error
+  end
 
-1. You have to return a monad from interactor as result.
-2. Contract failure will be handled as exception.
+  interactor.failure do |error|
+    # handle failure
+  end
+end
+```
 
 ## Contributing
 

data/lib/dried_interaction/dsl.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'dry/validation'
+require 'dry/schema'
+require 'dried_interaction/instance_methods'
+
+module DriedInteraction
+  module Dsl
+    MODES = %i[strict soft].freeze
+    attr_accessor :contract_validator, :contract_mode, :for_method
+
+    def contract(kind: :simple, mode: MODES.first, &block)
+      @contract_mode = resolve_contract_mode(mode)
+      @contract_validator = resolve_contract_validator(kind, &block)
+    end
+
+    def soft_contract(args = {}, &block)
+      contract(args.merge(mode: :soft), &block)
+    end
+
+    def strict_contract(args = {}, &block)
+      contract(args.merge(mode: :strict))
+    end
+
+    private
+
+    def resolve_contract_mode(mode)
+      MODES.include?(mode.to_sym) ? mode.to_sym : (raise ArgumentError)
+    end
+
+    def resolve_contract_validator(kind, &block)
+      case kind
+      when :simple
+        Dry::Schema.Params(&block)
+      when :extended
+        Dry::Validation.Contract(&block)
+      when Dry::Schema::Params
+        kind.merge(Dry::Schema.Params(&block))
+      when Dry::Validation::Contract
+        kind.build(&block)
+      else
+        raise ArgumentError
+      end
+    end
+  end
+end

data/lib/dried_interaction/instance_methods.rb

@@ -1,19 +1,25 @@
 # frozen_string_literal: true
 
+require 'dry/monads'
 require 'dried_interaction/error'
 
 module DriedInteraction
   module InstanceMethods
+    include Dry::Monads[:result]
+
     def call(*args)
       interaction_contract_error('Call method allows only one argument') if args.size != 1
-
       arg = args.first
+
       contract = self.class.contract_validator
+      interaction_contract_error('Contract must be filled') if arg && !contract
+
       contract_params = fetch_contract_params(contract)
-      check_params_presence_in_args(contract_params, arg.keys)
+      check_result = check_params_presence_in_args(contract_params, arg.keys)
+      return check_result if check_result&.failure?
 
       contract_result = contract.(arg)
-      return interaction_contract_error(contract_result.errors.messages) if contract_result.failure?
+      return interaction_contract_error(contract_result.errors) if contract_result.failure?
 
       super(arg)
     end
@@ -32,7 +38,16 @@ module DriedInteraction
     end
 
     def interaction_contract_error(msgs)
-      raise DriedInteractionError, class: self.class.to_s, errors: Array.wrap(msgs).join('; ')
+      error = DriedInteractionError.new(class: self.class.to_s, errors: msgs)
+
+      case self.class.contract_mode
+      when :strict
+        raise error
+      when :soft
+        Failure(error)
+      else
+        raise ArgumentError
+      end
     end
   end
 end

data/lib/dried_interaction/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DriedInteraction
-  VERSION = '0.1.1'
+  VERSION = '0.3.0'
 end

data/lib/dried_interaction.rb

@@ -5,12 +5,12 @@ require 'dry/matcher/result_matcher'
 require 'dry/monads'
 require 'dry-initializer'
 
-require 'dried_interaction/class_methods'
+require 'dried_interaction/dsl'
 require 'dried_interaction/instance_methods'
 
 module DriedInteraction
   def self.included(klass)
-    klass.extend(ClassMethods)
+    klass.extend(Dsl)
     klass.extend(Dry::Initializer)
 
     klass.prepend(InstanceMethods)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dried_interaction
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - gl-pv
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -140,10 +140,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- dried_interaction-0.1.0.gem
 - dried_interaction.gemspec
 - lib/dried_interaction.rb
-- lib/dried_interaction/class_methods.rb
+- lib/dried_interaction/dsl.rb
 - lib/dried_interaction/error.rb
 - lib/dried_interaction/instance_methods.rb
 - lib/dried_interaction/version.rb

data/lib/dried_interaction/class_methods.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry/validation'
-require 'dry/schema'
-
-module DriedInteraction
-  module ClassMethods
-    attr_accessor :contract_validator
-
-    def contract(kind = :simple, &block)
-      case kind
-      when :simple
-        @contract_validator = Dry::Schema.Params(&block)
-      when :extended
-        @contract_validator = Dry::Validation.Contract(&block)
-      else
-        raise ArgumentError
-      end
-    end
-  end
-end