Class: ServicePattern::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/service_pattern/service.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.call(*args, **opts, &blk) ⇒ Object 



12
13
14
 
# File 'lib/service_pattern/service.rb', line 12

def self.call(*args, **opts, &blk)
  execute(*args, **opts, &blk)
end

.chain(*args, **opts, &blk) ⇒ Object

The same as execute but doesn’t catch FailedError so they are passed on to the parent service call



3
4
5
6
7
8
9
10
 
# File 'lib/service_pattern/service.rb', line 3

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?

  service.perform
end

.convert_errors(errors) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/service_pattern/service.rb', line 24

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

.execute(*args, **opts, &blk) ⇒ Object 



16
17
18
 
# File 'lib/service_pattern/service.rb', line 16

def self.execute(*args, **opts, &blk)
  new(*args, **opts, &blk).execute
end

.execute!(*args, **opts, &blk) ⇒ Object 



20
21
22
 
# File 'lib/service_pattern/service.rb', line 20

def self.execute!(*args, **opts, &blk)
  new(*args, **opts, &blk).execute!
end

.fail!(errors) ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/service_pattern/service.rb', line 32

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

Instance Method Details

#can_execute? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/service_pattern/service.rb', line 42

def can_execute?
  succeed!
end

#execute ⇒ Object 



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/service_pattern/service.rb', line 46

def execute
  can_execute_response = can_execute?
  return can_execute_response unless can_execute_response.success?

  response = perform
  ServicePattern::Response.check_response!(self, response)
  response
rescue ServicePattern::FailedError => e
  ServicePattern::Response.new(errors: e.errors)
end

#execute! ⇒ Object 



57
58
59
60
61
62
63
64
 
# File 'lib/service_pattern/service.rb', line 57

def execute!
  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

#fail!(errors, type: nil) ⇒ Object 



70
71
72
73
74
 
# File 'lib/service_pattern/service.rb', line 70

def fail!(errors, type: nil)
  errors = [ServicePattern::FailError.new(message: errors, type: type)] if type

  ServicePattern::Service.fail!(errors)
end

#perform(*_args) ⇒ Object

Raises:

  • (NoMethodError) 


66
67
68
 
# File 'lib/service_pattern/service.rb', line 66

def perform(*_args)
  raise NoMethodError, "You should implement the `perform` method on your service"
end

#succeed!(result = nil) ⇒ Object 



76
77
78
 
# File 'lib/service_pattern/service.rb', line 76

def succeed!(result = nil)
  ServicePattern::Response.new(result: result)
end