servactory 1.5.2 → 1.6.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.1
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.19'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: A set of tools for building reliable services of any complexity
 email:
 - profox.rus@gmail.com
@@ -180,57 +194,56 @@ files:
 - 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/context/workspace/inputs.rb
 - lib/servactory/engine.rb
 - lib/servactory/errors/base.rb
+- lib/servactory/errors/collection.rb
 - lib/servactory/errors/failure.rb
-- lib/servactory/errors/input_argument_error.rb
-- lib/servactory/errors/internal_argument_error.rb
-- lib/servactory/errors/output_argument_error.rb
-- lib/servactory/input_arguments/checks/base.rb
-- lib/servactory/input_arguments/checks/errors.rb
-- lib/servactory/input_arguments/checks/inclusion.rb
-- lib/servactory/input_arguments/checks/must.rb
-- lib/servactory/input_arguments/checks/required.rb
-- lib/servactory/input_arguments/checks/type.rb
-- lib/servactory/input_arguments/collection.rb
-- lib/servactory/input_arguments/define_input_conflict.rb
-- lib/servactory/input_arguments/define_input_method.rb
-- lib/servactory/input_arguments/dsl.rb
-- lib/servactory/input_arguments/input_argument.rb
-- lib/servactory/input_arguments/option.rb
-- lib/servactory/input_arguments/options_collection.rb
-- lib/servactory/input_arguments/tools/check.rb
-- lib/servactory/input_arguments/tools/check_errors.rb
-- lib/servactory/input_arguments/tools/find_unnecessary.rb
-- lib/servactory/input_arguments/tools/prepare.rb
-- lib/servactory/input_arguments/tools/rules.rb
-- lib/servactory/input_arguments/workbench.rb
-- lib/servactory/inputs.rb
-- lib/servactory/internal_arguments/checks/base.rb
-- lib/servactory/internal_arguments/checks/type.rb
-- lib/servactory/internal_arguments/collection.rb
-- lib/servactory/internal_arguments/dsl.rb
-- lib/servactory/internal_arguments/internal_argument.rb
-- lib/servactory/internal_arguments/tools/prepare.rb
-- lib/servactory/internal_arguments/workbench.rb
-- lib/servactory/make_methods/collection.rb
-- lib/servactory/make_methods/dsl.rb
-- lib/servactory/make_methods/make_method.rb
-- lib/servactory/make_methods/workbench.rb
-- lib/servactory/output_arguments/checks/base.rb
-- lib/servactory/output_arguments/checks/type.rb
-- lib/servactory/output_arguments/collection.rb
-- lib/servactory/output_arguments/dsl.rb
-- lib/servactory/output_arguments/output_argument.rb
-- lib/servactory/output_arguments/tools/conflicts.rb
-- lib/servactory/output_arguments/tools/prepare.rb
-- lib/servactory/output_arguments/workbench.rb
+- lib/servactory/errors/input_error.rb
+- lib/servactory/errors/internal_error.rb
+- lib/servactory/errors/output_error.rb
+- lib/servactory/inputs/checks/base.rb
+- lib/servactory/inputs/checks/errors.rb
+- lib/servactory/inputs/checks/inclusion.rb
+- lib/servactory/inputs/checks/must.rb
+- lib/servactory/inputs/checks/required.rb
+- lib/servactory/inputs/checks/type.rb
+- lib/servactory/inputs/collection.rb
+- lib/servactory/inputs/define_input_conflict.rb
+- lib/servactory/inputs/define_input_method.rb
+- lib/servactory/inputs/dsl.rb
+- lib/servactory/inputs/input.rb
+- lib/servactory/inputs/option.rb
+- lib/servactory/inputs/options_collection.rb
+- lib/servactory/inputs/tools/check.rb
+- lib/servactory/inputs/tools/check_errors.rb
+- lib/servactory/inputs/tools/find_unnecessary.rb
+- lib/servactory/inputs/tools/prepare.rb
+- lib/servactory/inputs/tools/rules.rb
+- lib/servactory/inputs/workbench.rb
+- lib/servactory/internals/checks/base.rb
+- lib/servactory/internals/checks/type.rb
+- lib/servactory/internals/collection.rb
+- lib/servactory/internals/dsl.rb
+- lib/servactory/internals/internal.rb
+- lib/servactory/internals/tools/prepare.rb
+- lib/servactory/internals/workbench.rb
+- lib/servactory/methods/collection.rb
+- lib/servactory/methods/dsl.rb
+- lib/servactory/methods/method.rb
+- lib/servactory/methods/shortcuts/collection.rb
+- lib/servactory/methods/workbench.rb
+- lib/servactory/outputs/checks/base.rb
+- lib/servactory/outputs/checks/type.rb
+- lib/servactory/outputs/collection.rb
+- lib/servactory/outputs/dsl.rb
+- lib/servactory/outputs/output.rb
+- lib/servactory/outputs/tools/conflicts.rb
+- lib/servactory/outputs/tools/prepare.rb
+- lib/servactory/outputs/workbench.rb
 - lib/servactory/result.rb
 - lib/servactory/utils.rb
 - lib/servactory/version.rb

data/lib/servactory/context/configuration.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Context
-    class Configuration
-      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/context/workspace/error.rb

@@ -1,19 +0,0 @@
-# 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

@@ -1,33 +0,0 @@
-# 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, :<<, :to_a, :filter, :reject, :empty?, :first
-
-        def initialize(collection = Set.new)
-          @collection = collection
-        end
-
-        def not_blank
-          Errors.new(reject(&:blank?))
-        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/errors/input_argument_error.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Errors
-    class InputArgumentError < Servactory::Errors::Base; end
-  end
-end

data/lib/servactory/errors/internal_argument_error.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Errors
-    class InternalArgumentError < Servactory::Errors::Base; end
-  end
-end

data/lib/servactory/errors/output_argument_error.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Errors
-    class OutputArgumentError < Servactory::Errors::Base; end
-  end
-end

data/lib/servactory/input_arguments/dsl.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module InputArguments
-    module DSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def inherited(child)
-          super
-
-          child.send(:collection_of_input_arguments).merge(collection_of_input_arguments)
-        end
-
-        private
-
-        def input(name, **options)
-          collection_of_input_arguments << InputArgument.new(
-            name,
-            **options
-          )
-        end
-
-        def collection_of_input_arguments
-          @collection_of_input_arguments ||= Collection.new
-        end
-
-        def input_arguments_workbench
-          @input_arguments_workbench ||= Workbench.work_with(collection_of_input_arguments)
-        end
-      end
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module InputArguments
-    module Tools
-      class Rules
-        def self.check!(...)
-          new(...).check!
-        end
-
-        def initialize(context, collection_of_input_arguments)
-          @context = context
-          @collection_of_input_arguments = collection_of_input_arguments
-        end
-
-        def check!
-          @collection_of_input_arguments.each do |input_argument|
-            check_for!(input_argument)
-          end
-        end
-
-        private
-
-        def check_for!(input_argument)
-          return unless input_argument.with_conflicts?
-
-          raise_error_for(input_argument)
-        end
-
-        def raise_error_for(input_argument)
-          message_text = I18n.t(
-            "servactory.input_arguments.tools.rules.error",
-            service_class_name: @context.class.name,
-            input_name: input_argument.name,
-            conflict_code: input_argument.conflict_code
-          )
-
-          raise Servactory.configuration.input_argument_error_class, message_text
-        end
-      end
-    end
-  end
-end

data/lib/servactory/inputs.rb

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

data/lib/servactory/internal_arguments/checks/base.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module InternalArguments
-    module Checks
-      class Base
-        protected
-
-        def raise_error_with(message, **arguments)
-          message = message.call(**arguments) if message.is_a?(Proc)
-
-          raise Servactory.configuration.internal_argument_error_class, message
-        end
-      end
-    end
-  end
-end

data/lib/servactory/internal_arguments/dsl.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module InternalArguments
-    module DSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def inherited(child)
-          super
-
-          child.send(:collection_of_internal_arguments).merge(collection_of_internal_arguments)
-        end
-
-        private
-
-        def internal(name, **options)
-          collection_of_internal_arguments << InternalArgument.new(name, **options)
-        end
-
-        def collection_of_internal_arguments
-          @collection_of_internal_arguments ||= Collection.new
-        end
-
-        def internal_arguments_workbench
-          @internal_arguments_workbench ||= Workbench.work_with(collection_of_internal_arguments)
-        end
-      end
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module InternalArguments
-    module Tools
-      class Prepare
-        def self.prepare(...)
-          new(...).prepare
-        end
-
-        def initialize(context, collection_of_internal_arguments)
-          @context = context
-          @collection_of_internal_arguments = collection_of_internal_arguments
-        end
-
-        def prepare
-          @collection_of_internal_arguments.each do |internal_argument|
-            create_instance_variable_for(internal_argument)
-          end
-        end
-
-        private
-
-        def create_instance_variable_for(internal_argument)
-          @context.instance_variable_set(:"@#{internal_argument.name}", nil)
-
-          @context.class.class_eval(context_internal_argument_template_for(internal_argument))
-        end
-
-        # EXAMPLE:
-        #
-        #   define_method(:user=) do |value|
-        #     Servactory::InternalArguments::Checks::Type.check!( context: self, internal_argument:, value: )
-        #
-        #     instance_variable_set(:@user, value)
-        #   end
-        #
-        #   private attr_reader :user
-        #
-        def context_internal_argument_template_for(internal_argument)
-          <<-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
-
-            private
-
-            attr_reader :#{internal_argument.name}
-          RUBY
-        end
-      end
-    end
-  end
-end

data/lib/servactory/make_methods/dsl.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module MakeMethods
-    module DSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def inherited(child)
-          super
-
-          child.send(:collection_of_make_methods).merge(collection_of_make_methods)
-        end
-
-        private
-
-        def make(name, **options)
-          collection_of_make_methods << MakeMethod.new(name, **options)
-        end
-
-        def collection_of_make_methods
-          @collection_of_make_methods ||= Collection.new
-        end
-
-        def make_methods_workbench
-          @make_methods_workbench ||= Workbench.work_with(collection_of_make_methods)
-        end
-      end
-    end
-  end
-end

data/lib/servactory/output_arguments/checks/base.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module OutputArguments
-    module Checks
-      class Base
-        protected
-
-        def raise_error_with(message, **arguments)
-          message = message.call(**arguments) if message.is_a?(Proc)
-
-          raise Servactory.configuration.output_argument_error_class, message
-        end
-      end
-    end
-  end
-end

data/lib/servactory/output_arguments/dsl.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module OutputArguments
-    module DSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def inherited(child)
-          super
-
-          child.send(:collection_of_output_arguments).merge(collection_of_output_arguments)
-        end
-
-        private
-
-        def output(name, **options)
-          collection_of_output_arguments << OutputArgument.new(name, **options)
-        end
-
-        def collection_of_output_arguments
-          @collection_of_output_arguments ||= Collection.new
-        end
-
-        def output_arguments_workbench
-          @output_arguments_workbench ||= Workbench.work_with(collection_of_output_arguments)
-        end
-      end
-    end
-  end
-end

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

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module OutputArguments
-    module Tools
-      class Prepare
-        def self.prepare(...)
-          new(...).prepare
-        end
-
-        def initialize(context, collection_of_output_arguments)
-          @context = context
-          @collection_of_output_arguments = collection_of_output_arguments
-        end
-
-        def prepare
-          @collection_of_output_arguments.each do |output_argument|
-            create_instance_variable_for(output_argument)
-          end
-        end
-
-        private
-
-        def create_instance_variable_for(output_argument)
-          @context.instance_variable_set(:"@#{output_argument.name}", nil)
-
-          @context.class.class_eval(context_output_argument_template_for(output_argument))
-        end
-
-        # EXAMPLE:
-        #
-        #   define_method(:user=) do |value|
-        #     Servactory::InternalArguments::Checks::Type.check!( context: self, output_argument:, value: )
-        #
-        #     instance_variable_set(:@user, value)
-        #   end
-        #
-        #   private
-        #
-        #   attr_reader :user
-        #
-        def context_output_argument_template_for(output_argument)
-          <<-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
-
-            private
-
-            attr_reader :#{output_argument.name}
-          RUBY
-        end
-      end
-    end
-  end
-end

data/lib/servactory/output_arguments/workbench.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module OutputArguments
-    class Workbench
-      def self.work_with(...)
-        new(...)
-      end
-
-      def initialize(collection_of_output_arguments)
-        @collection_of_output_arguments = collection_of_output_arguments
-      end
-
-      def assign(context:)
-        @context = context
-      end
-
-      def find_conflicts_in!(collection_of_internal_arguments:)
-        Tools::Conflicts.check!(context, collection_of_output_arguments, collection_of_internal_arguments)
-      end
-
-      def prepare
-        Tools::Prepare.prepare(context, collection_of_output_arguments)
-      end
-
-      private
-
-      attr_reader :context, :collection_of_output_arguments
-    end
-  end
-end