service_pattern 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb37f2c1aa001cef4abdfe0937e15b82c52bb845d44c9527851bc6d770bfd44d
-  data.tar.gz: 52344b2c5450cb137bcb743c4fe24bf543e5c22c8d61a831a063d5a4b5de7829
+  metadata.gz: cdb56345fc9435ba6661951aa8d3cc5176022c2767881b340b6551c94c8e4caa
+  data.tar.gz: f9fc3f3ae0262dfa6c0ff58505cce750070074bdf9cb8d52ed826695ec3eb46e
 SHA512:
-  metadata.gz: 432e00eceea33e9f3335bcc00a5fc44f153ddbf925e11b853d3e6c698607bac1f090a6060eaa88875c5535d86863212409426b28a7ae5a1c66ad42991ceae1ca
-  data.tar.gz: a072a0f461b12c9e09e7a9d2c80ee593015434797cb6da32ef7825f0ab1c834e6d77caf22cc36ad264f52950980931cef6b7a6de3930a4d53280b2ef563673aa
+  metadata.gz: 5466648e3d09f9add63cd3205a94f4f27e9d732a322e84eba8982f16d8d448d745669fcdbd38ddb04a5ac29663491129ef7ef315589b37c5a5e43fe118f94563
+  data.tar.gz: b1dfe83d17699a4eb998a7a85614e735979443c2baedd27d51d65549a2896e4377b65c150c6b0a55889d194d6d25c7212fe6ea90a8db31ab62f9a23393d31b4d

data/README.md

@@ -23,7 +23,7 @@ Create your first service in "app/services/users/activator_service":
 class Users::ActivatorService < ApplicationService
   def execute
     User.all.find_each(&:activate!)
-    ServicePattern::Response.new(success: true)
+    succeed!
   end
 end
 ```
@@ -33,17 +33,35 @@ 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
-ServicePattern::Response.new(result: {message: "Hello world"})
+succeed!(message: "Hello world")
 ```
 
 You can then retrieve it like this:
@@ -52,5 +70,15 @@ 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,6 +1,7 @@
 module ServicePattern
   path = "#{File.dirname(__FILE__)}/service_pattern"
 
+  autoload :FailError, "#{path}/fail_error"
   autoload :FailedError, "#{path}/failed_error"
   autoload :Response, "#{path}/response"
   autoload :Service, "#{path}/service"

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

@@ -1 +1,11 @@
-class ServicePattern::FailedError < RuntimeError; end
+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

@@ -4,9 +4,9 @@ class ServicePattern::Service
     service = new(*args, &blk)
 
     can_execute_response = service.can_execute?
-    raise ServicePattern::FailedError, can_execute_response.errors.join(". ") unless can_execute_response.success?
+    ServicePattern::Service.fail!(can_execute_response.errors) unless can_execute_response.success?
 
-    service.execute
+    service.perform
   end
 
   def self.call(*args, &blk)
@@ -15,27 +15,60 @@ class ServicePattern::Service
 
   def self.execute(*args, &blk)
     service = new(*args, &blk)
+    service.execute
+  end
 
+  def self.execute!(*args, &blk)
+    service = new(*args, &blk)
     can_execute_response = service.can_execute?
-    return can_execute_response unless can_execute_response.success?
+    ServicePattern::Service.fail!(can_execute_response.errors) unless can_execute_response.success?
+    response = service.perform
+    ServicePattern::Service.fail!(response.errors) unless response.success?
+    response.result
+  end
 
-    service.execute
-  rescue ServicePattern::FailedError => e
-    ServicePattern::Response.new(errors: [e.message])
+  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.execute!(*args, &blk)
-    response = execute(*args, &blk)
-    raise ServicePattern::FailedError, response.errors.join(". ") unless response.success?
+  def self.fail!(errors)
+    errors = convert_errors(errors)
+    error_messages = errors.map(&:message)
 
-    response.result
+    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
+    can_execute_response = can_execute?
+    return can_execute_response unless can_execute_response.success?
+
+    perform
+  rescue ServicePattern::FailedError => e
+    ServicePattern::Response.new(errors: e.errors)
+  end
+
+  def perform(*_args)
+    raise NoMethodError, "You should implement the `perform` 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.4".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_pattern
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies: []
 description: ServicePattern for Ruby on Rails.
 email:
@@ -21,6 +21,7 @@ files:
 - README.md
 - Rakefile
 - lib/service_pattern.rb
+- lib/service_pattern/fail_error.rb
 - lib/service_pattern/failed_error.rb
 - lib/service_pattern/response.rb
 - lib/service_pattern/service.rb
@@ -38,7 +39,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="