slayer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 731adbde67b9dfe482a51fb05b76e3f77cd0f615
-  data.tar.gz: 1e482c6f28b9d9173252cdce74f18995ca77f0b3
+  metadata.gz: 14e54657ae9bed79dbb867f2c28a0c72a57d64bb
+  data.tar.gz: ea6a0f28be0e58b77fdde6675f35362bd0f4a57f
 SHA512:
-  metadata.gz: eb418185d91671b33a0433cd19c63e42e2d0dcb828b47cfbf0a477855d59ebda1a645c5b23eec0adb29cac1429fdb9f7185097295b3df01a2ef375303a77b2ed
-  data.tar.gz: 0e823344bfcb291cbee00d09a96c5fb5023868ea5166ddd46a13214f968dff6d178e6e276f308baaa1617fda79ff96fc3d88b5a820ec944bea2609472f8b4c9a
+  metadata.gz: 3bd6939e5a23675abe05b13506a276bb0cc3905b554e134cd543b800a94e6f33b3ab458b52c1fd394e4b6b4adea4bbc338c292d6419a5d13a05a06518fa3e896
+  data.tar.gz: ff07ca08187a2c6c13ff9f41e2fbad207d4f3607671faa940795d8fc6e612bf74b7be6ccc954075c5f0fed6779b61adde7f2607ef16abfe64d40920eaf6beb53

data/.githooks/pre-push

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+echo "Starting unit tests"
+rake test
+if [ $? -ne 0 ]; then
+    echo ""
+    echo ""
+    echo "Unit tests failed; push aborted!"
+    exit 1
+fi
+
+echo
+echo "Starting rubocop"
+rubocop --format worst --format simple --format offenses
+if [ $? -ne 0 ]; then
+    echo ""
+    echo ""
+    echo "Rubocop failed; push aborted!"
+    exit 1
+fi
+
+echo
+echo "All pre-push checks passed! Pushing to remote"

data/.gitignore

@@ -9,3 +9,4 @@
 /spec/reports/
 /tmp/
 /log*/*
+.byebug_history

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,61 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - 'lib/**/*.rb'
+    - 'test/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/CommentIndentation:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 120
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+# Temporarily disabled until this can be resolved in the todo file
+# Style/Documentation:
+#   Exclude:
+#     - 'spec/**/*'
+#     - 'test/**/*'
+#     - 'lib/ext/**/*'
+
+Style/ClassVars:
+  Exclude:
+    - 'lib/slayer/service.rb'
+
+Style/MutableConstant:
+  Exclude:
+    - 'lib/slayer/version.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,48 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-02-13 09:02:04 -0800 using RuboCop version 0.47.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/slayer/command.rb'
+    - 'test/lib/result_matcher_test.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/slayer/form.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 19
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 18
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 6
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/ext/**/*'
+    - 'lib/slayer/command.rb'
+    - 'lib/slayer/errors.rb'
+    - 'lib/slayer/form.rb'
+    - 'lib/slayer/result.rb'

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
+before_install: gem update --system
 language: ruby
 rvm:
   - 2.3.0
-before_install: gem install bundler -v 1.12.0
+  - 2.4.0

data/README.md

@@ -1,14 +1,28 @@
 ![Slayer](https://raw.githubusercontent.com/apsislabs/slayer/master/slayer_logo.png)
 
-# Slayer: A Service Layer
+# Slayer: A Killer Service Layer
 
-Slayer is intended to operate as a minimal service layer for your ruby application. To achieve this, Slayer provides base classes for writing small, composable services, which should behave as [pure functions](https://en.wikipedia.org/wiki/Pure_function).
+[![Gem Version](https://badge.fury.io/rb/slayer.svg)](https://badge.fury.io/rb/slayer) [![Build Status](https://travis-ci.org/apsislabs/slayer.svg?branch=master)](https://travis-ci.org/apsislabs/slayer) [![Code Climate](https://codeclimate.com/github/apsislabs/slayer/badges/gpa.svg)](https://codeclimate.com/github/apsislabs/slayer)
 
-Slayer Services should implement `call`, which will `pass` or `fail` the service based on input. Services return a `Slayer::Result` which has a predictable interface for determining `success?` or `failure?`, a `message`, and a `result`.
+Slayer is intended to operate as a minimal service layer for your ruby application. To achieve this, Slayer provides base classes for business logic.
 
-Services are composed by Composers, which describe the order and arguments for running a number of Services in sequence. If any of these Services fail, those run before it are rolled back by calling `rollback` on the service, passing the service its `result` object, and the original parameters.
+## Application Structure
 
-Composers also return a `Slayer::Result` object, which has as its `result` parameter a hash of the result objects from its composed services.
+Slayer provides 3 base classes for organizing your business logic: `Forms`, `Commands`, and `Services`. Each of these has a distinct role in your application's structure.
+
+### Forms
+
+`Slayer::Forms` are objects for wrapping a set of data, usually to be passed as a parameter to a `Command` or `Service`.
+
+### Commands
+
+`Slayer::Commands` are the bread and butter of your application's business logic. `Commands` are where you compose services, and perform one-off business logic tasks. In our applications, we usually create a single `Command` per `Controller` endpoint.
+
+`Commands` should call `Services`, but `Services` should never call `Commands`.
+
+### Services
+
+`Services` are the building blocks of `Commands`, and encapsulate re-usable chunks of application logic.
 
 ## Installation
 
@@ -20,55 +34,66 @@ gem 'slayer'
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install slayer
+```sh
+$ gem install slayer
+```
 
 ## Usage
 
+### Commands
+
+Slayer Commands should implement `call`, which will `pass` or `fail` the service based on input. Commands return a `Slayer::Result` which has a predictable interface for determining `success?` or `failure?`, a `message`, and a `result` payload object.
+
 ```ruby
-# A service that passes when given the string "foo"
+# A Command that passes when given the string "foo"
 # and fails if given anything else.
-class FooService < Slayer::Service
-    def call(foo:)
-      if foo == "foo"
-        pass! result: foo, message: "Passing FooService"
-      else
-        fail! result: foo, message: "Failing FooService"
-      end
+class FooCommand < Slayer::Command
+  def call(foo:)
+    if foo == "foo"
+      pass! result: foo, message: "Passing FooCommand"
+    else
+      fail! result: foo, message: "Failing FooCommand"
     end
+  end
 end
 
-# A placeholder service that always passes with returned result
-# as the argument passed into it.
-class BarService < Slayer::Service
-    def call(bar:)
-        pass! result: bar, message: "Passing BarService"
-    end
-end
+result = FooCommand.call(foo: "foo")
+result.success? # => true
+
+result = FooCommand.call(foo: "bar")
+result.success? # => false
+```
 
-# A simple composer which composes the FooService and BarService
-class FooBarComposer < Slayer::Composer
-    compose FooService, BarService
+### Forms
 
-    def call
-        pass! result: @results,  message: "Yay!"
-    end
+### Services
 
-    def foo_service_args
-        return { foo: @composer_params[:foo] }
-    end
+Slayer Services are objects that should implement re-usable pieces of application logic or common tasks. To prevent circular dependencies Services are required to declare which other Service classes they depend on. If a circular dependency is detected an error is raised.
 
-    def bar_service_args
-        return { bar: foo_service_results.message }
+In order to enforce the lack of circular dependencies, Service objects can only call other Services that are declared in their dependencies.
+
+```ruby
+class NetworkService < Slayer::Service
+    def self.post()
+        ...
     end
 end
 
+class StripeService < Slayer::Service
+  dependencies NetworkService
 
-result = FooBarComposer.call(foo: "Jim", bar: "Joe")
-result.success? # => true
+  def self.pay()
+    ...
+    NetworkService.post(url: "stripe.com", body: my_payload)
+    ...
+  end
+end
 ```
 
 ## Development
@@ -77,6 +102,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+To generate documentation run `yard`. To view undocumented files run `yard stats --list-undoc`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/apsislabs/slayer.

data/Rakefile

@@ -1,9 +1,9 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 

data/bin/install-githooks

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+cd "`dirname \"$0\"`/.."
+
+echo "Installing githooks for `pwd`"
+rm -rf .git/hooks
+ln -s -f ../.githooks/ .git/hooks

data/bin/setup

@@ -6,3 +6,4 @@ set -vx
 bundle install
 
 # Do any other automated setup that you need to do here
+bin/install-githooks

data/lib/ext/string_ext.rb

@@ -0,0 +1,11 @@
+class String
+  def underscore
+    word = dup
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+    word.tr!('-', '_')
+    word.downcase!
+    word
+  end
+end

data/lib/slayer.rb

@@ -1,6 +1,9 @@
-require "slayer/version"
-require "slayer/string_ext"
-require "slayer/errors"
-require "slayer/result"
-require "slayer/service"
-require "slayer/composer"
+require 'ext/string_ext' unless defined?(Rails)
+
+require 'slayer/version'
+require 'slayer/errors'
+require 'slayer/result'
+require 'slayer/result_matcher'
+require 'slayer/service'
+require 'slayer/command'
+require 'slayer/form'

data/lib/slayer/command.rb

@@ -0,0 +1,74 @@
+module Slayer
+  class Command
+    attr_accessor :result
+
+    # Internal: Command Class Methods
+    class << self
+      def call(*args, &block)
+        execute_call(block, *args) { |c, *a| c.run(*a) }
+      end
+
+      def call!(*args, &block)
+        execute_call(block, *args) { |c, *a| c.run!(*a) }
+      end
+
+      private
+
+      def execute_call(command_block, *args)
+        # Run the Command and capture the result
+        command = self.new
+        result  = command.tap { yield(command, *args) }.result
+
+        # Throw an exception if we don't return a result
+        raise CommandNotImplementedError unless result.is_a? Result
+
+        # Run the command block if one was provided
+        unless command_block.nil?
+          matcher = Slayer::ResultMatcher.new(result, command)
+
+          command_block.call(matcher)
+
+          # raise error if not all defaults were handled
+          unless matcher.handled_defaults?
+            raise(CommandResultNotHandledError, 'The pass or fail condition of a result was not handled')
+          end
+
+          begin
+            matcher.execute_matching_block
+          ensure
+            matcher.execute_ensure_block
+          end
+        end
+
+        return result
+      end
+    end # << self
+
+    def run(*args)
+      call(*args)
+    rescue CommandFailureError
+      # Swallow the Command Failure
+    end
+
+    # Run the Command
+    def run!(*args)
+      call(*args)
+    end
+
+    # Fail the Command
+    def fail!(result:, status: :default, message: nil)
+      @result = Result.new(result, status, message)
+      @result.fail!
+    end
+
+    # Pass the Command
+    def pass!(result:, status: :default, message: nil)
+      @result = Result.new(result, status, message)
+    end
+
+    # Call the command
+    def call
+      raise NotImplementedError, 'Commands must define method `#call`.'
+    end
+  end
+end

data/lib/slayer/errors.rb

@@ -1,21 +1,22 @@
 module Slayer
-    class ServiceFailure < StandardError
-        attr_reader :result
+  class CommandFailureError < StandardError
+    attr_reader :result
 
-        def initialize(result)
-            @result = result
-            super
-        end
+    def initialize(result)
+      @result = result
+      super
     end
+  end
 
-    class ServiceNotImplemented < StandardError
-        def initialize(message = nil)
-            message ||= %q(
-                Service implementation must call `fail!` or `pass!`,
-                or return a <Slayer::Result> object
-            )
-
-            super message
-        end
+  class CommandNotImplementedError < StandardError
+    def initialize(message = nil)
+      message ||= 'Command implementation must call `fail!` or `pass!`, or '\
+                  'return a <Slayer::Result> object'
+      super message
     end
+  end
+
+  class CommandResultNotHandledError < StandardError; end
+  class FormValidationError < StandardError; end
+  class ServiceDependencyError < StandardError; end
 end

data/lib/slayer/form.rb

@@ -0,0 +1,15 @@
+require 'virtus'
+
+module Slayer
+  class Form
+    include Virtus.model
+    include ActiveModel::Validations if defined?(Rails)
+
+    def validate!
+      validatable = respond_to?(:valid?) && respond_to?(:errors)
+
+      raise NotImplementedError unless validatable
+      raise FormValidationError, errors unless valid?
+    end
+  end
+end

data/lib/slayer/result.rb

@@ -1,23 +1,24 @@
 module Slayer
-    class Result
-        attr_reader :result, :message
+  class Result
+    attr_reader :value, :status, :message
 
-        def initialize(result, message)
-            @result = result
-            @message = message
-        end
+    def initialize(value, status, message)
+      @value   = value
+      @status  = status
+      @message = message
+    end
 
-        def success?
-            !failure?
-        end
+    def success?
+      !failure?
+    end
 
-        def failure?
-            @failure || false
-        end
+    def failure?
+      @failure || false
+    end
 
-        def fail!
-            @failure = true
-            raise ServiceFailure, self
-        end
+    def fail!
+      @failure = true
+      raise CommandFailureError, self
     end
+  end
 end

data/lib/slayer/result_matcher.rb

@@ -0,0 +1,217 @@
+module Slayer
+  # ResultMatcher is the object passed to the block of a {Command.call}. The ResultMatcher
+  # allows the block-author to specify which piece of logic they would like to invoke
+  # based on the state of the {Result} object.
+  #
+  # In the event that multiple blocks match the {Result}, only the most specific
+  # matching block will be invoked. Status matches take precedence over default matches.
+  # If there are two blocks with a matching status, the pass/fail block takes precedence
+  # over the all block.
+  #
+  # == Matching based on success or failure
+  #
+  # The ResultMatcher matches calls to {#pass} to a {Result} that returns +true+
+  # for {Result#success?}, calls to {#fail} to a {Result} that returns +true+
+  # for {Result#failure?}, and calls to {#all} to a {Result} in either state.
+  #
+  # A matching call to {#pass} or {#fail} takes precedence over matching calls to {#all}
+  #
+  # == Matching based on status
+  #
+  # Additionally, the ResultMatcher can also match by the {Result#status}. If a status
+  # or statuses is passed to {#pass}, {#fail}, or {#all}, these will only be invoked if the
+  # status of the {Result} matches the passed in status.
+  #
+  # If the default block is the same as the block for one of the statuses the status +:default+
+  # can be used to indicate which block should be used as the default. Successful status matches
+  # take precedence over default matchers.
+  #
+  # == Both pass and fail must be handled
+  #
+  # If the block form of a {Command.call} is invoked, both the block must handle the default
+  # status for both a {Result#success?} and a {Result#failure?}. If both are not handled,
+  # the matching block will not be invoked and a {CommandResultNotHandledError} will be
+  # raised.
+  #
+  # @example Matcher invokes the matching pass block, with precedence given to {#pass} and {#fail}
+  #   # Call produces a successful Result
+  #   SuccessCommand.call do |m|
+  #     m.pass { puts "Pass!" }
+  #     m.fail { puts "Fail!" }
+  #     m.all  { puts "All!"  } # will never be invoked, due to both a pass and fail response existing
+  #   end
+  #   # => prints "Pass!"
+  #
+  # @example Matcher invokes the matching status of the result object, or the default
+  #   # Call produces a successful Result with status :ok
+  #   SuccessCommand.call do |m|
+  #     m.pass(:ok) { puts "Pass, OK!" }
+  #     m.pass      { puts "Pass, default!" }
+  #     m.fail      { puts "Fail!" }
+  #   end
+  #   # => prints "Pass, OK!"
+  #
+  #   # Call produces a successful Result with status :created
+  #   SuccessCommand.call do |m|
+  #     m.pass(:ok) { puts "Pass, OK!" }
+  #     m.pass      { puts "Pass, default!" }
+  #     m.fail      { puts "Fail!" }
+  #   end
+  #   # => prints "Pass, default!"
+  #
+  # @example Matcher invokes the explicitly indicated default block
+  #   # Call produces a successful Result with status :created
+  #   SuccessCommand.call do |m|
+  #     m.pass(:ok, :default) { puts "Pass, OK!" }
+  #     m.pass(:great)        { puts "Pass, default!" }
+  #     m.fail                { puts "Fail!" }
+  #   end
+  #   # => prints "Pass, OK!"
+  #
+  # @example Matcher must handle both pass and fail defaults.
+  #   # Call produces a successful Result with status :ok
+  #   SuccessCommand.call do |m|
+  #     m.pass(:ok) { puts "Pass, OK!"}
+  #     m.fail      { puts "Fail!" }
+  #   end
+  #   # => raises CommandResultNotHandledError (because no default pass was provided)
+  #
+  #   # Call produces a successful Result with status :ok
+  #   SuccessCommand.call do |m|
+  #     m.pass(:ok, :default) { puts "Pass, OK!"}
+  #     m.fail                { puts "Fail!" }
+  #   end
+  #   # => prints "Pass, OK!"
+  #
+  #   # Call produces a successful Result with status :ok
+  #   SuccessCommand.call do |m|
+  #     m.pass(:ok) { puts "Pass, OK!"}
+  #     m.all       { puts "All!" }
+  #   end
+  #   # => prints "Pass, OK!"
+  #
+  #   # Call produces a successful Result with status :ok
+  #   SuccessCommand.call do |m|
+  #     m.pass(:ok, :default) { puts "Pass, OK!"}
+  #   end
+  #   # => raises CommandResultNotHandledError (because no default fail was provided)
+  class ResultMatcher
+    attr_reader :result, :command
+
+    # @api private
+    def initialize(result, command)
+      @result = result
+      @command = command
+
+      @status = result.status || :default
+
+      @handled_default_pass = false
+      @handled_default_fail = false
+
+      # These are set to false if they are never set. If they are set to `nil` that
+      # means the block intentionally passed `nil` as the block to be executed.
+      @matching_block       = false
+      @matching_all         = false
+      @default_block        = false
+      @default_all          = false
+      @ensure_block         = false
+    end
+
+    # Provide a block that should be invoked if the {Result} is a success.
+    #
+    # @param statuses [Array<status>] Statuses that should be compared to the {Result}. If
+    #   any of provided statuses match the {Result} this block will be considered a match.
+    #   The symbol +:default+ can also be used to indicate that this should match any {Result}
+    #   not matched by other matchers.
+    #
+    #   If no value is provided for statuses it defaults to +:default+.
+    def pass(*statuses, &block)
+      statuses << :default if statuses.empty?
+      @handled_default_pass ||= statuses.include?(:default)
+
+      block_is_match   = @result.success? && statuses.include?(@status)
+      block_is_default = @result.success? && statuses.include?(:default)
+
+      @matching_block = block if block_is_match
+      @default_block  = block if block_is_default
+    end
+
+    # Provide a block that should be invoked if the {Result} is a failure.
+    #
+    # @param statuses [Array<status>] Statuses that should be compared to the {Result}. If
+    #   any of provided statuses match the {Result} this block will be considered a match.
+    #   The symbol +:default+ can also be used to indicate that this should match any {Result}
+    #   not matched by other matchers.
+    #
+    #   If no value is provided for statuses it defaults to +:default+.
+    def fail(*statuses, &block)
+      statuses << :default if statuses.empty?
+      @handled_default_fail ||= statuses.include?(:default)
+
+      block_is_match   = @result.failure? && statuses.include?(@status)
+      block_is_default = @result.failure? && statuses.include?(:default)
+
+      @matching_block = block if block_is_match
+      @default_block  = block if block_is_default
+    end
+
+    # Provide a block that should be invoked for any {Result}. This has a lower precedence that
+    # either {#pass} or {#fail}.
+    #
+    # @param statuses [Array<status>] Statuses that should be compared to the {Result}. If
+    #   any of provided statuses match the {Result} this block will be considered a match.
+    #   The symbol +:default+ can also be used to indicate that this should match any {Result}
+    #   not matched by other matchers.
+    #
+    #   If no value is provided for statuses it defaults to +:default+.
+    def all(*statuses, &block)
+      statuses << :default if statuses.empty?
+      @handled_default_pass ||= statuses.include?(:default)
+      @handled_default_fail ||= statuses.include?(:default)
+
+      block_is_match   = statuses.include?(@status)
+      block_is_default = statuses.include?(:default)
+
+      @matching_all = block if block_is_match
+      @default_all  = block if block_is_default
+    end
+
+    # Provide a block that should be always be invoked after other blocks have executed. This block
+    # will be invoked even if the other block raises an error.
+    def ensure(&block)
+      @ensure_block = block
+    end
+
+    # @return Whether both the pass and the fail defaults have been handled.
+    #
+    # @api private
+    def handled_defaults?
+      return @handled_default_pass && @handled_default_fail
+    end
+
+    # Executes the provided block that best matched the {Result}. If no block matched
+    # nothing is executed
+    #
+    # @api private
+    def execute_matching_block
+      if @matching_block != false # nil should pass this test
+        @matching_block&.call(@result, @command) # explicit nil will not get called with
+                                                 # safe navigation (&.)
+      elsif @matching_all != false
+        @matching_all&.call(@result, @command)
+      elsif @default_block != false
+        @default_block&.call(@result, @command)
+      elsif @default_all
+        @default_all&.call(@result, @command)
+      end
+    end
+
+    def execute_ensure_block
+      # rubocop:disable Style/IfUnlessModifier
+      if @ensure_block != false # nil should pass this test
+        @ensure_block.call(@result, @command)
+      end
+      # rubocop:enable Style/IfUnlessModifier
+    end
+  end
+end

data/lib/slayer/service.rb

@@ -1,52 +1,182 @@
 module Slayer
-    class Service
-        attr_accessor :result
-
-        # Internal: Service Class Methods
-        class << self
-            def call(*args, &block)
-                # Run the Service and capture the result
-                result = new.tap { |s|
-                    s.run(*args, &block)
-                }.result
-
-                # Throw an exception if we don't return a result
-                raise ServiceNotImplemented unless result.is_a? Result
-                return result
-            end
+  # Slayer Services are objects that should implement re-usable pieces of
+  # application logic or common tasks. To prevent circular dependencies Services
+  # are required to declare which other Service classes they depend on. If a
+  # circular dependency is detected an error is raised.
+  #
+  # In order to enforce the lack of circular dependencies, Service objects can
+  # only call other Services that are declared in their dependencies.
+  class Service
+    # List the other Service class that this service class depends on. Only
+    # dependencies that are included in this call my be invoked from class
+    # or instances methods of this service class.
+    #
+    # If no dependencies are provided, no other Service classes may be used by
+    # this Service class.
+    #
+    # @param deps [Array<Class>] An array of the other Slayer::Service classes that are used as dependencies
+    #
+    # @example Service calls with dependency declared
+    #   class StripeService < Slayer::Service
+    #     dependencies NetworkService
+    #
+    #     def self.pay()
+    #       ...
+    #       NetworkService.post(url: "stripe.com", body: my_payload) # OK
+    #       ...
+    #     end
+    #   end
+    #
+    # @example Service calls without a dependency declared
+    #   class JiraApiService < Slayer::Service
+    #
+    #     def self.create_issue()
+    #       ...
+    #       NetworkService.post(url: "stripe.com", body: my_payload) # Raises Slayer::ServiceDependencyError
+    #       ...
+    #     end
+    #   end
+    #
+    # @return [Array<Class>] The transitive closure of dependencies for this object.
+    def self.dependencies(*deps)
+      raise(ServiceDependencyError, "There were multiple dependencies calls of #{self}") if @deps
+
+      deps.each do |dep|
+        unless dep.is_a?(Class)
+          raise(ServiceDependencyError, "The object #{dep} passed to dependencies service was not a class")
         end
 
-        # Run the Service, rescue from Failures
-        def run(*args, &block)
-            begin
-                run!(*args, &block)
-            rescue ServiceFailure
-            end
+        unless dep < Slayer::Service
+          raise(ServiceDependencyError, "The object #{dep} passed to dependencies was not a subclass of #{self}")
         end
+      end
+
+      unless deps.uniq.length == deps.length
+        raise(ServiceDependencyError, "There were duplicate dependencies in #{self}")
+      end
+
+      @deps = deps
+
+      # Calculate the transitive dependencies and raise an error if there are circular dependencies
+      transitive_dependencies
+    end
+
+    class << self
+
+      attr_reader :deps
+
+      def transitive_dependencies(dependency_hash = {}, visited = [])
+        return @transitive_dependencies if @transitive_dependencies
 
-        # Run the Service
-        def run!(*args, &block)
-            call(*args, &block)
+        @deps ||= []
+
+        # If we've already visited ourself, bail out. This is necessary to halt
+        # execution for a circular chain of dependencies. #halting-problem-solved
+        return dependency_hash[self] if visited.include?(self)
+
+        visited << self
+        dependency_hash[self] ||= []
+
+        # Add each of our dependencies (and it's transitive dependency chain) to our
+        # own dependencies.
+
+        @deps.each do |dep|
+          dependency_hash[self] << dep
+
+          unless visited.include?(dep)
+            child_transitive_dependencies = dep.transitive_dependencies(dependency_hash, visited)
+            dependency_hash[self].concat(child_transitive_dependencies)
+          end
+
+          dependency_hash[self].uniq
         end
 
-        # Fail the Service
-        def fail! result:, message:
-            @result = Result.new(result, message)
-            @result.fail!
+        # NO CIRCULAR DEPENDENCIES!
+        if dependency_hash[self].include? self
+          raise(ServiceDependencyError, "#{self} had a circular dependency")
         end
 
-        # Pass the Service
-        def pass! result:, message:
-            @result = Result.new(result, message)
+        # Store these now, so next time we can short-circuit.
+        @transitive_dependencies = dependency_hash[self]
+
+        return @transitive_dependencies
+      end
+
+      def before_each_method(*)
+        @deps ||= []
+        @@allowed_services ||= nil
+
+        # Confirm that this method call is allowed
+        raise_if_not_allowed
+
+        @@allowed_services ||= []
+        @@allowed_services << @deps
+      end
+
+      def raise_if_not_allowed
+        if @@allowed_services
+          allowed = @@allowed_services.last
+          if !allowed || !allowed.include?(self)
+            raise(ServiceDependencyError, "Attempted to call #{self} from another #{Slayer::Service}"\
+                                          ' which did not declare it as a dependency')
+          end
         end
+      end
+
+      def after_each_method(*)
+        @@allowed_services.pop
+        @@allowed_services = nil if @@allowed_services.empty?
+      end
+
+      def singleton_method_added(name)
+        return if self == Slayer::Service
+        return if @__last_methods_added && @__last_methods_added.include?(name)
+
+        with = :"#{name}_with_before_each_method"
+        without = :"#{name}_without_before_each_method"
 
-        # Call the service
-        def call
-            raise NotImplementedError, "Services must define method `#call`."
+        @__last_methods_added = [name, with, without]
+        define_singleton_method with do |*args, &block|
+          before_each_method name
+          begin
+            send without, *args, &block
+          rescue
+            raise
+          ensure
+            after_each_method name
+          end
         end
 
-        # Do nothing
-        def rollback
+        singleton_class.send(:alias_method, without, name)
+        singleton_class.send(:alias_method, name, with)
+
+        @__last_methods_added = nil
+      end
+
+      def method_added(name)
+        return if self == Slayer::Service
+        return if @__last_methods_added && @__last_methods_added.include?(name)
+
+        with = :"#{name}_with_before_each_method"
+        without = :"#{name}_without_before_each_method"
+
+        @__last_methods_added = [name, with, without]
+        define_method with do |*args, &block|
+          self.class.before_each_method name
+          begin
+            send without, *args, &block
+          rescue
+            raise
+          ensure
+            self.class.after_each_method name
+          end
         end
-    end
-end
+
+        alias_method without, name
+        alias_method name, with
+
+        @__last_methods_added = nil
+      end
+    end # << self
+  end # class Service
+end # module Slayer

data/lib/slayer/version.rb

@@ -1,3 +1,3 @@
 module Slayer
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/slayer.gemspec

@@ -4,21 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'slayer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "slayer"
+  spec.name          = 'slayer'
   spec.version       = Slayer::VERSION
-  spec.authors       = ["Wyatt Kirby"]
-  spec.email         = ["kirby.wa@gmail.com"]
+  spec.authors       = ['Wyatt Kirby', 'Noah Callaway']
+  spec.email         = ['wyatt@apsis.io', 'noah@apsis.io']
 
-  spec.summary       = %q{A service layer}
-  spec.homepage      = "http://www.apsis.io"
-  spec.license       = "MIT"
+  spec.summary       = %q{A killer service layer}
+  spec.homepage      = 'http://www.apsis.io'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_dependency 'dry-validation', '~> 0.10'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+  spec.add_development_dependency 'mocha', '~> 1.2'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'rubocop', '~> 0.47.1'
 end

metadata

@@ -1,15 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: slayer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wyatt Kirby
+- Noah Callaway
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,27 +81,105 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
 description: 
 email:
-- kirby.wa@gmail.com
+- wyatt@apsis.io
+- noah@apsis.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".githooks/pre-push"
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/install-githooks
 - bin/setup
+- lib/ext/string_ext.rb
 - lib/slayer.rb
-- lib/slayer/composer.rb
+- lib/slayer/command.rb
 - lib/slayer/errors.rb
+- lib/slayer/form.rb
 - lib/slayer/result.rb
+- lib/slayer/result_matcher.rb
 - lib/slayer/service.rb
-- lib/slayer/string_ext.rb
 - lib/slayer/version.rb
 - slayer.gemspec
 - slayer_logo.png
@@ -99,5 +206,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: A service layer
+summary: A killer service layer
 test_files: []

data/lib/slayer/composer.rb

@@ -1,80 +0,0 @@
-module Slayer
-    class Composer < Service
-        attr_accessor :called
-        attr_accessor :results
-        attr_accessor :called_services
-        attr_accessor :composer_params
-
-        class << self
-            def compose(*services)
-                @services = services.flatten
-            end
-
-            def services
-                @services ||= []
-            end
-        end
-
-        # Locate Results from Magic Methods
-        def method_missing(method_sym, *arguments, &block)
-            if method_sym.to_s =~ /^(.*)_results$/
-                results = @results[$1.to_sym]
-                return results unless results.nil?
-            end
-
-            super
-        end
-
-        def run!(**args, &block)
-            @composer_params = args
-            @called_services = []
-            @results = {}
-
-            # Attempt to run each Service, if any fail,
-            # call rollback on all those already run in
-            # reverse order.
-            begin
-                self.class.services.each do |service|
-                    service_sym  = service_to_sym(service)
-                    service_args = service_to_args(service)
-
-                    # Run the service then add it to called_services
-                    @results[service_sym] = service.new.run!(service_args)
-                    @called_services << service
-                end
-            rescue ServiceFailure
-                @called_services.reverse_each do |service|
-                    service_args   = service_to_args(service)
-                    service_result = service_results(service)
-
-                    # Pass the original args and result object
-                    service.rollback(service_args, service_result)
-                end
-
-                raise
-            end
-
-            call
-            @called = true
-        end
-
-        private
-
-            # Convert a Service to an underscored symbol
-            def service_to_sym(service)
-                service.name.underscore.to_sym
-            end
-
-            # Convert a Service to a call to an args method
-            def service_to_args(service)
-                service_sym = service_to_sym(service)
-                self.method("#{service_sym}_args").call
-            end
-
-            # Convert a Service to its result object
-            def service_results(service)
-                service_sym = service_to_sym(service)
-                return @results[service_sym]
-            end
-    end
-end

data/lib/slayer/string_ext.rb

@@ -1,11 +0,0 @@
-class String
-  def underscore
-    word = self.dup
-    word.gsub!(/::/, '/')
-    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-    word.tr!("-", "_")
-    word.downcase!
-    word
-  end
-end