service_pattern 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6787a4f53bfdd57a07123e7eced76fdce0857cd
-  data.tar.gz: 1dede4fdc6bfcd28b8fef48927f8d1362c0a0dfa
+SHA256:
+  metadata.gz: 77863da179021d925441d0bf4a64fe8756ce925c45262523e7e34ff35e03956b
+  data.tar.gz: 815cac6f2393f6f92181a14fd311c565d63069e96c9aebc3827c315fa24d2832
 SHA512:
-  metadata.gz: 1de0f2175621e1ab35333e41ce768bb0b44bc92468b0c5266faee84658bff910fa1fdceb766dcfe649b16a4711ced4c34b40569e9602c847d6706ac72f6b05f0
-  data.tar.gz: 5332d4b8173004adee2ba1e6061e793cf3c7ee39cee66b2cac2df390218260c63dddbd5204903e545b7622d7061e4dd799768e26dafc7630773389133a28cc0b
+  metadata.gz: 370ba577ae9fc3a77746e518502c71d872e22ee49ddab016124c1c3105a48b8cc6667e22ea4f9369f4224b9de298c3ff04940031eb86aeb1e8d9f8890fcb0289
+  data.tar.gz: a80e81f4419b97fa4721a747a180729484264635d4feff4edb572d5e4dabda6a11d86928d1ba5fb1fcf11c9bd94734d82c9449bce4c8ee7d762af3c5e47de19c

data/README.md

@@ -12,5 +12,73 @@ Add this line to your application's Gemfile:
 gem "service_pattern"
 ```
 
+Create an application service that your other services will enherit from in "app/services/application_service":
+```ruby
+class ApplicationService < ServicePattern::Service
+end
+```
+
+Create your first service in "app/services/users/activator_service":
+```ruby
+class Users::ActivatorService < ApplicationService
+  def execute
+    User.all.find_each(&:activate!)
+    succeed!
+  end
+end
+```
+
+Then call it like this:
+```ruby
+response = Users::ActivatorService.()
+
+if response.success?
+  puts "Result: #{response.result}"
+else
+  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 = 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,32 +1,68 @@
 class ServicePattern::Service
-  def self.call(*args)
-    service = new(*args)
+  # 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)
 
-    begin
-      can_execute_response = service.can_execute?
+    can_execute_response = service.can_execute?
+    ServicePattern::Service.fail!(can_execute_response.errors) unless can_execute_response.success?
 
-      puts "can_execute_response: #{can_execute_response.success?} (#{can_execute_response.errors})"
+    service.execute
+  end
 
-      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
+  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.fail!(errors)
+    errors = [errors] unless errors.is_a?(Array)
+    errors = errors.map do |error|
+      error = ServicePattern::FailError.new(message: error) unless error.is_a?(ServicePattern::FailError)
+      error
+    end
+
+    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.2".freeze
+  VERSION = "0.0.7".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_pattern
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2020-09-02 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