service_pattern 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a0cc423721d1d11a5e300f3719b01dcd3eba89dcad83d97cc168372acc01593
-  data.tar.gz: de7dcffe6dd6ac6bda7d5195e75622ca1bda3c37b3cca394ca11e2a827445da6
+  metadata.gz: 96981ef35e60c1b498368709d6471d5c880538e0acf3eade1b74e533323fb502
+  data.tar.gz: 01b10dfe476c603e06a3a17bd5a875d2afbaf536ec4622a4ab885a5a063d5498
 SHA512:
-  metadata.gz: c304984c8080f2234c44cb07f96566f8830ca7a17e1564f76f7d5f52183dd0317c4584dc36a990ae6a7a97f77e1719d8fcb3fb36463be9e62c694d6e69521210
-  data.tar.gz: 0a168abccb3b302f15987e67515214e16565e4ba654f8c7079131eeeb2cbbb2ddeb3976ce4b0645215278df8c0f180feeaba9f36eb511d796624f22823a79eaa
+  metadata.gz: 6f7203eed9b42ee98a5cc9712be296da4983cd2aad28cd2dde4b1679cc1d41db4e3406f8f7e63f3f5b9deb2877c27c2f4d543378f552bfc011125f67ef46aefa
+  data.tar.gz: 6996d0eb63b2a25ad46f4ca9dad580b2acd750d9f87f98afb0e2123fd76c1e46022095a6e498d3f6867969246cb23ddbaeb93ec6b2fb27b749b335ed3bfbce7e

data/README.md

@@ -35,7 +35,7 @@ response = Users::ActivatorService.()
 if response.success?
   puts "Result: #{response.result}"
 else
-  puts "Errors: #{response.errors.join(". ")}"
+  puts "Errors: #{response.error_messages.join(". ")}"
 end
 ```
 
@@ -46,10 +46,17 @@ response = Users::ActivatorService.execute()
 if response.success?
   puts "Result: #{response.result}"
 else
-  puts "Errors: #{response.errors.join(". ")}"
+  puts "Errors: #{response.error_messages.join(". ")}"
+  puts "Custom error? #{response.error_type?(:custom_error) ? "Yes" : "No"}"
+  puts "Only custom error? #{response.only_error_type?(:custom_error) ? "Yes" : "No"}"
 end
 ```
 
+Raise a normal service error unless error is of a specific type.
+```ruby
+response.raise_error! unless response.only_error_type?(:custom_error)
+```
+
 Or raise an error if it fails and return the result directly:
 ```ruby
 result = Users::ActivatorService.execute!
@@ -80,5 +87,10 @@ Or with multiple errors:
 fail! ["Hello world", "Hello again"]
 ```
 
+Or with error types:
+```ruby
+fail! "Hello world", type: :message
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/service_pattern/response.rb

@@ -1,6 +1,12 @@
 class ServicePattern::Response
   attr_reader :errors, :result
 
+  def self.check_response!(service, response)
+    return if response.is_a?(ServicePattern::Response)
+
+    raise ServicePattern::InvalidResponseError, "Expected a ServicePattern::Response from #{service.class.name} but it was instead: #{response.class.name}"
+  end
+
   def initialize(errors: [], result: nil)
     @errors = ServicePattern::Service.convert_errors(errors)
     @result = result
@@ -15,6 +21,23 @@ class ServicePattern::Response
     @error_types ||= @errors.map(&:type).reject(&:blank?)
   end
 
+  def error_type?(type)
+    error_types.include?(type)
+  end
+
+  def only_error_type?(type)
+    error_types.length == 1 && error_type?(type)
+  end
+
+  def raise_error!
+    return if errors.empty?
+
+    error = ServicePattern::FailedError.new(error_messages.join(". "))
+    error.errors = errors
+
+    raise error
+  end
+
   def success?
     @success
   end

data/lib/service_pattern/service.rb

@@ -1,7 +1,7 @@
 class ServicePattern::Service
   # The same as execute but doesn't catch FailedError so they are passed on to the parent service call
-  def self.chain(*args, &blk)
-    service = new(*args, &blk)
+  def self.chain(*args, **opts, &blk)
+    service = new(*args, **opts, &blk)
 
     can_execute_response = service.can_execute?
     ServicePattern::Service.fail!(can_execute_response.errors) unless can_execute_response.success?
@@ -9,16 +9,16 @@ class ServicePattern::Service
     service.perform
   end
 
-  def self.call(*args, &blk)
-    execute(*args, &blk)
+  def self.call(*args, **opts, &blk)
+    execute(*args, **opts, &blk)
   end
 
-  def self.execute(*args, &blk)
-    new(*args, &blk).execute
+  def self.execute(*args, **opts, &blk)
+    new(*args, **opts, &blk).execute
   end
 
-  def self.execute!(*args, &blk)
-    new(*args, &blk).execute!
+  def self.execute!(*args, **opts, &blk)
+    new(*args, **opts, &blk).execute!
   end
 
   def self.convert_errors(errors)
@@ -47,7 +47,9 @@ class ServicePattern::Service
     can_execute_response = can_execute?
     return can_execute_response unless can_execute_response.success?
 
-    perform
+    response = perform
+    ServicePattern::Response.check_response!(self, response)
+    response
   rescue ServicePattern::FailedError => e
     ServicePattern::Response.new(errors: e.errors)
   end
@@ -56,6 +58,7 @@ class ServicePattern::Service
     can_execute_response = can_execute?
     ServicePattern::Service.fail!(can_execute_response.errors) unless can_execute_response.success?
     response = perform
+    ServicePattern::Response.check_response!(self, response)
     ServicePattern::Service.fail!(response.errors) unless response.success?
     response.result
   end

data/lib/service_pattern/version.rb

@@ -1,3 +1,3 @@
 module ServicePattern
-  VERSION = "1.0.2".freeze
+  VERSION = "1.0.6".freeze
 end

data/lib/service_pattern.rb

@@ -1,4 +1,6 @@
 module ServicePattern
+  class InvalidResponseError < RuntimeError; end
+
   path = "#{File.dirname(__FILE__)}/service_pattern"
 
   autoload :FailError, "#{path}/fail_error"

metadata

@@ -1,15 +1,155 @@
 --- !ruby/object:Gem::Specification
 name: service_pattern
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.6
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
-dependencies: []
+date: 2022-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: best_practice_project
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ServicePattern for Ruby on Rails.
 email:
 - kaspernj@gmail.com
@@ -39,14 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: ServicePattern for Ruby on Rails.