servactory 1.4.6 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 995ff46dfe5e3620a05d0bbe4b21f515de2b63e593f971e1ec906721cd4bfb6d
-  data.tar.gz: 9df30c884f28760025da0a9f1e68ccb12a42e5cea702602c086fd0b31212da62
+  metadata.gz: 417ec054ab2d314d3a54167a81ee92408cc3f631fea88220d85d06838dcb86db
+  data.tar.gz: 4e49086ca53660fd8e7e7cddce9734092703278f6da7f3880b43922ae053fe49
 SHA512:
-  metadata.gz: 6bf7a7a0b667c3dce0926747b36fa85dc7cb6452e54cf7a51367918f8530cd09996a0d21e5d19d0fc06bc91cdfa3c00f2f0a464b9816738b9ea935b88c0d997b
-  data.tar.gz: 8b29bf3059b7420492c63321737eca8b9f79deea94ce52dfb5dd203c70f0a8fecbbeb29b55e2eb73a687220f85cbb71a5bd85664cd5b45a404e2cbe7ed168a42
+  metadata.gz: b511278027c0384d1643b46b3b88a48e17f1f2b5685824f06190f98c07f5e4398a5494b9da8c2c75250ed14c1f3b3123b2c917bb00fa0a9159b5ccecc1fc2117
+  data.tar.gz: '0865a04061268ae4e582a499728b4b881d41d398cf322c9a91f10d24f14588904b1c65dca2f81750bd5bd912ac04384344216d73aed6f5699499c50531a884f6'

data/README.md

