light-service 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65825f46d1fd42f09f7e31d1c6237936c848aa7f
-  data.tar.gz: cc2963f8195cb9e33b1bbb0fad85864d9249e29d
+  metadata.gz: 713a827193e2ac90169a99251cbb9d9745ed4394
+  data.tar.gz: 91400a943609efb9e0a811437b73d30faf1090cb
 SHA512:
-  metadata.gz: 5b1cd806096d97fef2f82e8310affaa87102377ce6e318b613f8035ebe542731bcf5331d38e9a54fa748207cc4579da165c55a4a3d95cacd20988200034d52fc
-  data.tar.gz: 5ab53d49c280764ef5cf6e1097ea103059db80d018bef4fc5533baeb80878c010c8c6852d6f9a2ad7abdba612d54e07031894f166ac072078d62e8ded2ef866f
+  metadata.gz: 4ceecbf3154d271ead7dfb8105dc38100589b0e0158943c3994a1f1649b30b9e5d65725b7d3416311b1975b5a8a5a0a181a2c26e4843689637b88a873d2792a3
+  data.tar.gz: 6f44c67e69cd032a46320d75ab6a7188f3d177e090207abdcbed34a1db984b914367d2ba6a9eeb3aaa881d3f4e9f91a59207323993db8984d7024b754ab387bc

data/.travis.yml

@@ -2,6 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.2
 # uncomment this line if your project needs to run something other than `rake`:
 script: bundle exec rspec spec

data/README.md

@@ -273,6 +273,10 @@ For further examples, please visit the project's [Wiki](https://github.com/adomo
 Huge thanks to the [contributors](https://github.com/adomokos/light-service/graphs/contributors)!
 
 ## Release Notes
+### 0.3.4
+* The method call `with` is [now optional](https://github.com/adomokos/light-service/blob/master/spec/organizer_spec.rb#L18) in case you have nothing to put into the context.
+* Action name is being displayed in the error message when the expected or promised key is not in the context.
+
 ### 0.3.3
 * Switching the promises and expects keys accessors from Action to Context
 

data/lib/light-service/action.rb

@@ -14,19 +14,28 @@ module LightService
         @_promised_keys = args
       end
 
+      def expected_keys
+        @_expected_keys
+      end
+
+      def promised_keys
+        @_promised_keys
+      end
+
       def executed
         define_singleton_method "execute" do |context = {}|
           action_context = create_action_context(context)
           return action_context if action_context.stop_processing?
+          action = self
 
-          ContextKeyVerifier.verify_expected_keys_are_in_context(action_context, @_expected_keys)
+          ContextKeyVerifier.verify_expected_keys_are_in_context(action_context, action)
 
-          action_context.define_accessor_methods_for_keys(@_expected_keys)
-          action_context.define_accessor_methods_for_keys(@_promised_keys)
+          action_context.define_accessor_methods_for_keys(expected_keys)
+          action_context.define_accessor_methods_for_keys(promised_keys)
 
           yield(action_context)
 
-          ContextKeyVerifier.verify_promised_keys_are_in_context(action_context, @_promised_keys)
+          ContextKeyVerifier.verify_promised_keys_are_in_context(action_context, action)
         end
       end
 

data/lib/light-service/context_key_verifier.rb

@@ -4,15 +4,15 @@ module LightService
 
   class ContextKeyVerifier
     class << self
-      def verify_expected_keys_are_in_context(context, expected_keys)
-        verify_keys_are_in_context(context, expected_keys) do |not_found_keys|
-          fail ExpectedKeysNotInContextError, "expected #{format_keys(not_found_keys)} to be in the context"
+      def verify_expected_keys_are_in_context(context, action)
+        verify_keys_are_in_context(context, action.expected_keys) do |not_found_keys|
+          fail ExpectedKeysNotInContextError, "expected #{format_keys(not_found_keys)} to be in the context during #{action.to_s}"
         end
       end
 
-      def verify_promised_keys_are_in_context(context, promised_keys)
-        verify_keys_are_in_context(context, promised_keys) do |not_found_keys|
-          fail PromisedKeysNotInContextError, "promised #{format_keys(not_found_keys)} to be in the context"
+      def verify_promised_keys_are_in_context(context, action)
+        verify_keys_are_in_context(context, action.promised_keys) do |not_found_keys|
+          fail PromisedKeysNotInContextError, "promised #{format_keys(not_found_keys)} to be in the context during #{action.to_s}"
         end
       end
 

data/lib/light-service/organizer.rb

@@ -8,6 +8,10 @@ module LightService
       def with(data)
         new.with(data)
       end
+
+      def reduce(actions)
+        new.with.reduce(actions)
+      end
     end
 
     def with(data = {})

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

data/light-service.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = LightService::VERSION
 
-  gem.add_development_dependency("rspec", "~> 2.0")
+  gem.add_development_dependency("rspec", "~> 3.0")
+  gem.add_development_dependency("rspec-its", "~> 1.0")
   gem.add_development_dependency("simplecov", "~> 0.7.1")
   gem.add_development_dependency("pry", "0.9.12.2")
 end

data/spec/action_expected_keys_spec.rb

@@ -11,6 +11,15 @@ module LightService
         context.milk_tea = "#{context.tea} - #{context.milk}"
       end
     end
+    class DummyActionForKeysToPromiseWithError
+      include LightService::Action
+      expects :tea, :milk
+      promises :milk_tea
+
+      executed do |context|
+        context[:some_tea] = "#{context.tea} - #{context.milk}"
+      end
+    end
 
     context "when expected keys are in the context" do
       it "can access the keys as class methods" do
@@ -23,13 +32,22 @@ module LightService
       end
     end
 
-    context "when expected keys are not in the context" do
+    context "when expected key is not in the context" do
       it "raises an error" do
-        exception_error_text = "expected :milk to be in the context"
+        exception_error_text = "expected :milk to be in the context during LightService::DummyActionForKeysToExpect"
         expect {
           DummyActionForKeysToExpect.execute(:tea => "black")
         }.to raise_error(ExpectedKeysNotInContextError, exception_error_text)
       end
     end
+
+    context "when promised key is not in context" do
+      it "raises an error" do
+        exception_error_text = "promised :milk_tea to be in the context during LightService::DummyActionForKeysToPromiseWithError"
+        expect {
+          DummyActionForKeysToPromiseWithError.execute(:tea => "black", :milk => "2%")
+        }.to raise_error(PromisedKeysNotInContextError, exception_error_text)
+      end
+    end
   end
 end

data/spec/action_promised_keys_spec.rb

@@ -14,7 +14,7 @@ module LightService
 
     context "when the promised key is not in the context" do
       it "raises an ArgumentError" do
-        exception_error_text = "promised :milk_tea, :something_else to be in the context"
+        exception_error_text = "promised :milk_tea, :something_else to be in the context during LightService::DummyActionForKeysToPromise"
         expect {
           DummyActionForKeysToPromise.execute(:tea => "black", :milk => "full cream")
         }.to raise_error(PromisedKeysNotInContextError, exception_error_text)

data/spec/action_spec.rb

@@ -31,7 +31,7 @@ module LightService
 
         DummyAction.execute(context)
 
-        context.to_hash.keys.should be_empty
+        expect(context.to_hash.keys).to be_empty
       end
     end
 
@@ -39,7 +39,7 @@ module LightService
       it "executes the block" do
         DummyAction.execute(context)
 
-        context.to_hash.keys.should eq [:test_key]
+        expect(context.to_hash.keys).to eq [:test_key]
       end
     end
 
@@ -49,7 +49,7 @@ module LightService
 
         DummyAction.execute(context)
 
-        context.to_hash.keys.should be_empty
+        expect(context.to_hash.keys).to be_empty
       end
 
       it "does not execute skipped actions" do
@@ -59,14 +59,14 @@ module LightService
 
         SkippedAction.execute(context)
 
-        context.to_hash.should eq ({:test_key => "test_value"})
+        expect(context.to_hash).to eq ({:test_key => "test_value"})
       end
     end
 
     it "returns the context" do
       result = DummyAction.execute(context)
 
-      result.to_hash.should eq ({:test_key => "test_value"})
+      expect(result.to_hash).to eq ({:test_key => "test_value"})
     end
 
     context "when invoked with hash" do

data/spec/context_spec.rb

@@ -6,7 +6,7 @@ module LightService
     describe "can be made" do
       context "with no arguments" do
         subject { Context.make }
-        it { should be_success }
+        it { is_expected.to be_success }
         its(:message) { should be_empty }
       end
 
@@ -49,7 +49,7 @@ module LightService
       context = Context.make
       context.skip_all!
 
-      expect(context.skip_all?).to be_true
+      expect(context.skip_all?).to be_truthy
     end
 
     it "can be pushed into a SUCCESS state" do
@@ -112,12 +112,12 @@ module LightService
 
       it "flags processing to stop on failure" do
         context.fail!("on purpose")
-        expect(context.stop_processing?).to be_true
+        expect(context.stop_processing?).to be_truthy
       end
 
       it "flags processing to stop when remaining actions should be skipped" do
         context.skip_all!
-        expect(context.stop_processing?).to be_true
+        expect(context.stop_processing?).to be_truthy
       end
     end
 

data/spec/organizer_spec.rb

@@ -14,6 +14,10 @@ describe LightService::Organizer do
     def self.do_something_with_no_actions(action_arguments)
       with(action_arguments).reduce
     end
+
+    def self.do_something_with_no_starting_context
+      reduce([AnAction, AnotherAction])
+    end
   end
 
   let(:context) { ::LightService::Context.make(user: user) }
@@ -21,10 +25,10 @@ describe LightService::Organizer do
 
   context "when #with is called with hash" do
     before do
-      AnAction.should_receive(:execute) \
+      expect(AnAction).to receive(:execute) \
               .with(context) \
               .and_return context
-      AnotherAction.should_receive(:execute) \
+      expect(AnotherAction).to receive(:execute) \
               .with(context) \
               .and_return context
     end
@@ -37,10 +41,10 @@ describe LightService::Organizer do
 
   context "when #with is called with Context" do
     before do
-      AnAction.should_receive(:execute) \
+      expect(AnAction).to receive(:execute) \
               .with(context) \
               .and_return context
-      AnotherAction.should_receive(:execute) \
+      expect(AnotherAction).to receive(:execute) \
               .with(context) \
               .and_return context
     end
@@ -54,7 +58,21 @@ describe LightService::Organizer do
   context "when no Actions are specified" do
     it "throws a Runtime error" do
       expect { AnOrganizer.do_something_with_no_actions(context) }.to \
-              raise_error RuntimeError, "No action(s) were provided"
+        raise_error RuntimeError, "No action(s) were provided"
+    end
+  end
+
+  context "when no starting context is specified" do
+    it "creates one implicitly" do
+      expect(AnAction).to receive(:execute) \
+        .with({}) \
+        .and_return(context)
+      expect(AnotherAction).to receive(:execute) \
+        .with(context) \
+        .and_return(context)
+
+      expect { AnOrganizer.do_something_with_no_starting_context } \
+        .not_to raise_error
     end
   end
 end

data/spec/sample/calculates_order_tax_action_spec.rb

@@ -9,8 +9,8 @@ describe CalculatesOrderTaxAction do
   end
 
   it "calculates the tax based on the tax percentage" do
-    order.stub(:total => 100)
-    order.should_receive(:tax=).with 7.2
+    allow(order).to receive_messages(:total => 100)
+    expect(order).to receive(:tax=).with 7.2
     CalculatesOrderTaxAction.execute(context)
   end
 end

data/spec/sample/calculates_tax_spec.rb

@@ -9,16 +9,16 @@ describe CalculatesTax do
   let(:context) { double('context') }
 
   it "calls the actions in order" do
-    ::LightService::Context.stub(:make) \
+    allow(::LightService::Context).to receive(:make) \
                             .with(:order => order) \
                             .and_return context
 
-    LooksUpTaxPercentageAction.stub(:execute).with(context).and_return context
-    CalculatesOrderTaxAction.stub(:execute).with(context).and_return context
-    ProvidesFreeShippingAction.stub(:execute).with(context).and_return context
+    allow(LooksUpTaxPercentageAction).to receive(:execute).with(context).and_return context
+    allow(CalculatesOrderTaxAction).to receive(:execute).with(context).and_return context
+    allow(ProvidesFreeShippingAction).to receive(:execute).with(context).and_return context
 
     result = CalculatesTax.for_order(order)
 
-    result.should eq context
+    expect(result).to eq context
   end
 end

data/spec/sample/looks_up_tax_percentage_action_spec.rb

@@ -7,8 +7,8 @@ describe LooksUpTaxPercentageAction do
   let(:region) { double('region') }
   let(:order) do
     order = double('order')
-    order.stub(:region => region)
-    order.stub(:total => 200)
+    allow(order).to receive_messages(:region => region)
+    allow(order).to receive_messages(:total => 200)
     order
   end
   let(:context) do
@@ -19,35 +19,35 @@ describe LooksUpTaxPercentageAction do
 
   context "when the tax_ranges were not found" do
     it "sets the context to failure" do
-      TaxRange.stub(:for_region).with(region).and_return nil
+      allow(TaxRange).to receive(:for_region).with(region).and_return nil
       LooksUpTaxPercentageAction.execute(context)
 
-      context.should be_failure
-      context.message.should eq "The tax ranges were not found"
+      expect(context).to be_failure
+      expect(context.message).to eq "The tax ranges were not found"
     end
   end
 
   context "when the tax_percentage is not found" do
     it "sets the context to failure" do
-      TaxRange.stub(:for_region).with(region).and_return tax_ranges
-      tax_ranges.stub(:for_total => nil)
+      allow(TaxRange).to receive(:for_region).with(region).and_return tax_ranges
+      allow(tax_ranges).to receive_messages(:for_total => nil)
 
       LooksUpTaxPercentageAction.execute(context)
 
-      context.should be_failure
-      context.message.should eq "The tax percentage was not found"
+      expect(context).to be_failure
+      expect(context.message).to eq "The tax percentage was not found"
     end
   end
 
   context "when the tax_percentage is found" do
     it "sets the tax_percentage in context" do
-      TaxRange.stub(:for_region).with(region).and_return tax_ranges
-      tax_ranges.stub(:for_total => 25)
+      allow(TaxRange).to receive(:for_region).with(region).and_return tax_ranges
+      allow(tax_ranges).to receive_messages(:for_total => 25)
 
       LooksUpTaxPercentageAction.execute(context)
 
-      context.should be_success
-      context.fetch(:tax_percentage).should eq 25
+      expect(context).to be_success
+      expect(context.fetch(:tax_percentage)).to eq 25
     end
   end
 end

data/spec/sample/provides_free_shipping_action_spec.rb

@@ -10,8 +10,8 @@ describe ProvidesFreeShippingAction do
 
   context "when the order total with tax is > 200" do
     specify "order gets free shipping" do
-      order.stub(:total_with_tax => 201)
-      order.should_receive(:provide_free_shipping!)
+      allow(order).to receive_messages(:total_with_tax => 201)
+      expect(order).to receive(:provide_free_shipping!)
 
       ProvidesFreeShippingAction.execute(context)
     end
@@ -19,8 +19,8 @@ describe ProvidesFreeShippingAction do
 
   context "when the order total with tax is <= 200" do
     specify "order gets free shipping" do
-      order.stub(:total_with_tax => 200)
-      order.should_not_receive(:provide_free_shipping!)
+      allow(order).to receive_messages(:total_with_tax => 200)
+      expect(order).not_to receive(:provide_free_shipping!)
 
       ProvidesFreeShippingAction.execute(context)
     end

data/spec/spec_helper.rb

@@ -3,3 +3,4 @@ $LOAD_PATH << File.join(File.dirname(__FILE__))
 
 require 'light-service'
 require 'ostruct'
+require 'rspec/its'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Attila Domokos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        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