light-service 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d68f9d14bf6972f0063f0e4765b582857ecdf8c
-  data.tar.gz: ac5f09a4248a65df0781d5e93a5e7df6e95c1cfb
+  metadata.gz: cce43f62b668f6fa04385c772ca0d006b9e92ca0
+  data.tar.gz: 3d246a1c22bc6dfa9afef1c64d77c1b15b16618b
 SHA512:
-  metadata.gz: 1ca0cb1b7e3f80e13a43560069e854c8ba410d905a2ed874a700203908465f408bc379d650cf1c820ab74ec6983ed0b30fea978e3b1c6797acb9694603b8934f
-  data.tar.gz: 6b66eb9c58f7a7fa6414bff2df6223a2e66f8d4f17de15e107514f45aa77131b778bec94f9715c026f4216720836c37069c9c93f5684587ab6d6f1293646e4de
+  metadata.gz: 2c00210b56fb1be0cf27ac8c415f421421902088443ed8919d48ee600f22446e8d2b007586b5a4fae553fe39e11092589face9df3950e6e638f5e1a7fa524a81
+  data.tar.gz: 4171398c9f082dae55888485c98e7fe0d335cd0bd527c488b095921055b05659ab1495b33be899b1460839ac41783d902d43121c074276e94c8670481646dae9

data/README.md

@@ -147,8 +147,8 @@ I gave a [talk at RailsConf 2013](http://www.adomokos.com/2013/06/simple-and-ele
 simple and elegant Rails code where I told the story of how LightService was extracted from the projects I had worked on.
 
 ## Expects and Promises
-Let me introduce to you the `expects` and `promises` macros. Think of these as a rule set of inputs/outputs for the action.
-`expects` describes what keys it needs to execute and `promises` makes sure the keys are in the context after the
+The `expects` and `promises` macros are rules for the inputs/outputs of an action.
+`expects` describes what keys it needs to execute, and `promises` makes sure the keys are in the context after the
 action is reduced. If either of them are violated, a custom exception is thrown.
 
 This is how it's used:

data/RELEASES.md

@@ -1,5 +1,8 @@
 A brief list of new features and changes introduced with the specified version.
 
+### 0.5.2
+* Guarding context keys against the reserved keys the context needs to operate.
+
 ### 0.5.1
 * Removing the thrown exception for invoking the "executed" macro twice
 

data/lib/light-service.rb

@@ -6,7 +6,7 @@ require 'light-service/errors'
 require 'light-service/configuration'
 require 'light-service/localization_adapter'
 require 'light-service/context'
-require 'light-service/context_key_verifier'
+require 'light-service/context/key_verifier'
 require 'light-service/organizer/with_reducer'
 require 'light-service/organizer/with_reducer_log_decorator'
 require 'light-service/organizer/with_reducer_factory'

data/lib/light-service/action.rb

@@ -25,28 +25,25 @@ module LightService
       end
 
       def executed
-        define_singleton_method "execute" do |context = {}|
+        define_singleton_method :execute do |context = {}|
           action_context = create_action_context(context)
           return action_context if action_context.stop_processing?
 
           # Store the action within the context
           action_context.current_action = self
 
-          Context::KeyVerifier.verify_expected_keys_are_in_context(action_context)
+          Context::KeyVerifier.verify_keys(action_context) do
+            action_context.define_accessor_methods_for_keys(all_keys)
 
-          action_context.define_accessor_methods_for_keys(expected_keys)
-          action_context.define_accessor_methods_for_keys(promised_keys)
-
-          yield(action_context)
-
-          Context::KeyVerifier.verify_promised_keys_are_in_context(action_context)
+            yield(action_context)
+          end
         end
       end
 
       def rolled_back
         raise "`rolled_back` macro can not be invoked again" if self.respond_to?(:rollback)
 
-        define_singleton_method "rollback" do |context = {}|
+        define_singleton_method :rollback do |context = {}|
           yield(context)
 
           context
@@ -64,6 +61,10 @@ module LightService
         LightService::Context.make(context)
       end
 
+      def all_keys
+        expected_keys + promised_keys
+      end
+
     end
   end
 end

data/lib/light-service/context/key_verifier.rb

@@ -0,0 +1,114 @@
+module LightService; class Context
+  class KeyVerifier
+    attr_reader :context, :action
+
+    def initialize(context)
+      @context = context
+      @action = context.current_action
+    end
+
+    def are_all_keys_in_context?(keys)
+      not_found_keys = keys_not_found(keys)
+      !not_found_keys.any?
+    end
+
+    def keys_not_found(keys)
+      keys ||= context.keys
+      keys - context.keys
+    end
+
+    def format_keys(keys)
+      keys.map { |k| ":#{k}"}.join(', ')
+    end
+
+    def error_message
+      "#{type_name} #{format_keys(keys_not_found(keys))} to be in the context during #{action}"
+    end
+
+    def throw_error_predicate(keys)
+      raise NotImplementedError, 'Sorry, you have to override length'
+    end
+
+    def verify
+      return context if context.failure?
+
+      if throw_error_predicate(keys)
+        Configuration.logger.error error_message
+        fail error_to_throw, error_message
+      end
+
+      context
+    end
+
+    def self.verify_keys(context, &block)
+      ReservedKeysVerifier.new(context).verify
+      ExpectedKeyVerifier.new(context).verify
+
+      block.call
+
+      PromisedKeyVerifier.new(context).verify
+    end
+  end
+
+  class ExpectedKeyVerifier < KeyVerifier
+    def type_name
+      "expected"
+    end
+
+    def keys
+      action.expected_keys
+    end
+
+    def error_to_throw
+      ExpectedKeysNotInContextError
+    end
+
+    def throw_error_predicate(keys)
+      !are_all_keys_in_context?(keys)
+    end
+  end
+
+  class PromisedKeyVerifier < KeyVerifier
+    def type_name
+      "promised"
+    end
+
+    def keys
+      action.promised_keys
+    end
+
+    def error_to_throw
+      PromisedKeysNotInContextError
+    end
+
+    def throw_error_predicate(keys)
+      !are_all_keys_in_context?(keys)
+    end
+  end
+
+  class ReservedKeysVerifier < KeyVerifier
+    def violated_keys
+      (action.promised_keys + action.expected_keys) & reserved_keys
+    end
+
+    def error_message
+      "promised or expected keys cannot be a reserved key: [#{format_keys(violated_keys)}]"
+    end
+
+    def keys
+      violated_keys
+    end
+
+    def error_to_throw
+      ReservedKeysInContextError
+    end
+
+    def throw_error_predicate(keys)
+      keys.any?
+    end
+
+    def reserved_keys
+      [:message, :error_code, :current_action].freeze
+    end
+  end
+end; end

data/lib/light-service/errors.rb

@@ -2,4 +2,5 @@ module LightService
   class FailWithRollbackError < StandardError; end
   class ExpectedKeysNotInContextError < StandardError; end
   class PromisedKeysNotInContextError < StandardError; end
+  class ReservedKeysInContextError < StandardError; end
 end

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/spec/action_expected_keys_spec.rb

@@ -32,4 +32,19 @@ describe ":expects macro" do
     expect(resulting_context[:milk_tea]).to eq("black - full cream - with dark chocolate")
   end
 
+  context "when a reserved key is listed as an expected key" do
+    it "raises an error indicating a reserved key is expected" do
+      exception_error_text = "promised or expected keys cannot be a reserved key: [:message]"
+      expect {
+        TestDoubles::MakesTeaExpectingReservedKey.execute(:tea => "black", :message => "no no")
+      }.to raise_error(LightService::ReservedKeysInContextError, exception_error_text)
+    end
+
+    it "raises an error indicating that multiple reserved keys are expected" do
+      exception_error_text = "promised or expected keys cannot be a reserved key: [:message, :error_code, :current_action]"
+      expect {
+        TestDoubles::MakesTeaExpectingMultipleReservedKeys.execute(:tea => "black", :message => "no no", :error_code => 1, :current_action => "update")
+      }.to raise_error(LightService::ReservedKeysInContextError, exception_error_text)
+    end
+  end
 end

data/spec/action_promised_keys_spec.rb

@@ -77,6 +77,22 @@ describe ":promises macro" do
     end
   end
 
+  context "when a reserved key is listed as a promised key" do
+    it "raises an error indicating a reserved key has been promised" do
+      exception_error_text = "promised or expected keys cannot be a reserved key: [:message]"
+      expect {
+        TestDoubles::MakesTeaPromisingReservedKey.execute(:tea => "black")
+      }.to raise_error(LightService::ReservedKeysInContextError, exception_error_text)
+    end
+
+    it "raises an error indicating that multiple reserved keys have been promised" do
+      exception_error_text = "promised or expected keys cannot be a reserved key: [:message, :error_code, :current_action]"
+      expect {
+        TestDoubles::MakesTeaPromisingMultipleReservedKeys.execute(:tea => "black")
+      }.to raise_error(LightService::ReservedKeysInContextError, exception_error_text)
+    end
+  end
+
   it "can collect promised keys when the `promised` macro is called multiple times" do
     resulting_context = TestDoubles::MultiplePromisesAction.execute(
                             :coffee => "espresso",
@@ -85,5 +101,4 @@ describe ":promises macro" do
     expect(resulting_context.cappuccino).to eq("Cappucino needs espresso and a little milk")
     expect(resulting_context.latte).to eq("Latte needs espresso and a lot of milk")
   end
-
 end

data/spec/test_doubles.rb

@@ -176,4 +176,41 @@ module TestDoubles
     end
   end
 
+  class MakesTeaExpectingReservedKey
+    include LightService::Action
+    expects :tea, :message
+
+    executed do |context|
+      context.product = context.number + 3
+    end
+  end
+
+  class MakesTeaExpectingMultipleReservedKeys
+    include LightService::Action
+    expects :tea, :message, :error_code, :current_action
+
+    executed do |context|
+      context.product = context.number + 3
+    end
+  end
+
+  class MakesTeaPromisingReservedKey
+    include LightService::Action
+    expects :tea
+    promises :product, :message
+
+    executed do |context|
+      context.product = context.number + 3
+    end
+  end
+
+  class MakesTeaPromisingMultipleReservedKeys
+    include LightService::Action
+    expects :tea
+    promises :product, :message, :error_code, :current_action
+
+    executed do |context|
+      context.product = context.number + 3
+    end
+  end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Attila Domokos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2015-04-06 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
@@ -87,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -99,7 +99,7 @@ files:
 - lib/light-service/action.rb
 - lib/light-service/configuration.rb
 - lib/light-service/context.rb
-- lib/light-service/context_key_verifier.rb
+- lib/light-service/context/key_verifier.rb
 - lib/light-service/errors.rb
 - lib/light-service/localization_adapter.rb
 - lib/light-service/organizer.rb
@@ -142,17 +142,17 @@ 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.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A service skeleton with an emphasis on simplicity

data/lib/light-service/context_key_verifier.rb

@@ -1,48 +0,0 @@
-module LightService
-  class Context
-    class KeyVerifier
-      class << self
-        def verify_expected_keys_are_in_context(context)
-          action = context.current_action
-
-          verify_keys_are_in_context(context, action.expected_keys) do |not_found_keys|
-            error_message = "expected #{format_keys(not_found_keys)} to be in the context during #{action}"
-
-            Configuration.logger.error error_message
-            fail ExpectedKeysNotInContextError, error_message
-          end
-        end
-
-        def verify_promised_keys_are_in_context(context)
-          return context if context.failure?
-
-          action = context.current_action
-
-          verify_keys_are_in_context(context, action.promised_keys) do |not_found_keys|
-            error_message = "promised #{format_keys(not_found_keys)} to be in the context during #{action}"
-
-            Configuration.logger.error error_message
-            fail PromisedKeysNotInContextError, error_message
-          end
-        end
-
-        private
-
-        def verify_keys_are_in_context(context, keys)
-          keys ||= context.keys
-
-          not_found_keys = keys - context.keys
-          unless not_found_keys.empty?
-            yield not_found_keys
-          end
-
-          context
-        end
-
-        def format_keys(keys)
-          keys.map { |k| ":#{k}"}.join(', ')
-        end
-      end
-    end
-  end
-end