servactory 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ba22a3302a9dde10fcadfc2cc5777e83589e86862b8e96484ddd3ad62e78782
-  data.tar.gz: 4fa891477fb78494b3df34bb50f3b5bea018d331471662e235d91c49d82b9e6c
+  metadata.gz: e9766f87f647b0873a6671d88811141a77b571fb15ac5ee6b10b78e2e5696ca6
+  data.tar.gz: c36ee73abad2d9241f6b48190cbf3351fe8c9c40bc7cb9bdfdfb09c04e5d05f8
 SHA512:
-  metadata.gz: c4c5e7cbf5c7708cc468f25152086d974c1ecfee76222bade55215c4f14ee9b0b20194755338152ac21e72845e8c1358f4e185b08b6db08319c48990b5cf43ef
-  data.tar.gz: 70c1325c6b7de415565d41f4471798d1349c0627eeca7a329b876d703500b338acb725a5bd5adc41578656488541a13690358d377799c493f8e8ba719bb1c710
+  metadata.gz: 11b27258c9a302cb989eed03fe4f1325c03855f58fd3a79b6cad7a3846fa8e9395f780fe0d9a2dd30c9b044d4e98df4677857c93c275f9bfe8780d6ebefe5d5e
+  data.tar.gz: 57800e68b8c8bece089513dcf0b0ff8da6ab2efb33a4d4a694b11995dae51b7dd0496b1b0f4b6c0ba403db5c6037432e43371d68bea5b56bb05844d98fb36e8e

data/README.md

@@ -81,36 +81,105 @@ class SendService < ApplicationService::Base
 end
 ```
 
-### Inputs
+### Input attributes
+
+#### Isolated usage
+
+With this approach, all input attributes are available only from `inputs`.
 
 ```ruby
-class SendService < ApplicationService::Base
+class UserService::Accept < ApplicationService::Base
   input :user, type: User
   
-  stage { make :something }
+  stage { make :accept! }
   
   private
   
-  def something
-    # ...
+  def accept!
+    inputs.user.accept!
   end
 end
 ```
 
-### Outputs
+#### As an internal argument
+
+With this approach, all input attributes are available from `inputs` as well as directly from the context.
 
 ```ruby
-class SendService < ApplicationService::Base
+class UserService::Accept < ApplicationService::Base
+  input :user, type: User, internal: true
+  
+  stage { make :accept! }
+  
+  private
+  
+  def accept!
+    user.accept!
+  end
+end
+```
+
+### Output attributes
+
+```ruby
+class NotificationService::Create < ApplicationService::Base
   input :user, type: User
   
   output :notification, type: Notification
   
-  stage { make :something }
+  stage { make :create_notification! }
   
   private
   
-  def something
-    self.notification = Notification.create!
+  def create_notification!
+    self.notification = Notification.create!(user: inputs.user)
+  end
+end
+```
+
+### Internal attributes
+
+```ruby
+class NotificationService::Create < ApplicationService::Base
+  input :user, type: User
+
+  internal :inviter, type: User
+  
+  output :notification, type: Notification
+  
+  stage do
+    make :assign_inviter
+    make :create_notification!
+  end
+  
+  private
+  
+  def assign_inviter
+    self.inviter = user.inviter
+  end
+  
+  def create_notification!
+    self.notification = Notification.create!(user: inputs.user, inviter:)
   end
 end
 ```
+
+### Result
+
+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)
+```
+
+Will return this:
+
+```ruby
+#<Servactory::Result:0x0000000112c00748 @notification=...>
+```
+
+And then you can work with this result, for example, in this way:
+
+```ruby
+Notification::SendJob.perform_later(service_result.notification.id)
+```

data/lib/servactory/context/dsl.rb

@@ -15,7 +15,9 @@ module Servactory
 
           input_arguments_workbench.find_unnecessary!
           input_arguments_workbench.check_rules!
-          output_arguments_workbench.find_conflicts_in!(collection_of_internal_arguments:)
+          output_arguments_workbench.find_conflicts_in!(
+            collection_of_internal_arguments: collection_of_internal_arguments
+          )
 
           prepare_data
 
@@ -25,7 +27,7 @@ module Servactory
 
           Servactory::Result.prepare_for(
             context: context_store.context,
-            collection_of_output_arguments:
+            collection_of_output_arguments: collection_of_output_arguments
           )
         end
 
@@ -34,10 +36,10 @@ module Servactory
         attr_reader :context_store
 
         def assign_data_with(arguments)
