servactory 1.6.4 → 1.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8baf1ff3aab8a43c92e83987cb5f4cfbc426be9aacabf5fe63dd01e133c891e
-  data.tar.gz: 0af5e8fe8bf02fe5f15c68655e298b2d097b402764d231045683907afa35ded3
+  metadata.gz: c8df03a33262af045766ff179c047c3260b85f182aa0541137597e13d7d50bbe
+  data.tar.gz: 813454694dafd13757259a9c45ad455e30e4fd73013a8d51b5022624d3bd194a
 SHA512:
-  metadata.gz: aa8ffc01e6bab482d397f07e18847ec5d0b70bbd1e94bf7ff1ab6f080efca2502547ee92db3b663ba2bac15c2c6add762094ab37d9c47b73eb7b66f8f3ed9b10
-  data.tar.gz: a15fc2c38e21b6637ff5b9f1273006c0aae2dfe5d8d084390a18e2ce262329510fe80ab2bc16d47f18f3da8a40c5f5daea0533ad4b611a0e9ce8868eacf87b8f
+  metadata.gz: b61bf7ef77779b5f8c697c514a2af1baac91095c553a31ff60c9e6080233f6153eae13b24a818e527a3f887755e35c3643ffd81c47fbbabdb5c64f8dc1a98054
+  data.tar.gz: 9722ed5fff0d2390a11636e2dc28e313cb338c726e8a9c630c4eee75ac1046a8684cb7dc7385691aaab7393bf1b9568a61b500c5a2334ca2d157d2eb239988d5

data/README.md

@@ -9,9 +9,56 @@ 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](./docs/pages/CONTRIBUTING.md) as well.
+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.
 
 ## License
 

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/methods/dsl.rb

@@ -11,17 +11,45 @@ module Servactory
         def inherited(child)
           super
 
-          child.send(:collection_of_methods).merge(collection_of_methods)
+          child.send(:collection_of_stages).merge(collection_of_stages)
         end
 
         private
 
+        def stage(&block)
+          @current_stage = Stage.new(position: next_position)
+
+          instance_eval(&block)
+
+          @current_stage = nil
+
+          nil
+        end
+
+        def wrap_in(wrapper)
+          return if @current_stage.blank?
+
+          @current_stage.wrapper = wrapper
+        end
+
+        def rollback(rollback)
+          return if @current_stage.blank?
+
+          @current_stage.rollback = rollback
+        end
+
         def make(name, position: nil, **options)
-          collection_of_methods << Method.new(
+          position = position.presence || next_position
+
+          @current_stage = @current_stage.presence || Stage.new(position: position)
+
+          @current_stage.methods << Method.new(
             name,
-            position: position.presence || next_position,
+            position: position,
             **options
           )
+
+          collection_of_stages << @current_stage
         end
 
         def method_missing(shortcut_name, *args, &block)
@@ -39,15 +67,15 @@ module Servactory
         end
 
         def next_position
-          collection_of_methods.size + 1
+          collection_of_stages.size + 1
         end
 
-        def collection_of_methods
-          @collection_of_methods ||= Collection.new
+        def collection_of_stages
+          @collection_of_stages ||= StageCollection.new
         end
 
         def methods_workbench
-          @methods_workbench ||= Workbench.work_with(collection_of_methods)
+          @methods_workbench ||= Workbench.work_with(collection_of_stages)
         end
       end
     end

data/lib/servactory/methods/method_collection.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Methods
+    class MethodCollection
+      # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
+      extend Forwardable
+      def_delegators :@collection, :<<, :each, :sort_by
+
+      def initialize(collection = Set.new)
+        @collection = collection
+      end
+
+      def sorted_by_position
+        MethodCollection.new(sort_by(&:position))
+      end
+    end
+  end
+end

data/lib/servactory/methods/stage.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Methods
+    class Stage
+      attr_accessor :position,
+                    :wrapper,
+                    :rollback
+
+      def initialize(position:, wrapper: nil, rollback: nil)
+        @position = position
+        @wrapper = wrapper
+        @rollback = rollback
+      end
+
+      def next_method_position
+        methods.size + 1
+      end
+
+      def methods
+        @methods ||= MethodCollection.new
+      end
+    end
+  end
+end

data/lib/servactory/methods/{collection.rb → stage_collection.rb}

@@ -2,7 +2,7 @@
 
 module Servactory
   module Methods
-    class Collection
+    class StageCollection
       # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
       extend Forwardable
       def_delegators :@collection, :<<, :each, :merge, :sort_by, :size, :empty?
@@ -12,7 +12,7 @@ module Servactory
       end
 
       def sorted_by_position
-        Collection.new(sort_by(&:position))
+        StageCollection.new(sort_by(&:position))
       end
     end
   end

data/lib/servactory/methods/workbench.rb

@@ -7,8 +7,8 @@ module Servactory
         new(...)
       end
 
-      def initialize(collection_of_methods)
-        @collection_of_methods = collection_of_methods
+      def initialize(collection_of_stages)
+        @collection_of_stages = collection_of_stages
       end
 
       def assign(context:)
@@ -16,24 +16,48 @@ module Servactory
       end
 
       def run!
-        return try_to_use_call if collection_of_methods.empty?
+        return try_to_use_call if collection_of_stages.empty?
 
-        collection_of_methods.sorted_by_position.each do |make_method|
-          next if unnecessary_for?(make_method)
-
-          context.send(make_method.name)
+        collection_of_stages.sorted_by_position.each do |stage|
+          call_stage(stage)
         end
       end
 
       private
 
       attr_reader :context,
-                  :collection_of_methods
+                  :collection_of_stages
 
       def try_to_use_call
         context.try(:send, :call)
       end
 
+      def call_stage(stage)
+        wrapper = stage.wrapper
+        rollback = stage.rollback
+        methods = stage.methods.sorted_by_position
+
+        if wrapper.is_a?(Proc)
+          call_wrapper_with_methods(wrapper, rollback, methods)
+        else
+          call_methods(methods)
+        end
+      end
+
+      def call_wrapper_with_methods(wrapper, rollback, methods)
+        wrapper.call(methods: -> { call_methods(methods) })
+      rescue StandardError => e
+        context.send(rollback, e) if rollback.present?
+      end
+
+      def call_methods(methods)
+        methods.each do |make_method|
+          next if unnecessary_for?(make_method)
+
+          context.send(make_method.name)
+        end
+      end
+
       def unnecessary_for?(make_method)
         condition = make_method.condition
         is_condition_opposite = make_method.is_condition_opposite

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 = 4
+    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.4
+  version: 1.6.6
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -231,10 +231,12 @@ files:
 - lib/servactory/internals/validations/base.rb
 - lib/servactory/internals/validations/type.rb
 - lib/servactory/internals/workbench.rb
-- lib/servactory/methods/collection.rb
 - lib/servactory/methods/dsl.rb
 - lib/servactory/methods/method.rb
+- lib/servactory/methods/method_collection.rb
 - lib/servactory/methods/shortcuts/collection.rb
+- lib/servactory/methods/stage.rb
+- lib/servactory/methods/stage_collection.rb
 - lib/servactory/methods/workbench.rb
 - lib/servactory/outputs/collection.rb
 - lib/servactory/outputs/dsl.rb
@@ -252,7 +254,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/afuno/servactory
+  documentation_uri: https://servactory.com
   source_code_uri: https://github.com/afuno/servactory
+  bug_tracker_uri: https://github.com/afuno/servactory/issues
   changelog_uri: https://github.com/afuno/servactory/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: