servactory 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ef221cf056da7376cec0a04e0dd92ddba328f34163fe050d74e3f0158eb1e17
-  data.tar.gz: 2bc1b62867fb2e6c09692bfd76c315bbf739202b445fc99e46511b6dd3437c6f
+  metadata.gz: e9766f87f647b0873a6671d88811141a77b571fb15ac5ee6b10b78e2e5696ca6
+  data.tar.gz: c36ee73abad2d9241f6b48190cbf3351fe8c9c40bc7cb9bdfdfb09c04e5d05f8
 SHA512:
-  metadata.gz: 126ca96b81dcbea82334b216f9b911c33282aca4c66c26d511655339cd56184ce6fac7475420184f6fcd4681d34afe210f8ebffe18e0894c635c6bcbdc045754
-  data.tar.gz: 22675c25495d5e2b3edfda926c5392985294c78c03e0e2d6f8930b8a8d5a7618dc94dd7cec413fba5b6ce234d23bbeea44c68cf58fc95d0e223c73c437721b43
+  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/input_arguments/checks/must.rb

@@ -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)
 

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}`, " \

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)
@@ -35,6 +37,17 @@ module Servactory
         }
       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/version.rb

@@ -3,7 +3,7 @@
 module Servactory
   module VERSION
     MAJOR = 1
-    MINOR = 2
+    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.2.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