light-service 0.10.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1f6b68783827acc1479c9728d2483dcba8c9c0e7
-  data.tar.gz: 0446e28166fd582394cb74819e855d26241e0393
+SHA256:
+  metadata.gz: 1e9dfb5cf61024afa28719b84e160c9580fa39c99eda19b73cdb0cced9017da2
+  data.tar.gz: 7f389c208b3b06000c84859d595d9b49acf8dfe8d370736ee564a1ae8ef8b5d1
 SHA512:
-  metadata.gz: 6ac7178a1ea5e9fa7cd22a16de9533c953b504b5a999c26912fbb512e578cd1dcde66fc44d4414b56bf6e0c5be4d679b85b595bdc4e708cc6ac1bbd177a61e94
-  data.tar.gz: 5a881eca505d834cbf1b270215c0134f9b6d831fa37c29ca2737dec6d3fec6de9e224d0683f704e635301d6c9b47eb545e6e165d0c5a6aa69fd8f2b621e34376
+  metadata.gz: b1b7792d344efe1aab4297f8774649590b8e0336a44082da31a167a62b75a039b7f89759923beb9a463f6c017b0387297efc815f357deae31270b54e2c1c1bcc
+  data.tar.gz: 0d1d339a23d2d7b39bd5403d81fe1e1519a89eec22fd64f00931d9dc49a81c5476f67e6dd28591e0e88c55b1378d1155ed0d1700100569aa9b43a1922c860f3e

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 vendor/bundle
 bin
+.idea

data/.rubocop.yml

@@ -1,4 +1,7 @@
+require: rubocop-performance
+
 AllCops:
+  TargetRubyVersion: 2.3
   Exclude:
     - 'lib/light-service.rb'
     - 'vendor/bundle/**/*'
@@ -46,3 +49,6 @@ Metrics/BlockLength:
 
 Layout/TrailingBlankLines:
   Enabled: false
+
+Layout/EndOfLine:
+  EnforcedStyle: lf

data/.travis.yml

@@ -4,16 +4,15 @@ env:
   - RUN_COVERAGE_REPORT=true
 
 rvm:
-  - 2.2.2
-  - 2.3.3
-  - 2.4.1
-  - 2.5.0
+  - 2.4.2
+  - 2.5.3
+  - 2.6.0
+  - 2.7.0
 
 before_install:
   - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc'
   - gem install bundler
-  - bundle update simplecov
-  - bundle install --path vendor/bundle
+  - bundle install --clean --path vendor/bundle
 
 # uncomment this line if your project needs to run something other than `rake`:
 script:
@@ -24,10 +23,13 @@ gemfile:
   - gemfiles/activesupport_3.gemfile
   - gemfiles/activesupport_4.gemfile
   - gemfiles/activesupport_5.gemfile
+  - gemfiles/activesupport_6.gemfile
 
 matrix:
   exclude:
-  - rvm: 2.1.8
-    gemfile: gemfiles/activesupport_5.gemfile
-  - rvm: 2.2.2
-    gemfile: gemfiles/activesupport_5.gemfile
+  - rvm: 2.4.2
+    gemfile: gemfiles/activesupport_6.gemfile
+  - rvm: 2.7.0
+    gemfile: gemfiles/activesupport_3.gemfile
+  - rvm: 2.7.0
+    gemfile: gemfiles/activesupport_4.gemfile

data/Appraisals

@@ -9,3 +9,7 @@ end
 appraise "activesupport-5" do
   gem "activesupport", "~> 5.0"
 end
+
+appraise "activesupport-6" do
+  gem "activesupport", "~> 6.0"
+end

data/README.md

@@ -1,10 +1,10 @@
 ![LightService](https://raw.githubusercontent.com/adomokos/light-service/master/resources/light-service.png)
 
 [![Gem Version](https://img.shields.io/gem/v/light-service.svg)](https://rubygems.org/gems/light-service)
-[![Build Status](https://secure.travis-ci.org/adomokos/light-service.png)](http://travis-ci.org/adomokos/light-service)
-[![Code Climate](https://codeclimate.com/github/adomokos/light-service.png)](https://codeclimate.com/github/adomokos/light-service)
-[![Dependency Status](https://beta.gemnasium.com/badges/github.com/adomokos/light-service.svg)](https://beta.gemnasium.com/projects/github.com/adomokos/light-service)
+[![Build Status](https://secure.travis-ci.org/adomokos/light-service.svg)](http://travis-ci.org/adomokos/light-service)
+[![Code Climate](https://codeclimate.com/github/adomokos/light-service.svg)](https://codeclimate.com/github/adomokos/light-service)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+[![Download Count](https://ruby-gem-downloads-badge.herokuapp.com/light-service?type=total)](https://rubygems.org/gems/light-service)
 
 <br><br>
 
@@ -79,7 +79,7 @@ Wouldn't it be nice to see this instead?
 (
   LooksUpTaxPercentage,
   CalculatesOrderTax,
-  ChecksFreeShipping
+  ProvidesFreeShipping
 )
 ```
 
@@ -257,12 +257,12 @@ Check out this example:
 
 ```ruby
 class LogDuration
-  def self.call(action, context)
+  def self.call(context)
     start_time = Time.now
     result = yield
     duration = Time.now - start_time
     LightService::Configuration.logger.info(
-      :action   => action,
+      :action   => context.current_action,
       :duration => duration
     )
 
@@ -295,14 +295,16 @@ Consider this code:
 class SomeOrganizer
   extend LightService::Organizer
 
-  def call(ctx)
+  def self.call(ctx)
     with(ctx).reduce(actions)
   end
 
-  def actions
-    OneAction,
-    TwoAction,
-    ThreeAction
+  def self.actions
+    [
+      OneAction,
+      TwoAction,
+      ThreeAction
+    ]
   end
 end
 
@@ -346,14 +348,16 @@ class SomeOrganizer
                           end
                         end)
 
-  def call(ctx)
+  def self.call(ctx)
     with(ctx).reduce(actions)
   end
 
-  def actions
-    OneAction,
-    TwoAction,
-    ThreeAction
+  def self.actions
+    [
+      OneAction,
+      TwoAction,
+      ThreeAction
+    ]
   end
 end
 
@@ -452,9 +456,9 @@ class AnOrganizer
 
   def self.call(order)
     with(:order => order).reduce(
-        AnAction,
-        AnotherAction,
-      )
+      AnAction,
+      AnotherAction,
+    )
   end
 end
 
@@ -535,6 +539,15 @@ I, [DATE]  INFO -- : [LightService] - ;-) <TestDoubles::MakesLatteAction> has de
 I, [DATE]  INFO -- : [LightService] - context message: Can't make a latte with a fatty milk like that!
 ```
 
+You can specify the logger on the organizer level, so the organizer does not use the global logger.
+
+```ruby
+class FooOrganizer
+  extend LightService::Organizer
+  log_with Logger.new("/my/special.log")
+end
+```
+
 ## Error Codes
 You can add some more structure to your error handling by taking advantage of error codes in the context.
 Normally, when something goes wrong in your actions, you fail the process by setting the context to failure:
@@ -746,13 +759,15 @@ end
 
 This code is much easier to reason about, it's less noisy and it captures the goal of LightService well: simple, declarative code that's easy to understand.
 
-The 5 different orchestrator constructs an organizer can have:
+The 7 different orchestrator constructs an organizer can have:
 
 1. `reduce_until`
 2. `reduce_if`
 3. `iterate`
 4. `execute`
 5. `with_callback`
+6. `add_to_context`
+7. `add_aliases`
 
 `reduce_until` behaves like a while loop in imperative languages, it iterates until the provided predicate in the lambda evaluates to true. Take a look at [this acceptance test](spec/acceptance/organizer/reduce_until_spec.rb) to see how it's used.
 
@@ -764,6 +779,10 @@ To take advantage of another organizer or action, you might need to tweak the co
 
 Use `with_callback` when you want to execute actions with a deferred and controlled callback. It works similar to a Sax parser, I've used it for processing large files. The advantage of it is not having to keep large amount of data in memory. See [this acceptance test](spec/acceptance/organizer/with_callback_spec.rb) as a working example.
 
+`add_to_context` can add key-value pairs on the fly to the context. This functionality is useful when you need a value injected into the context under a specific key right before the subsequent actions are executed. [This test](spec/acceptance/organizer/add_to_context_spec.rb) describes its functionality.
+
+Your action needs a certain key in the context but it's under a different one? Use the function `add_aliases` to alias an existing key in the context under the desired key. Take a look at [this test](spec/acceptance/organizer/add_aliases_spec.rb) to see an example.
+
 ## ContextFactory for Faster Action Testing
 
 As the complexity of your workflow increases, you will find yourself spending more and more time creating a context (LightService::Context it is) for your action tests. Some of this code can be reused by clever factories, but still, you are using a context that is artificial, and can be different from what the previous actions produced. This is especially true, when you use LightService in ETLs, where you start out with initial data and your actions are mutating its state.

data/RELEASES.md

@@ -1,5 +1,22 @@
 A brief list of new features and changes introduced with the specified version.
 
+### 0.13.0
+* [Add 'add_to_context' and 'add_aliases'](https://github.com/adomokos/light-service/pull/172)
+* Updating Ruby compatibility, minor fixes
+
+### 0.12.0
+* [Per organizer logger](https://github.com/adomokos/light-service/pull/162)
+* [Fix 'fail_and_return!' not accepting 'error_code' option](https://github.com/adomokos/light-service/pull/168)
+
+### 0.11.0
+* [Switch to 'each_with_object' in WithReducer](https://github.com/adomokos/light-service/pull/149).
+
+### 0.10.3
+* [Adding ContextFactory](https://github.com/adomokos/light-service/pull/147).
+
+### 0.10.2
+* [Revert 0.10.1](https://github.com/adomokos/light-service/pull/146), it breaks tests in our apps :-(.
+
 ### 0.10.1
 * [Fixing ContextFactory](https://github.com/adomokos/light-service/pull/141) for orchestrator methods in Organizers.
 

data/gemfiles/activesupport_6.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.0"
+gem "appraisal", "~> 2.0"
+
+gemspec :path => "../"

data/lib/light-service.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'active_support/core_ext/string'
 
 require 'light-service/version'
 

data/lib/light-service/context.rb

@@ -88,7 +88,7 @@ module LightService
 
     def fail_and_return!(*args)
       fail!(*args)
-      throw(:jump_when_failed, *args)
+      throw(:jump_when_failed)
     end
 
     def fail_with_rollback!(message = nil, error_code = nil)
@@ -115,8 +115,10 @@ module LightService
 
     def define_accessor_methods_for_keys(keys)
       return if keys.nil?
+
       keys.each do |key|
         next if respond_to?(key.to_sym)
+
         define_singleton_method(key.to_s) { fetch(key) }
         define_singleton_method("#{key}=") { |value| self[key] = value }
       end
@@ -161,6 +163,7 @@ module LightService
 
     def check_nil(value)
       return 'nil' unless value
+
       "'#{value}'"
     end
   end

data/lib/light-service/localization_adapter.rb

@@ -34,7 +34,7 @@ module LightService
       scope = i18n_scope_from_class(action_class, type)
       options[:scope] = scope
 
-      I18n.t(key, options)
+      I18n.t(key, **options)
     end
 
     def i18n_scope_from_class(action_class, type)

data/lib/light-service/organizer.rb

@@ -56,6 +56,24 @@ module LightService
       def with_callback(action, steps)
         WithCallback.run(self, action, steps)
       end
+
+      def log_with(logger)
+        @logger = logger
+      end
+
+      def logger
+        @logger
+      end
+
+      def add_to_context(**args)
+        args.map do |key, value|
+          execute(->(ctx) { ctx[key.to_sym] = value })
+        end
+      end
+
+      def add_aliases(args)
+        execute(->(ctx) { ctx.assign_aliases(ctx.aliases.merge(args)) })
+      end
     end
 
     module Macros
@@ -63,6 +81,8 @@ module LightService
         @aliases = key_hash
       end
 
+      # This looks like an accessor,
+      # but it's used as a macro in the Organizer
       def before_actions(*logic)
         self.before_actions = logic
       end
@@ -71,6 +91,13 @@ module LightService
         @before_actions = [logic].flatten
       end
 
+      def append_before_actions(action)
+        @before_actions ||= []
+        @before_actions.push(action)
+      end
+
+      # This looks like an accessor,
+      # but it's used as a macro in the Organizer
       def after_actions(*logic)
         self.after_actions = logic
       end
@@ -78,6 +105,11 @@ module LightService
       def after_actions=(logic)
         @after_actions = [logic].flatten
       end
+
+      def append_after_actions(action)
+        @after_actions ||= []
+        @after_actions.push(action)
+      end
     end
   end
 end

data/lib/light-service/organizer/with_reducer.rb

@@ -23,19 +23,18 @@ module LightService
 
       def reduce(*actions)
         raise "No action(s) were provided" if actions.empty?
+
         actions.flatten!
 
-        actions.reduce(context) do |current_context, action|
+        actions.each_with_object(context) do |action, current_context|
           begin
-            result = invoke_action(current_context, action)
+            invoke_action(current_context, action)
           rescue FailWithRollbackError
-            result = reduce_rollback(actions)
+            reduce_rollback(actions)
           ensure
             # For logging
             yield(current_context, action) if block_given?
           end
-
-          result
         end
       end
 

data/lib/light-service/organizer/with_reducer_factory.rb

@@ -2,13 +2,17 @@ module LightService
   module Organizer
     class WithReducerFactory
       def self.make(monitored_organizer)
-        if LightService::Configuration.logger.nil?
-          # :nocov:
-          WithReducer.new
-          # :nocov:
-        else
-          WithReducerLogDecorator.new(monitored_organizer, WithReducer.new)
-        end
+        logger = monitored_organizer.logger ||
+                 LightService::Configuration.logger
+        decorated = WithReducer.new
+
+        return decorated if logger.nil?
+
+        WithReducerLogDecorator.new(
+          monitored_organizer,
+          :decorated => decorated,
+          :logger => logger
+        )
       end
     end
   end

data/lib/light-service/organizer/with_reducer_log_decorator.rb

@@ -5,10 +5,10 @@ module LightService
 
       alias logged? logged
 
-      def initialize(organizer, decorated = WithReducer.new)
+      def initialize(organizer, decorated: WithReducer.new, logger:)
         @decorated = decorated
         @organizer = organizer
-        @logger = LightService::Configuration.logger
+        @logger = logger
         @logged = false
       end
 

data/lib/light-service/testing/context_factory.rb

@@ -8,23 +8,28 @@ module LightService
       end
 
       def for(action)
-        @organizer.before_actions = [
+        @organizer.append_before_actions(
           lambda do |ctx|
             if ctx.current_action == action
+              # The last `:_before_actions` hook is for
+              # ContextFactory, remove it, so it won't
+              # be invoked again
+              ctx[:_before_actions].pop
+
               throw(:return_ctx_from_execution, ctx)
             end
           end
-        ]
+        )
 
         self
       end
 
-      def with(ctx)
-        escaped = catch(:return_ctx_from_execution) do
-          @organizer.call(ctx)
+      # More than one arguments can be passed to the
+      # Organizer's #call method
+      def with(*args, &block)
+        catch(:return_ctx_from_execution) do
+          @organizer.call(*args, &block)
         end
-
-        escaped
       end
 
       def initialize(organizer)