light-service 0.4.0 → 0.5.0

data/spec/action_spec.rb

@@ -9,7 +9,7 @@ describe LightService::Action do
     it "returns immediately" do
       context.fail!("an error")
 
-      TestDoubles::AddsTwoAction.execute(context)
+      TestDoubles::AddsTwoActionWithFetch.execute(context)
 
       expect(context.to_hash.keys).to be_empty
     end
@@ -17,7 +17,7 @@ describe LightService::Action do
 
   context "when the action context does not have failure" do
     it "executes the block" do
-      TestDoubles::AddsTwoAction.execute(context)
+      TestDoubles::AddsTwoActionWithFetch.execute(context)
 
       expect(context.to_hash.keys).to eq [:number]
       expect(context.fetch(:number)).to eq(2)
@@ -28,32 +28,32 @@ describe LightService::Action do
     it "returns immediately" do
       context.skip_all!
 
-      TestDoubles::AddsTwoAction.execute(context)
+      TestDoubles::AddsTwoActionWithFetch.execute(context)
 
       expect(context.to_hash.keys).to be_empty
     end
 
     it "does not execute skipped actions" do
-      TestDoubles::AddsTwoAction.execute(context)
+      TestDoubles::AddsTwoActionWithFetch.execute(context)
       expect(context.to_hash).to eq ({:number => 2})
 
       context.skip_all!
 
-      TestDoubles::AddsTwoAction.execute(context)
+      TestDoubles::AddsTwoActionWithFetch.execute(context)
       # Since the action was skipped, the number remains 2
       expect(context.to_hash).to eq ({:number => 2})
     end
   end
 
   it "returns the context" do
-    result = TestDoubles::AddsTwoAction.execute(context)
+    result = TestDoubles::AddsTwoActionWithFetch.execute(context)
 
     expect(result.to_hash).to eq ({:number => 2})
   end
 
   context "when invoked with hash" do
     it "creates LightService::Context implicitly" do
-      result = TestDoubles::AddsTwoAction.execute(:some_key => "some value")
+      result = TestDoubles::AddsTwoActionWithFetch.execute(:some_key => "some value")
 
       expect(result).to be_success
       expect(result.keys).to eq([:some_key, :number])
@@ -62,7 +62,7 @@ describe LightService::Action do
 
   context "when invoked without arguments" do
     it "creates LightService::Context implicitly" do
-      result = TestDoubles::AddsTwoAction.execute
+      result = TestDoubles::AddsTwoActionWithFetch.execute
 
       expect(result).to be_success
       expect(result.keys).to eq([:number])

data/spec/context_spec.rb

@@ -3,6 +3,8 @@ require 'test_doubles'
 
 describe LightService::Context do
 
+  let(:context) { LightService::Context.make }
+
   describe "can be made" do
     context "with no arguments" do
       subject { LightService::Context.make }
@@ -46,21 +48,18 @@ describe LightService::Context do
   end
 
   it "can be asked for skip_all?" do
-    context = LightService::Context.make
     context.skip_all!
 
     expect(context.skip_all?).to be_truthy
   end
 
   it "can be pushed into a SUCCESS state" do
-    context = LightService::Context.make
     context.succeed!("a happy end")
 
     expect(context).to be_success
   end
 
   it "can be pushed into a SUCCESS state without a message" do
-    context = LightService::Context.make
     context.succeed!
 
     expect(context).to be_success
@@ -68,7 +67,6 @@ describe LightService::Context do
   end
 
   it "can be pushed into a FAILURE state without a message" do
-    context = LightService::Context.make
     context.fail!
 
     expect(context).to be_failure
@@ -76,14 +74,12 @@ describe LightService::Context do
   end
 
   it "can be pushed into a FAILURE state with a message" do
-    context = LightService::Context.make
     context.fail!("a sad end")
 
     expect(context).to be_failure
   end
 
   it "can be pushed into a FAILURE state with a message in an options hash" do
-    context = LightService::Context.make
     context.fail!("a sad end")
 
     expect(context).to be_failure
@@ -92,7 +88,6 @@ describe LightService::Context do
   end
 
   it "can be pushed into a FAILURE state with an error code in an options hash" do
-    context = LightService::Context.make
     context.fail!("a sad end", 10005)
 
     expect(context).to be_failure
@@ -100,16 +95,41 @@ describe LightService::Context do
     expect(context.error_code).to eq(10005)
   end
 
-  it "can set a flag to skip all subsequent actions" do
+  it "uses localization adapter to translate failure message" do
+    action_class = TestDoubles::AnAction
+    expect(LightService::Configuration.localization_adapter).to receive(:failure)
+                                                 .with(:failure_reason, action_class, {})
+                                                 .and_return("message")
+
     context = LightService::Context.make
+    context.current_action = action_class
+    context.fail!(:failure_reason)
+
+    expect(context).to be_failure
+    expect(context.message).to eq("message")
+  end
+
+  it "uses localization adapter to translate success message" do
+    action_class = TestDoubles::AnAction
+    expect(LightService::Configuration.localization_adapter).to receive(:success)
+                                                 .with(:action_passed, action_class, {})
+                                                 .and_return("message")
+
+    context = LightService::Context.make
+    context.current_action = action_class
+    context.succeed!(:action_passed)
+
+    expect(context).to be_success
+    expect(context.message).to eq("message")
+  end
+
+  it "can set a flag to skip all subsequent actions" do
     context.skip_all!
 
     expect(context).to be_skip_all
   end
 
   context "stopping additional processing in an action" do
-    let(:context) { LightService::Context.make }
-
     it "flags processing to stop on failure" do
       context.fail!("on purpose")
       expect(context.stop_processing?).to be_truthy
@@ -121,4 +141,8 @@ describe LightService::Context do
     end
   end
 
+  it "can fail with FailWithRollBackError" do
+    expect { context.fail_with_rollback!("roll me back") }.to \
+      raise_error(LightService::FailWithRollbackError)
+  end
 end

data/spec/localization_adapter_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+require 'test_doubles'
+
+describe LightService::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/organizer/with_reducer_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'test_doubles'
+
+describe LightService::Organizer::WithReducer do
+  let(:context) { LightService::Context.make }
+  let(:action1) { double(:action1) }
+  let(:action2) { double(:action2) }
+  let(:actions) { [action1, action2] }
+
+  before { context.current_action = action2 }
+
+  it "reduces the provided actions" do
+    expect(action1).to receive(:execute).with(context).and_return(context)
+    expect(action2).to receive(:execute).with(context).and_return(context)
+
+    result = described_class.new.with(context).reduce(actions)
+
+    expect(result).to eq(context)
+    expect(result).to be_success
+  end
+
+  context "when FailWithRollbackError is caught" do
+    it "reduces the rollback" do
+      expect(action1).to receive(:execute).with(context).and_return(context)
+      expect(action2).to receive(:execute).with(context) { raise LightService::FailWithRollbackError }
+      expect(action1).to receive(:rollback).with(context).and_return(context)
+      expect(action2).to receive(:rollback).with(context).and_return(context)
+
+      result = described_class.new.with(context).reduce(actions)
+
+      expect(result).to eq(context)
+    end
+
+    it "reduces the rollback with an action without `rollback`" do
+      expect(action1).to receive(:execute).with(context).and_return(context)
+      expect(action2).to receive(:execute).with(context) { raise LightService::FailWithRollbackError }
+      expect(action2).to receive(:rollback).with(context).and_return(context)
+
+      result = described_class.new.with(context).reduce(actions)
+
+      expect(result).to eq(context)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,3 +4,6 @@ $LOAD_PATH << File.join(File.dirname(__FILE__))
 require 'light-service'
 require 'ostruct'
 require 'rspec/its'
+require 'active_support/core_ext/string'
+
+I18n.enforce_available_locales = true

data/spec/test_doubles.rb

@@ -1,7 +1,7 @@
 # A collection of Action and Organizer dummies used in specs
 
 module TestDoubles
-  class AddsTwoAction
+  class AddsTwoActionWithFetch
     include LightService::Action
 
     executed do |context|
@@ -63,7 +63,12 @@ module TestDoubles
 
     executed do |context|
       if context.milk == :very_hot
-        context.fail!("Can't make a latte from a milk that's too hot!")
+        context.fail!("Can't make a latte from a milk that's very hot!")
+        next context
+      end
+
+      if context.milk == :super_hot
+        context.fail_with_rollback!("Can't make a latte from a milk that's super hot!")
         next context
       end
 
@@ -103,7 +108,7 @@ module TestDoubles
 
     def self.call(milk, coffee)
       with(:milk => milk, :coffee => coffee)
-          .reduce(TestDoubles::AddsTwoAction,
+          .reduce(TestDoubles::AddsTwoActionWithFetch,
                   TestDoubles::MakesLatteAction)
     end
   end
@@ -111,10 +116,10 @@ module TestDoubles
   class MakesCappuccinoAddsTwoAndFails
     include LightService::Organizer
 
-    def self.call(coffee)
-      with(:milk => :very_hot, :coffee => coffee)
+    def self.call(coffee, this_hot = :very_hot)
+      with(:milk => this_hot, :coffee => coffee)
           .reduce(TestDoubles::MakesLatteAction,
-                  TestDoubles::AddsTwoAction)
+                  TestDoubles::AddsTwoActionWithFetch)
 
     end
   end
@@ -125,8 +130,50 @@ module TestDoubles
     def self.call(coffee)
       with(:milk => "5%", :coffee => coffee)
           .reduce(TestDoubles::MakesLatteAction,
-                  TestDoubles::AddsTwoAction)
+                  TestDoubles::AddsTwoActionWithFetch)
+
+    end
+  end
 
+  class AdditionOrganizer
+    extend LightService::Organizer
+
+    def self.add_numbers(number)
+      with(:number => number).reduce(
+        AddsOneAction,
+        AddsTwoAction,
+        AddsThreeAction
+      )
+    end
+  end
+
+  class AddsOneAction
+    include LightService::Action
+    expects :number
+    promises :number
+
+    executed do |context|
+      context.number += 1
     end
   end
+
+  class AddsTwoAction
+    include LightService::Action
+    expects :number
+
+    executed do |context|
+      context.number += 2
+    end
+  end
+
+  class AddsThreeAction
+    include LightService::Action
+    expects :number
+    promises :product
+
+    executed do |context|
+      context.product = context.number + 3
+    end
+  end
+
 end

metadata

@@ -1,55 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Attila Domokos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
 - !ruby/object:Gem::Dependency
@@ -73,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -86,6 +100,8 @@ files:
 - lib/light-service/configuration.rb
 - lib/light-service/context.rb
 - lib/light-service/context_key_verifier.rb
+- lib/light-service/errors.rb
+- lib/light-service/localization_adapter.rb
 - lib/light-service/organizer.rb
 - lib/light-service/organizer/with_reducer.rb
 - lib/light-service/organizer/with_reducer_factory.rb
@@ -96,11 +112,15 @@ files:
 - resources/organizer_and_actions.png
 - spec/acceptance/add_numbers_spec.rb
 - spec/acceptance/log_from_organizer_spec.rb
+- spec/acceptance/message_localization_spec.rb
+- spec/acceptance/rollback_spec.rb
 - spec/action_expected_keys_spec.rb
 - spec/action_expects_and_promises_spec.rb
 - spec/action_promised_keys_spec.rb
 - spec/action_spec.rb
 - spec/context_spec.rb
+- spec/localization_adapter_spec.rb
+- spec/organizer/with_reducer_spec.rb
 - spec/organizer_spec.rb
 - spec/sample/calculates_order_tax_action_spec.rb
 - spec/sample/calculates_tax_spec.rb
@@ -122,28 +142,32 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A service skeleton with an emphasis on simplicity
 test_files:
 - spec/acceptance/add_numbers_spec.rb
 - spec/acceptance/log_from_organizer_spec.rb
+- spec/acceptance/message_localization_spec.rb
+- spec/acceptance/rollback_spec.rb
 - spec/action_expected_keys_spec.rb
 - spec/action_expects_and_promises_spec.rb
 - spec/action_promised_keys_spec.rb
 - spec/action_spec.rb
 - spec/context_spec.rb
+- spec/localization_adapter_spec.rb
+- spec/organizer/with_reducer_spec.rb
 - spec/organizer_spec.rb
 - spec/sample/calculates_order_tax_action_spec.rb
 - spec/sample/calculates_tax_spec.rb