Class: FunctionalLightService::Context
Overview
rubocop:disable Metrics/ClassLength
Defined Under Namespace
Classes: ExpectedKeyVerifier, KeyVerifier, PromisedKeyVerifier, ReservedKeysVerifier
Constant Summary
Prelude::Option::None, Prelude::Option::Option
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
#Failure, #Success, #try!
#None, #Option, #Some
Constructor Details
#initialize(context = {}, outcome = Success(:message => '', :error => nil)) ⇒ Context
rubocop:disable Lint/MissingSuper
9
10
11
12
13
14
|
# File 'lib/functional-light-service/context.rb', line 9
def initialize(context = {},
outcome = Success(:message => '', :error => nil))
@outcome = outcome
@skip_remaining = false
context.to_hash.each { |k, v| self[k] = v }
end
|
Instance Attribute Details
#current_action ⇒ Object
Returns the value of attribute current_action.
6
7
8
|
# File 'lib/functional-light-service/context.rb', line 6
def current_action
@current_action
end
|
Returns the value of attribute outcome.
6
7
8
|
# File 'lib/functional-light-service/context.rb', line 6
def outcome
@outcome
end
|
Class Method Details
.make(context = {}) ⇒ Object
rubocop:enable Lint/MissingSuper
17
18
19
20
21
22
23
24
25
26
27
|
# File 'lib/functional-light-service/context.rb', line 17
def self.make(context = {})
unless context.is_a?(Hash) || context.is_a?(FunctionalLightService::Context)
msg = 'Argument must be Hash or FunctionalLightService::Context'
raise ArgumentError, msg
end
context = new(context) unless context.is_a?(Context)
context.assign_aliases(context.delete(:_aliases)) if context[:_aliases]
context
end
|
Instance Method Details
125
126
127
128
|
# File 'lib/functional-light-service/context.rb', line 125
def [](key)
key = aliases.key(key) || key
return super(key)
end
|
#add_to_context(values) ⇒ Object
29
30
31
|
# File 'lib/functional-light-service/context.rb', line 29
def add_to_context(values)
merge! values
end
|
121
122
123
|
# File 'lib/functional-light-service/context.rb', line 121
def aliases
@aliases ||= {}
end
|
#assign_aliases(aliases) ⇒ Object
113
114
115
116
117
118
119
|
# File 'lib/functional-light-service/context.rb', line 113
def assign_aliases(aliases)
@aliases = aliases
aliases.each_pair do |key, key_alias|
self[key_alias] = self[key]
end
end
|
#define_accessor_methods_for_keys(keys) ⇒ Object
102
103
104
105
106
107
108
109
110
111
|
# File 'lib/functional-light-service/context.rb', line 102
def define_accessor_methods_for_keys(keys)
return if keys.nil?
keys.each do |key|
next if respond_to?(key.to_sym)
define_singleton_method(key.to_s) { fetch(key) }
define_singleton_method("#{key}=") { |value| self[key] = value }
end
end
|
#error_code ⇒ Object
54
55
56
|
# File 'lib/functional-light-service/context.rb', line 54
def error_code
@outcome.value[:error]
end
|
#fail!(message = nil, options_or_error_code = {}) ⇒ Object
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
# File 'lib/functional-light-service/context.rb', line 65
def fail!(message = nil, options_or_error_code = {})
options_or_error_code ||= {}
if options_or_error_code.is_a?(Hash)
error_code = options_or_error_code.delete(:error_code)
options = options_or_error_code
else
error_code = options_or_error_code
options = {}
end
message = Configuration.localization_adapter.failure(message,
current_action,
options)
@outcome = Failure(:message => message, :error => error_code)
end
|
#fail_and_return!(*args) ⇒ Object
83
84
85
86
|
# File 'lib/functional-light-service/context.rb', line 83
def fail_and_return!(*args)
fail!(*args)
throw(:jump_when_failed)
end
|
#fail_with_rollback!(message = nil, error_code = nil) ⇒ Object
88
89
90
91
|
# File 'lib/functional-light-service/context.rb', line 88
def fail_with_rollback!(message = nil, error_code = nil)
fail!(message, error_code)
raise FailWithRollbackError
end
|
#failure? ⇒ Boolean
37
38
39
|
# File 'lib/functional-light-service/context.rb', line 37
def failure?
@outcome.failure?
end
|
#fetch(key, default = nil, &blk) ⇒ Object
130
131
132
133
134
135
136
|
# File 'lib/functional-light-service/context.rb', line 130
def fetch(key, default = nil, &blk)
self[key] ||= if block_given?
super(key, &blk)
else
super
end
end
|
138
139
140
141
|
# File 'lib/functional-light-service/context.rb', line 138
def inspect
"#{self.class}(#{self}, success: #{success?}, message: #{check_nil(message)}, error_code: " \
"#{check_nil(error_code)}, skip_remaining: #{@skip_remaining}, aliases: #{@aliases})"
end
|
50
51
52
|
# File 'lib/functional-light-service/context.rb', line 50
def message
@outcome.value[:message]
end
|
#reset_skip_remaining! ⇒ Object
45
46
47
48
|
# File 'lib/functional-light-service/context.rb', line 45
def reset_skip_remaining!
@outcome = Success(:message => '', :error => nil)
@skip_remaining = false
end
|
#skip_remaining!(message = nil) ⇒ Object
93
94
95
96
|
# File 'lib/functional-light-service/context.rb', line 93
def skip_remaining!(message = nil)
@outcome = Success(:message => message)
@skip_remaining = true
end
|
#skip_remaining? ⇒ Boolean
41
42
43
|
# File 'lib/functional-light-service/context.rb', line 41
def skip_remaining?
@skip_remaining
end
|
#stop_processing? ⇒ Boolean
98
99
100
|
# File 'lib/functional-light-service/context.rb', line 98
def stop_processing?
failure? || skip_remaining?
end
|
#succeed!(message = nil, options = {}) ⇒ Object
58
59
60
61
62
63
|
# File 'lib/functional-light-service/context.rb', line 58
def succeed!(message = nil, options = {})
message = Configuration.localization_adapter.success(message,
current_action,
options)
@outcome = Success(:message => message)
end
|
#success? ⇒ Boolean
33
34
35
|
# File 'lib/functional-light-service/context.rb', line 33
def success?
@outcome.success?
end
|