simple_service 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7f97f4de9f329a4f7188fb1bb5b29e05552f7fc
-  data.tar.gz: 4ec23950462d5ead39a0011da3bb8faa34f3c46b
+  metadata.gz: 7e5f8250d7c8ab14b2d10bea01d8c411f45971b3
+  data.tar.gz: 142559ae98f856791cd1a42abaf2a6159fc74f0b
 SHA512:
-  metadata.gz: e5294419ccca5e623bd821a414cd646cd5542e741421c6ebc2168a4fc96e59da8fa3059477283e9ebe105ea009d099fb64e601a65e133e3a47d798dbe9191096
-  data.tar.gz: 15eeeb65864d2c0e42f4d218f4929d6ccaac2c5691049559c8a42b85a8c3e897e2e818533ac9a9c38da29f86133c0fdc75c739db27aeaa464022ce5343c67d70
+  metadata.gz: 5993861fe94469b479220a9621d331381878e709108be079127d39e83062344fb08d390b62983cae2390988d4a864c24051cbe9fe9f242dbeed035a0bb073a68
+  data.tar.gz: 8041a351c27b68708f3e2bb9daf1aa6d392224d0bfd60d7a45847cc0a49cd257d2fe41d045fcef37cb44caac5c15339c4d2cca65f3f9893e987094eeaaedb122

data/lib/simple_service/organizer.rb

@@ -25,8 +25,25 @@ module SimpleService
     def call
       with_validation do |_commands|
         _commands.each do |command|
+
+          # halt further command calls if success has been set to false
+          # in a previously called command
           break if context[:success] == false
-          new_context = command.new(context).call
+
+          # if command class defines "expects" then only feed the command
+          # those keys, otherwise just give it the entire context
+          _context = if command.get_expects.any?
+            {}.tap do |c|
+              command.get_expects.each {|key| c[key] = context[key] }
+            end
+          else
+            context
+          end
+
+          # instantiate and call the command
+          new_context = command.new(_context).call
+
+          # update the master context with the results of the command
           @context.merge!(new_context)
         end
       end
@@ -40,6 +57,10 @@ module SimpleService
 
     private
 
+    def failed?
+      !successful?
+    end
+
     def successful?
       context[:success] == true
     end
@@ -47,10 +68,18 @@ module SimpleService
     def with_validation
       add_validation_keys_to_context unless skip_validation
 
+      # ensure that the organizer and commands are setup correctly
+      # by injecting an internal service organizer into the stack of
+      # commands to be executed. Only include this if skip_validation is
+      # not set. Since both user defined and internal services use this code
+      # the skip_validation avoids an infinite loop
       _commands = skip_validation ? commands : [EnsureOrganizerIsValid] + commands
 
       yield(_commands)
 
+      # cleanup context keys that are used by the validation so the final
+      # return is clean even if the user does not define "returns" in their
+      # organizer
       remove_validation_keys_from_context unless skip_validation
     end
 

data/lib/simple_service/service_base.rb

@@ -6,10 +6,18 @@ module SimpleService
         @expects = args
       end
 
+      def get_expects
+        @expects || []
+      end
+
       def returns(*args)
         @returns = args
       end
 
+      def get_returns
+        @returns || []
+      end
+
       def skip_validation(skip=true)
         @skip_validation = skip
       end
@@ -57,7 +65,7 @@ module SimpleService
 
         # only automatically set context[:success] on Organizers and only if its not already set
         # by a command calling #failure!
-        if !_context.has_key?(:success) && self.class.ancestors.include?(SimpleService::Organizer)
+        if !_context.has_key?(:success) && organizer?
           _context[:success] = true
         end
 
@@ -65,7 +73,7 @@ module SimpleService
       end
 
       def find_specified_return_keys
-        if returns.nil? || returns.empty?
+        if returns.nil? || returns.empty? || (organizer? && failed?)
           context
         else
           returns.inject({}) do |to_return, return_param|
@@ -82,11 +90,11 @@ module SimpleService
       end
 
       def expects
-        self.class.instance_variable_get('@expects') || []
+        self.class.get_expects
       end
 
       def returns
-        self.class.instance_variable_get('@returns') || []
+        self.class.get_returns
       end
 
       def skip_validation
@@ -97,6 +105,10 @@ module SimpleService
         (expects + returns + ['message', 'success']).uniq
       end
 
+      def organizer?
+        self.class.ancestors.include?(SimpleService::Organizer)
+      end
+
       def failure!(message = nil)
         context[:success] = false
         context[:message] = message || 'There was a problem'

data/lib/simple_service/version.rb

@@ -1,3 +1,3 @@
 module SimpleService
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
 end

data/spec/lib/command_spec.rb

@@ -24,11 +24,13 @@ describe SimpleService::Command do
   end
 
   describe '.call' do
+
     it 'returns the correct keys when using class method' do
       expect(
         ValidCommand.call(foo: 'blah', bar: 'meh')
       ).to eql(bar: 'modified', baz: 'blah')
     end
+
   end
 
   describe '#call' do
@@ -83,4 +85,20 @@ describe SimpleService::Command do
 
   end
 
+  describe '.get_expects' do
+
+    it 'returns an array of expected keys' do
+      expect(ValidCommand.get_expects.sort).to eql([:foo, :bar].sort)
+    end
+
+  end
+
+  describe '.get_returns' do
+
+    it 'returns an array of keys to return' do
+      expect(ValidCommand.get_returns.sort).to eql([:baz, :bar].sort)
+    end
+
+  end
+
 end

data/spec/lib/organizer_spec.rb

@@ -105,9 +105,17 @@ describe SimpleService::Organizer do
       ).to eql({ baz: 'baz', success: true })
     end
 
+    describe '.get_expects' do
+
+      it 'returns an array of expected keys' do
+        expect(GetterSetterOrganizer.get_expects.sort).to eql [:bar, :foo]
+      end
+
+    end
+
   end
 
-  context 'service with command that calls fail_and_return' do
+  context 'service with command that calls failure!' do
 
     class FailAndReturnErrorMessage < SimpleService::Command
       def call
@@ -122,6 +130,7 @@ describe SimpleService::Organizer do
     end
 
     class FailAndReturn < SimpleService::Organizer
+      returns :something_not_set
       commands FailAndReturnErrorMessage, ShouldNotRun
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_service
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Jarrod Spillers