servactory 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ffa3b926585163837e461a8a1b129a81f951f88a8d715dd6e74297e0a37ddd
-  data.tar.gz: 1d1a3326828e282ad0f46bc76e2754fb44e0dbd5f2e00c452cd6e856866bcbbd
+  metadata.gz: 781548f2f3cda01476bfa6570d3b1fac94890c3b86271f6bc58a32542f2d2ce9
+  data.tar.gz: fdddb44644b45ce539193db90e86bfefc63b3fd8140b2a54bd8654d22027191a
 SHA512:
-  metadata.gz: 07c4e1f255a4fabe953a3c1381229000b564b80fc0e4f1c08547fed23dcc9cb9b31ebab678d76f894ce55e5506120d412fab26bf214f433f00cf43d958b502d7
-  data.tar.gz: 85cadb2169b968a0e9cda6f9279d9be37b01acdc0f7f91ca2b7f8458e89a219213ad317b84002d1b7684bb695a73b4c5a3a6c092a4e3a61c05984e2ee027a164
+  metadata.gz: 60bc160221bfad63233635071ddb345f814c9ca1bdab3867cb5d3ae58835b43bca0c6a7928200a2553995bf836cfe1592d42f3dbfaa48ea97e44af8ae5eb75e2
+  data.tar.gz: 8a272ec82df4539946462099c9dd45857d1583b1526f74fa78d05e1a8896762e61a580bac4016ea0b78c62bb1ebf16480e9992dfadd4c99950b0938557a68f54

data/README.md

