simple_service 1.0.2 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34986961f7123b9e3d467a2886eac29975e5ca1c
-  data.tar.gz: 69ef5d5fd27746e2f9cd3ef1fdebf8ca1052f9b7
+  metadata.gz: 62127eaaf7ab561f13e676804054b5f6c5badb6b
+  data.tar.gz: 3c707fa3145d309d2ffe402a9083136cb464d0ab
 SHA512:
-  metadata.gz: de14c40b0a186d035b1a7c1a8b43a4e9d6ac7c00209bccde3f7200661f816baeba28c2b4d94875b95c98122bc95433b9d991367c226ae5ca92f6ef7f7d778d13
-  data.tar.gz: 6946d0168b295ff890883a2c7fb966fc5b0214441581712fbc5f785dbb2c999387dc45db49d8e7cd9e12e3564c127012438551049e9069b2dadbd748b925f6ea
+  metadata.gz: 966251837c81145882975a90ceb9ad88a97e9bcd39d182216e1fc4b0e425f8167d835a87df0bb3c3d43ab83624633a050334b2f46fb7cf35273d97815dd4e7d9
+  data.tar.gz: 31a500a462b2b4d98b7a49a6470ad93fe977b512744d8861b2d3e1d03536295a002060ab5c4b46ec7b2b10e7b533595bf5f0591f07ac2aeb619540adbae5327a

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.ruby-version
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -14,17 +14,18 @@ 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 
 the sequence of command executions and modified by each command. After a 
-successful run, the entire context hash (or a specified subset) is returned.
+successful run, the keys specified are returned. If keys are not specified, the 
+entire context hash is returned.
 
 First, setup an Organizer class. An Organizer needs the following things defined:
 
   * expects: keys that are required to be passed into initialize when an 
     instance of organizer is created. If not defined the organizer will 
     accept arbitrary arguments.
-  * returns: keys that will be returned when the organizer has executed all of 
+  * returns: keys that will be returned when the organizer has called all of 
     its commands
-  * commands: classes that define all the steps that the organizer will execute. 
-    The organizer will call #execute on each command in order and the context 
+  * commands: classes that define all the steps that the organizer will call. 
+    The organizer will execute #call on each command in order and the context 
     hash is passed to each of these commands. Any keys within the context that 
     are modified will be merged back into the organizer and passed along to the 
     next command.
@@ -36,12 +37,12 @@ class ProcessSomethingComplex < SimpleService::Organizer
   # leave out to accept any arguments/keys
   expects :something, :another_thing
 
-  # optional - specifies which keys get returned after #execute is called on
+  # optional - specifies which keys get returned after #call is executed on
   # an organizer instance
   returns :modified_thing
 
   # what steps comprise this service
-  # #execute will be called on an instance of each class in sequence
+  # #call will be executed on an instance of each class in sequence
   commands DoSomethingImportant, DoAnotherStep
 
 end
@@ -66,7 +67,7 @@ class DoSomethingImportant < SimpleService::Command
   # getters and setters are available for each key specified
   # in expects and returns. If not using expects and returns
   # simply interact with the context hash directly
-  def execute
+  def call
     # uses getters and setters to modify the context
     self.modified_something = self.something.to_i + 1
 
@@ -88,14 +89,14 @@ end
 ## Usage
 
 Using the service is straight forward - just instantiate it, passing in the 
-intial context hash, and then call execute.
+intial context hash, and then call.
 
 ```ruby
 starting_context = {
   something: '1', 
   :another_thing: AnotherThing.new
 }
-modified_context = ProcessSomethingComplex.new(starting_context).execute
+modified_context = ProcessSomethingComplex.new(starting_context).call
 
 modified_context[:modified_thing] # => 2
 ```
@@ -104,6 +105,12 @@ If you are using this with a Rails app, placing top level services in
 app/services/ and all commands in app/services/commands/ is recommended. If
 not using rails, a similar structure would also be recommended.
 
+For further examination of usage, here are a few examples:
+
+* [hello world example](example/hello_world.rb)
+* [nested services example](example/nested_services.rb)
+* [override #call on the organizer](example/override_organizer_call_method.rb)
+
 ## Inspiration and Rationale
 
 This gem is heavily inspired by two very nice gems: 
@@ -113,7 +120,7 @@ This gem is heavily inspired by two very nice gems:
 Mutations is a great gem, but lacks the concept of a top level organizer. 
 LightService brings in the notion of the organizer object, but doesn't create 
 instances of its action objects (what are referred to as commands here). Using 
-instances rather than class level execute definitions allows the use of private 
+instances rather than class level #call definitions allows the use of private 
 methods within the command for more complex commands that still do a single thing.
 
 The other goal of this gem is to do as little as possible above and beyond 

data/example/hello_world.rb

@@ -1,12 +1,11 @@
 require 'rubygems'
-require 'pry'
 require 'simple_service'
 
 class ConcatName < SimpleService::Command
   expects :first_name, :last_name
   returns :name
 
-  def execute
+  def call
     self.name = "#{first_name} #{last_name}"
   end
 end
@@ -15,7 +14,7 @@ class CreateHelloString < SimpleService::Command
   expects :name
   returns :hello
 
-  def execute
+  def call
     self.hello = "#{name}, say hello world!"
   end
 end
@@ -26,5 +25,5 @@ class SayHello < SimpleService::Organizer
   commands ConcatName, CreateHelloString
 end
 
-result = SayHello.new(first_name: 'Ruby', last_name: 'Gem').execute
+result = SayHello.new(first_name: 'Ruby', last_name: 'Gem').call
 puts result[:hello]

data/example/nested_organizer.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'simple_service'
+
+class Increment < SimpleService::Command
+  expects :counter
+  returns :counter
+
+  def call
+    self.counter += 1
+  end
+end
+
+class IncrementCounter < SimpleService::Organizer
+  expects :counter
+  returns :counter
+  commands Increment, Increment, Increment
+end
+
+class ReallyIncrementThatCounter < SimpleService::Organizer
+  expects :counter
+  returns :counter
+  commands IncrementCounter, IncrementCounter, IncrementCounter
+end
+
+result = IncrementCounter.new(counter: 0).call
+puts "IncrementCounter: #{result[:counter]}"
+
+result = ReallyIncrementThatCounter.new(counter: 0).call
+puts "ReallyIncrementThatCounter: #{result[:counter]}"

data/example/nested_services.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'simple_service'
+
+class Increment < SimpleService::Command
+  expects :counter
+  returns :counter
+
+  def execute
+    self.counter += 1
+  end
+end
+
+class IncrementCounter < SimpleService::Organizer
+  expects :counter
+  returns :counter
+  commands Increment, Increment, Increment
+end
+
+class ReallyIncrementThatCounter < SimpleService::Organizer
+  expects :counter
+  returns :counter
+  commands IncrementCounter, IncrementCounter, IncrementCounter
+end
+
+result = IncrementCounter.new(counter: 0).execute
+puts "IncrementCounter: #{result[:counter]}"
+
+result = ReallyIncrementThatCounter.new(counter: 0).execute
+puts "ReallyIncrementThatCounter: #{result[:counter]}"

data/example/override_organizer_call_method.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'simple_service'
+
+class ConcatAnotherName < SimpleService::Command
+  expects :first_name, :last_name
+  returns :name
+
+  def call
+    self.name = "#{first_name} #{last_name}"
+  end
+end
+
+class CreateAnotherHelloString < SimpleService::Command
+  expects :name
+  returns :hello
+
+  def call
+    self.hello ||= ''
+    self.hello += "#{name}, say hello world!"
+  end
+end
+
+class SayHelloMultipleTimes < SimpleService::Organizer
+  expects :first_name, :last_name, :num_times
+  returns :hello
+  commands ConcatAnotherName, CreateAnotherHelloString
+
+  # overriding the #call method on the organizer allows
+  # you to do things like loop and call the service commands
+  # multiple times
+  def call
+    num_times.times do
+      super
+    end
+  end
+end
+
+result = SayHelloMultipleTimes.new(first_name: 'Ruby', last_name: 'Gem', num_times: 3).call
+puts result[:hello]

data/lib/simple_service/command.rb

@@ -8,40 +8,20 @@ module SimpleService
 
     def initialize(context={})
       @context = context
-      setup_execute_chain
+      setup_call_chain
       define_getters_and_setters
-    end
-
-    # execute is where the command's behavior is defined
-    # execute should be overriden by whatever class inherits from
-    # this class
-    def execute
-      error_msg = "#{self.class} - does not define an execute method"
-      raise SimpleService::ExecuteNotDefinedError , error_msg
-    end
-
-    private
 
-    def all_specified_context_keys
-      (expects + returns)
+      unless skip_validation
+        ValidatesExpectedKeys.new(provided_keys: context.keys).call
+      end
     end
 
-    def define_getters_and_setters
-      all_specified_context_keys.each do |key|
-        self.class.class_eval do
-
-          # getter
-          define_method key do
-            self.context[key]
-          end
-
-          # setter
-          define_method "#{key}=" do |val|
-            self.context[key] = val
-          end
-
-        end
-      end
+    # call is where the command's behavior is defined
+    # call should be overriden by whatever class inherits from
+    # this class
+    def call
+      error_msg = "#{self.class} - does not define a call method"
+      raise SimpleService::CallNotDefinedError , error_msg
     end
 
   end

data/lib/simple_service/commands/validates_commands_not_empty.rb

@@ -0,0 +1,16 @@
+module SimpleService
+  class ValidatesCommandsNotEmpty < Command
+
+    expects :provided_commands
+
+    skip_validation true
+
+    def call
+      if provided_commands.nil? || provided_commands.empty?
+        error_msg = 'This Organizer class does not contain any command definitions'
+        raise SimpleService::OrganizerCommandsNotDefinedError, error_msg
+      end
+    end
+
+  end
+end

data/lib/simple_service/commands/validates_commands_properly_inherit.rb

@@ -0,0 +1,24 @@
+module SimpleService
+  class ValidatesCommandsProperlyInherit < Command
+
+    expects :provided_commands
+
+    skip_validation true
+
+    def call
+      # valid commands inherit from Command and do not inherit from service
+      # reject all valid commands and anything left over is invalid
+      invalid_commands = provided_commands.to_a.reject do |command|
+        command.ancestors.include?(SimpleService::Command) ||
+        command.ancestors.include?(SimpleService::Organizer)
+      end
+
+      if invalid_commands.any?
+        error_msg = invalid_commands.join(', ') +
+          ' - must inherit from SimpleService::Command'
+        raise SimpleService::CommandParentClassInvalidError, error_msg
+      end
+    end
+
+  end
+end

data/lib/simple_service/commands/validates_expected_keys.rb

@@ -0,0 +1,19 @@
+module SimpleService
+  class ValidatesExpectedKeys < Command
+
+    expects :expected_keys, :provided_keys
+
+    skip_validation true
+
+    def call
+      arguments_not_included = expected_keys.to_a - provided_keys.to_a
+
+      if arguments_not_included.any?
+        error_msg = 'keys required by the organizer but not found in the context: ' +
+          arguments_not_included.join(', ')
+        raise ExpectedKeyError, error_msg
+      end
+    end
+
+  end
+end

data/lib/simple_service/ensure_organizer_is_valid.rb

@@ -0,0 +1,21 @@
+module SimpleService
+  class EnsureOrganizerIsValid < Organizer
+
+    expects :expected_keys, :provided_keys, :provided_commands
+
+    skip_validation true # false so as to not cause an infinite loop
+
+    commands ValidatesExpectedKeys,
+             ValidatesCommandsNotEmpty,
+             ValidatesCommandsProperlyInherit
+
+    def call
+      super
+
+      # dont return the keys within this internal service
+      # so we dont pollute external service objects
+      context.select { |k,v| !expects.include?(k) }
+    end
+
+  end
+end

data/lib/simple_service/exceptions.rb

@@ -3,6 +3,6 @@ module SimpleService
   class OrganizerCommandsNotDefinedError < StandardError; end;
   class CommandParentClassInvalidError < StandardError; end;
   class ExpectedKeyError < StandardError; end;
-  class ExecuteNotDefinedError < StandardError; end;
+  class CallNotDefinedError < StandardError; end;
   class ReturnKeyError < StandardError; end;
 end

data/lib/simple_service/organizer.rb

@@ -9,14 +9,8 @@ module SimpleService
     def initialize(context={})
       @context = context
 
-      ArgumentValidator.new(
-        context: context,
-        expects: expects,
-        returns: returns,
-        commands: commands
-      ).execute
-
-      setup_execute_chain
+      setup_call_chain
+      define_getters_and_setters
     end
 
     def self.commands(*args)
@@ -27,12 +21,49 @@ module SimpleService
       self.class.instance_variable_get('@commands')
     end
 
-    def execute
-      commands.each do |command|
-        @context.merge!(command.new(context).execute)
+    def call
+      with_validation do |_commands|
+        _commands.each do |command|
+          @context.merge!(command.new(context).call)
+        end
       end
     end
 
+    # allow execution of the service from the class level for those
+    # that prefer that style
+    def self.call(context)
+      self.new(context).call
+    end
+
+    private
+
+    def with_validation
+      add_validation_keys_to_context unless skip_validation
+
+      _commands = skip_validation ? commands : [EnsureOrganizerIsValid] + commands
+
+      yield(_commands)
+
+      remove_validation_keys_from_context unless skip_validation
+    end
+
+    def add_validation_keys_to_context
+      context.merge!(validation_hash)
+    end
+
+    def remove_validation_keys_from_context
+      validation_hash.keys.each do |key|
+        context.delete(key)
+      end
+    end
+
+    def validation_hash
+      @validation_hash ||= {
+        provided_keys: context.keys,
+        expected_keys: expects,
+        provided_commands: commands
+      }
+    end
   end
 
 end

data/lib/simple_service/service_base.rb

@@ -9,22 +9,26 @@ module SimpleService
       def returns(*args)
         @returns = args
       end
+
+      def skip_validation(skip=true)
+        @skip_validation = skip
+      end
     end
 
     module InstanceMethods
 
-      def setup_execute_chain
+      def setup_call_chain
         self.class.class_eval do
 
           # grab the method object and hold onto it here
-          execute_method = instance_method(:execute)
+          call_method = instance_method(:call)
 
-          # redefine the execute method, call the existing execute method object,
-          # and then run return key checking... allows user to implement execute in
+          # redefine the call method, execute the existing call method object,
+          # and then run return key checking... allows user to implement call in
           # their individual command classes without having to call super or any
           # other method to return only specific context keys
-          define_method :execute do
-            execute_method.bind(self).call
+          define_method :call do
+            call_method.bind(self).call
             find_specified_return_keys
           end
         end
@@ -54,6 +58,33 @@ module SimpleService
       def returns
         self.class.instance_variable_get('@returns') || []
       end
+
+      def skip_validation
+        self.class.instance_variable_get('@skip_validation')
+      end
+
+      def all_specified_context_keys
+        (expects + returns).uniq
+      end
+
+      def define_getters_and_setters
+        all_specified_context_keys.each do |key|
+          self.class.class_eval do
+
+            # getter
+            define_method key do
+              self.context[key]
+            end
+
+            # setter
+            define_method "#{key}=" do |val|
+              self.context[key] = val
+            end
+
+          end
+        end
+      end
+
     end
 
   end

data/lib/simple_service/version.rb

@@ -1,3 +1,3 @@
 module SimpleService
-  VERSION = '1.0.2'
+  VERSION = '1.2.5'
 end

data/lib/simple_service.rb

@@ -1,10 +1,12 @@
 require 'simple_service/service_base'
-require 'simple_service/argument_validator'
 require 'simple_service/command'
-require 'simple_service/exceptions'
 require 'simple_service/organizer'
+require 'simple_service/exceptions'
+require 'simple_service/commands/validates_commands_not_empty'
+require 'simple_service/commands/validates_commands_properly_inherit'
+require 'simple_service/commands/validates_expected_keys'
+require 'simple_service/ensure_organizer_is_valid'
 require 'simple_service/version'
 
 module SimpleService
-  # Your code goes here...
 end

data/spec/lib/command_spec.rb

@@ -3,41 +3,48 @@ require 'spec_helper'
 describe SimpleService::Command do
 
   class ValidCommand < SimpleService::Command
-
     expects :foo, :bar
     returns :bar, :baz
-
-    def execute
+    def call
       context.merge!(
         bar: 'modified',
         baz: 'blah'
       )
     end
+  end
 
+  class InvalidReturnCommand < SimpleService::Command
+    expects :foo
+    returns :foo, :baz
+    def call; true; end
   end
 
-  class NoExecuteDefinedCommand < SimpleService::Command
+
+  class CallNotDefinedCommand < SimpleService::Command
   end
 
-  describe '#execute' do
+  describe '#call' do
 
     context 'when #returns is not empty' do
       it 'returns the correct keys from the context' do
         expect(
-          ValidCommand.new(foo: 'blah', bar: 'meh').execute
+          ValidCommand.new(foo: 'blah', bar: 'meh').call
         ).to eql(bar: 'modified', baz: 'blah')
       end
     end
 
     context 'raises error' do
 
-      it 'when command does not define an execute method' do
+      it 'when command does not define an call method' do
+        expect {
+          CallNotDefinedCommand.new.call
+        }.to raise_error(SimpleService::CallNotDefinedError)
+      end
+
+      it 'when command attempts to return a key that doesnt exist' do
         expect {
-          NoExecuteDefinedCommand.new.execute
-        }.to raise_error(
-          SimpleService::ExecuteNotDefinedError,
-          'NoExecuteDefinedCommand - does not define an execute method'
-        )
+          InvalidReturnCommand.new.call
+        }.to raise_error(SimpleService::ReturnKeyError)
       end
 
     end

