light-service 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 839bc255742513ba7c0cabc80bd8f72e35d4a442
-  data.tar.gz: 5957a2d95ac83d37cb9ba40629446ba4952ab835
+  metadata.gz: 35d148e9bdcc089cd30046a2a99eff468ec77fde
+  data.tar.gz: 95b6d152ab5eca62471cfb245be0f60c2d4bfc73
 SHA512:
-  metadata.gz: 2c992973e9289bbf41dd73f77f9ee2e12d1e6bc2f55ad0d6af293e026a785931ee52dabe6ce2b5d85cf00afb86ffdf1218087a3cb1bdb6b525fa102ddd800a8c
-  data.tar.gz: 7663059f0fad0ee5235306928110b6f7c5d77a057e0c34055fa9ac5eaae5756308855532023348c1a968120d8ed6b8a97649e8db5a7a3e973f3b69cc98dc1f7a
+  metadata.gz: 20fe035e150978da67f5cc624c9e142fc5299c7b20cc1f71d89c90a665577daa85ec73e32f695950f7d5d52ce0a4604159b08d367b195d27191819c18f497b38
+  data.tar.gz: 829ccc813a76c16da7ceb7aaa02262d30c555b5486224212b016588a45c2f172e050e6a2c6adc0c2ebef2c28ce5e9f3968a6c791fbc30c2cf4bee2f2a336824d

data/README.md

@@ -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
     )
 

data/RELEASES.md

@@ -1,5 +1,8 @@
 A brief list of new features and changes introduced with the specified version.
 
+### 0.10.2
+* [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 :-(.
 

data/lib/light-service/organizer.rb

@@ -63,6 +63,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 +73,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 +87,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/testing/context_factory.rb

@@ -1,17 +1,6 @@
 module LightService
   module Testing
     class ContextFactory
-      class ContextFactoryOrganizer
-        extend LightService::Organizer
-        class << self
-          attr_accessor :actions
-        end
-
-        def self.call(ctx)
-          with(ctx).reduce(actions)
-        end
-      end
-
       attr_reader :organizer
 
       def self.make_from(organizer)
@@ -19,25 +8,33 @@ module LightService
       end
 
       def for(action)
-        ContextFactoryOrganizer.actions = find_up_to(action)
+        @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)
-        ContextFactoryOrganizer.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
       end
 
       def initialize(organizer)
         @organizer = organizer
       end
-
-      def find_up_to(action)
-        original_actions = organizer.actions
-
-        original_actions.take_while do |current_action|
-          current_action != action
-        end
-      end
     end
   end
 end

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.10.2".freeze
+  VERSION = "0.10.3".freeze
 end

data/spec/acceptance/after_actions_spec.rb

@@ -64,4 +64,17 @@ RSpec.describe 'Action after_actions' do
       expect(result.fetch(:number)).to eq(1)
     end
   end
+
+  describe 'after_actions can be appended' do
+    it 'adds to the :_after_actions collection' do
+      TestDoubles::AdditionOrganizer.append_after_actions(
+        lambda do |ctx|
+          ctx.number -= 3 if ctx.current_action == TestDoubles::AddsThreeAction
+        end
+      )
+
+      result = TestDoubles::AdditionOrganizer.call(0)
+      expect(result.fetch(:number)).to eq(3)
+    end
+  end
 end

data/spec/acceptance/testing/context_factory_spec.rb

@@ -8,12 +8,12 @@ class AdditionOrganizerContextFactory
     LightService::Testing::ContextFactory
       .make_from(TestDoubles::AdditionOrganizer)
       .for(action)
-      .with(:number => number)
+      .with(number)
   end
 end
 
 RSpec.describe TestDoubles::AddsThreeAction do
-  it "creates a context for the action with ContextFactory wrapper" do
+  it 'creates a context for the action with ContextFactory wrapper' do
     context =
       AdditionOrganizerContextFactory
       .make_for(TestDoubles::AddsThreeAction, 1)
@@ -21,13 +21,34 @@ RSpec.describe TestDoubles::AddsThreeAction do
     expect(context.number).to eq(7)
   end
 
-  it "creates a context for the action using the ContextFactory" do
+  it 'creates a context for the action using the ContextFactory' do
     context =
       LightService::Testing::ContextFactory
       .make_from(TestDoubles::AdditionOrganizer)
       .for(TestDoubles::AddsThreeAction)
-      .with(:number => 4) # Context is a "glorified" hash
+      .with(4) # Context is a "glorified" hash
 
     expect(context.number).to eq(7)
   end
+
+  it "works with multiple arguments passed to Organizer's call method" do
+    context = LightService::Testing::ContextFactory
+              .make_from(TestDoubles::ExtraArgumentAdditionOrganizer)
+              .for(described_class)
+              .with(4, 2)
+
+    expect(context.number).to eq(9)
+  end
+end
+
+RSpec.describe TestDoubles::AddsTwoAction do
+  it 'does not execute a callback entirely from a ContextFactory' do
+    context = LightService::Testing::ContextFactory
+              .make_from(TestDoubles::CallbackOrganizer)
+              .for(described_class)
+              .with(:number => 0)
+
+    # add 1, add 10, then stop before executing first add 2
+    expect(context.number).to eq(11)
+  end
 end

data/spec/test_doubles.rb

@@ -223,6 +223,22 @@ module TestDoubles
     end
   end
 
+  class ExtraArgumentAdditionOrganizer
+    extend LightService::Organizer
+
+    def self.call(number, another_number)
+      with(:number => number + another_number).reduce(actions)
+    end
+
+    def self.actions
+      [
+        AddsOneAction,
+        AddsTwoAction,
+        AddsThreeAction
+      ]
+    end
+  end
+
   class AddsOneAction
     extend LightService::Action
     expects :number
@@ -251,6 +267,99 @@ module TestDoubles
     end
   end
 
+  class IterateOrganizer
+    extend LightService::Organizer
+
+    def self.call(ctx)
+      with(ctx).reduce(actions)
+    end
+
+    def self.actions
+      [
+        AddsOneIteratesAction,
+        iterate(:numbers, [
+                  AddsTwoAction,
+                  AddsThreeAction
+                ])
+      ]
+    end
+  end
+
+  class AddsOneIteratesAction
+    extend LightService::Action
+    expects :numbers
+    promises :numbers
+
+    executed do |context|
+      context.numbers = context.numbers.map { |n| n + 1 }
+    end
+  end
+
+  class CallbackOrganizer
+    extend LightService::Organizer
+
+    def self.call(ctx)
+      with(ctx).reduce(actions)
+    end
+
+    def self.actions
+      [
+        AddsOneAction,
+        with_callback(AddTenCallbackAction, [
+                        AddsTwoAction,
+                        AddsThreeAction
+                      ])
+      ]
+    end
+  end
+
+  class AddTenCallbackAction
+    extend LightService::Action
+    expects :number, :callback
+
+    executed do |context|
+      context.number += 10
+      context.number =
+        context.callback.call(context).fetch(:number)
+    end
+  end
+
+  class ReduceUntilOrganizer
+    extend LightService::Organizer
+
+    def self.call(ctx)
+      with(ctx).reduce(actions)
+    end
+
+    def self.actions
+      [
+        AddsOneAction,
+        reduce_until(->(ctx) { ctx.number > 3 }, [
+                       AddsTwoAction,
+                       AddsThreeAction
+                     ])
+      ]
+    end
+  end
+
+  class ReduceIfOrganizer
+    extend LightService::Organizer
+
+    def self.call(ctx)
+      with(ctx).reduce(actions)
+    end
+
+    def self.actions
+      [
+        AddsOneAction,
+        reduce_if(->(ctx) { ctx.number > 1 }, [
+                    AddsTwoAction,
+                    AddsThreeAction
+                  ])
+      ]
+    end
+  end
+
   class MakesTeaExpectingReservedKey
     extend LightService::Action
     expects :tea, :message

data/spec/testing/context_factory/iterate_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe 'ContextFactory - used with IterateOrganizer' do
+  let(:organizer) { TestDoubles::IterateOrganizer }
+
+  context 'when called with outside iterate steps' do
+    it 'creates a context up-to the action defined before the iteration' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsOneIteratesAction)
+        .with(:numbers => [1, 2])
+
+      expect(ctx[:numbers]).to eq([1, 2])
+    end
+
+    it 'creates a context up-to iteration with empty context steps' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsTwoAction)
+        .with(:numbers => [1, 2])
+
+      expect(ctx.numbers).to eq([2, 3])
+    end
+
+    it 'creates a context only to the first step of the iteration' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsThreeAction)
+        .with(:numbers => [1, 2])
+
+      expect(ctx.numbers).to eq([2, 3])
+      expect(ctx.number).to eq(4)
+    end
+  end
+end

data/spec/testing/context_factory/reduce_if_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe 'ContextFactory - used with ReduceIfOrganizer' do
+  let(:organizer) { TestDoubles::ReduceIfOrganizer }
+
+  context 'when called with a truthy argument action' do
+    it 'executes a context up-to the callback action' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsThreeAction)
+        .with(:number => 1)
+
+      expect(ctx.number).to eq(4)
+    end
+
+    it 'creates a context up-to action with empty context steps' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsTwoAction)
+        .with(:number => 1)
+
+      expect(ctx.number).to eq(2)
+    end
+  end
+
+  context 'when called with a false argument action' do
+    it 'does not execute the steps' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsThreeAction)
+        .with(:number => 0)
+
+      expect(ctx.number).to eq(1)
+    end
+  end
+end

data/spec/testing/context_factory/reduce_until_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe 'ContextFactory - used with ReduceUntilOrganizer' do
+  let(:organizer) { TestDoubles::ReduceUntilOrganizer }
+
+  context 'when called with truthy block' do
+    it 'creates a context up-to the action defined before the iteration' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsTwoAction)
+        .with(:number => 1)
+
+      expect(ctx[:number]).to eq(2)
+    end
+
+    it 'creates a context only to the first step of the loop' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsThreeAction)
+        .with(:number => 1)
+
+      expect(ctx.number).to eq(4)
+    end
+  end
+
+  context 'when called with falsey block' do
+    it 'creates a context up-to the first step' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsThreeAction)
+        .with(:number => 7)
+
+      expect(ctx[:number]).to eq(10)
+    end
+  end
+end

data/spec/testing/context_factory/with_callback_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe 'ContextFactory - used with CallbackOrganizer' do
+  let(:organizer) { TestDoubles::CallbackOrganizer }
+
+  context 'when called with the callback action' do
+    it 'creates a context up-to the callback action' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddTenCallbackAction)
+        .with(:number => 1)
+
+      expect(ctx.number).to eq(2)
+    end
+
+    it 'creates a context up-to callback action with empty context steps' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsTwoAction)
+        .with(:number => 1)
+
+      expect(ctx.number).to eq(12)
+    end
+
+    it 'creates a context up-to the action defined in context steps' do
+      ctx =
+        LightService::Testing::ContextFactory
+        .make_from(organizer)
+        .for(TestDoubles::AddsThreeAction)
+        .with(:number => 1)
+
+      expect(ctx.number).to eq(14)
+    end
+  end
+end

data/spec/testing/context_factory_spec.rb

@@ -2,13 +2,15 @@ require 'spec_helper'
 require 'test_doubles'
 
 describe 'ContextFactory - used with AdditionOrganizer' do
+  let(:organizer) { TestDoubles::AdditionOrganizer }
+
   context 'when called with the first action' do
     it 'does not alter the context' do
       ctx =
         LightService::Testing::ContextFactory
-        .make_from(TestDoubles::AdditionOrganizer)
+        .make_from(organizer)
         .for(TestDoubles::AddsOneAction)
-        .with(:number => 1)
+        .with(1)
 
       expect(ctx[:number]).to eq(1)
     end
@@ -18,9 +20,9 @@ describe 'ContextFactory - used with AdditionOrganizer' do
     it 'adds one to the number provided' do
       ctx =
         LightService::Testing::ContextFactory
-        .make_from(TestDoubles::AdditionOrganizer)
+        .make_from(organizer)
         .for(TestDoubles::AddsTwoAction)
-        .with(:number => 1)
+        .with(1)
 
       expect(ctx.number).to eq(2)
     end
@@ -30,11 +32,31 @@ describe 'ContextFactory - used with AdditionOrganizer' do
     it 'creates a context up-to the action defined' do
       ctx =
         LightService::Testing::ContextFactory
-        .make_from(TestDoubles::AdditionOrganizer)
+        .make_from(organizer)
         .for(TestDoubles::AddsThreeAction)
-        .with(:number => 1)
+        .with(1)
 
       expect(ctx.number).to eq(4)
     end
   end
+
+  context 'when there are already before_actions' do
+    it 'only appends before_actions' do
+      TestDoubles::AdditionOrganizer.before_actions = [
+        lambda do |ctx|
+          ctx[:number] += 1 \
+            if ctx.current_action == TestDoubles::AddsTwoAction
+        end
+      ]
+
+      context =
+        LightService::Testing::ContextFactory
+        .make_from(TestDoubles::AdditionOrganizer)
+        .for(TestDoubles::AddsThreeAction)
+        .with(4) # Context is a "glorified" hash
+
+      expect(context.number).to eq(8)
+      expect(context[:_before_actions].length).to eq(1)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Attila Domokos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-30 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -179,6 +179,10 @@ files:
 - spec/spec_helper.rb
 - spec/support.rb
 - spec/test_doubles.rb
+- spec/testing/context_factory/iterate_spec.rb
+- spec/testing/context_factory/reduce_if_spec.rb
+- spec/testing/context_factory/reduce_until_spec.rb
+- spec/testing/context_factory/with_callback_spec.rb
 - spec/testing/context_factory_spec.rb
 homepage: https://github.com/adomokos/light-service
 licenses:
@@ -252,4 +256,8 @@ test_files:
 - spec/spec_helper.rb
 - spec/support.rb
 - spec/test_doubles.rb
+- spec/testing/context_factory/iterate_spec.rb
+- spec/testing/context_factory/reduce_if_spec.rb
+- spec/testing/context_factory/reduce_until_spec.rb
+- spec/testing/context_factory/with_callback_spec.rb
 - spec/testing/context_factory_spec.rb