service_pattern 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8d475628b9f7d75075a9069a45e64849402685d7
-  data.tar.gz: 06c1e5aa4f668b258a753503c74edaaa30dcf858
+SHA256:
+  metadata.gz: 8ba006abbb363e6e905b04bc28d034d3ce3500a1972569796b3a4535d399f2a5
+  data.tar.gz: d6843c0cba4fcfe46ea34dc4b7e650a9356566a4e4c6ce2703234a3f44b88ca9
 SHA512:
-  metadata.gz: ec2869750e398a401e478bc755f8d1a351f1264ffa5be853e5e79bf0441bc23f11bf4f0abd7dd5446ed222a16e7eda9148d049df013d0a0ffac7557d6c8e3ed6
-  data.tar.gz: a77b1ad0406d8693ab31397ba307b306f627120baf0dd9ee09ca7eccbd68987b72a9b53371c0aa965797275b00bab5ef1004c3ba0dee4e80ef62d67c0c4f7a9c
+  metadata.gz: 4f0069948ebd6189ab2915d74b5a5ef299a61628082b58f8913ec5224746322d4f354542b4ece26d8672d58b38668651bc95b1ab660b2e4cf55bbbb0d2130393
+  data.tar.gz: 1c5dc20138d2d26a3e3b2e93d292861fd981c4fe7afc2a984dc09e48fe46dfd51ac71bd7e9030507a5d4998ff93a9c03c897173a96ef594f2aa410fb524a6b64

data/README.md

@@ -21,9 +21,9 @@ end
 Create your first service in "app/services/users/activator_service":
 ```ruby
 class Users::ActivatorService < ApplicationService
-  def execute!
+  def execute
     User.all.find_each(&:activate!)
-    ServicePattern::Response.new(success: true)
+    succeed!
   end
 end
 ```
@@ -33,11 +33,52 @@ Then call it like this:
 response = Users::ActivatorService.()
 
 if response.success?
-  puts "Wee"
+  puts "Result: #{response.result}"
 else
-  puts "Errors: #{result.errors.join(". ")}"
+  puts "Errors: #{response.errors.join(". ")}"
 end
 ```
 
+Or like this:
+```ruby
+response = Users::ActivatorService.execute()
+
+if response.success?
+  puts "Result: #{response.result}"
+else
+  puts "Errors: #{response.errors.join(". ")}"
+end
+```
+
+Or raise an error if it fails and return the result directly:
+```ruby
+result = Users::ActivatorService.execute!
+
+puts "Result: #{result}"
+```
+
+### Returning results
+
+You can also return a result, which will automatically make the response successfull:
+```ruby
+succeed!(message: "Hello world")
+```
+
+You can then retrieve it like this:
+```ruby
+response = Users::ActivatorService.()
+puts "Result: #{response.result}"
+```
+
+You can fail a service like this
+```ruby
+fail! "Hello world"
+```
+
+Or with multiple errors:
+```ruby
+fail! ["Hello world", "Hello again"]
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/service_pattern.rb

@@ -1,7 +1,8 @@
 module ServicePattern
   path = "#{File.dirname(__FILE__)}/service_pattern"
 
-  autoload :CantExecuteError, "#{path}/cant_execute_error"
+  autoload :FailError, "#{path}/fail_error"
+  autoload :FailedError, "#{path}/failed_error"
   autoload :Response, "#{path}/response"
   autoload :Service, "#{path}/service"
 end

data/lib/service_pattern/fail_error.rb

@@ -0,0 +1,8 @@
+class ServicePattern::FailError
+  attr_reader :message, :type
+
+  def initialize(message:, type: nil)
+    @message = message
+    @type = type
+  end
+end

data/lib/service_pattern/failed_error.rb

@@ -0,0 +1,11 @@
+class ServicePattern::FailedError < RuntimeError
+  attr_accessor :errors
+
+  def error_messages
+    @error_messages ||= @errors.map(&:message)
+  end
+
+  def error_types
+    @error_types ||= @errors.map(&:type)
+  end
+end

data/lib/service_pattern/response.rb

@@ -1,19 +1,18 @@
 class ServicePattern::Response
   attr_reader :errors, :result
 
-  def initialize(args)
-    @errors = args[:errors] || []
-    @result = args[:result]
+  def initialize(errors: [], result: nil)
+    @errors = ServicePattern::Service.convert_errors(errors)
+    @result = result
+    @success = !errors || errors.empty?
+  end
+
+  def error_messages
+    @error_messages ||= @errors.map(&:message)
+  end
 
-    if args.key?(:success)
-      @success = args.fetch(:success)
-    elsif args.key?(:errors) && @errors.any?
-      @success = false
-    elsif @result
-      @success = true
-    else
-      raise "Couldn't figure out if it was a success"
-    end
+  def error_types
+    @error_types ||= @errors.map(&:type).reject(&:blank?)
   end
 
   def success?

data/lib/service_pattern/service.rb

@@ -1,29 +1,71 @@
 class ServicePattern::Service
-  def self.call(*args)
-    service = new(*args)
-
-    begin
-      can_execute_response = service.can_execute?
-      return can_execute_response unless can_execute_response.success?
-      service.execute!
-    rescue => e
-      ServicePattern::Response.new(errors: ["#{e.class.name}: #{e.message}"], success: false)
-    end
+  # 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)
+
+    can_execute_response = service.can_execute?
+    ServicePattern::Service.fail!(can_execute_response.errors) unless can_execute_response.success?
+
+    service.execute
+  end
+
+  def self.call(*args, &blk)
+    execute(*args, &blk)
   end
 
-  def self.execute!(*args)
-    service = new(*args)
+  def self.execute(*args, &blk)
+    service = new(*args, &blk)
 
     can_execute_response = service.can_execute?
-    raise ServicePattern::CantExecuteError, can_execute_response.errors.join(". ") unless can_execute_response.success?
-    service.execute!
+    return can_execute_response unless can_execute_response.success?
+
+    service.execute
+  rescue ServicePattern::FailedError => e
+    ServicePattern::Response.new(errors: e.errors)
+  end
+
+  def self.execute!(*args, &blk)
+    service = new(*args, &blk)
+    can_execute_response = service.can_execute?
+    ServicePattern::Service.fail!(can_execute_response.errors) unless can_execute_response.success?
+    response = service.execute
+    ServicePattern::Service.fail!(response.errors) unless response.success?
+    response.result
+  end
+
+  def self.convert_errors(errors)
+    errors = [errors] unless errors.is_a?(Array)
+    errors.map do |error|
+      error = ServicePattern::FailError.new(message: error) unless error.is_a?(ServicePattern::FailError)
+      error
+    end
+  end
+
+  def self.fail!(errors)
+    errors = convert_errors(errors)
+    error_messages = errors.map(&:message)
+
+    error = ServicePattern::FailedError.new(error_messages.join(". "))
+    error.errors = errors
+
+    raise error
   end
 
   def can_execute?
-    ServicePattern::Response.new(success: true)
+    succeed!
+  end
+
+  def execute(*_args)
+    raise NoMethodError, "You should implement the `execute` method on your service"
+  end
+
+  def fail!(errors, type: nil)
+    errors = [ServicePattern::FailError.new(message: errors, type: type)] if type
+
+    ServicePattern::Service.fail!(errors)
   end
 
-  def execute!(*_args)
-    raise NoMethodError, "You should implement the `execute!` method on your service"
+  def succeed!(result = nil)
+    ServicePattern::Response.new(result: result)
   end
 end

data/lib/service_pattern/version.rb

@@ -1,3 +1,3 @@
 module ServicePattern
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.8".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_pattern
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-21 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies: []
 description: ServicePattern for Ruby on Rails.
 email:
@@ -21,7 +21,8 @@ files:
 - README.md
 - Rakefile
 - lib/service_pattern.rb
-- lib/service_pattern/cant_execute_error.rb
+- lib/service_pattern/fail_error.rb
+- lib/service_pattern/failed_error.rb
 - lib/service_pattern/response.rb
 - lib/service_pattern/service.rb
 - lib/service_pattern/version.rb
@@ -45,8 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: ServicePattern for Ruby on Rails.

data/lib/service_pattern/cant_execute_error.rb

@@ -1 +0,0 @@
-class ServicePattern::CantExecuteError < RuntimeError; end