@@ -3,26 +3,27 @@
 A set of tools for building reliable services of any complexity.
 
 [![Gem version](https://img.shields.io/gem/v/servactory?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/servactory)
+[![Release Date](https://img.shields.io/github/release-date/afuno/servactory)](https://github.com/afuno/servactory/releases)
 
 ## Contents
 
-- [Requirements](https://github.com/afuno/servactory/edit/main/README.md#requirements)
-- [Getting started](https://github.com/afuno/servactory/edit/main/README.md#getting-started)
-  - [Conventions](https://github.com/afuno/servactory/edit/main/README.md#conventions)
-  - [Installation](https://github.com/afuno/servactory/edit/main/README.md#installation)
-  - [Preparation](https://github.com/afuno/servactory/edit/main/README.md#preparation)
-- [Usage](https://github.com/afuno/servactory/edit/main/README.md#usage)
-  - [Minimal example](https://github.com/afuno/servactory#minimal-example)
-  - [Input attributes](https://github.com/afuno/servactory#input-attributes)
-    - [Isolated usage](https://github.com/afuno/servactory#isolated-usage)
-    - [As an internal argument](https://github.com/afuno/servactory#isolated-usage)
-    - [Optional inputs](https://github.com/afuno/servactory#optional-inputs)
-    - [An array of specific values](https://github.com/afuno/servactory#an-array-of-specific-values)
-    - [Inclusion](https://github.com/afuno/servactory#inclusion)
-    - [Must](https://github.com/afuno/servactory#must)
-  - [Output attributes](https://github.com/afuno/servactory/edit/main/README.md#output-attributes)
-  - [Internal attributes](https://github.com/afuno/servactory/edit/main/README.md#internal-attributes)
-  - [Result](https://github.com/afuno/servactory/edit/main/README.md#result)
+- [Requirements](#requirements)
+- [Getting started](#getting-started)
+  - [Conventions](#conventions)
+  - [Installation](#installation)
+  - [Preparation](#preparation)
+- [Usage](#usage)
+  - [Minimal example](#minimal-example)
+  - [Input attributes](#input-attributes)
+    - [Isolated usage](#isolated-usage)
+    - [As an internal argument](#isolated-usage)
+    - [Optional inputs](#optional-inputs)
+    - [An array of specific values](#an-array-of-specific-values)
+    - [Inclusion](#inclusion)
+    - [Must](#must)
+  - [Output attributes](#output-attributes)
+  - [Internal attributes](#internal-attributes)
+  - [Result](#result)
 
 ## Requirements
 
@@ -93,16 +94,18 @@ end
 
 ```ruby
 class MinimalService < ApplicationService::Base
-  stage { make :something }
+  stage { make :call }
   
   private
   
-  def something
+  def call
     # ...
   end
 end
 ```
 
+[More examples](https://github.com/afuno/servactory/tree/main/examples/usual)
+
 ### Input attributes
 
 #### Isolated usage

data/lib/servactory/context/dsl.rb

@@ -8,7 +8,7 @@ module Servactory
       end
 
       module ClassMethods
-        def call!(arguments) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def call!(arguments = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
           @context_store ||= Store.new(self)
 
           assign_data_with(arguments)

data/lib/servactory/input_arguments/checks/required.rb

@@ -14,14 +14,14 @@ module Servactory
 
         private_constant :DEFAULT_MESSAGE
 
-        def self.check(context:, input:, value:, **)
-          return unless should_be_checked_for?(input)
+        def self.check(context:, input:, value:, check_key:, **)
+          return unless should_be_checked_for?(input, check_key)
 
           new(context: context, input: input, value: value).check
         end
 
-        def self.should_be_checked_for?(input)
-          input.required?
+        def self.should_be_checked_for?(input, check_key)
+          check_key == :required && input.required?
         end
 
         ##########################################################################
@@ -34,15 +34,17 @@ module Servactory
           @value = value
         end
 
-        def check # rubocop:disable Metrics/MethodLength
+        def check # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           if @input.array? && @value.present?
             return if @value.respond_to?(:all?) && @value.all?(&:present?)
           elsif @value.present?
             return
           end
 
+          _, message = @input.required.values_at(:is, :message)
+
           add_error(
-            DEFAULT_MESSAGE,
+            message.presence || DEFAULT_MESSAGE,
             service_class_name: @context.class.name,
             input: @input,
             value: @value

data/lib/servactory/input_arguments/input_argument.rb

@@ -6,15 +6,13 @@ module Servactory
       ARRAY_DEFAULT_VALUE = ->(is: false, message: nil) { { is: is, message: message } }
 
       attr_reader :name,
-                  :collection_of_options,
-                  :types
+                  :collection_of_options
 
       def initialize(name, collection_of_options:, type:, **options)
         @name = name
         @collection_of_options = collection_of_options
-        @types = Array(type)
 
-        add_basic_options_with(options)
+        add_basic_options_with(type: type, options: options)
 
         @collection_of_options.each do |option|
           self.class.attr_reader(:"#{option.name}")
@@ -23,13 +21,14 @@ module Servactory
         end
       end
 
-      def add_basic_options_with(options)
+      def add_basic_options_with(type:, options:)
         # Check Class: Servactory::InputArguments::Checks::Required
         add_required_option_with(options)
 
         # Check Class: Servactory::InputArguments::Checks::Type
-        add_array_option_with(options)
+        add_types_option_with(type)
         add_default_option_with(options)
+        add_array_option_with(options)
 
         # Check Class: Servactory::InputArguments::Checks::Inclusion
         add_inclusion_option_with(options)
@@ -69,28 +68,15 @@ module Servactory
         )
       end
 
-      def add_array_option_with(options) # rubocop:disable Metrics/MethodLength
+      def add_types_option_with(type)
         collection_of_options << Option.new(
-          name: :array,
+          name: :types,
           input: self,
+          original_value: Array(type),
           check_class: Servactory::InputArguments::Checks::Type,
-          define_input_methods: lambda do
-            <<-RUBY
-              def array?
-                Servactory::Utils.boolean?(array[:is])
-              end
-            RUBY
-          end,
-          define_conflicts: lambda do
-            <<-RUBY
-              return :array_vs_array if array? && types.include?(Array)
-              return :array_vs_inclusion if array? && inclusion_present?
-            RUBY
-          end,
-          need_for_checks: false,
-          value_key: :is,
-          value_fallback: false,
-          **options
+          need_for_checks: true,
+          value_fallback: nil,
+          with_advanced_mode: false
         )
       end
 
@@ -113,6 +99,31 @@ module Servactory
         )
       end
 
+      def add_array_option_with(options) # rubocop:disable Metrics/MethodLength
+        collection_of_options << Option.new(
+          name: :array,
+          input: self,
+          check_class: Servactory::InputArguments::Checks::Type,
+          define_input_methods: lambda do
+            <<-RUBY
+              def array?
+                Servactory::Utils.boolean?(array[:is])
+              end
+            RUBY
+          end,
+          define_conflicts: lambda do
+            <<-RUBY
+              return :array_vs_array if array? && types.include?(Array)
+              return :array_vs_inclusion if array? && inclusion_present?
+            RUBY
+          end,
+          need_for_checks: false,
+          value_key: :is,
+          value_fallback: false,
+          **options
+        )
+      end
+
       def add_inclusion_option_with(options) # rubocop:disable Metrics/MethodLength
         collection_of_options << Option.new(
           name: :inclusion,
@@ -172,11 +183,7 @@ module Servactory
       end
 
       def options_for_checks
-        {
-          types: types
-        }.merge(
-          collection_of_options.options_for_checks
-        )
+        collection_of_options.options_for_checks
       end
 
       def conflict_code

data/lib/servactory/input_arguments/option.rb

@@ -14,12 +14,14 @@ module Servactory
                   :value_key,
                   :value
 
+      # rubocop:disable Metrics/MethodLength
       def initialize(
         name:,
         input:,
         check_class:,
         need_for_checks:,
         value_fallback:,
+        original_value: nil,
         value_key: nil,
         define_input_methods: nil,
         define_conflicts: nil,
@@ -32,10 +34,16 @@ module Servactory
         @need_for_checks = need_for_checks
         @value_key = value_key
 
-        @value = prepare_value_for(options, value_fallback: value_fallback, with_advanced_mode: with_advanced_mode)
+        @value = prepare_value_for(
+          original_value: original_value,
+          options: options,
+          value_fallback: value_fallback,
+          with_advanced_mode: with_advanced_mode
+        )
 
         input.instance_eval(define_input_methods.call) if define_input_methods.present?
       end
+      # rubocop:enable Metrics/MethodLength
 
       def need_for_checks?
         need_for_checks
@@ -43,7 +51,9 @@ module Servactory
 
       private
 
-      def prepare_value_for(options, value_fallback:, with_advanced_mode:)
+      def prepare_value_for(original_value:, options:, value_fallback:, with_advanced_mode:)
+        return original_value if original_value.present?
+
         return options.fetch(@name, value_fallback) unless with_advanced_mode
 
         prepare_advanced_for(

data/lib/servactory/input_arguments/tools/prepare.rb

@@ -39,9 +39,10 @@ module Servactory
         end
 
         def create_instance_variables
-          Servactory::Inputs.class_eval(class_inputs_template)
+          inputs_class = Servactory::Inputs.dup
+          inputs_class.class_eval(class_inputs_template) if class_inputs_template.present?
 
-          @context.assign_inputs(Servactory::Inputs.new(**@inputs_variables))
+          @context.assign_inputs(inputs_class.new(**@inputs_variables))
 
           @context.class.class_eval(context_internal_variables_template) if context_internal_variables_template.present?
 
@@ -54,10 +55,6 @@ module Servactory
 
         # EXAMPLE:
         #
-        #   attr_reader(*[:attr_1]); def initialize(attr_1); @attr_1 = attr_1; end
-        #
-        # OR
-        #
         #   attr_reader(*[:attr_1, :attr_2, :attr_3])
         #
         #   def initialize(attr_1:, attr_2:, attr_3:)
@@ -65,18 +62,20 @@ module Servactory
         #   end
         #
         def class_inputs_template
-          <<-RUBY.squish
-            attr_reader(*#{@inputs_variables.keys});
+          return if @inputs_variables.blank?
+
+          @class_inputs_template ||= <<-RUBY
+            attr_reader(*#{@inputs_variables.keys})
 
-            def initialize(#{@inputs_variables.keys.join(':, ')}:);
-              #{@inputs_variables.keys.map { |key| "@#{key} = #{key}" }.join('; ')};
+            def initialize(#{@inputs_variables.keys.join(':, ')}:)
+              #{@inputs_variables.keys.map { |key| "@#{key} = #{key}" }.join('; ')}
             end
           RUBY
         end
 
         # EXAMPLE:
         #
-        #   private attr_reader(*[:attr_1]);
+        #   private; attr_reader(*[:attr_1]);
         #
         def context_internal_variables_template
           return if @internal_variables.blank?

data/lib/servactory/inputs.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Servactory
-  class Inputs # rubocop:disable Lint/EmptyClass
-    # NOTE: Look at the file `lib/servactory/input_arguments/tools/prepare.rb`
+  class Inputs
+    def initialize(**)
+      # NOTE: Look at the file `lib/servactory/input_arguments/tools/prepare.rb`
+    end
   end
 end

data/lib/servactory/version.rb

@@ -4,7 +4,7 @@ module Servactory
   module VERSION
     MAJOR = 1
     MINOR = 4
-    PATCH = 0
+    PATCH = 2
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-07 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement