servactory 2.16.1 → 3.0.0.rc1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 2.16.1
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Anton Sokolov
@@ -214,14 +214,28 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- config/locales/de.yml
 - config/locales/en.yml
+- config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/it.yml
 - config/locales/ru.yml
-- lib/generators/servactory/install_generator.rb
-- lib/generators/servactory/rspec_generator.rb
-- lib/generators/servactory/service_generator.rb
-- lib/generators/servactory/templates/services/application_service/base.rb
-- lib/generators/servactory/templates/services/application_service/exceptions.rb
-- lib/generators/servactory/templates/services/application_service/result.rb
+- lib/generators/README.md
+- lib/generators/servactory/base.rb
+- lib/generators/servactory/extension/USAGE
+- lib/generators/servactory/extension/extension_generator.rb
+- lib/generators/servactory/extension/templates/extension.rb.tt
+- lib/generators/servactory/install/USAGE
+- lib/generators/servactory/install/install_generator.rb
+- lib/generators/servactory/install/templates/application_service/base.rb.tt
+- lib/generators/servactory/install/templates/application_service/exceptions.rb.tt
+- lib/generators/servactory/install/templates/application_service/result.rb.tt
+- lib/generators/servactory/rspec/USAGE
+- lib/generators/servactory/rspec/rspec_generator.rb
+- lib/generators/servactory/rspec/templates/service_spec.rb.tt
+- lib/generators/servactory/service/USAGE
+- lib/generators/servactory/service/service_generator.rb
+- lib/generators/servactory/service/templates/service.rb.tt
 - lib/servactory.rb
 - lib/servactory/actions/action.rb
 - lib/servactory/actions/collection.rb
@@ -236,11 +250,12 @@ files:
 - lib/servactory/configuration/actions/rescue_handlers/collection.rb
 - lib/servactory/configuration/actions/shortcuts/collection.rb
 - lib/servactory/configuration/collection_mode/class_names_collection.rb
+- lib/servactory/configuration/config.rb
+- lib/servactory/configuration/configurable.rb
 - lib/servactory/configuration/dsl.rb
 - lib/servactory/configuration/factory.rb
 - lib/servactory/configuration/hash_mode/class_names_collection.rb
 - lib/servactory/configuration/option_helpers/option_helpers_collection.rb
-- lib/servactory/configuration/setup.rb
 - lib/servactory/context/callable.rb
 - lib/servactory/context/dsl.rb
 - lib/servactory/context/warehouse/base.rb
@@ -297,22 +312,60 @@ files:
 - lib/servactory/outputs/dsl.rb
 - lib/servactory/outputs/output.rb
 - lib/servactory/result.rb
+- lib/servactory/stroma/dsl.rb
+- lib/servactory/stroma/entry.rb
+- lib/servactory/stroma/exceptions/base.rb
+- lib/servactory/stroma/exceptions/invalid_hook_type.rb
+- lib/servactory/stroma/exceptions/key_already_registered.rb
+- lib/servactory/stroma/exceptions/registry_frozen.rb
+- lib/servactory/stroma/exceptions/registry_not_finalized.rb
+- lib/servactory/stroma/exceptions/unknown_hook_target.rb
+- lib/servactory/stroma/hooks/applier.rb
+- lib/servactory/stroma/hooks/collection.rb
+- lib/servactory/stroma/hooks/factory.rb
+- lib/servactory/stroma/hooks/hook.rb
+- lib/servactory/stroma/registry.rb
+- lib/servactory/stroma/settings/collection.rb
+- lib/servactory/stroma/settings/registry_settings.rb
+- lib/servactory/stroma/settings/setting.rb
+- lib/servactory/stroma/state.rb
 - lib/servactory/test_kit/fake_type.rb
 - lib/servactory/test_kit/result.rb
 - lib/servactory/test_kit/rspec/helpers.rb
+- lib/servactory/test_kit/rspec/helpers/argument_matchers.rb
+- lib/servactory/test_kit/rspec/helpers/concerns/error_messages.rb
+- lib/servactory/test_kit/rspec/helpers/concerns/service_class_validation.rb
+- lib/servactory/test_kit/rspec/helpers/fluent.rb
+- lib/servactory/test_kit/rspec/helpers/input_validator.rb
+- lib/servactory/test_kit/rspec/helpers/legacy.rb
+- lib/servactory/test_kit/rspec/helpers/mock_executor.rb
+- lib/servactory/test_kit/rspec/helpers/output_validator.rb
+- lib/servactory/test_kit/rspec/helpers/service_mock_builder.rb
+- lib/servactory/test_kit/rspec/helpers/service_mock_config.rb
 - lib/servactory/test_kit/rspec/matchers.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/consists_of_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/inclusion_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/message_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/must_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/schema_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/types_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/base/attribute_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/base/submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/base/submatcher_context.rb
+- lib/servactory/test_kit/rspec/matchers/base/submatcher_registry.rb
+- lib/servactory/test_kit/rspec/matchers/concerns/attribute_data_access.rb
+- lib/servactory/test_kit/rspec/matchers/concerns/error_message_builder.rb
+- lib/servactory/test_kit/rspec/matchers/concerns/value_comparison.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_input_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_input_matchers/default_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_input_matchers/optional_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_input_matchers/required_matcher.rb
-- lib/servactory/test_kit/rspec/matchers/have_service_input_matchers/valid_with_matcher.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_internal_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/have_service_output_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/result/be_failure_service_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/result/be_success_service_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/input/default_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/input/optional_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/input/required_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/input/valid_with_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/shared/consists_of_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/shared/inclusion_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/shared/message_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/shared/must_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/shared/schema_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/shared/target_submatcher.rb
+- lib/servactory/test_kit/rspec/matchers/submatchers/shared/types_submatcher.rb
 - lib/servactory/test_kit/utils/faker.rb
 - lib/servactory/tool_kit/dynamic_options/consists_of.rb
 - lib/servactory/tool_kit/dynamic_options/format.rb
@@ -322,6 +375,7 @@ files:
 - lib/servactory/tool_kit/dynamic_options/multiple_of.rb
 - lib/servactory/tool_kit/dynamic_options/must.rb
 - lib/servactory/tool_kit/dynamic_options/schema.rb
+- lib/servactory/tool_kit/dynamic_options/target.rb
 - lib/servactory/utils.rb
 - lib/servactory/version.rb
 homepage: https://github.com/servactory/servactory
@@ -348,7 +402,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A set of tools for building reliable services of any complexity
 test_files: []

data/lib/generators/servactory/install_generator.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/base"
-
-module Servactory
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("templates", __dir__)
-
-      def copy_services
-        directory "services/application_service", "app/services/application_service"
-      end
-
-      def copy_locales
-        %i[en ru].each do |locale|
-          copy_file "../../../../config/locales/#{locale}.yml", "config/locales/servactory.#{locale}.yml"
-        end
-      end
-    end
-  end
-end

data/lib/generators/servactory/rspec_generator.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-
-module Servactory
-  module Generators
-    class RspecGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path("templates", __dir__)
-
-      argument :attributes, type: :array, default: [], banner: "input_name"
-
-      def create_service
-        create_file "app/services/#{file_path}_spec.rb" do
-          <<~RUBY
-            # frozen_string_literal: true
-
-            RSpec.describe #{class_name}, type: :service do
-              pending "add some examples to (or delete) \#{__FILE__}"
-
-              # let(:attributes) do
-              #   {
-              #{input_attribute_draw}
-              #   }
-              # end
-              #
-              #{input_let_draw}
-              #
-              # describe "validation" do
-              #   describe "inputs" do
-              #{input_validation_draw}
-              #   end
-              #
-              #   describe "internals" do
-              #     it { expect { perform }.to have_internal(:some_data).type(String) }
-              #   end
-              # end
-              #
-              # describe ".call!" do
-              #   subject(:perform) { described_class.call!(**attributes) }
-              #
-              #   describe "and the data required for work is also valid" do
-              #     it { expect(perform).to be_success_service }
-              #
-              #     # ...
-              #   end
-              #
-              #   describe "but the data required for work is invalid" do
-              #     # Provide a reason why the data is invalid and then use this:
-              #     it { expect(perform).to be_failure_service }
-              #
-              #     # ...
-              #   end
-              # end
-            end
-          RUBY
-        end
-      end
-
-      def input_attribute_draw
-        input_names.map do |input_name|
-          <<~RUBY.strip
-            #     #{input_name}: #{input_name}
-          RUBY
-        end.join(",\n  ")
-      end
-
-      def input_let_draw
-        input_names.map do |input_name|
-          <<~RUBY.strip
-            # let(:#{input_name}) { "Some value" }
-          RUBY
-        end.join("\n  ")
-      end
-
-      def input_validation_draw
-        input_names.map do |input_name|
-          <<~RUBY.strip
-            #     it { expect { perform }.to have_input(:#{input_name}).valid_with(attributes).type(String).required }
-          RUBY
-        end.join("\n  ")
-      end
-
-      def input_names
-        @input_names ||= attributes_names
-      end
-    end
-  end
-end

data/lib/generators/servactory/service_generator.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-
-module Servactory
-  module Generators
-    class ServiceGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path("templates", __dir__)
-
-      argument :attributes, type: :array, default: [], banner: "input_name"
-
-      def create_service # rubocop:disable Metrics/MethodLength
-        create_file "app/services/#{file_path}.rb" do
-          <<~RUBY
-            # frozen_string_literal: true
-
-            class #{class_name} < ApplicationService::Base
-              #{input_draw}
-
-              output :result, type: Symbol
-
-              make :something
-
-              private
-
-              def something
-                # Write your code here
-
-                outputs.result = :done
-              end
-            end
-          RUBY
-        end
-      end
-
-      def input_draw
-        input_names.map do |input_name|
-          <<~RUBY.squish
-            input :#{input_name}, type: String
-          RUBY
-        end.join("\n  ")
-      end
-
-      def input_names
-        @input_names ||= attributes_names
-      end
-    end
-  end
-end

data/lib/servactory/configuration/setup.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Configuration
-    class Setup
-      attr_accessor :input_exception_class,
-                    :internal_exception_class,
-                    :output_exception_class,
-                    :success_class,
-                    :failure_class,
-                    :result_class,
-                    :collection_mode_class_names,
-                    :hash_mode_class_names,
-                    :input_option_helpers,
-                    :internal_option_helpers,
-                    :output_option_helpers,
-                    :action_aliases,
-                    :action_shortcuts,
-                    :action_rescue_handlers,
-                    :i18n_root_key,
-                    :predicate_methods_enabled
-
-      def initialize # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-        @input_exception_class = Servactory::Exceptions::Input
-        @internal_exception_class = Servactory::Exceptions::Internal
-        @output_exception_class = Servactory::Exceptions::Output
-
-        @success_class = Servactory::Exceptions::Success
-        @failure_class = Servactory::Exceptions::Failure
-
-        @result_class = Servactory::Result
-
-        @collection_mode_class_names =
-          Servactory::Configuration::CollectionMode::ClassNamesCollection.new(default_collection_mode_class_names)
-
-        @hash_mode_class_names =
-          Servactory::Configuration::HashMode::ClassNamesCollection.new(default_hash_mode_class_names)
-
-        @input_option_helpers =
-          Servactory::Configuration::OptionHelpers::OptionHelpersCollection.new(default_input_option_helpers)
-
-        @internal_option_helpers =
-          Servactory::Configuration::OptionHelpers::OptionHelpersCollection.new(default_internal_option_helpers)
-
-        @output_option_helpers =
-          Servactory::Configuration::OptionHelpers::OptionHelpersCollection.new(default_output_option_helpers)
-
-        @action_aliases = Servactory::Configuration::Actions::Aliases::Collection.new
-        @action_shortcuts = Servactory::Configuration::Actions::Shortcuts::Collection.new
-        @action_rescue_handlers = Servactory::Configuration::Actions::RescueHandlers::Collection.new
-
-        @i18n_root_key = "servactory"
-
-        @predicate_methods_enabled = true
-      end
-
-      def predicate_methods_enabled?
-        @predicate_methods_enabled
-      end
-
-      private
-
-      def default_collection_mode_class_names
-        Set[Array, Set]
-      end
-
-      def default_hash_mode_class_names
-        Set[Hash]
-      end
-
-      def default_input_option_helpers
-        Set[
-          Servactory::Maintenance::Attributes::OptionHelper.new(name: :optional, equivalent: { required: false }),
-          Servactory::ToolKit::DynamicOptions::ConsistsOf.use(collection_mode_class_names:),
-          Servactory::ToolKit::DynamicOptions::Schema.use(default_hash_mode_class_names:),
-          Servactory::ToolKit::DynamicOptions::Inclusion.use
-        ]
-      end
-
-      def default_internal_option_helpers
-        Set[
-          Servactory::ToolKit::DynamicOptions::ConsistsOf.use(collection_mode_class_names:),
-          Servactory::ToolKit::DynamicOptions::Schema.use(default_hash_mode_class_names:),
-          Servactory::ToolKit::DynamicOptions::Inclusion.use
-        ]
-      end
-
-      def default_output_option_helpers
-        Set[
-          Servactory::ToolKit::DynamicOptions::ConsistsOf.use(collection_mode_class_names:),
-          Servactory::ToolKit::DynamicOptions::Schema.use(default_hash_mode_class_names:),
-          Servactory::ToolKit::DynamicOptions::Inclusion.use
-        ]
-      end
-    end
-  end
-end

data/lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/consists_of_matcher.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module TestKit
-    module Rspec
-      module Matchers
-        module HaveServiceAttributeMatchers
-          class ConsistsOfMatcher
-            OPTION_NAME = :consists_of
-            OPTION_BODY_KEY = :type
-
-            attr_reader :missing_option
-
-            def initialize(described_class, attribute_type, attribute_name, option_types, consists_of_types)
-              @described_class = described_class
-              @attribute_type = attribute_type
-              @attribute_type_plural = attribute_type.to_s.pluralize.to_sym
-              @attribute_name = attribute_name
-              @option_types = option_types
-              @consists_of_types = consists_of_types
-
-              @attribute_data = described_class.info.public_send(attribute_type_plural).fetch(attribute_name)
-
-              @missing_option = ""
-            end
-
-            def description
-              result = "consists_of: "
-              result + consists_of_types.join(", ")
-            end
-
-            def matches?(subject)
-              if submatcher_passes?(subject)
-                true
-              else
-                @missing_option = build_missing_option
-
-                false
-              end
-            end
-
-            private
-
-            attr_reader :described_class,
-                        :attribute_type,
-                        :attribute_type_plural,
-                        :attribute_name,
-                        :option_types,
-                        :consists_of_types,
-                        :attribute_data
-
-            def submatcher_passes?(_subject)
-              attribute_consists_of = attribute_data.fetch(OPTION_NAME)
-              attribute_consists_of_types = Array(attribute_consists_of.fetch(OPTION_BODY_KEY))
-
-              attribute_consists_of_types.difference(consists_of_types).empty? &&
-                consists_of_types.difference(attribute_consists_of_types).empty?
-            end
-
-            def build_missing_option
-              "should be consists_of"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/inclusion_matcher.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module TestKit
-    module Rspec
-      module Matchers
-        module HaveServiceAttributeMatchers
-          class InclusionMatcher
-            OPTION_NAME = :inclusion
-            OPTION_BODY_KEY = :in
-
-            attr_reader :missing_option
-
-            def initialize(described_class, attribute_type, attribute_name, values)
-              @described_class = described_class
-              @attribute_type = attribute_type
-              @attribute_type_plural = attribute_type.to_s.pluralize.to_sym
-              @attribute_name = attribute_name
-              @values = values
-
-              @attribute_data = described_class.info.public_send(attribute_type_plural).fetch(attribute_name)
-
-              @missing_option = ""
-            end
-
-            def description
-              "inclusion: #{values.join(', ')}"
-            end
-
-            def matches?(subject)
-              if submatcher_passes?(subject)
-                true
-              else
-                @missing_option = build_missing_option
-
-                false
-              end
-            end
-
-            private
-
-            attr_reader :described_class,
-                        :attribute_type,
-                        :attribute_type_plural,
-                        :attribute_name,
-                        :values,
-                        :attribute_data
-
-            def submatcher_passes?(_subject)
-              attribute_inclusion = attribute_data.fetch(OPTION_NAME)
-              attribute_inclusion_in = attribute_inclusion.fetch(OPTION_BODY_KEY)
-
-              attribute_inclusion_in.difference(values).empty? &&
-                values.difference(attribute_inclusion_in).empty?
-            end
-
-            def build_missing_option
-              attribute_inclusion = attribute_data.fetch(OPTION_NAME)
-              attribute_inclusion_in = attribute_inclusion.fetch(OPTION_BODY_KEY)
-
-              <<~MESSAGE
-                should include the expected values
-
-                  expected #{values.inspect}
-                       got #{attribute_inclusion_in.inspect}
-              MESSAGE
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/message_matcher.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module TestKit
-    module Rspec
-      module Matchers
-        module HaveServiceAttributeMatchers
-          class MessageMatcher
-            attr_reader :missing_option
-
-            def initialize(described_class, attribute_type, attribute_name, submatcher, custom_message)
-              @described_class = described_class
-              @attribute_type = attribute_type
-              @attribute_type_plural = attribute_type.to_s.pluralize.to_sym
-              @attribute_name = attribute_name
-              @custom_message = custom_message
-
-              attribute_data = described_class.info.public_send(attribute_type_plural).fetch(attribute_name)
-
-              attribute_schema = attribute_data.fetch(submatcher.class::OPTION_NAME)
-              @attribute_schema_is = attribute_schema.fetch(submatcher.class::OPTION_BODY_KEY)
-              @attribute_schema_message = attribute_schema.fetch(:message)
-
-              @missing_option = ""
-            end
-
-            def description
-              result = "message: "
-              result + attribute_schema_message
-            end
-
-            def matches?(subject)
-              if submatcher_passes?(subject)
-                true
-              else
-                @missing_option = build_missing_option
-
-                false
-              end
-            end
-
-            private
-
-            attr_reader :described_class,
-                        :attribute_type,
-                        :attribute_type_plural,
-                        :attribute_name,
-                        :option_types,
-                        :custom_message,
-                        :attribute_schema_is,
-                        :attribute_schema_message
-
-            def submatcher_passes?(_subject)
-              schema_message_equal?
-            end
-
-            def schema_message_equal? # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-              @schema_message_equal ||=
-                if custom_message.present? && !attribute_schema_message.nil?
-                  if custom_message.is_a?(RSpec::Matchers::BuiltIn::BaseMatcher)
-                    RSpec::Expectations::ValueExpectationTarget
-                      .new(attribute_schema_message)
-                      .to(custom_message)
-
-                    true
-                  elsif attribute_schema_message.is_a?(Proc)
-                    attribute_schema_message.call.casecmp(custom_message).zero?
-                  else
-                    attribute_schema_message.casecmp(custom_message).zero?
-                  end
-                else
-                  true
-                end
-            end
-
-            def build_missing_option
-              unless schema_message_equal? # rubocop:disable Style/GuardClause
-                <<~MESSAGE
-                  should return expected message in case of problem:
-
-                    expected #{attribute_schema_message.inspect}
-                         got #{custom_message.inspect}
-                MESSAGE
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end