responsibility 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8b5b58fe0c75ff392eeee922e72ebd697b5e210
-  data.tar.gz: cbf0dcaa8696297f15191e0e28304b7221df5afb
+  metadata.gz: 8e4652bca8e4700672ee129c9a6af61a1f8119c4
+  data.tar.gz: 49a393345b8d3130d3914a78d69c5dba91aac172
 SHA512:
-  metadata.gz: 81e650119d4e5f0b442e1a006cae04f43eed2bafd9afd84264c356f63ac7330f8841000be780bcc8bb32986711cadbc5ee72c6eb99f9ac00c1b12790dae40eda
-  data.tar.gz: 93cdb5f3448ac67f25b55f1bbf2d9bed19983ca8b9e9445442871c2f6d035db8393c148bafb04bbc4646118150f0d020322bb66eccf311ad1fcbcdb39e533e48
+  metadata.gz: 56c619981d0d09d269c561dcc5f67d423505b859113819cc08ddcb1fa772ecb02918fe73b878613bff12350a4e6b13404e778c92faa72b564f4566846a9d7d25
+  data.tar.gz: 93c81363a141a066f12ae345186c9826dffef04f02d2a0a26ca204e726036d1b1243a036049c5fe207feddc40f37b71525e6ac9651a6d9d10a3f8d22a4ba48ab

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    responsibility (0.1.0)
+    responsibility (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Erick Brower
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,8 +1,7 @@
-# Responsibility
+# Responsibility [![Build Status](https://travis-ci.org/erickbrower/responsibility.svg?branch=master)](https://travis-ci.org/erickbrower/responsibility)
 
 A Responsibility is a class that provides a single piece of functionality,
-as per the Single Responsibility Principle
-[https://en.wikipedia.org/wiki/Single_responsibility_principle]. This class
+as per the [Single Responsibility Principle](https://en.wikipedia.org/wiki/Single_responsibility_principle). This class
 provides a single method called "perform", with optional "before" and
 "after" hooks. It also keeps track of any errors set during execution.
 
@@ -24,6 +23,11 @@ Or install it yourself as:
 
 ## Usage
 
+Define a class, `include Responsibility`, and define a `perform` method.
+If `before` is defined and returns `false` or calls `fail!` then the `perform` or `after` methods will not be run. The same rule applies to `perform`, and in the case of failure `after` will not be called.
+
+Any keyword arguments (or just a hash) passed to `perform` will become attributes of the resulting object
+
 A simple example could be something like:
 
 ```ruby
@@ -50,6 +54,49 @@ user = User.new(
   password: "Wubba Lubba Dub Dub!"
 )
 result = UserSignupService.perform(user: user)
+result.success? #=> true
+result.errors #=> []
+result.user #=> Our newly persisted user
+
+```
+
+If errors are created during `before`, `perform`, or `after` then the service fails. In the example above, if the user isn't valid we add an error. In this case the result object would look like:
+
+```ruby
+user = User.new(
+  email: "",
+  password: ""
+)
+result = UserSignupService.perform(user: user)
+result.success? #=> false
+result.errors #=> ["User was not provided or is not valid"]
+```
+
+Another contrived example with an explicit failure, assuming the User object couldn't be persisted:
+```ruby
+class UserSignupService
+  include Responsibility
+
+  def before
+    unless user.present? && user.valid?
+      errors << "User was not provided or is not valid"
+    end
+  end
+
+  def perform
+    unless user.save
+      fail!(message: "User could not be saved")
+    end
+  end
+
+  def after
+    UserConfirmationEmailService.perform(email: user.email)
+  end
+end
+
+result = UserSignupService.perform(user: user)
+result.success?  #=> false
+result.errors #=> ["User could not be saved"]
 
 ```
 

data/Rakefile

@@ -4,7 +4,3 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
-
-task :console do
-  sh "irb -rubygems -I lib -r responsibility.rb"
-end

data/lib/responsibility.rb

@@ -1,7 +1,11 @@
+# Author:: Erick Brower  (mailto:cerickbrower@gmail.com)
+# License:: MIT
+
 require "responsibility/version"
 require "responsibility/initializer"
 require "responsibility/instance_methods"
 require "responsibility/class_methods"
+require "responsibility/failure_error"
 
 module Responsibility
   def self.included(base)

data/lib/responsibility/class_methods.rb

@@ -1,41 +1,54 @@
 module Responsibility
   module ClassMethods
-    def before(obj)
-      if obj.respond_to?(:before)
-        result = obj.before
-        if obj.errors.any?
-          obj.instance_variable_set("@success", false)
-        else
-          obj.instance_variable_set("@success", !!result)
+    def before(service)
+      begin
+        if service.respond_to?(:before)
+          if !service.before || service.errors.any?
+            handle_failure(service: service)
+          end
         end
+      rescue FailureError => e
+        handle_failure(service: service, error: e)
       end
+      service.success?
     end
 
-    def after(obj)
-      if obj.respond_to?(:after)
-        result = obj.after
-        if obj.errors.any?
-          obj.instance_variable_set("@success", false)
-        else
-          obj.instance_variable_set("@success", !!result)
+    def after(service)
+      begin
+        if service.respond_to?(:after)
+          if !service.after || service.errors.any?
+            handle_failure(service: service)
+          end
         end
+      rescue FailureError => e
+        handle_failure(service: service, error: e)
       end
+      service.success?
     end
 
     def perform(*args)
       args = {} if args.is_a?(Array)
       service = new(args)
-      before(service)
-      if service.success?
-        service.perform
-      end
-      if service.errors.any?
-        service.instance_variable_set("@success", false)
+      if before(service)
+        begin
+          service.perform
+          handle_failure(service: service) if service.errors.any?
+        rescue FailureError => e
+          handle_failure(service: service, error: e)
+        end
       end
       if service.success?
-        after(service)
+        if !after(service) || service.errors.any?
+          handle_failure(service: service)
+        end
       end
       service
     end
+
+    private
+    def handle_failure(service:, error: nil)
+      service.instance_variable_set("@success", false)
+      service.errors << error.message if error
+    end
   end
 end

data/lib/responsibility/failure_error.rb

@@ -0,0 +1 @@
+class FailureError < StandardError; end;

data/lib/responsibility/initializer.rb

@@ -1,13 +1,14 @@
 module Responsibility
   module Initializer
     def initialize(args)
-      args[:errors] = []
       args.each do |key, val|
         self.class.send(:attr_accessor, key)
         instance_variable_set("@#{key}", val)
       end
       self.class.send(:attr_reader, :success)
       instance_variable_set("@success", true)
+      self.class.send(:attr_reader, :errors)
+      instance_variable_set("@errors", [])
     end
   end
 end

data/lib/responsibility/instance_methods.rb

@@ -8,12 +8,8 @@ module Responsibility
       success == false
     end
 
-    def fail!
-      success = false
-    end
-
-    def succeed!
-      success = true
+    def fail!(message: nil)
+      raise FailureError.new(message)
     end
   end
 end

data/lib/responsibility/version.rb

@@ -1,3 +1,3 @@
 module Responsibility
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/responsibility.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
     provides a single method called "perform", with optional "before" and
     "after" hooks.
     HEREDOC
-  spec.homepage      = "http://erickbrower.com"
+  spec.homepage      = "http://github.com/erickbrower/responsibility"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: responsibility
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Erick Brower
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-14 00:00:00.000000000 Z
+date: 2017-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,17 +83,19 @@ files:
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/responsibility.rb
 - lib/responsibility/class_methods.rb
+- lib/responsibility/failure_error.rb
 - lib/responsibility/initializer.rb
 - lib/responsibility/instance_methods.rb
 - lib/responsibility/version.rb
 - responsibility.gemspec
-homepage: http://erickbrower.com
+homepage: http://github.com/erickbrower/responsibility
 licenses: []
 metadata: {}
 post_install_message: