servactory 1.6.5 → 1.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0ef0253d0030321767ea6a532f52fada7923dcf9f0cc87e7651d7df5a1ec57
-  data.tar.gz: 5e080cef06176ffdd734802503cf987fa6608f3acccf7d1497da6ad0968142c9
+  metadata.gz: c8df03a33262af045766ff179c047c3260b85f182aa0541137597e13d7d50bbe
+  data.tar.gz: 813454694dafd13757259a9c45ad455e30e4fd73013a8d51b5022624d3bd194a
 SHA512:
-  metadata.gz: 1195d6f2dcebe355307197eaf11cf0591ba5d9486020572afc8e4991741920664d0f8525052c1d1742e9af14eee627634e7be439529e9827ecfdaa437e87c8a0
-  data.tar.gz: 48ed814dff14b30ac71d3484649ac7412e54ec8edcdc2bc8bcaa925d2babac1573efd473547717d83ea821064926ca8a9810c34fa91995d018d7b5e6c23bc221
+  metadata.gz: b61bf7ef77779b5f8c697c514a2af1baac91095c553a31ff60c9e6080233f6153eae13b24a818e527a3f887755e35c3643ffd81c47fbbabdb5c64f8dc1a98054
+  data.tar.gz: 9722ed5fff0d2390a11636e2dc28e313cb338c726e8a9c630c4eee75ac1046a8684cb7dc7385691aaab7393bf1b9568a61b500c5a2334ca2d157d2eb239988d5

data/README.md

@@ -9,6 +9,53 @@ A set of tools for building reliable services of any complexity.
 
 See [servactory.com](https://servactory.com) for documentation.
 
+## Examples
+
+### Service
+
+```ruby
+class UserService::Authenticate < ApplicationService::Base
+  input :email, type: String
+  input :password, type: String
+
+  output :user, type: User
+
+  private
+
+  def call
+    if (user = User.find_by(email: inputs.email)&.authenticate(inputs.password))
+      self.user = user
+    else
+      fail!(message: "Authentication failed")
+    end
+  end
+end
+```
+
+### Using in controller
+
+```ruby
+class SessionsController < ApplicationController
+  def create
+    service_result = UserService::Authenticate.call(**session_params)
+
+    if service_result.success?
+      session[:current_user_id] = service_result.user.id
+      redirect_to service_result.user
+    else
+      flash.now[:message] = service_result.errors.first.message
+      render :new
+    end
+  end
+
+  private
+
+  def session_params
+    params.require(:session).permit(:email, :password)
+  end
+end
+```
+
 ## Contributing
 
 This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. We recommend reading the [contributing guide](./website/docs/CONTRIBUTING.md) as well.

data/lib/servactory/inputs/dsl.rb

@@ -16,9 +16,10 @@ module Servactory
 
         private
 
-        def input(name, **options)
+        def input(name, *helpers, **options)
           collection_of_inputs << Input.new(
             name,
+            *helpers,
             **options
           )
         end

data/lib/servactory/inputs/input.rb

@@ -5,12 +5,21 @@ module Servactory
     class Input # rubocop:disable Metrics/ClassLength
       ARRAY_DEFAULT_VALUE = ->(is: false, message: nil) { { is: is, message: message } }
 
+      HELPER_LIBRARY = {
+        optional: { required: false },
+        internal: { internal: true },
+        as_array: { array: true }
+      }.freeze
+
+      private_constant :ARRAY_DEFAULT_VALUE, :HELPER_LIBRARY
+
       attr_reader :name,
                   :internal_name
 
       # rubocop:disable Style/KeywordParametersOrder
       def initialize(
         name,
+        *helpers,
         as: nil,
         type:,
         **options
@@ -18,6 +27,8 @@ module Servactory
         @name = name
         @internal_name = as.present? ? as : name
 
+        options = apply_helpers_for_options(helpers: helpers, options: options) if helpers.present?
+
         add_basic_options_with(type: type, options: options)
 
         collection_of_options.each do |option|
@@ -28,6 +39,20 @@ module Servactory
       end
       # rubocop:enable Style/KeywordParametersOrder
 
+      def apply_helpers_for_options(helpers:, options:)
+        prepared_options = {}
+
+        helpers.each do |helper|
+          next unless HELPER_LIBRARY.key?(helper)
+
+          found_helper = HELPER_LIBRARY[helper]
+
+          prepared_options.merge!(found_helper)
+        end
+
+        options.merge(prepared_options)
+      end
+
       def add_basic_options_with(type:, options:)
         # Check Class: Servactory::Inputs::Validations::Required
         add_required_option_with(options)
@@ -63,7 +88,7 @@ module Servactory
             )
           ],
           define_input_conflicts: [
-            DefineInputConflict.new(content: -> { return :required_vs_default if required? && default_value_present? })
+            DefineInputConflict.new(content: -> { :required_vs_default if required? && default_value_present? })
           ],
           need_for_checks: true,
           value_key: :is,
@@ -114,8 +139,8 @@ module Servactory
             )
           ],
           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? })
+            DefineInputConflict.new(content: -> { :array_vs_array if array? && types.include?(Array) }),
+            DefineInputConflict.new(content: -> { :array_vs_inclusion if array? && inclusion_present? })
           ],
           need_for_checks: false,
           value_key: :is,

data/lib/servactory/internals/validations/type.rb

@@ -31,6 +31,8 @@ module Servactory
         end
 
         def validate!
+          return unless should_be_checked?
+
           return if prepared_types.any? { |type| @value.is_a?(type) }
 
           raise_error_with(
@@ -44,6 +46,12 @@ module Servactory
 
         private
 
+        def should_be_checked?
+          @internal.required? || (
+            @internal.optional? && !@value.nil?
+          )
+        end
+
         def prepared_types
           @prepared_types ||=
             Array(@internal.types).map do |type|

data/lib/servactory/outputs/validations/type.rb

@@ -31,6 +31,8 @@ module Servactory
         end
 
         def validate!
+          return unless should_be_checked?
+
           return if prepared_types.any? { |type| @value.is_a?(type) }
 
           raise_error_with(
@@ -44,6 +46,14 @@ module Servactory
 
         private
 
+        def should_be_checked?
+          @output.required? || (
+            @output.optional? && !@output.default.nil?
+          ) || (
+            @output.optional? && !@value.nil?
+          )
+        end
+
         def prepared_types
           @prepared_types ||=
             Array(@output.types).map do |type|

data/lib/servactory/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.6.6
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport