simple_service 2.1.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e3f3509cf01d669899e4b014dfd78117a99f0e0
-  data.tar.gz: 728f0043ddfc2e9d9c8d031416f900b2c4bba888
+  metadata.gz: 80b6b2d5cf8a166fb7c3666d0b71347526a0b9c7
+  data.tar.gz: 1e52375eca8157659afe17c69cf5c053bddde9df
 SHA512:
-  metadata.gz: 83f503070b874dd3f590e1ef8bcec3c806615a415b3f31a3f1c4c5735a5dc594bff649dc7bd20a031451a8a1b981b2e08aac7e7fc0141e5b9fcd248d1bdea9ef
-  data.tar.gz: d0b1f1da0d55f45d8ef5192bc3beb5d9fc924e8a2f03f51ab33141d6973019bf596e341fd5ef4ea06e9ef561e2ac443a4240937a7129e8063fbb17133fe85a0b
+  metadata.gz: '03186be2699de59c7d3f88d7a1df830fed42ec735c21bfb44f9e0c56678ab8b567097be327f0544adb653cc641db25bcff78f13ee716c6f8b49d2d39710372c4'
+  data.tar.gz: f8437b785fe9419de4b88c74bb40437184ef92a31532f8e23a105fd2be464587aac5f194e12ac542b2151807eedc85f7c9ee6ecfb9a6c341603d8e06093af3d6

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
   - jruby-19mode
-  - 2.1.0
   - 2.3.0
   - 2.3.3
   - 2.4.2

data/README.md

@@ -12,6 +12,18 @@ and composable units of business logic. The core concept of SimpleService is the
 When properly designed, these command objects can be composited together or even nested to create
 complex flows.
 
+# 2.0.0 update notes
+
+This update is a major refactor from previous 1.x.x versions. After revisiting this codebase I decided that 
+I needed to make SimpleService actually simple in both use and implementation. The gem has now been paired down
+to about 150 lines of code.
+
+* All functionality is added to your service class via module inclusion instead of inheritance
+* The concept of an Organizer has been removed
+* The DSL for defining interfaces has been removed in favor of simple keyword arguments
+* `#success` or `#failure` must be called within each command or call method
+* Services are always invoked via the class method `.call`. Previously you could use either `#call` or `.call`.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -84,7 +96,9 @@ result.failure? #=> true
 result.value #=> {:message=>"hey Bob, things went wrong."}
 ```
 
-You can also use ClassNames as commands and to organize them into other files:
+You can also use ClassNames as commands and to organize them into other files. If `#call` is
+defined and no other commands are defined via `command` or `commands` then SimpleService will
+automatically use `#call` as the default command
 
 ```ruby 
 require 'rubygems'
@@ -93,21 +107,24 @@ require 'simple_service'
 class CommandOne
   include SimpleService
 
-  command :add_stuff
-
-  def add_stuff(one:, two:)
-    success(three: one + two)
+  def call(one:, two:)
+    if one == 1 && two == 2
+      success(three: one + two)
+    else
+      failure(something: 'went wrong')
+    end
   end
 end
 
 class CommandTwo
   include SimpleService
 
-  command :add_more_stuff
-
-  def add_more_stuff(three:)
-    binding.pry
-    success(seven: three + 4)
+  def call(three:)
+    if three == 3
+      success(seven: three + 4)
+    else
+      failure(another_thing: 'went wrong')
+    end
   end
 end
 
@@ -120,9 +137,13 @@ end
 result = DoNestedStuff.call(one: 1, two: 2)
 result.success? #=> true
 result.value #=> {:seven=>7}
+
+result = DoNestedStuff.call(one: 2, two: 1)
+result.success? #=> false
+result.value #=> {something: 'went wrong'}
 ```
 
-If you would like your service to process an enumerable you can override `#call`
+If you would like your service to process an enumerable you can override `.call`
 on your service object. Invoking `#super` in your definition and passing along 
 the appropriate arguments will allow your command chain to proceed as normal, but
 called multiple times via a loop. The Result object returned from each call to `#super`
@@ -138,9 +159,14 @@ class LoopingService
 
   commands :add_one
 
-  def call(kwargs)
+  def self.call(count:)
     count = kwargs
 
+    # In this example the result object from super overwrites 
+    # the previous result/initial args. You could also capture 
+    # results in an array or hash for further manipulation.
+    # If you do not need to do anything with the result object
+    # then there is no need to assign it back to anything. 
     3.times do
       count = super(count)
     end
@@ -152,6 +178,10 @@ class LoopingService
     success(count: count + 1)
   end
 end
+
+result = LoopingService.call(count: 0) 
+result.is_a?(SimpleService::Result) #=> true
+result.value #=> {count: 3}
 ```
 
 If you are using this with a Rails app, placing top level services in 

data/lib/simple_service.rb

@@ -19,16 +19,6 @@ module SimpleService
   end
 
   module ClassMethods
-    def call(**kwargs)
-      service = self.new
-
-      if service.method(:call).arity.zero?
-        service.call
-      else
-        service.call(kwargs)
-      end
-    end
-
     def command(command_name)
       @commands ||= []
       @commands << command_name
@@ -38,45 +28,76 @@ module SimpleService
       @commands ||= []
       @commands += args
     end
-  end
 
-  module InstanceMethods
-    def result
-      @result ||= Result.new
-    end
+    def call(kwargs={})
+      service = self.new
 
-    def commands
-      self.class.instance_variable_get('@commands')
-    end
+      # if kwargs is a result obj then pull its hash out via #value
+      service.result.value = kwargs.is_a?(Result) ? kwargs.value : kwargs
 
-    def call(kwargs)
-      result.value = kwargs.is_a?(Result) ? kwargs.value : kwargs
+      get_commands(service).each do |cmnd|
+        service = execute_command(cmnd, service)
+        break if service.result.failure?
+      end
 
-      commands.each do |command|
-        @current_command = command
+      service.result
+    end
 
-        command_output = if command.is_a?(Class)
-          command.new.call(result.value)
-        elsif command.is_a?(Symbol)
-          method(command).call(result.value)
-        end
+    def get_commands(service)
+      if !@commands.nil? && @commands.any?
+        @commands
+      elsif service.respond_to?(:call)
+        [:call]
+      else
+        raise "No commands defined for #{self.to_s}, define at least one " \
+          'command or implement the #call method'
+      end
+    end
+
+    def execute_command(cmnd, service)
+      service.current_command = cmnd
 
-        if command_output.is_a?(Result)
-          result.append_result(command_output)
+      command_output = if cmnd.is_a?(Class)
+        cmnd.call(service.result.value)
+      elsif cmnd.is_a?(Symbol)
+        if service.method(cmnd).arity.zero?
+          service.public_send(cmnd)
+        else
+          service.public_send(cmnd, service.result.value)
         end
+      end
 
-        break if result.failure?
+      if command_output.is_a?(Result)
+        service.result.append_result(command_output)
       end
 
-      result
+      service
+    end
+  end
+
+  module InstanceMethods
+    def result
+      @result ||= Result.new
+    end
+
+    def current_command
+      @current_command
+    end
+
+    def current_command=(cmnd)
+      @current_command = cmnd
+    end
+
+    def commands
+      self.class.instance_variable_get('@commands') || []
     end
 
     def success(result_value)
-      result.success!(self.class, @current_command, result_value)
+      result.success!(self.class, current_command, result_value)
     end
 
     def failure(result_value)
-      result.failure!(self.class, @current_command, result_value)
+      result.failure!(self.class, current_command, result_value)
     end
   end
 end

data/lib/simple_service/version.rb

@@ -1,3 +1,3 @@
 module SimpleService
-  VERSION = '2.1.0'
+  VERSION = '2.1.3'
 end

data/spec/simple_service_spec.rb

@@ -1,13 +1,14 @@
 require 'spec_helper'
 require_relative 'support/basic_service'
 require_relative 'support/looping_service'
+require_relative 'support/empty_service'
 
 RSpec.describe SimpleService do
 
   let(:params) do
     {
-      foo: 'asdf',
-      bar: 'qwer',
+      foo: 'foo',
+      bar: 'bar',
       command_one_success: true,
       command_two_success: true,
     }
@@ -79,28 +80,34 @@ RSpec.describe SimpleService do
     end
   end
 
+  context 'improperly configured service class' do
+    it 'raises error when no commands or call defined' do
+      expect { EmptyService.call }.to raise_error(/No commands defined for EmptyService/)
+    end
+  end
+
   context 'record commands' do
     it 'records normal command execution' do
       expect(result.recorded_commands).to eq(
         [
           {
             class_name: 'BasicService',
-            command_name: :command_one,
+            command_name: :upcase_foo,
             success: true,
           },
           {
             class_name: 'BasicService',
-            command_name: :command_two,
+            command_name: :upcase_bar,
             success: true,
           },
           {
-            class_name: 'CommandOne',
-            command_name: :modify_foo_bar,
+            class_name: 'ModifyFooBar',
+            command_name: :call,
             success: true,
           },
           {
-            class_name: 'CommandTwo',
-            command_name: :combine_foo_bar,
+            class_name: 'CombineFooBar',
+            command_name: :call,
             success: true,
           },
         ]
@@ -116,26 +123,26 @@ RSpec.describe SimpleService do
         [
           {
             class_name: 'BasicService',
-            command_name: :command_one,
+            command_name: :upcase_foo,
             received_args: {
-              foo: 'asdf',
-              bar: 'qwer',
+              foo: 'foo',
+              bar: 'bar',
               command_one_success: true,
               command_two_success: true
             },
             success: {
               foo: 'FOO',
-              bar: 'qwer',
+              bar: 'bar',
               command_one_success: true,
               command_two_success: true,
             },
           },
           {
             class_name: 'BasicService',
-            command_name: :command_two,
+            command_name: :upcase_bar,
             received_args: {
               foo: 'FOO',
-              bar: 'qwer',
+              bar: 'bar',
               command_one_success: true,
               command_two_success: true
             },
@@ -147,8 +154,8 @@ RSpec.describe SimpleService do
             },
           },
           {
-            class_name: 'CommandOne',
-            command_name: :modify_foo_bar,
+            class_name: 'ModifyFooBar',
+            command_name: :call,
             received_args: {
               foo: 'FOO',
               bar: 'BAR',
@@ -162,8 +169,8 @@ RSpec.describe SimpleService do
             },
           },
           {
-            class_name: 'CommandTwo',
-            command_name: :combine_foo_bar,
+            class_name: 'CombineFooBar',
+            command_name: :call,
             received_args: {
               modified_foo: 'modified FOO',
               modified_bar: 'modified BAR',

data/spec/support/basic_service.rb

@@ -1,19 +1,20 @@
-require_relative 'command_one'
-require_relative 'command_two'
+require_relative 'modify_foo_bar'
+require_relative 'combine_foo_bar'
 
 class BasicService
   include SimpleService
 
-  command :command_one
-  command :command_two
-  commands CommandOne, CommandTwo
+  commands :upcase_foo,
+           :upcase_bar,
+           ModifyFooBar,
+           CombineFooBar
 
-  def command_one(**kwargs)
-    success(kwargs.merge(foo: 'FOO'))
+  def upcase_foo(**kwargs)
+    success(kwargs.merge(foo: kwargs[:foo].upcase))
   end
 
-  def command_two(**kwargs)
-    success(kwargs.merge(bar: 'BAR'))
+  def upcase_bar(**kwargs)
+    success(kwargs.merge(bar: kwargs[:bar].upcase))
   end
 end
 

data/spec/support/{command_two.rb → combine_foo_bar.rb}

@@ -1,9 +1,7 @@
-class CommandTwo
+class CombineFooBar
   include SimpleService
 
-  command :combine_foo_bar
-
-  def combine_foo_bar(modified_foo:, modified_bar:, command_two_success:)
+  def call(modified_foo:, modified_bar:, command_two_success:)
     combined_foo_bar = "combined #{modified_foo} #{modified_bar}"
 
     if command_two_success

data/spec/support/empty_service.rb

@@ -0,0 +1,4 @@
+class EmptyService
+  include SimpleService
+end
+

data/spec/support/looping_service.rb

@@ -3,7 +3,7 @@ class LoopingService
 
   commands :add_one
 
-  def call(kwargs)
+  def self.call(kwargs)
     count = kwargs
 
     3.times do

data/spec/support/{command_one.rb → modify_foo_bar.rb}

@@ -1,9 +1,7 @@
-class CommandOne
+class ModifyFooBar
   include SimpleService
 
-  command :modify_foo_bar
-
-  def modify_foo_bar(foo:, bar:, command_one_success:, command_two_success:)
+  def call(foo:, bar:, command_one_success:, command_two_success:)
     modified_foo = "modified #{foo}"
     modified_bar = "modified #{bar}"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_service
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Jarrod Spillers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,9 +118,10 @@ files:
 - spec/simple_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/basic_service.rb
-- spec/support/command_one.rb
-- spec/support/command_two.rb
+- spec/support/combine_foo_bar.rb
+- spec/support/empty_service.rb
 - spec/support/looping_service.rb
+- spec/support/modify_foo_bar.rb
 homepage: https://github.com/jspillers/simple_service
 licenses:
 - MIT
@@ -150,6 +151,7 @@ test_files:
 - spec/simple_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/basic_service.rb
-- spec/support/command_one.rb
-- spec/support/command_two.rb
+- spec/support/combine_foo_bar.rb
+- spec/support/empty_service.rb
 - spec/support/looping_service.rb
+- spec/support/modify_foo_bar.rb