servactory 1.4.3 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3877871b09a517026f3b66849d43348aae44feca18f2f97e101d1948cbc4f9d0
-  data.tar.gz: c6f0feca2515ebfd9e6123351c78ac29aee0ded0da66c4f689b259460ee7e403
+  metadata.gz: 8878b890cc7b43a45e8ea3e982a27e5873ec4d1aeff1ac91f6ce9ea77cc98e38
+  data.tar.gz: 4f2947b852d2f0e53965b79b88ce013ae442575dee4f6539b1a2684e242211a5
 SHA512:
-  metadata.gz: 3d9d7237afe83f2b813d3c3555a322c5357dcc56aff1f45c0289c8efc47a139f5dc0f1bfec5f81005be1083aa0372b40a99b345df212aeded2edb425a03337c8
-  data.tar.gz: e1c7a318ce6a853269c6c3240e4028921fbad2f2d50c0e0c8d1ef52820bff91fe96638e363bbf63f278419cf477c8c2211a929d0c8f19a7198dd4e76c2c122df
+  metadata.gz: 437c627bef5b24d7f5a5e7b3f4c3b75e207af58d37900d6a8c6cf8b73c69e6704feb575f01233362f1ce2c40f7c640d2900d3d58e416ea12ed682c9f23fd058b
+  data.tar.gz: fc9a5f1a97cf8db5483df7be46f805a6c8f5598b559237a89c2409ee761d61204b79da375d3d0228133b88f4e60fe124c22519c6a314d39bb33dbf585cd5422a

data/README.md

@@ -14,10 +14,13 @@ A set of tools for building reliable services of any complexity.
   - [Preparation](#preparation)
 - [Usage](#usage)
   - [Minimal example](#minimal-example)
+  - [Call](#call)
+  - [Result](#result)
   - [Input attributes](#input-attributes)
     - [Isolated usage](#isolated-usage)
     - [As an internal argument](#isolated-usage)
     - [Optional inputs](#optional-inputs)
+    - [As (internal name)](#as-internal-name)
     - [An array of specific values](#an-array-of-specific-values)
     - [Inclusion](#inclusion)
     - [Must](#must)
@@ -25,7 +28,9 @@ A set of tools for building reliable services of any complexity.
   - [Internal attributes](#internal-attributes)
   - [Stage](#stage)
   - [Failures](#failures)
-  - [Result](#result)
+- [Testing](#testing)
+- [Thanks](#thanks)
+- [Contributing](#contributing)
 
 ## Requirements
 
@@ -108,6 +113,47 @@ end
 
 [More examples](https://github.com/afuno/servactory/tree/main/examples/usual)
 
+### Call
+
+Services can only be called via `.call` and `.call!` methods.
+
+The `.call` method will only fail if it catches an exception in the input arguments.
+Internal and output attributes, as well as methods for failures - all this will be collected in the result.
+
+The `.call!` method will fail if it catches any exception.
+
+#### Via .call
+
+```ruby
+UsersService::Accept.call(user: User.first)
+```
+
+#### Via .call!
+
+```ruby
+UsersService::Accept.call!(user: User.first)
+```
+
+### Result
+
+All services have the result of their work. For example, in case of success this call:
+
+```ruby
+service_result = UsersService::Accept.call!(user: User.first)
+```
+
+Will return this:
+
+```ruby
+#<Servactory::Result:0x0000000107ad9e88 @user="...">
+```
+
+And then you can work with this result, for example, in this way:
+
+```ruby
+Notification::SendJob.perform_later(service_result.user.id)
+```
+
 ### Input attributes
 
 #### Isolated usage
@@ -160,6 +206,26 @@ class UsersService::Create < ApplicationService::Base
 end
 ```
 
+#### As (internal name)
+
+This option changes the name of the input within the service.
+
+```ruby
+class NotificationService::Create < ApplicationService::Base
+  input :customer, as: :user, type: User
+
+  output :notification, type: Notification
+
+  stage { make :create_notification! }
+
+  private
+
+  def create_notification!
+    self.notification = Notification.create!(user: inputs.user)
+  end
+end
+```
+
 #### An array of specific values
 
 ```ruby
@@ -323,22 +389,18 @@ def check!
 end
 ```
 
-### Result
+## Testing
 
-All services have the result of their work. For example, in case of success this call:
-
-```ruby
-service_result = NotificationService::Create.call!(user: User.first)
-```
+Testing Servactory services is the same as testing regular Ruby classes.
 
-Will return this:
+## Thanks
 
-```ruby
-#<Servactory::Result:0x0000000112c00748 @notification=...>
-```
+Thanks to [@sunny](https://github.com/sunny) for [Service Actor](https://github.com/sunny/actor).
 
-And then you can work with this result, for example, in this way:
+## Contributing
 
-```ruby
-Notification::SendJob.perform_later(service_result.notification.id)
-```
+1. Fork it (https://github.com/afuno/servactory/fork);
+2. Create your feature branch (`git checkout -b my-new-feature`);
+3. Commit your changes (`git commit -am "Add some feature"`);
+4. Push to the branch (`git push origin my-new-feature`);
+5. Create a new Pull Request.

data/lib/servactory/base.rb

@@ -8,5 +8,7 @@ module Servactory
     include InternalArguments::DSL
     include OutputArguments::DSL
     include Stage::DSL
+
+    private_class_method :new
   end
 end

data/lib/servactory/context/callable.rb

@@ -28,6 +28,29 @@ module Servactory
         )
       end
 
+      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

data/lib/servactory/context/store.rb

@@ -6,7 +6,7 @@ module Servactory
       attr_reader :context
 
       def initialize(service_class)
-        @context = service_class.new
+        @context = service_class.send(:new)
       end
     end
   end

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

@@ -6,14 +6,14 @@ module Servactory
       class Errors
         # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
         extend Forwardable
-        def_delegators :@collection, :<<, :filter, :reject, :empty?, :first
+        def_delegators :@collection, :<<, :to_a, :filter, :reject, :empty?, :first
 
-        def initialize(collection = [])
+        def initialize(collection = Set.new)
           @collection = collection
         end
 
-        def not_blank_and_uniq
-          Errors.new(reject(&:blank?).uniq)
+        def not_blank
+          Errors.new(reject(&:blank?))
         end
 
         def for_fails

data/lib/servactory/context/workspace.rb

@@ -23,7 +23,7 @@ module Servactory
       end
 
       def raise_first_fail
-        return if (tmp_errors = errors.for_fails.not_blank_and_uniq).empty?
+        return if (tmp_errors = errors.for_fails.not_blank).empty?
 
         raise Servactory.configuration.failure_class, tmp_errors.first.message
       end

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

@@ -4,18 +4,18 @@ module Servactory
   module InputArguments
     module Checks
       class Base
-        def initialize
-          @errors = []
-        end
-
-        attr_reader :errors
-
         protected
 
         def add_error(message, **arguments)
           message = message.call(**arguments) if message.is_a?(Proc)
 
-          errors.push(message)
+          errors << message
+        end
+
+        private
+
+        def errors
+          @errors ||= Errors.new
         end
       end
     end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Servactory
+  module InputArguments
+    module Checks
+      class Errors
+        # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
+        extend Forwardable
+        def_delegators :@collection, :<<, :to_a
+
+        def initialize(*)
+          @collection = Set.new
+        end
+      end
+    end
+  end
+end

data/lib/servactory/input_arguments/collection.rb

@@ -8,7 +8,7 @@ module Servactory
       def_delegators :@collection, :<<, :each, :map
 
       def initialize(*)
-        @collection = []
+        @collection = Set.new
       end
 
       def names

data/lib/servactory/input_arguments/define_input_conflict.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Servactory
+  module InputArguments
+    class DefineInputConflict
+      attr_reader :content
+
+      def initialize(content:)
+        @content = content
+      end
+    end
+  end
+end

data/lib/servactory/input_arguments/define_input_method.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Servactory
+  module InputArguments
+    class DefineInputMethod
+      attr_reader :name,
+                  :content
+
+      def initialize(name:, content:)
+        @name = name.to_sym
+        @content = content
+      end
+    end
+  end
+end

data/lib/servactory/input_arguments/input_argument.rb

@@ -6,10 +6,19 @@ module Servactory
       ARRAY_DEFAULT_VALUE = ->(is: false, message: nil) { { is: is, message: message } }
 
       attr_reader :name,
+                  :internal_name,
                   :collection_of_options
 
-      def initialize(name, collection_of_options:, type:, **options)
+      # rubocop:disable Style/KeywordParametersOrder
+      def initialize(
+        name,
+        as: nil,
+        collection_of_options:,
+        type:,
+        **options
+      )
         @name = name
+        @internal_name = as.present? ? as : name
         @collection_of_options = collection_of_options
 
         add_basic_options_with(type: type, options: options)
@@ -20,6 +29,7 @@ module Servactory
           instance_variable_set(:"@#{option.name}", option.value)
         end
       end
+      # rubocop:enable Style/KeywordParametersOrder
 
       def add_basic_options_with(type:, options:)
         # Check Class: Servactory::InputArguments::Checks::Required
@@ -45,22 +55,19 @@ module Servactory
           name: :required,
           input: self,
           check_class: Servactory::InputArguments::Checks::Required,
-          define_input_methods: lambda do
-            <<-RUBY
-              def required?
-                Servactory::Utils.boolean?(required[:is])
-              end
-
-              def optional?
-                !required?
-              end
-            RUBY
-          end,
-          define_conflicts: lambda do
-            <<-RUBY
-              return :required_vs_default if required? && default_value_present?
-            RUBY
-          end,
+          define_input_methods: [
+            DefineInputMethod.new(
+              name: :required?,
+              content: ->(value:) { Servactory::Utils.boolean?(value[:is]) }
+            ),
+            DefineInputMethod.new(
+              name: :optional?,
+              content: ->(value:) { !Servactory::Utils.boolean?(value[:is]) }
+            )
+          ],
+          define_input_conflicts: [
+            DefineInputConflict.new(content: -> { return :required_vs_default if required? && default_value_present? })
+          ],
           need_for_checks: true,
           value_key: :is,
           value_fallback: true,
@@ -72,8 +79,8 @@ module Servactory
         collection_of_options << Option.new(
           name: :types,
           input: self,
-          original_value: Array(type),
           check_class: Servactory::InputArguments::Checks::Type,
+          original_value: Array(type),
           need_for_checks: true,
           value_fallback: nil,
           with_advanced_mode: false
@@ -85,13 +92,12 @@ module Servactory
           name: :default,
           input: self,
           check_class: Servactory::InputArguments::Checks::Type,
-          define_input_methods: lambda do
-            <<-RUBY
-              def default_value_present?
-                !default.nil?
-              end
-            RUBY
-          end,
+          define_input_methods: [
+            DefineInputMethod.new(
+              name: :default_value_present?,
+              content: ->(value:) { !value.nil? }
+            )
+          ],
           need_for_checks: true,
           value_fallback: nil,
           with_advanced_mode: false,
@@ -104,19 +110,16 @@ module Servactory
           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,
+          define_input_methods: [
+            DefineInputMethod.new(
+              name: :array?,
+              content: ->(value:) { Servactory::Utils.boolean?(value[:is]) }
+            )
+          ],
+          define_input_conflicts: [
+            DefineInputConflict.new(content: -> { return :array_vs_array if array? && types.include?(Array) }),
+            DefineInputConflict.new(content: -> { return :array_vs_inclusion if array? && inclusion_present? })
+          ],
           need_for_checks: false,
           value_key: :is,
           value_fallback: false,
@@ -129,13 +132,12 @@ module Servactory
           name: :inclusion,
           input: self,
           check_class: Servactory::InputArguments::Checks::Inclusion,
-          define_input_methods: lambda do
-            <<-RUBY
-              def inclusion_present?
-                inclusion[:in].is_a?(Array) && inclusion[:in].present?
-              end
-            RUBY
-          end,
+          define_input_methods: [
+            DefineInputMethod.new(
+              name: :inclusion_present?,
+              content: ->(value:) { value[:in].is_a?(Array) && value[:in].present? }
+            )
+          ],
           need_for_checks: true,
           value_key: :in,
           value_fallback: nil,
@@ -148,13 +150,12 @@ module Servactory
           name: :must,
           input: self,
           check_class: Servactory::InputArguments::Checks::Must,
-          define_input_methods: lambda do
-            <<-RUBY
-              def must_present?
-                must.present?
-              end
-            RUBY
-          end,
+          define_input_methods: [
+            DefineInputMethod.new(
+              name: :must_present?,
+              content: ->(value:) { value.present? }
+            )
+          ],
           need_for_checks: true,
           value_key: :is,
           value_fallback: nil,
@@ -167,15 +168,14 @@ module Servactory
         collection_of_options << Option.new(
           name: :internal,
           input: self,
-          define_input_methods: lambda do
-            <<-RUBY
-              def internal?
-                Servactory::Utils.boolean?(internal[:is])
-              end
-            RUBY
-          end,
-          need_for_checks: false,
           check_class: nil,
+          define_input_methods: [
+            DefineInputMethod.new(
+              name: :internal?,
+              content: ->(value:) { Servactory::Utils.boolean?(value[:is]) }
+            )
+          ],
+          need_for_checks: false,
           value_key: :is,
           value_fallback: false,
           **options
@@ -187,9 +187,7 @@ module Servactory
       end
 
       def conflict_code
-        instance_eval(collection_of_options.defined_conflicts)
-
-        nil
+        collection_of_options.defined_conflict_code
       end
 
       def with_conflicts?

data/lib/servactory/input_arguments/option.rb

@@ -9,7 +9,8 @@ module Servactory
 
       attr_reader :name,
                   :check_class,
-                  :define_conflicts,
+                  :define_input_methods,
+                  :define_input_conflicts,
                   :need_for_checks,
                   :value_key,
                   :value
@@ -24,13 +25,14 @@ module Servactory
         original_value: nil,
         value_key: nil,
         define_input_methods: nil,
-        define_conflicts: nil,
+        define_input_conflicts: nil,
         with_advanced_mode: true,
         **options
       ) # do
         @name = name.to_sym
         @check_class = check_class
-        @define_conflicts = define_conflicts
+        @define_input_methods = define_input_methods
+        @define_input_conflicts = define_input_conflicts
         @need_for_checks = need_for_checks
         @value_key = value_key
 
@@ -41,7 +43,7 @@ module Servactory
           with_advanced_mode: with_advanced_mode
         )
 
-        input.instance_eval(define_input_methods.call) if define_input_methods.present?
+        prepare_input_methods_for(input)
       end
       # rubocop:enable Metrics/MethodLength
 
@@ -73,6 +75,22 @@ module Servactory
           DEFAULT_VALUE.call(key: value_key, value: value)
         end
       end
+
+      def prepare_input_methods_for(input)
+        input.instance_eval(define_input_methods_template) if define_input_methods_template.present?
+      end
+
+      def define_input_methods_template
+        return if @define_input_methods.blank?
+
+        @define_input_methods_template ||= @define_input_methods.map do |define_input_method|
+          <<-RUBY
+            def #{define_input_method.name}
+              #{define_input_method.content.call(value: @value)}
+            end
+          RUBY
+        end.join("\n")
+      end
     end
   end
 end

data/lib/servactory/input_arguments/options_collection.rb

@@ -5,10 +5,10 @@ module Servactory
     class OptionsCollection
       # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
       extend Forwardable
-      def_delegators :@collection, :<<, :filter, :each, :map
+      def_delegators :@collection, :<<, :filter, :each, :map, :flat_map
 
       def initialize(*)
-        @collection = []
+        @collection = Set.new
       end
 
       def check_classes
@@ -27,8 +27,12 @@ module Servactory
         end
       end
 
-      def defined_conflicts
-        map { |option| option.define_conflicts&.call }.reject(&:blank?).uniq.join
+      def defined_conflict_code
+        flat_map do |option|
+          option.define_input_conflicts&.map do |define_input_conflict|
+            define_input_conflict.content.call
+          end
+        end.reject(&:blank?).first
       end
     end
   end

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

@@ -13,8 +13,6 @@ module Servactory
           @incoming_arguments = incoming_arguments
           @collection_of_input_arguments = collection_of_input_arguments
           @collection_of_input_options = collection_of_input_options
-
-          @errors = []
         end
 
         def check!
@@ -42,7 +40,7 @@ module Servactory
               check_options: check_options
             )
 
-            @errors.push(*errors_from_checks)
+            errors.merge(errors_from_checks.to_a)
           end
         end
 
@@ -64,8 +62,12 @@ module Servactory
 
         ########################################################################
 
+        def errors
+          @errors ||= CheckErrors.new
+        end
+
         def raise_errors
-          return if (tmp_errors = @errors.reject(&:blank?).uniq).empty?
+          return if (tmp_errors = errors.not_blank).empty?
 
           raise Servactory.configuration.input_argument_error_class, tmp_errors.first
         end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Servactory
+  module InputArguments
+    module Tools
+      class CheckErrors
+        # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
+        extend Forwardable
+        def_delegators :@collection, :merge, :reject, :first, :empty?
+
+        def initialize(collection = Set.new)
+          @collection = collection
+        end
+
+        def not_blank
+          CheckErrors.new(reject(&:blank?))
+        end
+      end
+    end
+  end
+end

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

@@ -31,7 +31,7 @@ module Servactory
           input_value = @incoming_arguments.fetch(input.name, nil)
           input_value = input.default if input.optional? && input_value.blank?
 
-          @inputs_variables[input.name] = input_value
+          @inputs_variables[input.internal_name] = input_value
 
           return unless input.internal?
 

data/lib/servactory/internal_arguments/collection.rb

@@ -8,7 +8,7 @@ module Servactory
       def_delegators :@collection, :<<, :each, :map
 
       def initialize(*)
-        @collection = []
+        @collection = Set.new
       end
 
       def names

data/lib/servactory/output_arguments/collection.rb

@@ -8,7 +8,7 @@ module Servactory
       def_delegators :@collection, :<<, :each, :map
 
       def initialize(*)
-        @collection = []
+        @collection = Set.new
       end
 
       def names

data/lib/servactory/result.rb

@@ -9,13 +9,24 @@ module Servactory
     private
 
     def prepare_for(context:, collection_of_output_arguments:)
+      prepare_outputs_with(context: context, collection_of_output_arguments: collection_of_output_arguments)
+      prepare_statuses_with(context: context)
+
+      self
+    end
+
+    def prepare_outputs_with(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
+    end
 
-      self
+    def prepare_statuses_with(context:)
+      define_singleton_method(:errors) { context.errors }
+      define_singleton_method(:success?) { context.errors.empty? }
+      define_singleton_method(:failure?) { !context.errors.empty? }
     end
   end
 end

data/lib/servactory/stage/methods.rb

@@ -8,7 +8,7 @@ module Servactory
       def_delegators :@methods, :<<, :each
 
       def initialize(*)
-        @methods = []
+        @methods = Set.new
       end
     end
   end

data/lib/servactory/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.5
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -177,16 +177,20 @@ files:
 - 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