light-service 0.13.0 → 0.17.0

data/spec/action_optional_expected_keys_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require 'test_doubles'
+
+describe ":expects macro using defaults" do
+  context "when all expected keys are supplied" do
+    it "is expected to ignore default values" do
+      outcome = TestDoubles::AddsNumbersWithOptionalDefaults.execute(
+        :first_number => 3,
+        :second_number => 5,
+        :third_number => 7
+      )
+
+      expect(outcome.total).to eq 15
+    end
+  end
+
+  context "when defaults are supplied" do
+    it "is expected to use static values" do
+      outcome = TestDoubles::AddsNumbersWithOptionalDefaults.execute(
+        :first_number => 3,
+        :second_number => 7
+      )
+
+      expect(outcome.total).to eq 20
+    end
+
+    it "is expected to use dynamic values" do
+      outcome = TestDoubles::AddsNumbersWithOptionalDefaults.execute(
+        :first_number => 3,
+        :third_number => 5
+      )
+
+      expect(outcome.total).to eq 18
+    end
+
+    it "is expected to process defaults in their defined order" do
+      outcome = TestDoubles::AddsNumbersWithOptionalDefaults.execute(
+        :third_number => 5,
+        :first_number => 3
+      )
+
+      expect(outcome.total).to eq 18
+    end
+
+    it "is expected to use all defaults if required" do
+      outcome = TestDoubles::AddsNumbersWithOptionalDefaults.execute(
+        :first_number => 3
+      )
+
+      expect(outcome.total).to eq 23
+    end
+  end
+
+  context "when used within an organizer" do
+    it "is expected to process required defaults" do
+      outcome = TestDoubles::OrganizerWithActionsUsingDefaults.call
+
+      expect(outcome.total).to eq 20
+    end
+  end
+
+  context "when defaults are misconfigured" do
+    it "is expected to raise an exception" do
+      expect do
+        # Needs to be specified in the block
+        # as error is raised at define time
+        class AddsNumbersWithIncorrectDefaults
+          extend LightService::Action
+
+          expects  :first,  :default => 10 # This one is fine. Other two arent
+          expects  :second, :defalut => ->(ctx) { ctx[:first] + 7 }
+          expects  :third,  :deafult => 10
+          promises :total
+
+          executed do |ctx|
+            ctx.total = ctx.first + ctx.second + ctx.third
+          end
+        end
+      end.to raise_error(LightService::UnusableExpectKeyDefaultError)
+    end
+  end
+end

data/spec/action_spec.rb

@@ -68,6 +68,14 @@ describe LightService::Action do
     expect(result.to_hash).to eq(:number => 2)
   end
 
+  context "when called directly" do
+    it "is expected to not be organized" do
+      result = TestDoubles::AddsTwoActionWithFetch.execute(context)
+
+      expect(result.organized_by).to be_nil
+    end
+  end
+
   context "when invoked with hash" do
     it "creates LightService::Context implicitly" do
       ctx = { :some_key => "some value" }

data/spec/lib/generators/action_generator_advanced_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+require_relative '../../../lib/generators/light_service/action_generator.rb'
+require_relative './full_generator_test_blobs'
+
+describe LightService::Generators::ActionGenerator, :type => :generator do
+  destination File.expand_path('tmp', __dir__)
+
+  context "when generating an advanced action" do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    after(:all) do
+      FileUtils.rm_rf destination_root
+    end
+
+    arguments %w[
+      my/fancy/action
+      expects:foo,bar
+      promises:baz,qux
+      --no-roll-back
+      --dir=services
+    ]
+
+    specify do
+      expect(destination_root).to(have_structure do
+        directory "app/services/my/fancy" do
+          file "action.rb" do
+            contains FullGeneratorTestBlobs.advanced_action_blob
+          end
+        end
+
+        directory "spec/services/my/fancy" do
+          file "action_spec.rb" do
+            contains FullGeneratorTestBlobs.advanced_action_spec_blob
+          end
+        end
+      end)
+    end
+  end
+end

data/spec/lib/generators/action_generator_simple_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+require_relative '../../../lib/generators/light_service/action_generator.rb'
+require_relative './full_generator_test_blobs'
+
+describe LightService::Generators::ActionGenerator, :type => :generator do
+  destination File.expand_path('tmp', __dir__)
+
+  context "when generating a simple action" do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    after(:all) do
+      FileUtils.rm_rf destination_root
+    end
+
+    arguments %w[my_action]
+
+    specify do
+      expect(destination_root).to(have_structure do
+        directory "app/actions" do
+          file "my_action.rb" do
+            contains FullGeneratorTestBlobs.simple_action_blob
+          end
+        end
+
+        directory "spec/actions" do
+          file "my_action_spec.rb" do
+            contains FullGeneratorTestBlobs.simple_action_spec_blob
+          end
+        end
+      end)
+    end
+  end
+end

data/spec/lib/generators/full_generator_test_blobs.rb

@@ -0,0 +1,193 @@
+# rubocop:disable Metrics/ClassLength, Metrics/MethodLength
+class FullGeneratorTestBlobs
+  def self.simple_action_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      class MyAction
+        extend ::LightService::Action
+
+        executed do |ctx|
+        end
+
+        rolled_back do |ctx|
+        end
+      end
+    BLOB
+  end
+
+  def self.simple_action_spec_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe MyAction, type: :action do
+        subject { described_class.execute(ctx) }
+
+        let(:ctx) do
+          {
+          }
+        end
+
+        context "when executed" do
+          xit "is expected to be successful" do
+            expect(subject).to be_a_success
+          end
+        end
+      end
+    BLOB
+  end
+
+  # There's some weird whitespace issue which prevents
+  # using HEREDOCS :(
+  def self.advanced_action_blob
+    "# frozen_string_literal: true\n" \
+      "\n" \
+      "module My::Fancy\n" \
+      "  class Action\n" \
+      "    extend ::LightService::Action\n" \
+      "\n" \
+      "    expects  :foo, :bar\n" \
+      "    promises :baz, :qux\n" \
+      "\n" \
+      "    executed do |ctx|\n" \
+      "      foo = ctx.foo\n" \
+      "      bar = ctx.bar\n" \
+      "    end\n" \
+      "  end\n" \
+      "end"
+  end
+
+  def self.advanced_action_spec_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe My::Fancy::Action, type: :action do
+        subject { described_class.execute(ctx) }
+
+        let(:ctx) do
+          {
+            foo: nil,
+            bar: nil,
+          }
+        end
+
+        context "when executed" do
+          xit "is expected to be successful" do
+            expect(subject).to be_a_success
+          end
+
+          xit "is expected to promise 'baz'" do
+            expect(subject.baz).to eq SomeBazClass
+          end
+
+          xit "is expected to promise 'qux'" do
+            expect(subject.qux).to eq SomeQuxClass
+          end
+        end
+      end
+    BLOB
+  end
+
+  def self.simple_organizer_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      class MyOrganizer
+        extend ::LightService::Organizer
+
+        def self.call(params)
+          with(
+            #foo: params[:foo],
+            #bar: params[:bar]
+          ).reduce(actions)
+        end
+
+        def self.actions
+          [
+            #OneAction,
+            #TwoAction,
+          ]
+        end
+      end
+    BLOB
+  end
+
+  def self.simple_organizer_spec_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe MyOrganizer, type: :organizer do
+        subject { described_class.call(ctx) }
+
+        let(:ctx) do
+          {
+            #foo: 'something foo',
+            #bar: { baz: qux },
+          }
+        end
+
+        context "when called" do
+          xit "is expected to be successful" do
+            expect(subject).to be_a_success
+          end
+        end
+      end
+    BLOB
+  end
+
+  def self.advanced_organizer_blob
+    "# frozen_string_literal: true\n" \
+      "\n" \
+      "module My::Fancy\n" \
+      "  class Organizer\n" \
+      "    extend ::LightService::Organizer\n" \
+      "\n" \
+      "    def self.call(params)\n" \
+      "      with(\n" \
+      "        #foo: params[:foo],\n" \
+      "        #bar: params[:bar]\n" \
+      "      ).reduce(actions)\n" \
+      "    end\n" \
+      "\n" \
+      "    def self.actions\n" \
+      "      [\n" \
+      "        #My::Fancy::OneAction,\n" \
+      "        #My::Fancy::TwoAction,\n" \
+      "      ]\n" \
+      "    end\n" \
+      "  end\n" \
+      "end"
+  end
+
+  def self.advanced_organizer_spec_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe My::Fancy::Organizer, type: :organizer do
+        subject { described_class.call(ctx) }
+
+        let(:ctx) do
+          {
+            #foo: 'something foo',
+            #bar: { baz: qux },
+          }
+        end
+
+        context "when called" do
+          xit "is expected to be successful" do
+            expect(subject).to be_a_success
+          end
+        end
+      end
+    BLOB
+  end
+end
+# rubocop:enable Metrics/ClassLength, Metrics/MethodLength

data/spec/lib/generators/organizer_generator_advanced_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+require_relative '../../../lib/generators/light_service/organizer_generator.rb'
+require_relative './full_generator_test_blobs'
+
+describe LightService::Generators::OrganizerGenerator, :type => :generator do
+  destination File.expand_path('tmp', __dir__)
+
+  context "when generating an advanced organizer" do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    after(:all) do
+      FileUtils.rm_rf destination_root
+    end
+
+    arguments %w[my/fancy/organizer --dir=processes]
+
+    specify do
+      expect(destination_root).to(have_structure do
+        directory "app/processes/my/fancy" do
+          file "organizer.rb" do
+            contains FullGeneratorTestBlobs.advanced_organizer_blob
+          end
+        end
+
+        directory "spec/processes/my/fancy" do
+          file "organizer_spec.rb" do
+            contains FullGeneratorTestBlobs.advanced_organizer_spec_blob
+          end
+        end
+      end)
+    end
+  end
+end

data/spec/lib/generators/organizer_generator_simple_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+require_relative '../../../lib/generators/light_service/organizer_generator.rb'
+require_relative './full_generator_test_blobs'
+
+describe LightService::Generators::OrganizerGenerator, :type => :generator do
+  destination File.expand_path('tmp', __dir__)
+
+  context "when generating a simple organizer" do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    after(:all) do
+      FileUtils.rm_rf destination_root
+    end
+
+    arguments %w[my_organizer]
+
+    specify do
+      expect(destination_root).to(have_structure do
+        directory "app/organizers" do
+          file "my_organizer.rb" do
+            contains FullGeneratorTestBlobs.simple_organizer_blob
+          end
+        end
+
+        directory "spec/organizers" do
+          file "my_organizer_spec.rb" do
+            contains FullGeneratorTestBlobs.simple_organizer_spec_blob
+          end
+        end
+      end)
+    end
+  end
+end