data/spec/lib/commands/validates_commands_not_empty_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe SimpleService::ValidatesCommandsNotEmpty do
+
+  class DummyCommand < SimpleService::Command
+    def call; true; end
+  end
+
+  context '#call' do
+
+    it 'raises error when commands are not defined' do
+      expect {
+        SimpleService::ValidatesCommandsNotEmpty.new(provided_commands: nil).call
+      }.to raise_error(
+        SimpleService::OrganizerCommandsNotDefinedError,
+        'This Organizer class does not contain any command definitions'
+      )
+    end
+
+    it 'does not raise error when commands are defined' do
+      expect {
+        SimpleService::ValidatesCommandsNotEmpty.new(provided_commands: [DummyCommand]).call
+      }.to_not raise_error
+    end
+
+  end
+
+end

data/spec/lib/commands/validates_commands_properly_inherit_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe SimpleService::ValidatesCommandsProperlyInherit do
+
+  class ValidDummyCommand < SimpleService::Command
+    def call; true; end
+  end
+
+  class InvalidDummyCommand
+    def call; true; end
+  end
+
+  context '#call' do
+    it 'raises error when commands do not inherit from SimpleService::Command' do
+      expect {
+        SimpleService::ValidatesCommandsProperlyInherit.new(
+          provided_commands: [InvalidDummyCommand]
+        ).call
+      }.to raise_error(
+        SimpleService::CommandParentClassInvalidError,
+        'InvalidDummyCommand - must inherit from SimpleService::Command'
+      )
+    end
+
+    it 'does not raises error when commands inherit from SimpleService::Command' do
+      expect {
+        SimpleService::ValidatesCommandsProperlyInherit.new(
+          provided_commands: [ValidDummyCommand]
+        ).call
+      }.to_not raise_error
+    end
+  end
+
+end

data/spec/lib/commands/validates_expected_keys_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe SimpleService::ValidatesExpectedKeys do
+
+  let(:valid_keys) {{
+    expected_keys: [:foo],
+    provided_keys: [:foo],
+    some_other_key: 'blah'
+  }}
+
+  context '#call' do
+
+    let(:with_valid_keys) {
+      SimpleService::ValidatesExpectedKeys.new(valid_keys)
+    }
+
+    let(:with_missing_keys) {
+      _keys = valid_keys.merge(expected_keys: [:foo, :baz])
+      SimpleService::ValidatesExpectedKeys.new(_keys)
+    }
+
+    let(:does_not_expect_any_keys) {
+      _keys = valid_keys.merge(expected_keys: [])
+      SimpleService::ValidatesExpectedKeys.new(_keys)
+    }
+
+    context 'when all arguments are valid' do
+
+      it 'does not raise error' do
+        expect {
+          with_valid_keys.call
+        }.to_not raise_error
+      end
+
+    end
+
+    context 'when there are expected keys missing from provided keys' do
+
+      it 'raises an error' do
+        expect { with_missing_keys.call }.to raise_error(
+          SimpleService::ExpectedKeyError,
+          'keys required by the organizer but not found in the context: baz'
+        )
+      end
+
+    end
+
+    context 'no expected keys are given' do
+
+      it 'does not raise error' do
+        expect {
+          does_not_expect_any_keys.call
+        }.to_not raise_error
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/ensure_organizer_is_valid_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe SimpleService::EnsureOrganizerIsValid do
+
+  context '#call' do
+
+    class FooCommand < SimpleService::Command
+      def call; true; end
+    end
+
+    class BadInheritanceCommand
+      def call; true; end
+    end
+
+  end
+
+end

data/spec/lib/organizer_spec.rb

@@ -7,7 +7,7 @@ describe SimpleService::Organizer do
     class TestCommandOne < SimpleService::Command
       expects :foo
       returns :foo, :bar
-      def execute
+      def call
         context.merge!(bar: 'bar')
       end
     end
@@ -15,7 +15,7 @@ describe SimpleService::Organizer do
     class TestCommandTwo < SimpleService::Command
       expects :foo, :bar
       returns :foo, :bar, :baz
-      def execute
+      def call
         context.merge!(baz: 'baz')
       end
     end
@@ -26,10 +26,10 @@ describe SimpleService::Organizer do
       commands TestCommandOne, TestCommandTwo
     end
 
-    describe '#execute' do
+    describe '#call' do
       it 'returns the correct hash' do
         expect(
-          TestOrganizer.new(foo: 'foo').execute
+          TestOrganizer.new(foo: 'foo').call
         ).to eql(foo: 'foo', bar: 'bar', baz: 'baz')
       end
 
@@ -41,14 +41,14 @@ describe SimpleService::Organizer do
 
     class TestCommandThree < SimpleService::Command
       expects :foo
-      def execute
+      def call
         context.merge!(bar: 'bar')
       end
     end
 
     class TestCommandFour < SimpleService::Command
       expects :foo, :bar
-      def execute
+      def call
         context.merge!(baz: 'baz')
       end
     end
@@ -58,10 +58,10 @@ describe SimpleService::Organizer do
       commands TestCommandThree, TestCommandFour
     end
 
-    describe '#execute' do
+    describe '#call' do
       it 'returns the entire context' do
         expect(
-          TestOrganizerTwo.new(foo: 'foo', extra: 'extra').execute
+          TestOrganizerTwo.new(foo: 'foo', extra: 'extra').call
         ).to eql(foo: 'foo', bar: 'bar', baz: 'baz', extra: 'extra')
       end
 
@@ -74,7 +74,7 @@ describe SimpleService::Organizer do
     class GetterSetterCommand < SimpleService::Command
       expects :foo, :bar
       returns :baz
-      def execute
+      def call
         self.baz = self.foo
       end
     end
@@ -87,7 +87,7 @@ describe SimpleService::Organizer do
 
     it 'returns the correct hash' do
       expect(
-        GetterSetterOrganizer.new(foo: 'baz', bar: 'bar').execute
+        GetterSetterOrganizer.new(foo: 'baz', bar: 'bar').call
       ).to eql({ baz: 'baz' })
     end
 

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: simple_service
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.5
 platform: ruby
 authors:
 - Jarrod Spillers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A minimal service object composer with support for individual commands
@@ -88,25 +88,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - example/hello_world.rb
+- example/nested_organizer.rb
+- example/nested_services.rb
+- example/override_organizer_call_method.rb
 - lib/simple_service.rb
-- lib/simple_service/argument_validator.rb
 - lib/simple_service/command.rb
+- lib/simple_service/commands/validates_commands_not_empty.rb
+- lib/simple_service/commands/validates_commands_properly_inherit.rb
+- lib/simple_service/commands/validates_expected_keys.rb
+- lib/simple_service/ensure_organizer_is_valid.rb
 - lib/simple_service/exceptions.rb
 - lib/simple_service/organizer.rb
 - lib/simple_service/service_base.rb
 - lib/simple_service/version.rb
 - simple_service.gemspec
-- spec/lib/argument_validator_spec.rb
 - spec/lib/command_spec.rb
+- spec/lib/commands/validates_commands_not_empty_spec.rb
+- spec/lib/commands/validates_commands_properly_inherit_spec.rb
+- spec/lib/commands/validates_expected_keys_spec.rb
+- spec/lib/ensure_organizer_is_valid_spec.rb
 - spec/lib/organizer_spec.rb
 - spec/simple_service_spec.rb
 - spec/spec_helper.rb