-          input_arguments_workbench.assign(context: context_store.context, arguments:)  # 1
-          internal_arguments_workbench.assign(context: context_store.context)           # 2
-          output_arguments_workbench.assign(context: context_store.context)             # 3
-          stage_handyman&.assign(context: context_store.context)                        # 4
+          input_arguments_workbench.assign(context: context_store.context, arguments: arguments)  # 1
+          internal_arguments_workbench.assign(context: context_store.context)                     # 2
+          output_arguments_workbench.assign(context: context_store.context)                       # 3
+          stage_handyman&.assign(context: context_store.context)                                  # 4
         end
 
         def prepare_data
@@ -47,10 +49,10 @@ module Servactory
           internal_arguments_workbench.prepare  # 3
         end
 
-        def configuration(&)
+        def configuration(&block)
           context_configuration = Servactory::Context::Configuration.new
 
-          context_configuration.instance_eval(&)
+          context_configuration.instance_eval(&block)
         end
       end
     end

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

@@ -13,7 +13,7 @@ module Servactory
         def self.check(context:, input:, value:, check_key:, **)
           return unless should_be_checked_for?(input, check_key)
 
-          new(context:, input:, value:).check
+          new(context: context, input: input, value: value).check
         end
 
         def self.should_be_checked_for?(input, check_key)

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

@@ -14,7 +14,7 @@ module Servactory
         def self.check(context:, input:, value:, check_key:, check_options:)
           return unless should_be_checked_for?(input, check_key)
 
-          new(context:, input:, value:, check_options:).check
+          new(context: context, input: input, value: value, check_options: check_options).check
         end
 
         def self.should_be_checked_for?(input, check_key)
@@ -32,7 +32,7 @@ module Servactory
           @check_options = check_options
         end
 
-        def check
+        def check # rubocop:disable Metrics/MethodLength
           @check_options.each do |code, options|
             message = call_or_fetch_message_from(code, options)
 
@@ -42,7 +42,7 @@ module Servactory
               DEFAULT_MESSAGE,
               service_class_name: @context.class.name,
               input: @input,
-              code:
+              code: code
             )
           end
 
@@ -57,16 +57,15 @@ module Servactory
           return if check.call(value: @value)
 
           message.presence || DEFAULT_MESSAGE
-        rescue StandardError => e
+        rescue StandardError => _e
           message_text =
-            "[#{@context.class.name}] Syntax error inside `#{code}` of " \
-            "`#{@input.name}` input: [#{e.class}] #{e.message}"
+            "[#{@context.class.name}] Syntax error inside `#{code}` of `#{@input.name}` input"
 
           add_error(
             message_text,
             service_class_name: @context.class.name,
             input: @input,
-            code:
+            code: code
           )
         end
       end

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

@@ -17,7 +17,7 @@ module Servactory
         def self.check(context:, input:, value:, **)
           return unless should_be_checked_for?(input)
 
-          new(context:, input:, value:).check
+          new(context: context, input: input, value: value).check
         end
 
         def self.should_be_checked_for?(input)

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

@@ -6,7 +6,15 @@ module Servactory
       class Type < Base
         DEFAULT_MESSAGE = lambda do |service_class_name:, input:, expected_type:, given_type:|
           if input.array?
-            "[#{service_class_name}] Wrong type in input array `#{input.name}`, expected `#{expected_type}`"
+            array_message = input.array[:message]
+
+            if array_message.is_a?(Proc)
+              array_message.call(input: input, expected_type: expected_type)
+            elsif array_message.is_a?(String) && array_message.present?
+              array_message
+            else
+              "[#{service_class_name}] Wrong type in input array `#{input.name}`, expected `#{expected_type}`"
+            end
           else
             "[#{service_class_name}] Wrong type of input `#{input.name}`, " \
               "expected `#{expected_type}`, " \
@@ -19,7 +27,7 @@ module Servactory
         def self.check(context:, input:, value:, check_key:, check_options:)
           return unless should_be_checked_for?(input, value, check_key)
 
-          new(context:, input:, value:, types: check_options).check
+          new(context: context, input: input, value: value, types: check_options).check
         end
 
         def self.should_be_checked_for?(input, value, check_key)

data/lib/servactory/input_arguments/input_argument.rb

@@ -3,6 +3,8 @@
 module Servactory
   module InputArguments
     class InputArgument
+      ARRAY_DEFAULT_VALUE = ->(is: false, message: nil) { { is: is, message: message } }
+
       attr_reader :name,
                   :types,
                   :inclusion,
@@ -18,7 +20,7 @@ module Servactory
 
         @inclusion = options.fetch(:inclusion, nil)
         @must = options.fetch(:must, nil)
-        @array = options.fetch(:array, false)
+        @array = prepare_advanced_for(options.fetch(:array, ARRAY_DEFAULT_VALUE.call))
         @required = options.fetch(:required, true)
         @internal = options.fetch(:internal, false)
         @default = options.fetch(:default, nil)
@@ -26,15 +28,26 @@ module Servactory
 
       def options_for_checks
         {
-          types:,
-          inclusion:,
-          must:,
-          required:,
-          # internal:,
-          default:
+          types: types,
+          inclusion: inclusion,
+          must: must,
+          required: required,
+          # internal: internal,
+          default: default
         }
       end
 
+      def prepare_advanced_for(value)
+        if value.is_a?(Hash)
+          ARRAY_DEFAULT_VALUE.call(
+            is: value.fetch(:is, false),
+            message: value.fetch(:message, nil)
+          )
+        else
+          ARRAY_DEFAULT_VALUE.call(is: value)
+        end
+      end
+
       def conflict_code
         return :required_vs_default if required? && default_value_present?
         return :array_vs_array if array? && types.include?(Array)
@@ -52,7 +65,7 @@ module Servactory
       end
 
       def array?
-        Servactory::Utils.boolean?(array)
+        Servactory::Utils.boolean?(array[:is])
       end
 
       def required?

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

@@ -28,13 +28,18 @@ module Servactory
 
         def process_input(input)
           input.options_for_checks.each do |check_key, check_options|
-            process_option(check_key, check_options, input:)
+            process_option(check_key, check_options, input: input)
           end
         end
 
         def process_option(check_key, check_options, input:)
           check_classes.each do |check_class|
-            errors_from_checks = process_check_class(check_class, input:, check_key:, check_options:)
+            errors_from_checks = process_check_class(
+              check_class,
+              input: input,
+              check_key: check_key,
+              check_options: check_options
+            )
 
             @errors.push(*errors_from_checks)
           end
@@ -43,10 +48,10 @@ module Servactory
         def process_check_class(check_class, input:, check_key:, check_options:)
           check_class.check(
             context: @context,
-            input:,
+            input: input,
             value: @incoming_arguments.fetch(input.name, nil),
-            check_key:,
-            check_options:
+            check_key: check_key,
+            check_options: check_options
           )
         end
 

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

@@ -43,7 +43,7 @@ module Servactory
 
           @context.assign_inputs(Servactory::Inputs.new(**@inputs_variables))
 
-          @context.class.class_eval(context_internal_variables_template)
+          @context.class.class_eval(context_internal_variables_template) if context_internal_variables_template.present?
 
           @internal_variables.each do |input_name, input_value|
             @context.instance_variable_set(:"@#{input_name}", input_value)
@@ -79,8 +79,12 @@ module Servactory
         #   private attr_reader(*[:attr_1]);
         #
         def context_internal_variables_template
-          <<-RUBY.squish
-            private attr_reader(*#{@internal_variables.keys});
+          return if @internal_variables.blank?
+
+          @context_internal_variables_template ||= <<-RUBY.squish
+            private;
+
+            attr_reader(*#{@internal_variables.keys});
           RUBY
         end
       end

data/lib/servactory/internal_arguments/internal_argument.rb

@@ -16,8 +16,8 @@ module Servactory
 
       def options_for_checks
         {
-          types:,
-          required:
+          types: types,
+          required: required
         }
       end
 

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

@@ -42,14 +42,16 @@ module Servactory
             define_method(:#{internal_argument.name}=) do |value|;
               Servactory::InternalArguments::Checks::Type.check!(
                 context: self,
-                internal_argument:,
-                value:
+                internal_argument: internal_argument,
+                value: value
               );
 
               instance_variable_set(:@#{internal_argument.name}, value);
             end;
 
-            private attr_reader :#{internal_argument.name};
+            private;
+
+            attr_reader :#{internal_argument.name};
           RUBY
         end
       end

data/lib/servactory/output_arguments/output_argument.rb

@@ -18,9 +18,9 @@ module Servactory
 
       def options_for_checks
         {
-          types:,
-          required:,
-          default:
+          types: types,
+          required: required,
+          default: default
         }
       end
 

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

@@ -35,21 +35,25 @@ module Servactory
         #     instance_variable_set(:@user, value);
         #   end;
         #
-        #   private attr_reader :user;
+        #   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:
+                output_argument: output_argument,
+                value: value
               );
 
               instance_variable_set(:@#{output_argument.name}, value);
             end;
 
-            private attr_reader :#{output_argument.name};
+            private;
+
+            attr_reader :#{output_argument.name};
           RUBY
         end
       end

data/lib/servactory/stage/dsl.rb

@@ -12,10 +12,10 @@ module Servactory
 
         attr_reader :stage_handyman
 
-        def stage(&)
+        def stage(&block)
           @stage_factory ||= Factory.new
 
-          @stage_factory.instance_eval(&)
+          @stage_factory.instance_eval(&block)
 
           @stage_handyman = Handyman.work_in(@stage_factory)
 

data/lib/servactory/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -223,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="