@@ -26,7 +26,7 @@ A set of tools for building reliable services of any complexity.
     - [Must](#must)
   - [Output attributes](#output-attributes)
   - [Internal attributes](#internal-attributes)
-  - [Stage](#stage)
+  - [Make](#make)
   - [Failures](#failures)
 - [I18n](#i18n)
 - [Testing](#testing)
@@ -102,7 +102,7 @@ end
 
 ```ruby
 class MinimalService < ApplicationService::Base
-  stage { make :call }
+  make :call
   
   private
   
@@ -164,8 +164,8 @@ With this approach, all input attributes are available only from `inputs`. This
 ```ruby
 class UsersService::Accept < ApplicationService::Base
   input :user, type: User
-  
-  stage { make :accept! }
+
+  make :accept!
   
   private
   
@@ -182,8 +182,8 @@ With this approach, all input attributes are available from `inputs` as well as
 ```ruby
 class UsersService::Accept < ApplicationService::Base
   input :user, type: User, internal: true
-  
-  stage { make :accept! }
+
+  make :accept!
   
   private
   
@@ -217,7 +217,7 @@ class NotificationService::Create < ApplicationService::Base
 
   output :notification, type: Notification
 
-  stage { make :create_notification! }
+  make :create_notification!
 
   private
 
@@ -273,8 +273,8 @@ class NotificationService::Create < ApplicationService::Base
   input :user, type: User
   
   output :notification, type: Notification
-  
-  stage { make :create_notification! }
+
+  make :create_notification!
   
   private
   
@@ -293,11 +293,9 @@ class NotificationService::Create < ApplicationService::Base
   internal :inviter, type: User
   
   output :notification, type: Notification
-  
-  stage do
-    make :assign_inviter
-    make :create_notification!
-  end
+
+  make :assign_inviter
+  make :create_notification!
   
   private
   
@@ -311,14 +309,12 @@ class NotificationService::Create < ApplicationService::Base
 end
 ```
 
-### Stage
-
-A "stage" is a single action or group of actions that needs to be "make".
+### Make
 
 #### Minimal example
 
 ```ruby
-stage { make :something }
+make :something
 
 def something
   # ...
@@ -328,26 +324,19 @@ end
 #### Condition
 
 ```ruby
-stage { make :something, if: -> { Settings.something.enabled } }
+make :something, if: -> { Settings.something.enabled }
 
 def something
   # ...
 end
 ```
 
-#### Groups
-
-The functionality of stage groups will be expanded in future releases.
+#### Several
 
 ```ruby
-stage do
-  make :assign_api_model
-  make :perform_api_request
-end
-
-stage do
-  make :process_result
-end
+make :assign_api_model
+make :perform_api_request
+make :process_result
 
 def assign_api_model
   self.api_model = APIModel.new
@@ -362,14 +351,18 @@ def process_result
 end
 ```
 
+#### Inheritance
+
+Service inheritance is also supported.
+
 ### Failures
 
-The methods that are used in the stages may fail. In order to more informatively provide information about this outside the service, the following methods were prepared.
+The methods that are used in `make` may fail. In order to more informatively provide information about this outside the service, the following methods were prepared.
 
 #### Fail
 
 ```ruby
-stage { make :check! }
+make :check!
 
 def check!
   return if inputs.invoice_number.start_with?("AA")
@@ -381,7 +374,7 @@ end
 #### Fail for input
 
 ```ruby
-stage { make :check! }
+make :check!
 
 def check!
   return if inputs.invoice_number.start_with?("AA")

data/lib/servactory/base.rb

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

data/lib/servactory/context/callable.rb

@@ -18,7 +18,7 @@ module Servactory
 
         input_arguments_workbench.check!
 
-        stage_handyman.run_methods!
+        make_methods_workbench.run!
 
         context_store.context.raise_first_fail
 
@@ -43,7 +43,7 @@ module Servactory
 
         input_arguments_workbench.check!
 
-        stage_handyman.run_methods!
+        make_methods_workbench.run!
 
         Servactory::Result.prepare_for(
           context: context_store.context,
@@ -55,7 +55,7 @@ module Servactory
 
       attr_reader :context_store
 
-      def assign_data_with(arguments) # rubocop:disable Metrics/AbcSize
+      def assign_data_with(arguments)
         input_arguments_workbench.assign(
           context: context_store.context,
           arguments: arguments,
@@ -64,7 +64,7 @@ module Servactory
 
         internal_arguments_workbench.assign(context: context_store.context)
         output_arguments_workbench.assign(context: context_store.context)
-        stage_handyman&.assign(context: context_store.context)
+        make_methods_workbench.assign(context: context_store.context)
       end
 
       def prepare_data

data/lib/servactory/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Servactory
+  class Engine < Rails::Engine
+    isolate_namespace Servactory
+  end
+end

data/lib/servactory/input_arguments/collection.rb

@@ -5,7 +5,7 @@ module Servactory
     class Collection
       # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
       extend Forwardable
-      def_delegators :@collection, :<<, :each, :map
+      def_delegators :@collection, :<<, :each, :map, :merge
 
       def initialize(*)
         @collection = Set.new

data/lib/servactory/input_arguments/dsl.rb

@@ -8,6 +8,12 @@ module Servactory
       end
 
       module ClassMethods
+        def inherited(child)
+          super
+
+          child.send(:collection_of_input_arguments).merge(collection_of_input_arguments)
+        end
+
         private
 
         def input(name, **options)

data/lib/servactory/internal_arguments/collection.rb

@@ -5,7 +5,7 @@ module Servactory
     class Collection
       # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
       extend Forwardable
-      def_delegators :@collection, :<<, :each, :map
+      def_delegators :@collection, :<<, :each, :map, :merge
 
       def initialize(*)
         @collection = Set.new

data/lib/servactory/internal_arguments/dsl.rb

@@ -8,6 +8,12 @@ module Servactory
       end
 
       module ClassMethods
+        def inherited(child)
+          super
+
+          child.send(:collection_of_internal_arguments).merge(collection_of_internal_arguments)
+        end
+
         private
 
         def internal(name, **options)

data/lib/servactory/internal_arguments/workbench.rb

@@ -21,7 +21,8 @@ module Servactory
 
       private
 
-      attr_reader :context, :collection_of_internal_arguments
+      attr_reader :context,
+                  :collection_of_internal_arguments
     end
   end
 end

data/lib/servactory/{stage/methods.rb → make_methods/collection.rb}

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Stage
-    class Methods
+  module MakeMethods
+    class Collection
       # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
       extend Forwardable
-      def_delegators :@methods, :<<, :each
+      def_delegators :@collection, :<<, :each, :merge
 
       def initialize(*)
-        @methods = Set.new
+        @collection = Set.new
       end
     end
   end

data/lib/servactory/make_methods/dsl.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Servactory
+  module MakeMethods
+    module DSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def inherited(child)
+          super
+
+          child.send(:collection_of_make_methods).merge(collection_of_make_methods)
+        end
+
+        private
+
+        def make(name, **options)
+          collection_of_make_methods << MakeMethod.new(name, **options)
+        end
+
+        def collection_of_make_methods
+          @collection_of_make_methods ||= Collection.new
+        end
+
+        def make_methods_workbench
+          @make_methods_workbench ||= Workbench.work_with(collection_of_make_methods)
+        end
+      end
+    end
+  end
+end

data/lib/servactory/{stage/method.rb → make_methods/make_method.rb}

@@ -1,21 +1,16 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Stage
-    class Method
-      attr_reader :name, :condition
+  module MakeMethods
+    class MakeMethod
+      attr_reader :name,
+                  :condition
 
       def initialize(name, **options)
         @name = name
 
         @condition = options.fetch(:if, nil)
       end
-
-      # def options
-      #   {
-      #     condition:
-      #   }
-      # end
     end
   end
 end

data/lib/servactory/make_methods/workbench.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Servactory
+  module MakeMethods
+    class Workbench
+      def self.work_with(...)
+        new(...)
+      end
+
+      def initialize(collection_of_make_methods)
+        @collection_of_make_methods = collection_of_make_methods
+      end
+
+      def assign(context:)
+        @context = context
+      end
+
+      def run!
+        collection_of_make_methods.each do |make_method|
+          next if unnecessary_for?(make_method)
+
+          context.send(make_method.name)
+        end
+      end
+
+      private
+
+      attr_reader :context,
+                  :collection_of_make_methods
+
+      def unnecessary_for?(make_method)
+        condition = make_method.condition
+
+        return false if condition.blank?
+        return !Servactory::Utils.boolean?(condition) unless condition.is_a?(Proc)
+
+        !condition.call(context)
+      end
+    end
+  end
+end

data/lib/servactory/output_arguments/collection.rb

@@ -5,7 +5,7 @@ module Servactory
     class Collection
       # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
       extend Forwardable
-      def_delegators :@collection, :<<, :each, :map
+      def_delegators :@collection, :<<, :each, :map, :merge
 
       def initialize(*)
         @collection = Set.new

data/lib/servactory/output_arguments/dsl.rb

@@ -8,6 +8,12 @@ module Servactory
       end
 
       module ClassMethods
+        def inherited(child)
+          super
+
+          child.send(:collection_of_output_arguments).merge(collection_of_output_arguments)
+        end
+
         private
 
         def output(name, **options)

data/lib/servactory/version.rb

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

data/lib/servactory.rb

@@ -5,7 +5,6 @@ require "zeitwerk"
 require "active_support/core_ext/string"
 
 # require "servactory/support/loader"
-# require "servactory/engine"
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
@@ -29,6 +28,8 @@ module Servactory
   end
 end
 
+require "servactory/engine" if defined?(Rails::Engine)
+
 # require_relative "servactory/exceptions"
 
 # require_relative "servactory/base"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.5.0
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -186,6 +186,7 @@ files:
 - lib/servactory/context/workspace.rb
 - lib/servactory/context/workspace/error.rb
 - lib/servactory/context/workspace/errors.rb
+- lib/servactory/engine.rb
 - lib/servactory/errors/base.rb
 - lib/servactory/errors/failure.rb
 - lib/servactory/errors/input_argument_error.rb
@@ -218,6 +219,10 @@ files:
 - lib/servactory/internal_arguments/internal_argument.rb
 - lib/servactory/internal_arguments/tools/prepare.rb
 - lib/servactory/internal_arguments/workbench.rb
+- lib/servactory/make_methods/collection.rb
+- lib/servactory/make_methods/dsl.rb
+- lib/servactory/make_methods/make_method.rb
+- lib/servactory/make_methods/workbench.rb
 - lib/servactory/output_arguments/checks/base.rb
 - lib/servactory/output_arguments/checks/type.rb
 - lib/servactory/output_arguments/collection.rb
@@ -227,11 +232,6 @@ files:
 - lib/servactory/output_arguments/tools/prepare.rb
 - lib/servactory/output_arguments/workbench.rb
 - lib/servactory/result.rb
-- lib/servactory/stage/dsl.rb
-- lib/servactory/stage/factory.rb
-- lib/servactory/stage/handyman.rb
-- lib/servactory/stage/method.rb
-- lib/servactory/stage/methods.rb
 - lib/servactory/utils.rb
 - lib/servactory/version.rb
 homepage: https://github.com/afuno/servactory

data/lib/servactory/stage/dsl.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Stage
-    module DSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        private
-
-        attr_reader :stage_handyman
-
-        def stage(&block)
-          @stage_factory ||= Factory.new
-
-          @stage_factory.instance_eval(&block)
-
-          @stage_handyman = Handyman.work_in(@stage_factory)
-
-          # @stage_factory
-
-          nil
-        end
-      end
-    end
-  end
-end

data/lib/servactory/stage/factory.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Stage
-    class Factory
-      def make(name, **options)
-        methods << Method.new(name, **options)
-      end
-
-      def methods
-        @methods ||= Methods.new
-      end
-    end
-  end
-end

data/lib/servactory/stage/handyman.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Stage
-    class Handyman
-      def self.work_in(...)
-        new(...)
-      end
-
-      def initialize(factory)
-        @factory = factory
-      end
-
-      def assign(context:)
-        @context = context
-      end
-
-      def methods
-        factory.methods
-      end
-
-      def run_methods!
-        methods.each do |method|
-          next if method.condition && !method.condition.call(context)
-
-          context.send(method.name)
-        end
-      end
-
-      private
-
-      attr_reader :factory, :context
-    end
-  end
-end