servactory 1.4.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40fbce39ff24b8ea522a6cbd2f2b2d48a9e09034e8cc636da53827eefb254d6f
-  data.tar.gz: d2f56d8b47aac242932780b1969c5b47e2da961762fd7625da776ecb9966132b
+  metadata.gz: 3877871b09a517026f3b66849d43348aae44feca18f2f97e101d1948cbc4f9d0
+  data.tar.gz: c6f0feca2515ebfd9e6123351c78ac29aee0ded0da66c4f689b259460ee7e403
 SHA512:
-  metadata.gz: 7ecefb0457e5933ddc441df45adb512da42f815ca1cdb23920835aa5f39ea4e73c7eeb83832bb3d128c83a94a21126e30619af325f7afe540195e2a44cdead7a
-  data.tar.gz: 5d3772b974c1d23da5d2b75443d2a1437a0d547a8eb48f538391d66368f449f8065793f152401925a753eac4f908a6c7e02cbdbc8a0b4b019415da3ff44e89b3
+  metadata.gz: 3d9d7237afe83f2b813d3c3555a322c5357dcc56aff1f45c0289c8efc47a139f5dc0f1bfec5f81005be1083aa0372b40a99b345df212aeded2edb425a03337c8
+  data.tar.gz: e1c7a318ce6a853269c6c3240e4028921fbad2f2d50c0e0c8d1ef52820bff91fe96638e363bbf63f278419cf477c8c2211a929d0c8f19a7198dd4e76c2c122df

data/README.md

@@ -3,6 +3,7 @@
 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
 
@@ -22,6 +23,8 @@ A set of tools for building reliable services of any complexity.
     - [Must](#must)
   - [Output attributes](#output-attributes)
   - [Internal attributes](#internal-attributes)
+  - [Stage](#stage)
+  - [Failures](#failures)
   - [Result](#result)
 
 ## Requirements
@@ -51,7 +54,7 @@ bundle install
 
 ### Preparation
 
-We recommend that you first prepare the following files in your project.
+As a first step, it is recommended to prepare the base class for further inheritance.
 
 #### ApplicationService::Errors
 
@@ -93,16 +96,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
@@ -147,9 +152,9 @@ By default, all inputs are required. To make an input optional, specify `false`
 
 ```ruby
 class UsersService::Create < ApplicationService::Base
-  input :first_name, type: String, internal: true
+  input :first_name, type: String
   input :middle_name, type: String, required: false
-  input :last_name, type: String, internal: true
+  input :last_name, type: String
 
   # ...
 end
@@ -239,6 +244,85 @@ class NotificationService::Create < ApplicationService::Base
 end
 ```
 
+### Stage
+
+A "stage" is a single action or group of actions that needs to be "make".
+
+#### Minimal example
+
+```ruby
+stage { make :something }
+
+def something
+  # ...
+end
+```
+
+#### Condition
+
+```ruby
+stage { make :something, if: -> { Settings.something.enabled } }
+
+def something
+  # ...
+end
+```
+
+#### Groups
+
+The functionality of stage groups will be expanded in future releases.
+
+```ruby
+stage do
+  make :assign_api_model
+  make :perform_api_request
+end
+
+stage do
+  make :process_result
+end
+
+def assign_api_model
+  self.api_model = APIModel.new
+end
+
+def perform_api_request
+  self.response = APIClient.resource.create(api_model)
+end
+
+def process_result
+  ARModel.create!(response)
+end
+```
+
+### Failures
+
+The methods that are used in the stages may fail. In order to more informatively provide information about this outside the service, the following methods were prepared.
+
+#### Fail
+
+```ruby
+stage { make :check! }
+
+def check!
+  return if inputs.invoice_number.start_with?("AA")
+
+  fail!("Invalid invoice number")
+end
+```
+
+#### Fail for input
+
+```ruby
+stage { make :check! }
+
+def check!
+  return if inputs.invoice_number.start_with?("AA")
+
+  fail_input!(:invoice_number, "Invalid invoice number")
+end
+```
+
 ### Result
 
 All services have the result of their work. For example, in case of success this call:

data/lib/servactory/base.rb

@@ -2,6 +2,7 @@
 
 module Servactory
   class Base
+    include Configuration::DSL
     include Context::DSL
     include InputArguments::DSL
     include InternalArguments::DSL

data/lib/servactory/configuration/dsl.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Configuration
+    module DSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        private
+
+        def configuration(&block)
+          @configuration_factory ||= Factory.new
+
+          @configuration_factory.instance_eval(&block)
+        end
+      end
+    end
+  end
+end

data/lib/servactory/configuration/factory.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Configuration
+    class Factory
+      def input_argument_error_class(input_argument_error_class)
+        Servactory.configuration.input_argument_error_class = input_argument_error_class
+      end
+
+      def output_argument_error_class(output_argument_error_class)
+        Servactory.configuration.output_argument_error_class = output_argument_error_class
+      end
+
+      def internal_argument_error_class(internal_argument_error_class)
+        Servactory.configuration.internal_argument_error_class = internal_argument_error_class
+      end
+
+      def failure_class(failure_class)
+        Servactory.configuration.failure_class = failure_class
+      end
+    end
+  end
+end

data/lib/servactory/configuration/setup.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Configuration
+    class Setup
+      attr_accessor :input_argument_error_class,
+                    :internal_argument_error_class,
+                    :output_argument_error_class,
+                    :failure_class
+
+      def initialize
+        @input_argument_error_class = Servactory::Errors::InputArgumentError
+        @internal_argument_error_class = Servactory::Errors::InternalArgumentError
+        @output_argument_error_class = Servactory::Errors::OutputArgumentError
+
+        @failure_class = Servactory::Errors::Failure
+      end
+    end
+  end
+end

data/lib/servactory/context/callable.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Context
+    module Callable
+      def call!(arguments = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        @context_store = Store.new(self)
+
+        assign_data_with(arguments)
+
+        input_arguments_workbench.find_unnecessary!
+        input_arguments_workbench.check_rules!
+        output_arguments_workbench.find_conflicts_in!(
+          collection_of_internal_arguments: collection_of_internal_arguments
+        )
+
+        prepare_data
+
+        input_arguments_workbench.check!
+
+        stage_handyman.run_methods!
+
+        context_store.context.raise_first_fail
+
+        Servactory::Result.prepare_for(
+          context: context_store.context,
+          collection_of_output_arguments: collection_of_output_arguments
+        )
+      end
+
+      private
+
+      attr_reader :context_store
+
+      def assign_data_with(arguments) # rubocop:disable Metrics/AbcSize
+        input_arguments_workbench.assign(
+          context: context_store.context,
+          arguments: arguments,
+          collection_of_input_options: collection_of_input_options
+        )
+
+        internal_arguments_workbench.assign(context: context_store.context)
+        output_arguments_workbench.assign(context: context_store.context)
+        stage_handyman&.assign(context: context_store.context)
+      end
+
+      def prepare_data
+        input_arguments_workbench.prepare     # 1
+
+        output_arguments_workbench.prepare    # 2
+        internal_arguments_workbench.prepare  # 3
+      end
+    end
+  end
+end

data/lib/servactory/context/dsl.rb

@@ -4,61 +4,8 @@ module Servactory
   module Context
     module DSL
       def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def call!(arguments) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-          @context_store ||= Store.new(self)
-
-          assign_data_with(arguments)
-
-          input_arguments_workbench.find_unnecessary!
-          input_arguments_workbench.check_rules!
-          output_arguments_workbench.find_conflicts_in!(
-            collection_of_internal_arguments: collection_of_internal_arguments
-          )
-
-          prepare_data
-
-          input_arguments_workbench.check!
-
-          stage_handyman.run_methods!
-
-          Servactory::Result.prepare_for(
-            context: context_store.context,
-            collection_of_output_arguments: collection_of_output_arguments
-          )
-        end
-
-        private
-
-        attr_reader :context_store
-
-        def assign_data_with(arguments) # rubocop:disable Metrics/AbcSize
-          input_arguments_workbench.assign(
-            context: context_store.context,
-            arguments: arguments,
-            collection_of_input_options: collection_of_input_options
-          )
-
-          internal_arguments_workbench.assign(context: context_store.context)
-          output_arguments_workbench.assign(context: context_store.context)
-          stage_handyman&.assign(context: context_store.context)
-        end
-
-        def prepare_data
-          input_arguments_workbench.prepare     # 1
-
-          output_arguments_workbench.prepare    # 2
-          internal_arguments_workbench.prepare  # 3
-        end
-
-        def configuration(&block)
-          context_configuration = Servactory::Context::Configuration.new
-
-          context_configuration.instance_eval(&block)
-        end
+        base.extend(Callable)
+        base.prepend(Workspace)
       end
     end
   end

data/lib/servactory/context/store.rb

@@ -7,44 +7,6 @@ module Servactory
 
       def initialize(service_class)
         @context = service_class.new
-
-        service_class.class_eval(service_class_template_with(context))
-      end
-
-      private
-
-      # EXAMPLE:
-      #
-      #   attr_reader(:inputs)
-      #
-      #   def assign_inputs(inputs)
-      #     @inputs = inputs
-      #   end
-      #
-      #   def fail_input!(input_attribute_name, message, prefix: true)
-      #     message_text = prefix ? "[#{context.class.name}] Custom `\#{input_attribute_name}` input error: " : ""
-      #
-      #     message_text += message
-      #
-      #     raise Servactory.configuration.input_argument_error_class, message_text
-      #   end
-      #
-      def service_class_template_with(context)
-        <<-RUBY
-          attr_reader(:inputs)
-
-          def assign_inputs(inputs)
-            @inputs = inputs
-          end
-
-          def fail_input!(input_attribute_name, message, prefix: true)
-            message_text = prefix ? "[#{context.class.name}] Custom `\#{input_attribute_name}` input error: " : ""
-
-            message_text += message
-
-            raise Servactory.configuration.input_argument_error_class, message_text
-          end
-        RUBY
       end
     end
   end

data/lib/servactory/context/workspace/error.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Context
+    module Workspace
+      class Error
+        attr_reader :type,
+                    :message,
+                    :attribute_name
+
+        def initialize(type:, message:, attribute_name: nil)
+          @type = type
+          @message = message
+          @attribute_name = attribute_name
+        end
+      end
+    end
+  end
+end

data/lib/servactory/context/workspace/errors.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Context
+    module Workspace
+      class Errors
+        # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
+        extend Forwardable
+        def_delegators :@collection, :<<, :filter, :reject, :empty?, :first
+
+        def initialize(collection = [])
+          @collection = collection
+        end
+
+        def not_blank_and_uniq
+          Errors.new(reject(&:blank?).uniq)
+        end
+
+        def for_fails
+          filtered = filter { |error| error.type == :fail }
+
+          Errors.new(filtered)
+        end
+
+        def for_inputs
+          filtered = filter { |error| error.type == :inputs }
+
+          Errors.new(filtered)
+        end
+      end
+    end
+  end
+end

data/lib/servactory/context/workspace.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Context
+    module Workspace
+      attr_reader :inputs
+
+      def errors
+        @errors ||= Errors.new
+      end
+
+      def assign_inputs(inputs)
+        @inputs = inputs
+      end
+
+      def fail_input!(input_attribute_name, message)
+        raise Servactory.configuration.input_argument_error_class,
+              Error.new(type: :input, attribute_name: input_attribute_name, message: message).message
+      end
+
+      def fail!(error)
+        errors << Error.new(type: :fail, message: error)
+      end
+
+      def raise_first_fail
+        return if (tmp_errors = errors.for_fails.not_blank_and_uniq).empty?
+
+        raise Servactory.configuration.failure_class, tmp_errors.first.message
+      end
+    end
+  end
+end

data/lib/servactory/input_arguments/options_collection.rb

@@ -5,18 +5,18 @@ module Servactory
     class OptionsCollection
       # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
       extend Forwardable
-      def_delegators :@collection, :<<, :each, :select, :map
+      def_delegators :@collection, :<<, :filter, :each, :map
 
       def initialize(*)
         @collection = []
       end
 
       def check_classes
-        select { |option| option.check_class.present? }.map(&:check_class).uniq
+        filter { |option| option.check_class.present? }.map(&:check_class).uniq
       end
 
       def options_for_checks
-        select(&:need_for_checks?).to_h do |option|
+        filter(&:need_for_checks?).to_h do |option|
           value = if option.value.is_a?(Hash)
                     option.value.key?(:is) ? option.value.fetch(:is) : option.value
                   else

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,26 +62,30 @@ module Servactory
         #   end
         #
         def class_inputs_template
-          <<-RUBY.squish
-            attr_reader(*#{@inputs_variables.keys});
+          return if @inputs_variables.blank?
 
-            def initialize(#{@inputs_variables.keys.join(':, ')}:);
-              #{@inputs_variables.keys.map { |key| "@#{key} = #{key}" }.join('; ')};
+          @class_inputs_template ||= <<-RUBY
+            attr_reader(*#{@inputs_variables.keys})
+
+            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?
 
-          @context_internal_variables_template ||= <<-RUBY.squish
-            private;
+          @context_internal_variables_template ||= <<-RUBY
+            private
 
-            attr_reader(*#{@internal_variables.keys});
+            attr_reader(*#{@internal_variables.keys})
           RUBY
         end
       end

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/internal_arguments/tools/prepare.rb

@@ -29,29 +29,29 @@ module Servactory
 
         # EXAMPLE:
         #
-        #   define_method(:user=) do |value|;
-        #     Servactory::InternalArguments::Checks::Type.check!( context: self, internal_argument:, value: );
+        #   define_method(:user=) do |value|
+        #     Servactory::InternalArguments::Checks::Type.check!( context: self, internal_argument:, value: )
         #
-        #     instance_variable_set(:@user, value);
-        #   end;
+        #     instance_variable_set(:@user, value)
+        #   end
         #
-        #   private attr_reader :user;
+        #   private attr_reader :user
         #
         def context_internal_argument_template_for(internal_argument)
-          <<-RUBY.squish
-            define_method(:#{internal_argument.name}=) do |value|;
+          <<-RUBY
+            define_method(:#{internal_argument.name}=) do |value|
               Servactory::InternalArguments::Checks::Type.check!(
                 context: self,
                 internal_argument: internal_argument,
                 value: value
-              );
+              )
 
-              instance_variable_set(:@#{internal_argument.name}, value);
-            end;
+              instance_variable_set(:@#{internal_argument.name}, value)
+            end
 
-            private;
+            private
 
-            attr_reader :#{internal_argument.name};
+            attr_reader :#{internal_argument.name}
           RUBY
         end
       end

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

@@ -29,31 +29,31 @@ module Servactory
 
         # EXAMPLE:
         #
-        #   define_method(:user=) do |value|;
-        #     Servactory::InternalArguments::Checks::Type.check!( context: self, output_argument:, value: );
+        #   define_method(:user=) do |value|
+        #     Servactory::InternalArguments::Checks::Type.check!( context: self, output_argument:, value: )
         #
-        #     instance_variable_set(:@user, value);
-        #   end;
+        #     instance_variable_set(:@user, value)
+        #   end
         #
-        #   private;
+        #   private
         #
-        #   attr_reader :user;
+        #   attr_reader :user
         #
         def context_output_argument_template_for(output_argument)
-          <<-RUBY.squish
-            define_method(:#{output_argument.name}=) do |value|;
+          <<-RUBY
+            define_method(:#{output_argument.name}=) do |value|
               Servactory::OutputArguments::Checks::Type.check!(
                 context: self,
                 output_argument: output_argument,
                 value: value
-              );
+              )
 
-              instance_variable_set(:@#{output_argument.name}, value);
-            end;
+              instance_variable_set(:@#{output_argument.name}, value)
+            end
 
-            private;
+            private
 
-            attr_reader :#{output_argument.name};
+            attr_reader :#{output_argument.name}
           RUBY
         end
       end

data/lib/servactory/version.rb

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

data/lib/servactory.rb

@@ -17,11 +17,11 @@ module Servactory
   module_function
 
   def configuration
-    @configuration ||= Servactory::Configuration.new
+    @configuration ||= Servactory::Configuration::Setup.new
   end
 
   def reset
-    @configuration = Servactory::Configuration.new
+    @configuration = Servactory::Configuration::Setup.new
   end
 
   def configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.3
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-07 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -161,10 +161,16 @@ files:
 - Rakefile
 - lib/servactory.rb
 - lib/servactory/base.rb
-- lib/servactory/configuration.rb
+- lib/servactory/configuration/dsl.rb
+- lib/servactory/configuration/factory.rb
+- lib/servactory/configuration/setup.rb
+- lib/servactory/context/callable.rb
 - lib/servactory/context/configuration.rb
 - lib/servactory/context/dsl.rb
 - lib/servactory/context/store.rb
+- lib/servactory/context/workspace.rb
+- lib/servactory/context/workspace/error.rb
+- lib/servactory/context/workspace/errors.rb
 - lib/servactory/errors/base.rb
 - lib/servactory/errors/failure.rb
 - lib/servactory/errors/input_argument_error.rb

data/lib/servactory/configuration.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  class Configuration
-    attr_accessor :input_argument_error_class,
-                  :internal_argument_error_class,
-                  :output_argument_error_class,
-                  :failure_class
-
-    def initialize
-      @input_argument_error_class = Servactory::Errors::InputArgumentError
-      @internal_argument_error_class = Servactory::Errors::InternalArgumentError
-      @output_argument_error_class = Servactory::Errors::OutputArgumentError
-
-      @failure_class = Servactory::Errors::Failure
-    end
-  end
-end