light-service 0.13.0 → 0.17.0

data/lib/light-service/context/key_verifier.rb

@@ -111,7 +111,24 @@ module LightService
       end
 
       def reserved_keys
-        %i[message error_code current_action].freeze
+        %i[message error_code current_action organized_by].freeze
+      end
+    end
+
+    class ReservedKeysViaOrganizerVerifier < ReservedKeysVerifier
+      def initialize(context_data)
+        @context = LightService::Context.make(context_data)
+      end
+
+      def violated_keys
+        context.keys.map(&:to_sym) & reserved_keys
+      end
+
+      def error_message
+        <<~ERR
+          reserved keys cannot be added to the context
+          reserved key: [#{format_keys(violated_keys)}]
+        ERR
       end
     end
   end

data/lib/light-service/context.rb

@@ -8,7 +8,8 @@ module LightService
 
   # rubocop:disable ClassLength
   class Context < Hash
-    attr_accessor :message, :error_code, :current_action
+    attr_accessor :message, :error_code, :current_action, :around_actions,
+                  :organized_by
 
     def initialize(context = {},
                    outcome = Outcomes::SUCCESS,
@@ -18,6 +19,7 @@ module LightService
       @message = message
       @error_code = error_code
       @skip_remaining = false
+
       context.to_hash.each { |k, v| self[k] = v }
     end
 
@@ -114,9 +116,9 @@ module LightService
     end
 
     def define_accessor_methods_for_keys(keys)
-      return if keys.nil?
+      return if keys.blank?
 
-      keys.each do |key|
+      Array(keys).each do |key|
         next if respond_to?(key.to_sym)
 
         define_singleton_method(key.to_s) { fetch(key) }

data/lib/light-service/errors.rb

@@ -3,4 +3,5 @@ module LightService
   class ExpectedKeysNotInContextError < StandardError; end
   class PromisedKeysNotInContextError < StandardError; end
   class ReservedKeysInContextError < StandardError; end
+  class UnusableExpectKeyDefaultError < StandardError; end
 end

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

@@ -0,0 +1,21 @@
+module LightService
+  module Organizer
+    class ReduceIfElse
+      extend ScopedReducable
+
+      def self.run(organizer, condition_block, if_steps, else_steps)
+        lambda do |ctx|
+          return ctx if ctx.stop_processing?
+
+          ctx = if condition_block.call(ctx)
+                  scoped_reduce(organizer, ctx, if_steps)
+                else
+                  scoped_reduce(organizer, ctx, else_steps)
+                end
+
+          ctx
+        end
+      end
+    end
+  end
+end

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

@@ -1,10 +1,16 @@
 module LightService
   module Organizer
     class WithReducer
-      attr_reader :context
+      attr_reader   :context
+      attr_accessor :organizer
+
+      def initialize(monitored_organizer = nil)
+        @organizer = monitored_organizer
+      end
 
       def with(data = {})
         @context = LightService::Context.make(data)
+        @context.organized_by = organizer
         self
       end
 
@@ -24,6 +30,7 @@ module LightService
       def reduce(*actions)
         raise "No action(s) were provided" if actions.empty?
 
+        @context.around_actions ||= around_each_handler
         actions.flatten!
 
         actions.each_with_object(context) do |action, current_context|
@@ -53,12 +60,10 @@ module LightService
       private
 
       def invoke_action(current_context, action)
-        around_each_handler.call(current_context) do
-          if action.respond_to?(:call)
-            action.call(current_context)
-          else
-            action.execute(current_context)
-          end
+        if action.respond_to?(:call)
+          action.call(current_context)
+        else
+          action.execute(current_context)
         end
       end
 

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

@@ -4,7 +4,7 @@ module LightService
       def self.make(monitored_organizer)
         logger = monitored_organizer.logger ||
                  LightService::Configuration.logger
-        decorated = WithReducer.new
+        decorated = WithReducer.new(monitored_organizer)
 
         return decorated if logger.nil?
 

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

@@ -8,6 +8,9 @@ module LightService
       def initialize(organizer, decorated: WithReducer.new, logger:)
         @decorated = decorated
         @organizer = organizer
+
+        decorated.organizer = organizer
+
         @logger = logger
         @logged = false
       end

data/lib/light-service/organizer.rb

@@ -41,6 +41,10 @@ module LightService
         ReduceIf.run(self, condition_block, steps)
       end
 
+      def reduce_if_else(condition_block, if_steps, else_steps)
+        ReduceIfElse.run(self, condition_block, if_steps, else_steps)
+      end
+
       def reduce_until(condition_block, steps)
         ReduceUntil.run(self, condition_block, steps)
       end
@@ -65,9 +69,18 @@ module LightService
         @logger
       end
 
-      def add_to_context(**args)
-        args.map do |key, value|
-          execute(->(ctx) { ctx[key.to_sym] = value })
+      # Set the value as a key on the context hash
+      # and also create convenience accessors for the keys
+      def add_to_context(args)
+        Context::ReservedKeysViaOrganizerVerifier.new(args).verify
+
+        Hash(args).map do |key, value|
+          context_key = lambda do |ctx|
+            ctx[key.to_sym] = value
+            ctx.define_accessor_methods_for_keys(key)
+          end
+
+          execute(context_key)
         end
       end
 

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.13.0".freeze
+  VERSION = "0.17.0".freeze
 end

data/lib/light-service.rb

@@ -13,6 +13,7 @@ require 'light-service/organizer/with_reducer'
 require 'light-service/organizer/with_reducer_log_decorator'
 require 'light-service/organizer/with_reducer_factory'
 require 'light-service/organizer/reduce_if'
+require 'light-service/organizer/reduce_if_else'
 require 'light-service/organizer/reduce_until'
 require 'light-service/organizer/iterate'
 require 'light-service/organizer/execute'

data/light-service.gemspec

@@ -15,11 +15,16 @@ Gem::Specification.new do |gem|
   gem.name          = "light-service"
   gem.require_paths = ["lib"]
   gem.version       = LightService::VERSION
+  gem.required_ruby_version = '>= 2.5.0'
 
-  gem.add_runtime_dependency("activesupport", ">= 3.0.0")
+  gem.add_runtime_dependency("activesupport", ">= 4.0.0")
 
+  gem.add_development_dependency("generator_spec", "~> 0.9.4")
+  gem.add_development_dependency("test-unit", "~> 3.0") # Needed for generator specs.
+  gem.add_development_dependency("appraisal", "~> 2.3")
   gem.add_development_dependency("rspec", "~> 3.0")
   gem.add_development_dependency("simplecov", "~> 0.17")
+  gem.add_development_dependency("codecov", "~> 0.1")
   gem.add_development_dependency("rubocop", "~> 0.68.0")
   gem.add_development_dependency("rubocop-performance", "~> 1.2.0")
   gem.add_development_dependency("pry", "~> 0.12.2")

data/spec/acceptance/after_actions_spec.rb

@@ -65,6 +65,23 @@ RSpec.describe 'Action after_actions' do
     end
   end
 
+  context 'with callbacks' do
+    it 'ensures the correct :current_action is set' do
+      TestDoubles::TestWithCallback.after_actions = [
+        lambda do |ctx|
+          if ctx.current_action == TestDoubles::IterateCollectionAction
+            ctx.total -= 1000
+          end
+        end
+      ]
+
+      result = TestDoubles::TestWithCallback.call
+
+      expect(result.counter).to eq(3)
+      expect(result.total).to eq(-994)
+    end
+  end
+
   describe 'after_actions can be appended' do
     it 'adds to the :_after_actions collection' do
       TestDoubles::AdditionOrganizer.append_after_actions(

data/spec/acceptance/around_each_spec.rb

@@ -16,4 +16,19 @@ describe 'Executing arbitrary code around each action' do
       }]
     )
   end
+
+  it 'logs data with nested actions' do
+    context = { :number => 1, :logger => TestDoubles::TestLogger.new }
+
+    result = TestDoubles::AroundEachWithReduceIfOrganizer.call(context)
+
+    expect(result.fetch(:number)).to eq(7)
+    expect(result[:logger].logs).to eq(
+      [
+        { :action => TestDoubles::AddsOneAction, :before => 1, :after => 2 },
+        { :action => TestDoubles::AddsTwoAction, :before => 2, :after => 4 },
+        { :action => TestDoubles::AddsThreeAction, :before => 4, :after => 7 }
+      ]
+    )
+  end
 end

data/spec/acceptance/log_from_organizer_spec.rb

@@ -59,7 +59,7 @@ describe "Logs from organizer" do
       expect(log_message).to include(organizer_log_message)
     end
 
-    it "lists the keys in contect after the actions are executed" do
+    it "lists the keys in context after the actions are executed" do
       organizer_log_message = "[LightService] -     keys in context: " \
                               ":tea, :milk, :coffee, :milk_tea, :latte"
       expect(log_message).to include(organizer_log_message)

data/spec/acceptance/organizer/add_to_context_spec.rb

@@ -20,6 +20,20 @@ RSpec.describe LightService::Organizer do
     end
   end
 
+  class TestAddToContextReservedWords
+    extend LightService::Organizer
+
+    def self.call(context = LightService::Context.make)
+      with(context).reduce(steps)
+    end
+
+    def self.steps
+      [
+        add_to_context(:message => "yo", "error_code" => "00P5")
+      ]
+    end
+  end
+
   it 'adds items to the context on the fly' do
     result = TestAddToContext.call
 
@@ -27,4 +41,17 @@ RSpec.describe LightService::Organizer do
     expect(result.number).to eq(1)
     expect(result[:something]).to eq('hello')
   end
+
+  it 'adds items to the context as accessors' do
+    result = TestAddToContext.call
+
+    expect(result).to be_success
+    expect(result.something).to eq('hello')
+  end
+
+  it "will not add items as accessors when they are reserved" do
+    expect { TestAddToContextReservedWords.call }.to \
+      raise_error(LightService::ReservedKeysInContextError)
+      .with_message(/:message, :error_code/)
+  end
 end

data/spec/acceptance/organizer/execute_with_add_to_context_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe LightService::Organizer do
+  class TestExecuteWithAddToContext
+    extend LightService::Organizer
+
+    def self.call
+      with.reduce(steps)
+    end
+
+    def self.steps
+      [
+        add_to_context(:greeting => "hello"),
+        execute(->(ctx) { ctx.greeting.upcase! })
+      ]
+    end
+  end
+
+  context "when using context values created by add_to_context" do
+    it "is expected to reference them as accessors" do
+      result = TestExecuteWithAddToContext.call
+
+      expect(result).to be_a_success
+      expect(result.greeting).to eq "HELLO"
+    end
+  end
+end

data/spec/acceptance/organizer/iterate_spec.rb

@@ -20,6 +20,13 @@ RSpec.describe LightService::Organizer do
     expect(result.number).to eq(5)
   end
 
+  it "knows that it's being iterated from within an organizer" do
+    result = TestDoubles::TestIterate.call(:number => 1,
+                                           :counters => [1, 2, 3, 4])
+
+    expect(result.organized_by).to eq TestDoubles::TestIterate
+  end
+
   it 'will not iterate over a failed context' do
     empty_context.fail!('Something bad happened')
 

data/spec/acceptance/organizer/reduce_if_else_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe LightService::Organizer do
+  class TestReduceIfElse
+    extend LightService::Organizer
+
+    def self.call(context)
+      with(context).reduce(actions)
+    end
+
+    def self.actions
+      [
+        TestDoubles::AddsOneAction,
+        reduce_if_else(
+          ->(ctx) { ctx.number == 1 },
+          [TestDoubles::AddsOneAction],
+          [TestDoubles::AddsTwoAction]
+        )
+      ]
+    end
+  end
+
+  let(:empty_context) { LightService::Context.make }
+
+  it 'reduces the if_steps if the condition is true' do
+    result = TestReduceIfElse.call(:number => 0)
+
+    expect(result).to be_success
+    expect(result[:number]).to eq(2)
+  end
+
+  it 'reduces the else_steps if the condition is false' do
+    result = TestReduceIfElse.call(:number => 2)
+
+    expect(result).to be_success
+    expect(result[:number]).to eq(5)
+  end
+
+  it 'will not reduce over a failed context' do
+    empty_context.fail!('Something bad happened')
+
+    result = TestReduceIfElse.call(empty_context)
+
+    expect(result).to be_failure
+  end
+
+  it 'does not reduce over a skipped context' do
+    empty_context.skip_remaining!('No more needed')
+
+    result = TestReduceIfElse.call(empty_context)
+    expect(result).to be_success
+  end
+
+  it "knows that it's being conditionally reduced from within an organizer" do
+    result = TestReduceIfElse.call(:number => 2)
+
+    expect(result.organized_by).to eq TestReduceIfElse
+  end
+end

data/spec/acceptance/organizer/reduce_if_spec.rb

@@ -49,6 +49,12 @@ RSpec.describe LightService::Organizer do
     expect(result).to be_success
   end
 
+  it "knows that it's being conditionally reduced from within an organizer" do
+    result = TestReduceIf.call(:number => 2)
+
+    expect(result.organized_by).to eq TestReduceIf
+  end
+
   it 'skips actions within in its own scope' do
     org = Class.new do
       extend LightService::Organizer

data/spec/acceptance/organizer/reduce_until_spec.rb

@@ -40,4 +40,10 @@ RSpec.describe LightService::Organizer do
     result = TestReduceUntil.call(empty_context)
     expect(result).to be_success
   end
+
+  it "is expected to know its organizer when reducing until a condition" do
+    result = TestReduceUntil.call(:number => 1)
+
+    expect(result.organized_by).to eq TestReduceUntil
+  end
 end