civil_service 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7852028628b07b8e1cb66afa9b93551f7b8d1c617ba3161adf20d05355e53da4
-  data.tar.gz: 414e35fa95fadd0b904c82699958279c029bc2047f7c21b46631beed0a80ae3f
+  metadata.gz: 4a4a50e4d4765b2e8805078eeca14e8e0adfba0bd5e04c855ff3aae3263d2542
+  data.tar.gz: 9bda59ba00a76044a5ba5989302e77ef8d6ece6eb68f0001e8d45f5a17c2bbb1
 SHA512:
-  metadata.gz: 7752f150f11331751baf46f61c69cdf338196edc9ff5b4e86e42035c1d524c3d3bffa54d1c58a08f869b27ec05219cfe142c334a5582ed53ae4b8380e802fdd9
-  data.tar.gz: 10c2096c1ff5e6b967969d00be432d72c6a3811dbd7bdc6ee7d4b04fbea4da52676cb0f5f1344fadb65e842f9b3b494cbe3c7ec1370c269d4f613d22dfe31888
+  metadata.gz: 227d0b3c5e2bff1e011ad42088b18308e6d46074a90acf8852585a22ec95ca51179be13692ed21ccbb53919e69324599496308101586b6afb7d3dff39b17d1d7
+  data.tar.gz: a8cd818e88f53583333832e6a9525e00d8b20a9898808068aae120dc02646ae8ff8e676ce944c18d13727c67c37f5e852be7bd2a8d49c7b944cdbaeb31828598

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    civil_service (2.1.0)
+    civil_service (2.2.0)
       activemodel (>= 3.0.0)
 
 GEM

data/README.md

@@ -4,7 +4,7 @@
 
 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/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"

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
+      (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

@@ -25,6 +25,15 @@ class CivilService::Service
     end
   end
 
+  def call_and_raise
+    result = call
+    if result.exception
+      raise result.exception, result.exception.message, result.exception.backtrace
+    end
+
+    result
+  end
+
   def call!
     unless self.class.validate_manually
       raise CivilService::ServiceFailure.new(self, failure(errors)) unless valid?

data/lib/civil_service/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: civil_service
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Nat Budin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2019-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -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