simple_service 1.2.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 515fadc80305add45e86b396802b338cede2aa06
-  data.tar.gz: 841835535e8881c65fa145ae53eecd09bc33b89b
+  metadata.gz: c3411c81d77a21d53355ecbf0e36e8e8ab775d7f
+  data.tar.gz: ab7e72e01db7d9f4b759f8c3a2e2b6e1a255016c
 SHA512:
-  metadata.gz: 5b0c5dd85db59e62815ecec3ea749d4f81d0638f10e335da322576613626c8a7cd12a2815d7eeda6c39ee27b4dc43bee0d9c41910075de319a6a09a7053552ac
-  data.tar.gz: 2cfc971c8db2575311a893e53cce3f4aca902687eafcb7e68924bee36e8c22a30c9cfb6a85891420dbb3a2f57261cc57660e9a723a1fa46ce4281574f5f70e46
+  metadata.gz: a3ec8495a52be6cd7ffa5e6e8b3a8d29e85c32011540dd4f85e2444da22ade6451a5853af1ec58ec84837a04766bfe75bbf47c74d7a9ceb1ccfb6cd1ffdb5362
+  data.tar.gz: 6d5eb35ca7b7bb0d68f1009e0062f84cb924330887e1dafc33ca1e4e13d7f13757803a0bd583d93266530d4b8a39aa7755904b0c95b213a9655ee7526ea33608

data/README.md

@@ -1,8 +1,10 @@
 # SimpleService
 
+[![Gem Version](https://badge.fury.io/rb/simple_service.svg)](http://badge.fury.io/rb/simple_service)
 [![Code Climate](https://codeclimate.com/github/jspillers/simple_service/badges/gpa.svg)](https://codeclimate.com/github/jspillers/simple_service)
 [![Test Coverage](https://codeclimate.com/github/jspillers/simple_service/badges/coverage.svg)](https://codeclimate.com/github/jspillers/simple_service)
 [![Build Status](https://travis-ci.org/jspillers/simple_service.svg?branch=master)](https://travis-ci.org/jspillers/simple_service)
+<!--![](http://ruby-gem-downloads-badge.herokuapp.com/jspillers/simple_service)-->
 
 SimpleService gives you a way to organize service objects such that they adhere 
 to the single responsibility principle. Instead of writing large service objects 
@@ -11,12 +13,14 @@ set of sequentially performed "Command" objects. Commands are very small classes
 that perform exactly one task. When properly designed, these command
 objects can be reused in multiple organizers minimizing code duplication.
 
-When an organizer is instantiated a hash of arguments is passed in. This hash 
-is referred to as the context.  The context hash is carried along throughout 
+When an organizer is instantiated a hash is passed in containing initial arguments. 
+This hash is referred to as the context.  The context hash is carried along throughout 
 the sequence of command executions and modified by each command. After a 
 successful run, the keys specified are returned. If keys are not specified, the 
 entire context hash is returned.
 
+# Setup
+
 First, setup an Organizer class. An Organizer needs the following things defined:
 
   * expects: keys that are required to be passed into initialize when an 
@@ -86,6 +90,27 @@ class DoSomethingImportant < SimpleService::Command
 end
 ```
 
+Within any command you can call ```#failure!``` and then return in order to
+abort execution of subsequent commands within the organizer.
+
+```ruby
+class DemonstrateFailure < SimpleService::Command
+  
+  expects :something
+
+  returns :good_stuff
+
+  def call
+    if good_stuff_happens
+      self.good_stuff = 'yeah, success!'
+    else
+      failure!('something not so good happened; no more commands should be called')
+    end
+  end
+
+end
+```
+
 ## Usage
 
 Using the service is straight forward - just instantiate it, passing in the 

data/lib/simple_service/commands/validates_commands_not_empty.rb

@@ -3,7 +3,7 @@ module SimpleService
 
     expects :provided_commands
 
-    skip_validation true
+    skip_validation true # prevent infinite loop
 
     def call
       if provided_commands.nil? || provided_commands.empty?

data/lib/simple_service/commands/validates_commands_properly_inherit.rb

@@ -3,7 +3,7 @@ module SimpleService
 
     expects :provided_commands
 
-    skip_validation true
+    skip_validation true # prevent infinite loop
 
     def call
       # valid commands inherit from Command and do not inherit from service

data/lib/simple_service/commands/validates_expected_keys.rb

@@ -3,7 +3,7 @@ module SimpleService
 
     expects :expected_keys, :provided_keys
 
-    skip_validation true
+    skip_validation true # prevent infinite loop
 
     def call
       arguments_not_included = expected_keys.to_a - provided_keys.to_a

data/lib/simple_service/organizer.rb

@@ -6,7 +6,7 @@ module SimpleService
 
     attr_accessor :context
 
-    def initialize(context={})
+    def initialize(context = {})
       @context = context
 
       symbolize_context_keys
@@ -25,14 +25,16 @@ module SimpleService
     def call
       with_validation do |_commands|
         _commands.each do |command|
-          @context.merge!(command.new(context).call)
+          break if context[:success] == false
+          new_context = command.new(context).call
+          @context.merge!(new_context)
         end
       end
     end
 
     # allow execution of the service from the class level for those
     # that prefer that style
-    def self.call(context)
+    def self.call(context = {})
       self.new(context).call
     end
 

data/lib/simple_service/service_base.rb

@@ -29,7 +29,7 @@ module SimpleService
           # other method to return only specific context keys
           define_method :call do
             call_method.bind(self).call
-            find_specified_return_keys
+            return_context_with_success_status
           end
         end
       end
@@ -40,6 +40,17 @@ module SimpleService
         end
       end
 
+      def return_context_with_success_status
+        _context = find_specified_return_keys
+
+        # only automatically set context[:success] on Organizers and only if its not already set
+        if !_context.has_key?(:success) && self.class.ancestors.include?(SimpleService::Organizer)
+          _context[:success] = true
+        end
+
+        _context
+      end
+
       def find_specified_return_keys
         if returns.nil? || returns.empty?
           context
@@ -69,12 +80,17 @@ module SimpleService
         self.class.instance_variable_get('@skip_validation')
       end
 
-      def all_specified_context_keys
-        (expects + returns).uniq
+      def all_context_keys
+        (expects + returns + ['message', 'success']).uniq
+      end
+
+      def failure!(message = nil)
+        context[:success] = false
+        context[:message] = message || 'There was a problem'
       end
 
       def define_getters_and_setters
-        all_specified_context_keys.each do |key|
+        all_context_keys.each do |key|
           self.class.class_eval do
 
             # getter

data/lib/simple_service/version.rb

@@ -1,3 +1,3 @@
 module SimpleService
-  VERSION = '1.2.6'
+  VERSION = '1.3.0'
 end

data/spec/lib/organizer_spec.rb

@@ -30,13 +30,13 @@ describe SimpleService::Organizer do
       it 'returns the correct hash' do
         expect(
           TestOrganizer.new(foo: 'foo').call
-        ).to eql(foo: 'foo', bar: 'bar', baz: 'baz')
+        ).to eql(foo: 'foo', bar: 'bar', baz: 'baz', success: true)
       end
 
       it 'accepts string keys in context hash' do
         expect(
           TestOrganizer.new('foo' => 'foo').call
-        ).to eql(foo: 'foo', bar: 'bar', baz: 'baz')
+        ).to eql(foo: 'foo', bar: 'bar', baz: 'baz', success: true)
       end
 
     end
@@ -68,14 +68,14 @@ describe SimpleService::Organizer do
       it 'returns the entire context' do
         expect(
           TestOrganizerTwo.new(foo: 'foo', extra: 'extra').call
-        ).to eql(foo: 'foo', bar: 'bar', baz: 'baz', extra: 'extra')
+        ).to eql(foo: 'foo', bar: 'bar', baz: 'baz', extra: 'extra', success: true)
       end
 
     end
 
   end
 
-  describe 'service using getters and setters' do
+  context 'service using getters and setters' do
 
     class GetterSetterCommand < SimpleService::Command
       expects :foo, :bar
@@ -94,7 +94,40 @@ describe SimpleService::Organizer do
     it 'returns the correct hash' do
       expect(
         GetterSetterOrganizer.new(foo: 'baz', bar: 'bar').call
-      ).to eql({ baz: 'baz' })
+      ).to eql({ baz: 'baz', success: true })
+    end
+
+  end
+
+  context 'service with command that calls fail_and_return' do
+
+    class FailAndReturnErrorMessage < SimpleService::Command
+      def call
+        return failure!('something went wrong and we need to abort')
+      end
+    end
+
+    class ShouldNotRun < SimpleService::Command
+      def call
+        raise 'should not have gotten here'
+      end
+    end
+
+    class FailAndReturn < SimpleService::Organizer
+      commands FailAndReturnErrorMessage, ShouldNotRun
+    end
+
+    it 'returns a message' do
+      expect(FailAndReturn.call[:message]).to eql(
+        'something went wrong and we need to abort')
+    end
+
+    it 'returns success as false' do
+      expect(FailAndReturn.call[:success]).to eql(false)
+    end
+
+    it 'does not raise an exception' do
+      expect { FailAndReturn.call }.to_not raise_error
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_service
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.3.0
 platform: ruby
 authors:
 - Jarrod Spillers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler