functional-light-service 0.5.4 → 6.1.0

data/spec/acceptance/before_actions_spec.rb

@@ -1,98 +1,115 @@
-require 'spec_helper'
-require 'test_doubles'
-
-RSpec.describe 'Action before_actions' do
-  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 FunctionalLightService::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
-  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
+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 FunctionalLightService::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

@@ -1,60 +1,61 @@
-require 'spec_helper'
-
-describe "Log from an organizer with a custom logger" do
-  context "when overriding the global FunctionalLightService organizer" do
-    let(:global_logger_organizer) do
-      Class.new do
-        extend FunctionalLightService::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 FunctionalLightService::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 = FunctionalLightService::Configuration.logger
-      FunctionalLightService::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
-      FunctionalLightService::Configuration.logger = @original_global_logger
-    end
-  end
-end
+require 'spec_helper'
+
+describe "Log from an organizer with a custom logger" do
+  context "when overriding the global FunctionalLightService organizer" do
+    let(:global_logger_organizer) do
+      Class.new do
+        extend FunctionalLightService::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 FunctionalLightService::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 = FunctionalLightService::Configuration.logger
+      FunctionalLightService::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
+      FunctionalLightService::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 'functional-light-service/functional/maybe'
+
+describe "deprecation warnings" do
+  around do |example|
+    FunctionalLightService::Deprecations.silenced = false
+    FunctionalLightService::Deprecations.reset!
+    example.run
+  ensure
+    FunctionalLightService::Deprecations.silenced = true
+    FunctionalLightService::Deprecations.reset!
+  end
+
+  context "when including FunctionalLightService::Organizer" do
+    it "warns on stderr" do
+      expect do
+        class OrganizerIncludingLS
+          include FunctionalLightService::Organizer
+        end
+      end.to output(/Including FunctionalLightService::Organizer is deprecated/).to_stderr
+    end
+  end
+
+  context "when including FunctionalLightService::Action" do
+    it "warns on stderr" do
+      expect do
+        class ActionIncludingLS
+          include FunctionalLightService::Action
+        end
+      end.to output(/Including FunctionalLightService::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 FunctionalLightService::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 = FunctionalLightService::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
+      FunctionalLightService::Deprecations.silenced = true
+      expect { Maybe(nil) }.not_to output.to_stderr
+    end
+  end
+end

data/spec/acceptance/fail_spec.rb

@@ -1,50 +1,52 @@
-require 'spec_helper'
-
-RSpec.describe "fail_and_return!" do
-  describe "returns immediately from executed block" do
-    class FailAndReturnAction
-      extend FunctionalLightService::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 FunctionalLightService::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
+require 'spec_helper'
+
+RSpec.describe "fail_and_return!" do
+  describe "returns immediately from executed block" do
+    class FailAndReturnAction
+      extend FunctionalLightService::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 FunctionalLightService::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