switchyard 7.0.0

data/spec/acceptance/before_actions_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'test_doubles'
+
+RSpec.describe 'Action before_actions' do
+  # Gli hook restano sulla classe (non vengono piu consumati da #with):
+  # i test double sono condivisi, quindi vanno ripuliti dopo ogni esempio
+  after do
+    TestDoubles::AdditionOrganizer.before_actions = nil
+    TestDoubles::TestIterate.before_actions = nil
+    TestDoubles::TestWithCallback.before_actions = nil
+  end
+
+  describe 'works with simple organizers - from outside' do
+    it 'can be used to inject code block before each action' do
+      TestDoubles::AdditionOrganizer.before_actions = ->(ctx) do
+        ctx.number -= 2 if ctx.current_action == TestDoubles::AddsThreeAction
+      end
+
+      result = TestDoubles::AdditionOrganizer.call(0)
+
+      expect(result.fetch(:number)).to eq(4)
+    end
+
+    it 'works with iterator' do
+      TestDoubles::TestIterate.before_actions = [
+        ->(ctx) { ctx.number -= 2 if ctx.current_action == TestDoubles::AddsOneAction }
+      ]
+
+      result = TestDoubles::TestIterate.call(:number => 0,
+                                             :counters => [1, 2, 3, 4])
+
+      expect(result).to be_success
+      expect(result.number).to eq(-4)
+    end
+  end
+
+  describe 'can be added to organizers declaratively' do
+    module BeforeActions
+      class AdditionOrganizer
+        extend Switchyard::Organizer
+
+        before_actions ->(ctx) do
+          ctx.number -= 2 if ctx.current_action == TestDoubles::AddsOneAction
+        end,
+                       ->(ctx) do
+                         ctx.number -= 3 if ctx.current_action == TestDoubles::AddsThreeAction
+                       end
+
+        def self.call(number)
+          with(:number => number).reduce(actions)
+        end
+
+        def self.actions
+          [
+            TestDoubles::AddsOneAction,
+            TestDoubles::AddsTwoAction,
+            TestDoubles::AddsThreeAction
+          ]
+        end
+      end
+    end
+
+    it 'accepts before_actions hook lambdas from organizer' do
+      result = BeforeActions::AdditionOrganizer.call(0)
+
+      expect(result.fetch(:number)).to eq(1)
+    end
+
+    it 'keeps the declarative hooks on every subsequent call' do
+      first = BeforeActions::AdditionOrganizer.call(0)
+      second = BeforeActions::AdditionOrganizer.call(0)
+
+      expect(first.fetch(:number)).to eq(1)
+      expect(second.fetch(:number)).to eq(1)
+    end
+  end
+
+  describe 'works with callbacks' do
+    it 'can interact with actions from the outside' do
+      TestDoubles::TestWithCallback.before_actions = [
+        ->(ctx) { ctx.total -= 1000 if ctx.current_action == TestDoubles::AddToTotalAction }
+      ]
+      result = TestDoubles::TestWithCallback.call
+
+      expect(result.counter).to eq(3)
+      expect(result.total).to eq(-2994)
+    end
+  end
+
+  describe 'can halt all execution with a raised error' do
+    it 'does not call the rest of the callback steps' do
+      class SkipContextError < StandardError
+        attr_reader :ctx
+
+        def initialize(msg, ctx)
+          @ctx = ctx
+          super(msg)
+        end
+      end
+      TestDoubles::TestWithCallback.before_actions = [
+        ->(ctx) do
+          if ctx.current_action == TestDoubles::IncrementCountAction
+            ctx.total -= 1000
+            raise SkipContextError.new("stop context now", ctx)
+          end
+        end
+      ]
+      begin
+        TestDoubles::TestWithCallback.call
+      rescue SkipContextError => e
+        expect(e.ctx).not_to be_empty
+      end
+    end
+  end
+end

data/spec/acceptance/custom_log_from_organizer_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe "Log from an organizer with a custom logger" do
+  context "when overriding the global Switchyard organizer" do
+    let(:global_logger_organizer) do
+      Class.new do
+        extend Switchyard::Organizer
+
+        def self.call(number)
+          with(:number => number).reduce(actions)
+        end
+
+        def self.actions
+          [
+            TestDoubles::AddsOneAction,
+            TestDoubles::AddsTwoAction,
+            TestDoubles::AddsThreeAction
+          ]
+        end
+      end
+    end
+
+    let(:global_logger_string) { StringIO.new }
+
+    let(:custom_logger_string) { StringIO.new }
+    let(:custom_logger_organizer) do
+      custom_logger = Logger.new(custom_logger_string)
+
+      Class.new do
+        extend Switchyard::Organizer
+
+        log_with custom_logger
+
+        def self.call(coffee, this_hot = :very_hot)
+          with(:milk => this_hot, :coffee => coffee)
+            .reduce(TestDoubles::MakesLatteAction,
+                    TestDoubles::AddsTwoActionWithFetch)
+        end
+      end
+    end
+
+    before do
+      @original_global_logger = Switchyard::Configuration.logger
+      Switchyard::Configuration.logger = Logger.new(global_logger_string)
+    end
+
+    it "logs in own logger" do
+      global_logger_organizer.call(1)
+      custom_logger_organizer.call(:coffee => "Cappucino")
+
+      expect(custom_logger_string.string).to include("MakesLatteAction")
+      expect(custom_logger_string.string).to_not include("AddsOneAction")
+      expect(global_logger_string.string).to include("AddsOneAction")
+      expect(global_logger_string.string).to_not include("MakesLatteAction")
+    end
+
+    after do
+      Switchyard::Configuration.logger = @original_global_logger
+    end
+  end
+end

data/spec/acceptance/deprecation_warnings_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+# Maybe()/Null e il monkey-patch di Object sono opt-in: non fanno parte
+# del require chain di default della gem
+require 'switchyard/functional/maybe'
+
+describe "deprecation warnings" do
+  around do |example|
+    Switchyard::Deprecations.silenced = false
+    Switchyard::Deprecations.reset!
+    example.run
+  ensure
+    Switchyard::Deprecations.silenced = true
+    Switchyard::Deprecations.reset!
+  end
+
+  context "when including Switchyard::Organizer" do
+    it "warns on stderr" do
+      expect do
+        class OrganizerIncludingLS
+          include Switchyard::Organizer
+        end
+      end.to output(/Including Switchyard::Organizer is deprecated/).to_stderr
+    end
+  end
+
+  context "when including Switchyard::Action" do
+    it "warns on stderr" do
+      expect do
+        class ActionIncludingLS
+          include Switchyard::Action
+        end
+      end.to output(/Including Switchyard::Action is deprecated/).to_stderr
+    end
+  end
+
+  context "when using Maybe/Null" do
+    it "warns once per process" do
+      expect { Maybe(nil) }
+        .to output(%r{Maybe\(\)/Null are deprecated}).to_stderr
+      # warn-once: la seconda invocazione non emette nulla
+      expect { Maybe(nil) }.not_to output.to_stderr
+    end
+  end
+
+  context "when using the exotic operators" do
+    include Switchyard::Prelude::Result
+
+    it "Result#>= warns and delegates to #try" do
+      result = nil
+      expect { result = Success(1) >= ->(v) { Success(v + 1) } }
+        .to output(/Result#>= is deprecated/).to_stderr
+      expect(result).to eq(Success(2))
+    end
+
+    it "Result#<< warns and delegates to #pipe" do
+      expect { Success(1) << ->(_v) {} }
+        .to output(/Result#<< is deprecated/).to_stderr
+    end
+
+    it "Result#+ warns and still combines" do
+      result = nil
+      expect { result = Success(1) + Success(2) }
+        .to output(/Result#\+ is deprecated/).to_stderr
+      expect(result).to eq(Success(3))
+    end
+
+    it "Option#+ warns and still combines" do
+      some = Switchyard::Option::Some
+      result = nil
+      expect { result = some.new(1) + some.new(2) }
+        .to output(/Option#\+ is deprecated/).to_stderr
+      expect(result).to eq(some.new(3))
+    end
+  end
+
+  context "when silenced" do
+    it "emits nothing" do
+      Switchyard::Deprecations.silenced = true
+      expect { Maybe(nil) }.not_to output.to_stderr
+    end
+  end
+end

data/spec/acceptance/fail_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+RSpec.describe "fail_and_return!" do
+  describe "returns immediately from executed block" do
+    class FailAndReturnAction
+      extend Switchyard::Action
+
+      promises :one, :two
+
+      executed do |ctx|
+        ctx.one = 1
+        # Have to set it in Context
+        ctx.two = nil
+
+        ctx.fail_and_return!('Something went wrong')
+        ctx.two = 2
+      end
+    end
+
+    it "returns immediately from executed block" do
+      result = FailAndReturnAction.execute
+
+      expect(result).to be_failure
+      expect(result.two).to be_nil
+    end
+  end
+
+  describe "accepts error_code option" do
+    class FailAndReturnWithErrorCodeAction
+      extend Switchyard::Action
+
+      promises :one, :two
+
+      executed do |ctx|
+        ctx.one = 1
+        # Have to set it in Context
+        ctx.two = nil
+
+        ctx.fail_and_return!('Something went wrong', :error_code => 401)
+        ctx.two = 2
+      end
+    end
+
+    it "returned context contains the error_code" do
+      result = FailAndReturnWithErrorCodeAction.execute
+
+      expect(result).to be_failure
+      expect(result.error_code).to eq 401
+      expect(result.two).to be_nil
+    end
+  end
+end

data/spec/acceptance/log_from_organizer_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+require 'test_doubles'
+require 'stringio'
+
+describe "Logs from organizer" do
+  def collects_log
+    original_logger = Switchyard::Configuration.logger
+
+    strio = StringIO.new
+    Switchyard::Configuration.logger = Logger.new(strio)
+
+    yield
+
+    Switchyard::Configuration.logger = original_logger
+
+    strio.string
+  end
+
+  context "when every action has expects or promises" do
+    subject(:log_message) do
+      collects_log do
+        TestDoubles::MakesTeaAndCappuccino
+          .call("black tea", "2% milk", "espresso coffee")
+      end
+    end
+
+    it "describes what organizer was invoked" do
+      organizer_log_message = "[Switchyard] - calling organizer " \
+                              "<TestDoubles::MakesTeaAndCappuccino>"
+      expect(log_message).to include(organizer_log_message)
+    end
+
+    it "describes the actions invoked" do
+      organizer_log_message = "[Switchyard] - executing " \
+                              "<TestDoubles::MakesTeaWithMilkAction>"
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "[Switchyard] - executing " \
+                              "<TestDoubles::MakesLatteAction>"
+      expect(log_message).to include(organizer_log_message)
+    end
+
+    it "lists the keys in context before the actions are executed" do
+      organizer_log_message = "[Switchyard] -     " \
+                              "keys in context: :tea, :milk, :coffee"
+      expect(log_message).to include(organizer_log_message)
+    end
+
+    it "lists the expects actions are expecting" do
+      organizer_log_message = "[Switchyard] -   expects: :tea, :milk"
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "[Switchyard] -   expects: :coffee, :milk"
+      expect(log_message).to include(organizer_log_message)
+    end
+
+    it "lists the promises actions are promising" do
+      organizer_log_message = "[Switchyard] -   promises: :milk_tea"
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "[Switchyard] -   promises: :latte"
+      expect(log_message).to include(organizer_log_message)
+    end
+
+    it "lists the keys in contect after the actions are executed" do
+      organizer_log_message = "[Switchyard] -     keys in context: " \
+                              ":tea, :milk, :coffee, :milk_tea, :latte"
+      expect(log_message).to include(organizer_log_message)
+    end
+  end
+
+  context "when NOT every action expects or promises" do
+    subject(:log_message) do
+      collects_log do
+        TestDoubles::MakesCappuccinoAddsTwo.call("2% milk", "espresso coffee")
+      end
+    end
+
+    it "describes what organizer was invoked" do
+      organizer_log_message = "[Switchyard] - calling organizer " \
+                              "<TestDoubles::MakesCappuccinoAddsTwo>"
+      expect(log_message).to include(organizer_log_message)
+    end
+
+    it "does not list empty expects or promises" do
+      organizer_log_message = "[Switchyard] -   expects:\n"
+      expect(log_message).not_to include(organizer_log_message)
+      organizer_log_message = "[Switchyard] -   promises:\n"
+      expect(log_message).not_to include(organizer_log_message)
+    end
+  end
+
+  context "when the context has failed" do
+    subject(:log_message) do
+      collects_log do
+        TestDoubles::MakesCappuccinoAddsTwoAndFails
+          .call("espresso coffee")
+      end
+    end
+
+    it "logs it with a warning" do
+      organizer_log_message = "WARN -- : [Switchyard] - :-((( " \
+                              "<TestDoubles::MakesLatteAction> has failed..."
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "WARN -- : [Switchyard] - context message: " \
+                              "Can't make a latte from a milk that's very hot!"
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "[Switchyard] -  :-((( " \
+                              "<TestDoubles::AddsTwoAction> has failed..."
+      expect(log_message).not_to include(organizer_log_message)
+    end
+  end
+
+  context "when the context has failed with rollback" do
+    subject(:log_message) do
+      collects_log do
+        TestDoubles::MakesCappuccinoAddsTwoAndFails
+          .call("espresso coffee", :super_hot)
+      end
+    end
+
+    it "logs it with a warning" do
+      organizer_log_message = "WARN -- : [Switchyard] - :-((( " \
+                              "<TestDoubles::MakesLatteAction> has failed..."
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "WARN -- : [Switchyard] - context message: " \
+                              "Can't make a latte from a milk that's super hot!"
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "[Switchyard] -  :-((( " \
+                              "<TestDoubles::AddsTwoAction> " \
+                              "has failed..."
+      expect(log_message).not_to include(organizer_log_message)
+    end
+  end
+
+  context "when the context is skipping the rest" do
+    subject(:log_message) do
+      collects_log do
+        TestDoubles::MakesCappuccinoSkipsAddsTwo.call("espresso coffee")
+      end
+    end
+
+    it "logs it with a warning" do
+      organizer_log_message = "INFO -- : [Switchyard] - ;-) " \
+                              "<TestDoubles::MakesLatteAction> has decided " \
+                              "to skip the rest of the actions"
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "INFO -- : [Switchyard] - context message: " \
+                              "Can't make a latte with a fatty milk like that!"
+      expect(log_message).to include(organizer_log_message)
+      organizer_log_message = "INFO -- : [Switchyard] - ;-) " \
+                              "<TestDoubles::AddsTwoAction> has decided " \
+                              "to skip the rest of the actions"
+      expect(log_message).not_to include(organizer_log_message)
+    end
+  end
+end

data/spec/acceptance/message_localization_spec.rb

@@ -0,0 +1,119 @@
+require "spec_helper"
+require "test_doubles"
+
+class TestsLocalizationAdapter
+  extend Switchyard::Organizer
+
+  def self.call(pass_or_fail, message_or_key, i18n_options = {})
+    with(
+      :pass_or_fail => pass_or_fail,
+      :message_or_key => message_or_key,
+      :i18n_options => i18n_options
+    ).reduce(TestsLocalizationInvocationOptionsAction)
+  end
+end
+
+class TestsLocalizationInvocationOptionsAction
+  extend Switchyard::Action
+
+  expects :pass_or_fail, :message_or_key, :i18n_options
+
+  executed do |context|
+    if context.pass_or_fail == true
+      context.succeed!(context.message_or_key, context.i18n_options)
+    else
+      context.fail!(context.message_or_key, context.i18n_options)
+    end
+  end
+end
+
+def pass_with(message_or_key, i18n_options = {})
+  TestsLocalizationAdapter.call(true, message_or_key, i18n_options)
+end
+
+def fail_with(message_or_key, i18n_options = {})
+  TestsLocalizationAdapter.call(false, message_or_key, i18n_options)
+end
+
+describe "Localization Adapter" do
+  before do
+    I18n.backend.store_translations(
+      :en,
+      :tests_localization_invocation_options_action =>
+      {
+        :switchyard => {
+          :failures => {
+            :some_failure_reason => "This has failed",
+            :failure_with_interpolation => "Failed with %{reason}"
+          },
+          :successes => {
+            :some_success_reason => "This has passed",
+            :success_with_interpolation => "Passed with %{reason}"
+          }
+        }
+      }
+    )
+  end
+
+  describe "passing a simple string message" do
+    describe "by failing the context" do
+      it "returns the string" do
+        result = fail_with("string message")
+
+        expect(result).to be_failure
+        expect(result.message).to eq("string message")
+      end
+    end
+
+    describe "by passing the context" do
+      it "returns the string" do
+        result = pass_with("string message")
+
+        expect(result).to be_success
+        expect(result.message).to eq("string message")
+      end
+    end
+  end
+
+  describe "passing a Symbol" do
+    describe "by failing the context" do
+      it "performs a translation" do
+        result = fail_with(:some_failure_reason)
+
+        expect(result).to be_failure
+        expect(result.message).to eq("This has failed")
+      end
+    end
+
+    describe "by passing the contenxt" do
+      it "performs a translation" do
+        result = pass_with(:some_success_reason)
+
+        expect(result).to be_success
+        expect(result.message).to eq("This has passed")
+      end
+    end
+  end
+
+  describe "passing a Symbol with interpolation variables" do
+    describe "by failing the context" do
+      it "performs a translation with interpolation" do
+        result = fail_with(:failure_with_interpolation,
+                           :reason => "bad account")
+
+        expect(result).to be_failure
+        expect(result.message).to eq("Failed with bad account")
+      end
+    end
+
+    describe "by passing the context" do
+      it "performs a translation with interpolation" do
+        result = pass_with(:success_with_interpolation,
+                           :reason => "account in good standing")
+
+        expect(result).to be_success
+        expect(result.message).to eq("Passed with account in good standing")
+      end
+    end
+  end
+end

data/spec/acceptance/organizer/add_aliases_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+RSpec.describe Switchyard::Organizer do
+  class TestAddAliases
+    extend Switchyard::Organizer
+
+    def self.call(context = Switchyard::Context.make)
+      with(context).reduce(steps)
+    end
+
+    def self.steps
+      [
+        add_to_context(:my_message => "Hello There"),
+        # This will add the alias `:a_message` which points
+        # to the :my_message key's value
+        add_aliases(:my_message => :a_message),
+        TestDoubles::CapitalizeMessage
+      ]
+    end
+  end
+
+  it "adds aliases to the context embedded in the series of actions" do
+    result = TestAddAliases.call
+
+    expect(result).to be_success
+    expect(result.final_message).to eq("HELLO THERE")
+  end
+end

data/spec/acceptance/organizer/add_to_context_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+RSpec.describe Switchyard::Organizer do
+  class TestAddToContext
+    extend Switchyard::Organizer
+
+    def self.call(context = Switchyard::Context.make)
+      with(context).reduce(steps)
+    end
+
+    def self.steps
+      [
+        # This will add the `:number` key to the context
+        # with the value of 0, so it's available for
+        # AddsOneAction
+        add_to_context(:number => 0),
+        TestDoubles::AddsOneAction,
+        add_to_context(:something => "hello")
+      ]
+    end
+  end
+
+  it "adds items to the context on the fly" do
+    result = TestAddToContext.call
+
+    expect(result).to be_success
+    expect(result.number).to eq(1)
+    expect(result[:something]).to eq("hello")
+  end
+
+  it "defines accessors for the added keys" do
+    result = TestAddToContext.call
+
+    expect(result.something).to eq("hello")
+  end
+
+  it "raises when the added key conflicts with a Context method" do
+    organizer = Class.new do
+      extend Switchyard::Organizer
+
+      def self.call
+        reduce(steps)
+      end
+
+      def self.steps
+        [add_to_context(:message => "boom")]
+      end
+    end
+
+    expect { organizer.call }
+      .to raise_error(Switchyard::ReservedKeysInContextError,
+                      /:message conflicts/)
+  end
+end