light-service 0.17.0 → 0.19.0

data/lib/light-service/orchestrator.rb

@@ -114,9 +114,9 @@ module LightService
       end
 
       def issue_deprecation_warning_for(method_name)
-        msg = "`Orchestrator##{method_name}` is DEPRECATED and will be " \
-          "removed, please switch to `Organizer##{method_name} instead. "
-        ActiveSupport::Deprecation.warn(msg)
+        warning_msg = "`Orchestrator##{method_name}` is DEPRECATED and will be " \
+                      "removed, please switch to `Organizer##{method_name} instead. "
+        LightService::Deprecation.warn(warning_msg)
       end
     end
   end

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

@@ -0,0 +1,48 @@
+module LightService
+  module Organizer
+    class ReduceCase
+      extend ScopedReducable
+
+      class Arguments
+        attr_reader :value, :when, :else
+
+        def initialize(**args)
+          validate_arguments(**args)
+          @value = args[:value]
+          @when = args[:when]
+          @else = args[:else]
+        end
+
+        private
+
+        # rubocop:disable Style/MultilineIfModifier
+        def validate_arguments(**args)
+          raise(
+            ArgumentError,
+            "Expected keyword arguments: [:value, :when, :else]. Given: #{args.keys}"
+          ) unless args.keys.intersection(mandatory_arguments).count == mandatory_arguments.count
+        end
+        # rubocop:enable Style/MultilineIfModifier
+
+        def mandatory_arguments
+          %i[value when else]
+        end
+      end
+
+      def self.run(organizer, **args)
+        arguments = Arguments.new(**args)
+
+        lambda do |ctx|
+          return ctx if ctx.stop_processing?
+
+          matched_case = arguments.when.keys.find { |k| k.eql?(ctx[arguments.value]) }
+          steps = arguments.when[matched_case] || arguments.else
+
+          ctx = scoped_reduce(organizer, ctx, steps)
+
+          ctx
+        end
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module LightService
                       "its entry method (the one that calls with & reduce) " \
                       "should be named `call`. " \
                       "Please use #{klass}.call going forward."
-        ActiveSupport::Deprecation.warn(warning_msg)
+        LightService.deprecation_warning(warning_msg)
       end
 
       def self.caller_method(first_caller)

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

@@ -34,14 +34,12 @@ module LightService
         actions.flatten!
 
         actions.each_with_object(context) do |action, current_context|
-          begin
-            invoke_action(current_context, action)
-          rescue FailWithRollbackError
-            reduce_rollback(actions)
-          ensure
-            # For logging
-            yield(current_context, action) if block_given?
-          end
+          invoke_action(current_context, action)
+        rescue FailWithRollbackError
+          reduce_rollback(actions)
+        ensure
+          # For logging
+          yield(current_context, action) if block_given?
         end
       end
 

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

@@ -5,7 +5,7 @@ module LightService
 
       alias logged? logged
 
-      def initialize(organizer, decorated: WithReducer.new, logger:)
+      def initialize(organizer, logger:, decorated: WithReducer.new)
         @decorated = decorated
         @organizer = organizer
 
@@ -22,7 +22,7 @@ module LightService
 
         logger.info do
           "[LightService] -     keys in context: " \
-          "#{extract_keys(decorated.context.keys)}"
+            "#{extract_keys(decorated.context.keys)}"
         end
         self
       end

data/lib/light-service/organizer.rb

@@ -1,5 +1,3 @@
-require 'active_support/deprecation'
-
 module LightService
   module Organizer
     def self.extended(base_class)
@@ -10,7 +8,7 @@ module LightService
     def self.included(base_class)
       warning_msg = "including LightService::Organizer is deprecated. " \
                     "Please use `extend LightService::Organizer` instead"
-      ActiveSupport::Deprecation.warn(warning_msg)
+      LightService::Deprecation.warn(warning_msg)
       extended(base_class)
     end
 
@@ -49,6 +47,10 @@ module LightService
         ReduceUntil.run(self, condition_block, steps)
       end
 
