methodist 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4b0a1df657cf96583bdecf926cfa5beb74711aa2e942a47756e3eae03712ce8
-  data.tar.gz: ac96de08d5807f11da740f6356d246f2581c5befbe55e811b199cf6295935cd4
+  metadata.gz: 9a4de20033f56a487af8d2b4505604c19bc0c1262c73b81b8e0e6f7fcb3f0dce
+  data.tar.gz: 1c84021684ebfac6da5c09cfe87e55e83f9e104ec4ac67fc4b9e58a4c01db108
 SHA512:
-  metadata.gz: 934db6fde4c720b1cf7777a1107967a700c710c1430aeb3952b2dbb9021458848b4f243d2f0d5740098e6707002e785a6ae29aba770e41d45c9a1bcbb3c00da6
-  data.tar.gz: 45aea636ce515ddd5a5e8366e3d6cf337d16e18f93e675399c57cee8fcfe6003e555c1937268ee4d4eee87870590e91328d75451308470974c927125ecaba9c2
+  metadata.gz: cc2c157aca7127c5d6f8815ea9324dbce2341b5862b377b77bdff553276aa58275e46661c71a7b710d2119a5ebb9e13d160f8b2f68c7c6ee9e306fb03af259af
+  data.tar.gz: 1d592b18cc8befb21003dea5d43970acfe8fa258d251076f593eb0f83c722f759e4b7b91abca893cad1b1096004a635d1d9b494a63cc07b78d0cc8aa4e53ca31

data/lib/generators/builder/builder_generator.rb

@@ -7,8 +7,10 @@ class BuilderGenerator < MethodistGenerator
   PATTERN_FOLDER     = 'builders'.freeze
   TEMPLATE_FILE      = 'builder.erb'.freeze
   TEMPLATE_SPEC_FILE = 'builder_spec.erb'.freeze
+  PARENT_CLASS       = 'Methodist::Builder'.freeze
 
   class_option 'path',  type: :string,  desc: "Parent module for a new builder", default: PATTERN_FOLDER
+  class_option 'parent', type: :string, desc: "Parent class of generated class", default: PARENT_CLASS
 
   def generate
     template(

data/lib/generators/client/client_generator.rb

@@ -7,8 +7,10 @@ class ClientGenerator < MethodistGenerator
   PATTERN_FOLDER     = 'clients'.freeze
   TEMPLATE_FILE      = 'client.erb'.freeze
   TEMPLATE_SPEC_FILE = 'client_spec.erb'.freeze
+  PARENT_CLASS       = 'Methodist::Client'.freeze
 
   class_option 'path',  type: :string,  desc: "Parent module for a new client", default: PATTERN_FOLDER
+  class_option 'parent', type: :string, desc: "Parent class of generated class", default: PARENT_CLASS
 
   def generate
     template(

data/lib/generators/interactor/interactor_generator.rb

@@ -7,9 +7,11 @@ class InteractorGenerator < MethodistGenerator
   PATTERN_FOLDER     = 'interactors'.freeze
   TEMPLATE_FILE      = 'interactor.erb'.freeze
   TEMPLATE_SPEC_FILE = 'interactor_spec.erb'.freeze
+  PARENT_CLASS       = 'Methodist::Interactor'.freeze
 
   class_option 'skip-validations', type: :boolean, desc: "Skip validations in generated files", default: false
   class_option 'path',  type: :string,  desc: "Parent module for a new interactor", default: PATTERN_FOLDER
+  class_option 'parent', type: :string, desc: "Parent class of generated class", default: PARENT_CLASS
 
   def generate
     template(

data/lib/generators/interactor/templates/interactor.erb

@@ -2,7 +2,7 @@
 # Methodist interactors use dry-transaction.
 # Check docs here: https://github.com/dry-rb/dry-transaction
 <% end -%>
-class <%= name.camelcase %> < Methodist::Interactor
+class <%= name.camelcase %> < <%= options['parent'] %>
   <% unless options['skip-validations'] %>
   # See here the syntax for validation http://dry-rb.org/gems/dry-validation/
   schema do

data/lib/generators/observer/observer_generator.rb

@@ -8,9 +8,11 @@ class ObserverGenerator < MethodistGenerator
   TEMPLATE_FILE = 'observer.erb'.freeze
   TEMPLATE_SPEC_FILE = 'observer_spec.erb'.freeze
   DEFAULT_PREFIX = 'config/initializers'.freeze
+  PARENT_CLASS   = 'Methodist::Observer'.freeze
 
   class_option 'skip-validations', type: :boolean, desc: "Skip validations in generated files", default: false
   class_option 'path',  type: :string,  desc: "Parent module for new a interactor", default: PATTERN_FOLDER
+  class_option 'parent', type: :string, desc: "Parent class of generated class", default: PARENT_CLASS
 
   def generate
     template(

data/lib/generators/service/service_generator.rb

@@ -7,8 +7,10 @@ class ServiceGenerator < MethodistGenerator
   PATTERN_FOLDER     = 'services'.freeze
   TEMPLATE_FILE      = 'service.erb'.freeze
   TEMPLATE_SPEC_FILE = 'service_spec.erb'.freeze
+  PARENT_CLASS       = 'Methodist::Service'.freeze
 
   class_option 'path',  type: :string,  desc: "Parent module for a new service", default: PATTERN_FOLDER
+  class_option 'parent', type: :string, desc: "Parent class of generated class", default: PARENT_CLASS
 
   def generate
     template(

data/lib/methodist/interactor.rb

@@ -15,7 +15,7 @@ class Methodist::Interactor < Methodist::Pattern
   attr_accessor :validation_result
 
   class << self
-    attr_reader :input_schema
+    attr_reader :input_schema, :contract_class
     ##
     # Method set Dry::Validation schema for an interactor.
     #
@@ -46,6 +46,55 @@ class Methodist::Interactor < Methodist::Pattern
       end
     end
 
+    ##
+    # ATTENTION: require dry-validation >= 1.0.0
+    # Method set Dry::Validation::Contract contract for an interactor.
+    #
+    # Receive block for generating Dry::Validation:Contract
+    # result.
+    #
+    #   class InteractorClass < Methodist::Interactor
+    #     contract do
+    #       params do
+    #         required(:name).value(:str?)
+    #       end
+    #
+    #       rule(:name) do
+    #          ...
+    #       end
+    #     end
+    #
+    #     step :validate
+    #   end
+    #
+    #   InteractorClass.new.call(name: nil) #=> Failure(ValidationError)
+    #
+    # Or you can pass contract class:
+    #   class InteractorClass < Methodist::Interactor
+    #     contract contract_class: MyContract
+    #
+    #     step :validate
+    #   end
+    #
+    # ==== See
+    # http://dry-rb.org/gems/dry-validation/
+    #
+    # https://github.com/dry-rb/dry-transaction
+    ##
+    def contract(contract_class: nil, &block)
+      unless new_dry_validation?
+        raise DryValidationVersionError,
+          "Your depended dry-validation gem version must be gteq #{NEW_DRY_VALIDATION_V}"
+      end
+
+      unless block_given? || contract_class
+        raise ContractDefinitionError, 'You must pass block or contract_class to `contract`'
+      end
+
+      @contract_class = contract_class
+      @contract_class ||= Class.new(Dry::Validation::Contract, &block)
+    end
+
     private
 
     def dry_schema(&block)
@@ -96,8 +145,9 @@ class Methodist::Interactor < Methodist::Pattern
   def validate(input)
     input = {} unless input
     raise InputClassError, 'If you want to use custom #validate, you have to pass a hash to an interactor' unless input.is_a?(Hash)
-    raise SchemaDefinitionError, 'You have to define a schema with #schema method' unless input_schema
-    @validation_result = input_schema.call(input)
+    validator = contract_class ? contract_class : input_schema
+    raise ValidatorDefinitionError, 'you must define schema via #schema OR define contract via #contract' unless validator
+    @validation_result = validator.call(input)
     return Success(validation_result.to_h) if validation_result.success?
     Failure(failure_validation_value)
   end
@@ -108,6 +158,10 @@ class Methodist::Interactor < Methodist::Pattern
     @input_schema ||= self.class.input_schema rescue nil
   end
 
+  def contract_class
+    @contract_class ||= self.class.contract_class.new rescue nil
+  end
+
   ##
   # Method for validation input of interactor parameters.
   ##
@@ -120,6 +174,8 @@ class Methodist::Interactor < Methodist::Pattern
     }
   end
 
-  class SchemaDefinitionError < StandardError; end
+  class ValidatorDefinitionError < StandardError; end
   class InputClassError < StandardError; end
+  class DryValidationVersionError < StandardError; end
+  class ContractDefinitionError < StandardError; end
 end

data/lib/methodist/version.rb

@@ -1,3 +1,3 @@
 module Methodist
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: methodist
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Sergey Nesterov