@@ -120,24 +129,27 @@ 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.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A minimal service object composer with support for individual commands and
   top level organizer objects
 test_files:
-- spec/lib/argument_validator_spec.rb
 - spec/lib/command_spec.rb
+- spec/lib/commands/validates_commands_not_empty_spec.rb
+- spec/lib/commands/validates_commands_properly_inherit_spec.rb
+- spec/lib/commands/validates_expected_keys_spec.rb
+- spec/lib/ensure_organizer_is_valid_spec.rb
 - spec/lib/organizer_spec.rb
 - spec/simple_service_spec.rb
 - spec/spec_helper.rb

data/lib/simple_service/argument_validator.rb

@@ -1,57 +0,0 @@
-module SimpleService
-  class ArgumentValidator
-
-    attr_accessor :context, :expects, :commands
-
-    def initialize(opts)
-      @context  = opts[:context]
-      @expects  = opts[:expects]
-      @commands = opts[:commands]
-    end
-
-    def execute
-      validate_expected_arguments
-      validate_commands_not_empty
-      validate_commands_properly_inherit
-      true
-    end
-
-    private
-
-    def validate_expected_arguments
-      arguments_not_included = []
-
-      expects.each do |expected_arg|
-        arguments_not_included << expected_arg unless context.has_key?(expected_arg)
-      end
-
-      if arguments_not_included.any?
-        error_msg = 'keys required by the organizer but not found in the context: ' +
-          arguments_not_included.join(', ')
-        raise ExpectedKeyError, error_msg
-      end
-    end
-
-    def validate_commands_not_empty
-      if commands.nil? || commands.empty?
-        error_msg = 'This Organizer class does not contain any command definitions'
-        raise SimpleService::OrganizerCommandsNotDefinedError, error_msg
-      end
-
-    end
-
-    def validate_commands_properly_inherit
-      invalid_command_inherit = commands.select do |command|
-        # does the command class inherit from SimpleService::Command
-        !(command.ancestors.include?(SimpleService::Command))
-      end
-
-      if invalid_command_inherit.any?
-        error_msg = invalid_command_inherit.join(', ') +
-          ' - must inherit from SimpleService::Command'
-        raise SimpleService::CommandParentClassInvalidError, error_msg
-      end
-    end
-
-  end
-end

data/spec/lib/argument_validator_spec.rb

@@ -1,70 +0,0 @@
-require 'spec_helper'
-
-describe SimpleService::ArgumentValidator do
-
-  context 'execute' do
-
-    class FooCommand < SimpleService::Command
-      def execute; true; end
-    end
-
-    class BadInheritanceCommand
-      def execute; true; end
-    end
-
-    let(:valid_args) {{
-      context: { foo: 'bar'},
-      expects: [:foo],
-      returns: [:foo],
-      commands: [FooCommand]
-    }}
-
-    context 'when all arguments are valid' do
-
-      it 'does not raise error' do
-        expect {
-          SimpleService::ArgumentValidator.new(valid_args).execute
-        }.to_not raise_error
-      end
-
-      it 'returns true' do
-        expect(
-          SimpleService::ArgumentValidator.new(valid_args).execute
-        ).to eql true
-      end
-
-    end
-
-    it 'raises error when context does not contain expected keys' do
-      expect {
-        args = valid_args.merge(expects: [:baz])
-        SimpleService::ArgumentValidator.new(args).execute
-      }.to raise_error(
-        SimpleService::ExpectedKeyError,
-        'keys required by the organizer but not found in the context: baz'
-      )
-    end
-
-    it 'raises error when commands are not defined' do
-      expect {
-        args = valid_args.merge(commands: nil)
-        SimpleService::ArgumentValidator.new(args).execute
-      }.to raise_error(
-        SimpleService::OrganizerCommandsNotDefinedError,
-        'This Organizer class does not contain any command definitions'
-      )
-    end
-
-    it 'raises error when commands do not inherit from SimpleService::Command' do
-      expect {
-        args = valid_args.merge(commands: [BadInheritanceCommand])
-        SimpleService::ArgumentValidator.new(args).execute
-      }.to raise_error(
-        SimpleService::CommandParentClassInvalidError,
-        'BadInheritanceCommand - must inherit from SimpleService::Command'
-      )
-    end
-
-  end
-
-end