servactory 1.1.0

data/lib/servactory/output_arguments/dsl.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Servactory
+  module OutputArguments
+    module DSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        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/output_argument.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Servactory
+  module OutputArguments
+    class OutputArgument
+      attr_reader :name,
+                  :types,
+                  :required,
+                  :default
+
+      def initialize(name, type:, **options)
+        @name = name
+        @types = Array(type)
+
+        @required = options.fetch(:required, true)
+        @default = required? ? nil : options.fetch(:default, nil)
+      end
+
+      def options_for_checks
+        {
+          types:,
+          required:,
+          default:
+        }
+      end
+
+      def required?
+        Servactory::Utils.boolean?(required)
+      end
+
+      def optional?
+        !required?
+      end
+
+      def default_value_present?
+        !default.nil?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Servactory
+  module OutputArguments
+    module Tools
+      class Conflicts
+        def self.check!(...)
+          new(...).check!
+        end
+
+        def initialize(context, collection_of_output_arguments, collection_of_internal_arguments)
+          @context = context
+          @collection_of_output_arguments = collection_of_output_arguments
+          @collection_of_internal_arguments = collection_of_internal_arguments
+        end
+
+        def check!
+          return if overlapping_attributes.empty?
+
+          raise Servactory.configuration.output_argument_error_class,
+                "The \"#{@context.class.name}\" service contains internal attributes that " \
+                "conflict with outputs: \"#{overlapping_attributes.join(', ')}\""
+        end
+
+        private
+
+        def overlapping_attributes
+          @overlapping_attributes ||=
+            @collection_of_output_arguments.names.intersection(@collection_of_internal_arguments.names)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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.squish
+            define_method(:#{output_argument.name}=) do |value|;
+              Servactory::OutputArguments::Checks::Type.check!(
+                context: self,
+                output_argument:,
+                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

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

data/lib/servactory/result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Servactory
+  class Result
+    def self.prepare_for(...)
+      new.send(:prepare_for, ...)
+    end
+
+    private
+
+    def prepare_for(context:, collection_of_output_arguments:)
+      collection_of_output_arguments.each do |output|
+        self.class.attr_reader(:"#{output.name}")
+
+        instance_variable_set(:"@#{output.name}", context.instance_variable_get(:"@#{output.name}"))
+      end
+
+      self
+    end
+  end
+end

data/lib/servactory/stage/dsl.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Stage
+    module DSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        private
+
+        attr_reader :stage_handyman
+
+        def stage(&)
+          @stage_factory ||= Factory.new
+
+          @stage_factory.instance_eval(&)
+
+          @stage_handyman = Handyman.work_in(@stage_factory)
+
+          # @stage_factory
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/servactory/stage/factory.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Stage
+    class Factory
+      def make(name, **options)
+        methods << Method.new(name, **options)
+      end
+
+      def methods
+        @methods ||= Methods.new
+      end
+    end
+  end
+end

data/lib/servactory/stage/handyman.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Stage
+    class Handyman
+      def self.work_in(...)
+        new(...)
+      end
+
+      def initialize(factory)
+        @factory = factory
+      end
+
+      def assign(context:)
+        @context = context
+      end
+
+      def methods
+        factory.methods
+      end
+
+      def run_methods!
+        methods.each do |method|
+          next if method.condition && !method.condition.call(context)
+
+          context.send(method.name)
+        end
+      end
+
+      private
+
+      attr_reader :factory, :context
+    end
+  end
+end

data/lib/servactory/stage/method.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Stage
+    class Method
+      attr_reader :name, :condition
+
+      def initialize(name, **options)
+        @name = name
+
+        @condition = options.fetch(:if, nil)
+      end
+
+      # def options
+      #   {
+      #     condition:
+      #   }
+      # end
+    end
+  end
+end

data/lib/servactory/stage/methods.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Stage
+    class Methods
+      # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
+      extend Forwardable
+      def_delegators :@methods, :<<, :each
+
+      def initialize(*)
+        @methods = []
+      end
+    end
+  end
+end

data/lib/servactory/utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Utils
+    module_function
+
+    def boolean?(value)
+      value.to_s.casecmp("true").to_i.zero?
+    end
+  end
+end

data/lib/servactory/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Servactory
+  module VERSION
+    MAJOR = 1
+    MINOR = 1
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].join(".")
+  end
+end

data/lib/servactory.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+require "active_support/core_ext/string"
+
+# require "servactory/support/loader"
+# require "servactory/engine"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "dsl" => "DSL"
+)
+loader.setup
+
+module Servactory
+  module_function
+
+  def configuration
+    @configuration ||= Servactory::Configuration.new
+  end
+
+  def reset
+    @configuration = Servactory::Configuration.new
+  end
+
+  def configure
+    yield(configuration)
+  end
+end
+
+# require_relative "servactory/exceptions"
+
+# require_relative "servactory/base"

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: servactory
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Anton Sokolov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+description: A set of tools for building reliable services of any complexity
+email:
+- profox.rus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/servactory.rb
+- lib/servactory/base.rb
+- lib/servactory/configuration.rb
+- lib/servactory/context/configuration.rb
+- lib/servactory/context/dsl.rb
+- lib/servactory/context/store.rb
+- lib/servactory/errors/base.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/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/dsl.rb
+- lib/servactory/input_arguments/input_argument.rb
+- lib/servactory/input_arguments/tools/check.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/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/result.rb
+- lib/servactory/stage/dsl.rb
+- lib/servactory/stage/factory.rb
+- lib/servactory/stage/handyman.rb
+- lib/servactory/stage/method.rb
+- lib/servactory/stage/methods.rb
+- lib/servactory/utils.rb
+- lib/servactory/version.rb
+homepage: https://github.com/afuno/servactory
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/afuno/servactory
+  source_code_uri: https://github.com/afuno/servactory
+  changelog_uri: https://github.com/afuno/servactory/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A set of tools for building reliable services of any complexity
+test_files: []