service_operator 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbf2f3da24a3a69f4bdb08d13390973c846a732b8b15a46c0857cbf3c638e002
-  data.tar.gz: 9f9b1b3cd9b7bc9da0d093879aaff4f9b7c94d86bec63a46e640e05e24c17ce1
+  metadata.gz: 83016688ff1eb93f3668912441267fe9ee1dc49554d4fbd21d3898c81147e38f
+  data.tar.gz: 043a244c0a0526e97622a610ef159b17ea956030e6d0968b34072353b1a7afd7
 SHA512:
-  metadata.gz: 1d7ff1d4a0ed6b5102b94c4b852b59afc378596ab9c5f2280407992568b0d5b626c1d143b81dbf6ebfc9e99e628a1001a4c68e26c65c622d51f1f7cd2346c8fc
-  data.tar.gz: 19f1f61c75495088b1a6e62d89a8c7df6334a8a7f4c7d93b06c7da9bc74bb17a38e7a46ffd37ddf570ae7f8e494413f65a127b4091c351853550bf3e176082db
+  metadata.gz: 37543a1d1c319fd3b6bae20d850f769a7aa50171830772b6fe1ef07a55e32702416e816b2cf0d3b4c1384fd4e165d819330217c8d001f382d272331bc226f92d
+  data.tar.gz: 97673d31c36181d2d0eba27336e2347c55687f4cd68909700a3cd890b6c4d993ae66eacd9d66a9cbadf22a30db1702d7af6dde64226f9bb16c76e5e69384d2d3

data/.rubocop.yml

@@ -23,6 +23,9 @@ Style/Documentation:
 Style/BlockDelimiters:
   Enabled: false
 
+Style/ModuleFunction:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
 

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.2.3] - 2022-09-18
+### Modified
+- changing configuration
+
 ## [0.2.2] - 2022-09-12
 ### Modified
 - generating arguments for method call in Step

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    service_operator (0.2.2)
+    service_operator (0.2.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -15,15 +15,21 @@ $ bundle install
 
 ## Usage
 
-First you need create ApplicationOperator - basis class for your operators
+### Initializer
+
+Add configuration to config/initializers/service_operator.rb:
 ```ruby
-class ApplicationOperator
-  include ServiceOperator
+ServiceOperator.configure do |config|
+  config.call_parameters_method_name = :call_parameters
+end
+```
 
-  # configuration
-  configure do |config|
-    config.call_parameters_method_name = :call_parameters
-  end
+### ApplicationOperator
+
+You can create ApplicationOperator - basis class for your operators
+```ruby
+class ApplicationOperator
+  include ServiceOperator::Helpers
 
   private
 

data/lib/service_operator/configuration.rb

@@ -9,7 +9,7 @@ module ServiceOperator
       @call_method_name = :call
 
       # Operator tries to run this method on step's service for fetching arguments list.
-      @call_parameters_method_name = :call
+      @call_parameters_method_name = nil
 
       # Operator tries to run this method on step's service for checking failure status.
       @failure_method_name = nil

data/lib/service_operator/helpers.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative 'steps'
+require_relative 'step'
+require_relative 'hooks'
+require_relative 'context'
+
+module ServiceOperator
+  module Helpers
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include Steps
+        include Hooks
+
+        attr_reader :context
+      end
+    end
+
+    module ClassMethods
+      def required_params
+        @required_params ||= []
+      end
+
+      # Examples
+      #
+      #   class MyOperator
+      #     include ServiceOperator::Helpers
+      #
+      #     required_context :week
+      #   end
+      #
+      def required_context(*args)
+        @required_params = args.flatten
+      end
+
+      def call(args={})
+        new(**args).call
+      end
+    end
+
+    def initialize(args={})
+      @context = Context.build(args)
+      @context.validate(required_params: self.class.required_params)
+    end
+
+    def call
+      with_hooks { run_steps(self.class.steps) }
+      context
+    # rescue catches errors in before and after steps and stops execution
+    rescue StandardError
+      context
+    end
+
+    def configuration
+      ServiceOperator.instance
+    end
+  end
+end

data/lib/service_operator/hooks.rb

@@ -16,7 +16,7 @@ module ServiceOperator
       # Examples
       #
       #   class MyOperator
-      #     include ServiceOperator
+      #     include ServiceOperator::Helpers
       #
       #     around :use_transaction
       #

data/lib/service_operator/step.rb

@@ -43,15 +43,23 @@ module ServiceOperator
     # Then generate hash with these parameters from operator.context.
     # Then overwrite some of them from step's args.
     def fetch_service_call_arguments(service_object)
-      parameters_list =
-        service_object
-        .method(@operator.configuration.call_parameters_method_name)
-        .parameters
-      return if parameters_list.empty?
+      parameters_list = fetch_parameters_list(service_object)
+      return if parameters_list.nil? || parameters_list.empty?
 
       generate_argument_for_method_call(parameters_list)
     end
 
+    def fetch_parameters_list(service_object)
+      if @operator.configuration.call_parameters_method_name
+        service_object
+          .public_send(@operator.configuration.call_parameters_method_name)
+      else
+        service_object
+          .method(@operator.configuration.call_method_name)
+          .parameters
+      end
+    end
+
     def generate_argument_for_method_call(parameters_list, positional_arguments=[], keyword_arguments={})
       parameters_list.each { |type, name|
         case type
@@ -64,7 +72,7 @@ module ServiceOperator
     end
 
     def fetch_value(name)
-      args[name] ? @operator.send(name) : @operator.context[name]
+      args[name] ? @operator.send(args[name]) : @operator.context[name]
     end
   end
 end

data/lib/service_operator/steps.rb

@@ -24,7 +24,7 @@ module ServiceOperator
       # Examples
       #
       #   class MyOperator
-      #     include ServiceOperator
+      #     include ServiceOperator::Helpers
       #
       #     before :set_start_time
       #     before :initial, service: SomeService
@@ -47,7 +47,7 @@ module ServiceOperator
       # Examples
       #
       #   class MyOperator
-      #     include ServiceOperator
+      #     include ServiceOperator::Helpers
       #
       #     step :set_initiated
       #     step :perform_work, service: AnotherService
@@ -70,7 +70,7 @@ module ServiceOperator
       # Examples
       #
       #   class MyOperator
-      #     include ServiceOperator
+      #     include ServiceOperator::Helpers
       #
       #     after :set_finish_time
       #     after :finishing, service: SomeService

data/lib/service_operator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceOperator
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/service_operator.rb

@@ -1,75 +1,30 @@
 # frozen_string_literal: true
 
-require_relative 'service_operator/version'
-require_relative 'service_operator/steps'
-require_relative 'service_operator/step'
-require_relative 'service_operator/hooks'
-require_relative 'service_operator/context'
-require_relative 'service_operator/configuration'
+require 'service_operator/version'
+require 'service_operator/configuration'
+require 'service_operator/helpers'
 
 module ServiceOperator
-  def self.included(base)
-    base.class_eval do
-      extend ClassMethods
-      include Steps
-      include Hooks
+  extend self
 
-      attr_reader :configuration
-      attr_reader :context
-    end
+  def configuration
+    @configuration ||= Configuration.new
   end
 
-  module ClassMethods
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    # Examples
-    #
-    #   class MyOperator
-    #     include ServiceOperator
-    #
-    #     configure do |config|
-    #       config.call_method_name = :call
-    #       config.call_parameters_method_name = :call
-    #     end
-    #   end
-    #
-    def configure
-      yield(configuration)
-    end
-
-    def required_params
-      @required_params ||= []
-    end
-
-    # Examples
-    #
-    #   class MyOperator
-    #     include ServiceOperator
-    #
-    #     required_context :week
-    #   end
-    #
-    def required_context(*args)
-      @required_params = args.flatten
-    end
-
-    def call(args={})
-      new(**args).call
-    end
-  end
-
-  def initialize(args={})
-    @context = Context.build(args)
-    @context.validate(required_params: self.class.required_params)
+  # Examples
+  #
+  #   ServiceOperator.configure do |config|
+  #     config.call_parameters_method_name = :call_parameters
+  #     config.failure_method_name = :failure?
+  #   end
+  #
+  def configure
+    yield(configuration)
   end
 
-  def call
-    with_hooks { run_steps(self.class.steps) }
-    context
-  # rescue catches errors in before and after steps and stops execution
-  rescue StandardError
-    context
+  # Public: Default per thread service_operator instance if configured.
+  # Returns ServiceOperator::Configuration instance.
+  def instance
+    Thread.current[:service_operator_configuration] ||= configuration
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_operator
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -102,6 +102,7 @@ files:
 - lib/service_operator.rb
 - lib/service_operator/configuration.rb
 - lib/service_operator/context.rb
+- lib/service_operator/helpers.rb
 - lib/service_operator/hooks.rb
 - lib/service_operator/step.rb
 - lib/service_operator/steps.rb