civil_service 2.1.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7852028628b07b8e1cb66afa9b93551f7b8d1c617ba3161adf20d05355e53da4
-  data.tar.gz: 414e35fa95fadd0b904c82699958279c029bc2047f7c21b46631beed0a80ae3f
+  metadata.gz: 3cc309b95109e1703e10facefa160b6b3ec0d2c9cdeecc55c4d7fcca4fd3b788
+  data.tar.gz: bd935e564c4170b464e0fc5a577d885201c4a506f57bd5dd67ca69ceb5f5de5a
 SHA512:
-  metadata.gz: 7752f150f11331751baf46f61c69cdf338196edc9ff5b4e86e42035c1d524c3d3bffa54d1c58a08f869b27ec05219cfe142c334a5582ed53ae4b8380e802fdd9
-  data.tar.gz: 10c2096c1ff5e6b967969d00be432d72c6a3811dbd7bdc6ee7d4b04fbea4da52676cb0f5f1344fadb65e842f9b3b494cbe3c7ec1370c269d4f613d22dfe31888
+  metadata.gz: 10fbcc6182d07401c5e13580246511f9b8d9de9724bf049e21e0b343dee7b147dd2447ad1b58660488366dd892e05cfd5a2dba30dfeb2bf02d7d526117f09316
+  data.tar.gz: cb07f3d6487e639cac8c0645dc2b316a0ef017986e7d3bea0e0eaef66e66f37241b34d08989f2c558e737a549afba2e8d8c0dd49ca9cdc642c7af9c0d7914578

data/CHANGELOG.md

@@ -1,12 +1,36 @@
+# Version 2.4.0 - January 15, 2021
+
+- `#call`, `#call_and_raise`, and `#call!` now accept an optional keyword parameter called `validate`. This will
+  skip validations if passed `false`. (`true` is the default value.)
+- `#call!` now takes advantage of the `validate:` parameter internally to avoid running validations twice.
+
+# Version 2.3.0 - April 3, 2020
+
+- `#call!` now raises the underlying exception if the service threw an exception,
+  rather than hiding it inside a `CivilService::ServiceFailure`.
+
+# Version 2.2.1 - October 4, 2019
+
+- `CivilService::MultiResultService::MultiResult#exception` now checks the underlying exception on
+  the root result object, in case the service threw an exception.
+
+# Version 2.2.0 - September 26, 2019
+
+- Services now have a new `#call_and_raise` method, which will return a result object on failure
+  but will raise exceptions that are thrown inside the service call (effectively, the behavior of
+  `#call` in CivilService 1.0.0).
+- Added a new mixin called `CivilService::MultiResultService`, which allows creating services whose
+  results are composed of multiple results that are aggregated together.
+
 # Version 2.1.0 - September 25, 2019
 
-* `CivilService::Result#errors` now always returns an Errors object even if it hasn't been
+- `CivilService::Result#errors` now always returns an Errors object even if it hasn't been
   explicitly set.
 
 # Version 2.0.0 - June 26, 2019
 
-* BREAKING CHANGE: The behavior of `CivilService::Service#call` has changed when exceptions are
-  raised inside the service.  The `call` method will now catch the exception and return a failing
+- BREAKING CHANGE: The behavior of `CivilService::Service#call` has changed when exceptions are
+  raised inside the service. The `call` method will now catch the exception and return a failing
   result object, with the exception message as an error on `:base`.
 
   The behavior of `call!` has not changed: a failing result will be raised as a
@@ -17,8 +41,9 @@
   will (almost) never raise an exception, whereas `call!` can raise an exception.
 
   The exception to this rule (pun intended, always intend your puns) is that `call` will not catch
-  exceptions that don't inherit from `StandardError`, such as `SystemExit`.  See
+  exceptions that don't inherit from `StandardError`, such as `SystemExit`. See
   [Honeybadger's explanation](https://www.honeybadger.io/blog/a-beginner-s-guide-to-exceptions-in-ruby/)
   of why this is a good idea.
-* `CivilService::Result` now has an additional attribute called `exception`, which can be used to
+
+- `CivilService::Result` now has an additional attribute called `exception`, which can be used to
   retrieve an exception thrown inside a `call` method.

data/Gemfile.lock

@@ -1,27 +1,26 @@
 PATH
   remote: .
   specs:
-    civil_service (2.1.0)
+    civil_service (2.4.0)
       activemodel (>= 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activesupport (5.2.3)
+    activemodel (7.0.0)
+      activesupport (= 7.0.0)
+    activesupport (7.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.1.5)
-    i18n (1.6.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.9)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
-    rake (10.5.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    rake (13.0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
 
 PLATFORMS
   ruby
@@ -30,7 +29,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   civil_service!
   minitest (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -1,10 +1,10 @@
 # CivilService
 
-[![Build Status](https://travis-ci.org/neinteractiveliterature/civil_service.svg?branch=master)](https://travis-ci.org/neinteractiveliterature/civil_service)
+[![Build Status](https://travis-ci.org/actblue/civil_service.svg?branch=master)](https://travis-ci.org/actblue/civil_service)
 
 CivilService is a tiny framework for [service objects in Rails apps](https://hackernoon.com/service-objects-in-ruby-on-rails-and-you-79ca8a1c946e). With CivilService, you can use ActiveModel validations to do pre-flight checks before the service runs, and create your own result object classes to capture the results of complex operations.
 
-CivilService was extracted from [Intercode](https://github.com/neinteractiveliterature/intercode), a web app for convention organizers and participants.
+CivilService was extracted from [Intercode](https://github.com/neinteractiveliterature/intercode), a web app for convention organizers and participants.  It is now maintained by ActBlue.
 
 ## Installation
 
@@ -30,6 +30,7 @@ CivilService::Service is really a pretty tiny class.  It does, however, have som
   * What's the difference between `#errors` and `#exception`?  `#errors` is an instance of `ActiveModel::Errors`, whereas `#exception` is an instance of an exception class (it's only present if an exception was raised inside the service call).  If an exception is raised, the service result will respond true to `#failure?`, false to `#success?`, and the exception's message will be added to `#errors`, so most of the time you can ignore `#exception` - but it's there in case you need to dig into the details.
 * Services include `ActiveModel::Validations` so they can easily do pre-flight checks.  That means you can call `my_service.valid?` and `my_service.errors` just like you can for a model, and it also means that the service will fail if it's not valid.
 * In addition to `#call`, which always returns a result object, services have a `#call!` method, which will raise a `CivilService::ServiceFailure` exception if the service fails, or pass through an exception if one is raised inside the service call.  This might be easier in some workflows; for example, it will cause a rollback if used inside an ActiveRecord transaction block.
+* Finally, there's a third variant: `#call_and_raise`, which will re-raise any exceptions that occurred during the service execution, but will return a regular result object on failure.
 
 ## Basic example
 
@@ -87,4 +88,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/neinteractiveliterature/civil_service.
+Bug reports and pull requests are welcome on GitHub at https://github.com/actblue/civil_service.

data/civil_service.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activemodel", ">= 3.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/civil_service/multi_result_service.rb

@@ -0,0 +1,44 @@
+module CivilService::MultiResultService
+  extend ActiveSupport::Concern
+
+  class MultiResult < CivilService::Result
+    attr_accessor :results
+
+    def success?
+      (results || []).compact.all?(&:success)
+    end
+
+    def errors
+      errors = ActiveModel::Errors.new(self)
+      (results || []).compact.each do |result|
+        next if result.success?
+        result.errors.each do |attribute, error|
+          errors.add(attribute, error)
+        end
+      end
+      errors
+    end
+
+    def exception
+      super || (results || []).compact.map(&:exception).compact.first
+    end
+  end
+
+  def multi_result(results)
+    self.class.result_class.new(results: results)
+  end
+
+  class_methods do
+    def result_class=(result_class)
+      unless result_class <= CivilService::MultiResultService::MultiResult
+        raise 'In a MultiResultService, result_class must be a MultiResult'
+      end
+
+      @result_class = result_class
+    end
+  end
+
+  included do
+    self.result_class = CivilService::MultiResultService::MultiResult
+  end
+end

data/lib/civil_service/service.rb

@@ -12,8 +12,8 @@ class CivilService::Service
     end
   end
 
-  def call
-    unless self.class.validate_manually
+  def call(validate: true)
+    if validate && !self.class.validate_manually
       return failure(errors) unless valid?
     end
 
@@ -25,12 +25,21 @@ class CivilService::Service
     end
   end
 
-  def call!
-    unless self.class.validate_manually
+  def call_and_raise(validate: true)
+    result = call(validate: validate)
+    if result.exception
+      raise result.exception, result.exception.message, result.exception.backtrace
+    end
+
+    result
+  end
+
+  def call!(validate: true)
+    if validate && !self.class.validate_manually
       raise CivilService::ServiceFailure.new(self, failure(errors)) unless valid?
     end
 
-    result = inner_call
+    result = call_and_raise(validate: false) # we already just did the validation step if needed
     raise CivilService::ServiceFailure.new(self, result) if result.failure?
     result
   end

data/lib/civil_service/version.rb

@@ -1,3 +1,3 @@
 module CivilService
-  VERSION = "2.1.0"
+  VERSION = '2.4.0'
 end

data/lib/civil_service.rb

@@ -3,3 +3,4 @@ require "active_model"
 require "civil_service/result"
 require "civil_service/service_failure"
 require "civil_service/service"
+require "civil_service/multi_result_service"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: civil_service
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Nat Budin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,7 @@ files:
 - bin/setup
 - civil_service.gemspec
 - lib/civil_service.rb
+- lib/civil_service/multi_result_service.rb
 - lib/civil_service/result.rb
 - lib/civil_service/service.rb
 - lib/civil_service/service_failure.rb
@@ -95,7 +96,7 @@ files:
 homepage: https://github.com/neinteractiveliterature/civil_service
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A tiny service object framework for Rails apps
 test_files: []