+      def reduce_case(**args)
+        ReduceCase.run(self, **args)
+      end
+
       def iterate(collection_key, steps)
         Iterate.run(self, collection_key, steps)
       end

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

@@ -26,11 +26,15 @@ module LightService
 
       # More than one arguments can be passed to the
       # Organizer's #call method
+      # rubocop:disable Style/ArgumentsForwarding
       def with(*args, &block)
         catch(:return_ctx_from_execution) do
           @organizer.call(*args, &block)
         end
       end
+      # rubocop:enable Style/ArgumentsForwarding
+
+      ruby2_keywords :with if RUBY_VERSION >= "2.7"
 
       def initialize(organizer)
         @organizer = organizer

data/lib/light-service/version.rb

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

data/lib/light-service.rb

@@ -1,13 +1,15 @@
 require 'logger'
-require 'active_support/core_ext/string'
 
 require 'light-service/version'
 
 require 'light-service/errors'
 require 'light-service/configuration'
-require 'light-service/localization_adapter'
 require 'light-service/context'
 require 'light-service/context/key_verifier'
+require 'light-service/deprecation_warning'
+require 'light-service/i18n/localization_adapter'
+require 'light-service/localization_adapter'
+require 'light-service/localization_map'
 require 'light-service/organizer/scoped_reducable'
 require 'light-service/organizer/with_reducer'
 require 'light-service/organizer/with_reducer_log_decorator'
@@ -15,6 +17,7 @@ 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/reduce_case'
 require 'light-service/organizer/iterate'
 require 'light-service/organizer/execute'
 require 'light-service/organizer/with_callback'

data/light-service.gemspec

@@ -15,17 +15,14 @@ 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", ">= 4.0.0")
+  gem.required_ruby_version = '>= 2.6.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", "~> 1.26.0")
   gem.add_development_dependency("rubocop-performance", "~> 1.2.0")
-  gem.add_development_dependency("pry", "~> 0.12.2")
+  gem.add_development_dependency("pry", "~> 0.14")
 end

data/spec/acceptance/after_actions_spec.rb

@@ -34,14 +34,10 @@ RSpec.describe 'Action after_actions' do
       class AdditionOrganizer
         extend LightService::Organizer
         after_actions (lambda do |ctx|
-                         if ctx.current_action == TestDoubles::AddsOneAction
-                           ctx.number -= 2
-                         end
+                         ctx.number -= 2 if ctx.current_action == TestDoubles::AddsOneAction
                        end),
                       (lambda do |ctx|
-                         if ctx.current_action == TestDoubles::AddsThreeAction
-                           ctx.number -= 3
-                         end
+                         ctx.number -= 3 if ctx.current_action == TestDoubles::AddsThreeAction
                        end)
 
         def self.call(number)
@@ -69,9 +65,7 @@ RSpec.describe 'Action after_actions' 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
+          ctx.total -= 1000 if ctx.current_action == TestDoubles::IterateCollectionAction
         end
       ]
 

data/spec/acceptance/before_actions_spec.rb

@@ -34,14 +34,10 @@ RSpec.describe 'Action before_actions' do
       class AdditionOrganizer
         extend LightService::Organizer
         before_actions (lambda do |ctx|
-                          if ctx.current_action == TestDoubles::AddsOneAction
-                            ctx.number -= 2
-                          end
+                          ctx.number -= 2 if ctx.current_action == TestDoubles::AddsOneAction
                         end),
                        (lambda do |ctx|
-                          if ctx.current_action == TestDoubles::AddsThreeAction
-                            ctx.number -= 3
-                          end
+                          ctx.number -= 3 if ctx.current_action == TestDoubles::AddsThreeAction
                         end)
 
         def self.call(number)
@@ -69,9 +65,7 @@ RSpec.describe 'Action before_actions' do
     it 'can interact with actions from the outside' do
       TestDoubles::TestWithCallback.before_actions = [
         lambda do |ctx|
-          if ctx.current_action == TestDoubles::AddToTotalAction
-            ctx.total -= 1000
-          end
+          ctx.total -= 1000 if ctx.current_action == TestDoubles::AddToTotalAction
         end
       ]
       result = TestDoubles::TestWithCallback.call

data/spec/acceptance/include_warning_spec.rb

@@ -5,7 +5,7 @@ describe "Including is discouraged" do
     it "gives warning" do
       expected_msg = "including LightService::Organizer is deprecated. " \
                      "Please use `extend LightService::Organizer` instead"
-      expect(ActiveSupport::Deprecation).to receive(:warn)
+      expect(LightService::Deprecation).to receive(:warn)
         .with(expected_msg)
 
       class OrganizerIncludingLS
@@ -18,7 +18,7 @@ describe "Including is discouraged" do
     it "gives warning" do
       expected_msg = "including LightService::Action is deprecated. " \
                      "Please use `extend LightService::Action` instead"
-      expect(ActiveSupport::Deprecation).to receive(:warn)
+      expect(LightService::Deprecation).to receive(:warn)
         .with(expected_msg)
 
       class ActionIncludingLS

data/spec/acceptance/message_localization_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 require "test_doubles"
 
-class TestsLocalizationAdapter
+class TestsI18nLocalizationAdapter
   extend LightService::Organizer
 
   def self.call(pass_or_fail, message_or_key, i18n_options = {})
@@ -9,11 +9,11 @@ class TestsLocalizationAdapter
       :pass_or_fail => pass_or_fail,
       :message_or_key => message_or_key,
       :i18n_options => i18n_options
-    ).reduce(TestsLocalizationInvocationOptionsAction)
+    ).reduce(TestsI18nLocalizationInvocationOptionsAction)
   end
 end
 
-class TestsLocalizationInvocationOptionsAction
+class TestsI18nLocalizationInvocationOptionsAction
   extend LightService::Action
   expects :pass_or_fail, :message_or_key, :i18n_options
 
@@ -27,18 +27,18 @@ class TestsLocalizationInvocationOptionsAction
 end
 
 def pass_with(message_or_key, i18n_options = {})
-  TestsLocalizationAdapter.call(true, message_or_key, i18n_options)
+  TestsI18nLocalizationAdapter.call(true, message_or_key, i18n_options)
 end
 
 def fail_with(message_or_key, i18n_options = {})
-  TestsLocalizationAdapter.call(false, message_or_key, i18n_options)
+  TestsI18nLocalizationAdapter.call(false, message_or_key, i18n_options)
 end
 
-describe "Localization Adapter" do
+describe "I18n Localization Adapter" do
   before do
     I18n.backend.store_translations(
       :en,
-      :tests_localization_invocation_options_action =>
+      :tests_i18n_localization_invocation_options_action =>
       {
         :light_service => {
           :failures => {

data/spec/acceptance/not_having_call_method_warning_spec.rb

@@ -4,8 +4,8 @@ require 'test_doubles'
 describe "Organizer should invoke with/reduce from a call method" do
   context "when the organizer does not have a `call` method" do
     it "gives warning" do
-      expect(ActiveSupport::Deprecation)
-        .to receive(:warn)
+      expect(LightService)
+        .to receive(:deprecation_warning)
         .with(/^The <OrganizerWithoutCallMethod> class is an organizer/)
 
       class OrganizerWithoutCallMethod
@@ -22,7 +22,7 @@ describe "Organizer should invoke with/reduce from a call method" do
 
   context "when the organizer has the `call` method" do
     it "does not issue a warning" do
-      expect(ActiveSupport::Deprecation)
+      expect(LightService::Deprecation)
         .not_to receive(:warn)
 
       class OrganizerWithCallMethod

data/spec/acceptance/organizer/reduce_case_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe LightService::Organizer do
+  class TestReduceCase
+    extend LightService::Organizer
+
+    def self.call(context)
+      with(context).reduce(actions)
+    end
+
+    def self.actions
+      [
+        reduce_case(
+          :value => :incr_num,
+          :when => {
+            :one => [TestDoubles::AddsOneAction],
+            :two => [TestDoubles::AddsTwoAction],
+            :three => [TestDoubles::AddsThreeAction]
+          },
+          :else => [TestDoubles::FailureAction]
+        )
+      ]
+    end
+  end
+
+  it 'adds one if the incr_num is one' do
+    result = TestReduceCase.call(:number => 0, :incr_num => :one)
+
+    expect(result).to be_success
+    expect(result[:number]).to eq(1)
+  end
+
+  it 'adds two if the incr_num is two' do
+    result = TestReduceCase.call(:number => 0, :incr_num => :two)
+
+    expect(result).to be_success
+    expect(result[:number]).to eq(2)
+  end
+
+  it 'adds three if the incr_num is three' do
+    result = TestReduceCase.call(:number => 0, :incr_num => :three)
+
+    expect(result).to be_success
+    expect(result[:number]).to eq(3)
+  end
+
+  it 'will fail if the incr_num is neither one, two, or three' do
+    result = TestReduceCase.call(:number => 0, :incr_num => :four)
+
+    expect(result).to be_failure
+  end
+end

data/spec/acceptance/organizer/reduce_if_spec.rb

@@ -63,6 +63,7 @@ RSpec.describe LightService::Organizer do
         reduce(actions)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def self.actions
         [
           reduce_if(
@@ -76,6 +77,7 @@ RSpec.describe LightService::Organizer do
           execute(->(c) { c[:last_outside] = true })
         ]
       end
+      # rubocop:enable Metrics/AbcSize
     end
 
     result = org.call

data/spec/acceptance/skip_all_warning_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe "skip_all! has been deprecated" do
 
     expected_msg = "Using skip_all! has been deprecated, " \
                    "please use `skip_remaining!` instead."
-    expect(ActiveSupport::Deprecation).to receive(:warn)
+    expect(LightService::Deprecation).to receive(:warn)
       .with(expected_msg)
 
     SkipAllDeprecatedAction.execute

data/spec/context/inspect_spec.rb

@@ -13,13 +13,7 @@ RSpec.describe LightService::Context do
   describe '#inspect' do
     it 'inspects the hash with all the fields' do
       inspected_context =
-        'LightService::Context({}, ' \
-        + 'success: true, ' \
-        + 'message: \'\', ' \
-        + 'error_code: nil, ' \
-        + 'skip_remaining: false, ' \
-        + 'aliases: {}' \
-        + ')'
+        "LightService::Context({}, success: true, message: '', error_code: nil, skip_remaining: false, aliases: {})"
 
       expect(context.inspect).to eq(inspected_context)
     end
@@ -28,13 +22,8 @@ RSpec.describe LightService::Context do
       context.fail!('There was an error')
 
       inspected_context =
-        'LightService::Context({}, ' \
-        + 'success: false, ' \
-        + 'message: \'There was an error\', ' \
-        + 'error_code: nil, ' \
-        + 'skip_remaining: false, ' \
-        + 'aliases: {}' \
-        + ')'
+        "LightService::Context({}, success: false, message: 'There was an error', error_code: nil, " \
+        "skip_remaining: false, aliases: {})"
 
       expect(context.inspect).to eq(inspected_context)
     end
@@ -43,13 +32,8 @@ RSpec.describe LightService::Context do
       context.skip_remaining!('No need to process')
 
       inspected_context =
-        'LightService::Context({}, ' \
-        + 'success: true, ' \
-        + 'message: \'No need to process\', ' \
-        + 'error_code: nil, ' \
-        + 'skip_remaining: true, ' \
-        + 'aliases: {}' \
-        + ')'
+        "LightService::Context({}, success: true, message: 'No need to process', error_code: nil, " \
+        "skip_remaining: true, aliases: {})"
 
       expect(context.inspect).to eq(inspected_context)
     end

data/spec/context_spec.rb

@@ -152,7 +152,7 @@ RSpec.describe LightService::Context do
   end
 
   it "warns about the outcome attribute reader being deprecated" do
-    expect(ActiveSupport::Deprecation).to receive(:warn)
+    expect(LightService::Deprecation).to receive(:warn)
 
     expect(context.outcome).to eq(::LightService::Outcomes::SUCCESS)
   end
@@ -167,7 +167,7 @@ RSpec.describe LightService::Context do
   end
 
   it "allows a default block value for #fetch" do
-    expect(context.fetch(:madeup) { :default }).to eq(:default)
+    expect(context.fetch(:madeup, :default)).to eq(:default)
   end
 
   context "when aliases are included via .make" do

data/spec/i18n_localization_adapter_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+require 'test_doubles'
+
+describe LightService::I18n::LocalizationAdapter do
+  let(:action_class) { TestDoubles::AnAction }
+  let(:adapter) { described_class.new }
+
+  describe "#failure" do
+    subject { adapter.failure(message_or_key, action_class) }
+
+    context "when provided a Symbol" do
+      let(:message_or_key) { :not_found }
+
+      it "translates the message" do
+        expected_scope = "test_doubles/an_action.light_service.failures"
+
+        expect(I18n).to receive(:t)
+          .with(message_or_key, :scope => expected_scope)
+          .and_return("message")
+
+        expect(subject).to eq("message")
+      end
+
+      it "allows passing interpolation options to I18n layer" do
+        expect(I18n).to receive(:t)
+          .with(message_or_key, hash_including(:i18n_variable => "value"))
+          .and_return("message")
+
+        subject = adapter.failure(message_or_key,
+                                  action_class,
+                                  :i18n_variable => "value")
+
+        expect(subject).to eq("message")
+      end
+    end
+
+    context "when provided a String" do
+      let(:message_or_key) { "action failed" }
+
+      it "returns the message" do
+        expect(subject).to eq(message_or_key)
+      end
+    end
+  end
+
+  describe "#success" do
+    subject { adapter.success(message_or_key, action_class) }
+
+    context "when provided a Symbol" do
+      let(:message_or_key) { :not_found }
+
+      it "translates the message" do
+        expected_scope = "test_doubles/an_action.light_service.successes"
+
+        expect(I18n).to receive(:t)
+          .with(message_or_key, :scope => expected_scope)
+          .and_return("message")
+
+        expect(subject).to eq("message")
+      end
+
+      it "allows passing interpolation options to I18n layer" do
+        expect(I18n).to receive(:t)
+          .with(message_or_key, hash_including(:i18n_variable => "value"))
+          .and_return("message")
+
+        subject = adapter.success(message_or_key,
+                                  action_class,
+                                  :i18n_variable => "value")
+
+        expect(subject).to eq("message")
+      end
+    end
+
+    context "when provided a String" do
+      let(:message_or_key) { "action failed" }
+
+      it "returns the message" do
+        expect(subject).to eq(message_or_key)
+      end
+    end
+  end
+end

data/spec/lib/generators/action_generator_advanced_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-require_relative '../../../lib/generators/light_service/action_generator.rb'
+require_relative '../../../lib/generators/light_service/action_generator'
 require_relative './full_generator_test_blobs'
 
 describe LightService::Generators::ActionGenerator, :type => :generator do

data/spec/lib/generators/action_generator_simple_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-require_relative '../../../lib/generators/light_service/action_generator.rb'
+require_relative '../../../lib/generators/light_service/action_generator'
 require_relative './full_generator_test_blobs'
 
 describe LightService::Generators::ActionGenerator, :type => :generator do

data/spec/lib/generators/organizer_generator_advanced_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-require_relative '../../../lib/generators/light_service/organizer_generator.rb'
+require_relative '../../../lib/generators/light_service/organizer_generator'
 require_relative './full_generator_test_blobs'
 
 describe LightService::Generators::OrganizerGenerator, :type => :generator do

data/spec/lib/generators/organizer_generator_simple_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-require_relative '../../../lib/generators/light_service/organizer_generator.rb'
+require_relative '../../../lib/generators/light_service/organizer_generator'
 require_relative './full_generator_test_blobs'
 
 describe LightService::Generators::OrganizerGenerator, :type => :generator do