civil_service 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0155a0d0cbcf7c649725deedc1eb51e64ebe4f6a5f77ea4fbb6022768598afd
-  data.tar.gz: 82f50992961ad30130760307434340c180a459052fe4fa04c1bd295472be8a19
+  metadata.gz: 7852028628b07b8e1cb66afa9b93551f7b8d1c617ba3161adf20d05355e53da4
+  data.tar.gz: 414e35fa95fadd0b904c82699958279c029bc2047f7c21b46631beed0a80ae3f
 SHA512:
-  metadata.gz: ec1adf3b57089d4849ca5ce70b2ed8b9938ee03aabd55b3e0952ee0d3cb0734e87bac765794b023c83b80276312c1e754a3ce517a97af9eaed80ac1f94e242b0
-  data.tar.gz: ff3622cb3f407734e8adfe0b4f844d9db437f72a642b17669920339027bdd62cf1a0aaf27d11fa4e35bcfdb2c878572579f1066cb5ec25567a6d0253dc6f32ab
+  metadata.gz: 7752f150f11331751baf46f61c69cdf338196edc9ff5b4e86e42035c1d524c3d3bffa54d1c58a08f869b27ec05219cfe142c334a5582ed53ae4b8380e802fdd9
+  data.tar.gz: 10c2096c1ff5e6b967969d00be432d72c6a3811dbd7bdc6ee7d4b04fbea4da52676cb0f5f1344fadb65e842f9b3b494cbe3c7ec1370c269d4f613d22dfe31888

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# Version 2.1.0 - September 25, 2019
+
+* `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

data/Gemfile.lock

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

data/README.md

@@ -26,8 +26,10 @@ Or install it yourself as:
 
 CivilService::Service is really a pretty tiny class.  It does, however, have some opinions that create a potentially-useful abstraction for app developers:
 
-* When called, services always return a result object that responds to (at least) `#success?`, `#failure?`, and `#errors`.  This lets your code paths that call services be consistent and simple.  (If you want to return more information as a result of running the service, it's easy to define a custom result class for your service.)
+* When called, services always return a result object that responds to (at least) `#success?`, `#failure?`, `#errors`, and `#exception`.  This lets your code paths that call services be consistent and simple.  (If you want to return more information as a result of running the service, it's easy to define a custom result class for your service.)
+  * 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.
 
 ## Basic example
 

data/lib/civil_service/result.rb

@@ -1,6 +1,7 @@
 class CivilService::Result
   include ActiveModel::Model
-  attr_accessor :success, :errors, :exception
+  attr_accessor :success, :exception
+  attr_writer :errors
 
   def self.success(attributes = {})
     new(attributes.merge(success: true))
@@ -17,4 +18,8 @@ class CivilService::Result
   def failure?
     !success?
   end
+
+  def errors
+    @errors ||= ActiveModel::Errors.new(self)
+  end
 end

data/lib/civil_service/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: civil_service
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Nat Budin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel