Class: Micro::Case::Result
- Inherits:
-
Object
- Object
- Micro::Case::Result
show all
- Defined in:
- lib/micro/case/result.rb,
lib/micro/case/result/wrapper.rb,
lib/micro/case/result/transitions.rb
Defined Under Namespace
Classes: Transitions, Wrapper
Constant Summary
collapse
- @@transitions_enabled =
true
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(transitions_mapper = Transitions::MapEverything) ⇒ Result
Returns a new instance of Result.
24
25
26
27
28
29
30
31
32
33
34
|
# File 'lib/micro/case/result.rb', line 24
def initialize(transitions_mapper = Transitions::MapEverything)
enable_transitions = @@transitions_enabled
@__is_unknown = true
@__accumulated_data = {}
@__tracked_use_cases = Set.new
@__accessible_attributes = {}
@__transitions = enable_transitions ? [] : Kind::Empty::ARRAY
@__transitions_mapper = transitions_mapper if enable_transitions
end
|
Instance Attribute Details
#data ⇒ Object
Also known as:
value
Returns the value of attribute data.
20
21
22
|
# File 'lib/micro/case/result.rb', line 20
def data
@data
end
|
#type ⇒ Object
Returns the value of attribute type.
20
21
22
|
# File 'lib/micro/case/result.rb', line 20
def type
@type
end
|
#use_case ⇒ Object
Returns the value of attribute use_case.
20
21
22
|
# File 'lib/micro/case/result.rb', line 20
def use_case
@use_case
end
|
Class Method Details
.transitions_enabled? ⇒ Boolean
16
17
18
|
# File 'lib/micro/case/result.rb', line 16
def self.transitions_enabled?
@@transitions_enabled
end
|
Instance Method Details
#[](key) ⇒ Object
53
54
55
|
# File 'lib/micro/case/result.rb', line 53
def [](key)
data[key]
end
|
#__set__(is_success, data, type, use_case) ⇒ Object
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
# File 'lib/micro/case/result.rb', line 160
def __set__(is_success, data, type, use_case)
raise Error::InvalidResultType unless type.is_a?(Symbol)
raise Error::InvalidUseCase unless use_case.is_a?(::Micro::Case)
@__success, @type, @use_case = is_success, type, use_case
@data = FetchData.call(data).freeze
raise Micro::Case::Error::InvalidResult.new(is_success, type, use_case) unless @data
@__accumulated_data.merge!(@data)
use_case_attributes = Utils::Hashes.symbolize_keys(@use_case.attributes)
unless @__tracked_use_cases.member?(use_case_class = @use_case.class)
@__tracked_use_cases.add(use_case_class)
__update_accessible_attributes(use_case_attributes)
end
__set_transition(use_case_attributes) unless @__transitions.frozen?
self
end
|
#__set_accessible_attributes__(arg) ⇒ Object
185
186
187
188
189
190
191
192
|
# File 'lib/micro/case/result.rb', line 185
def __set_accessible_attributes__(arg)
return arg unless arg.is_a?(Hash)
attributes = Utils::Hashes.symbolize_keys(arg)
__update_accessible_attributes(attributes)
__fetch_accessible_attributes
end
|
#accessible_attributes ⇒ Object
85
86
87
|
# File 'lib/micro/case/result.rb', line 85
def accessible_attributes
@__accessible_attributes.keys
end
|
#failure? ⇒ Boolean
77
78
79
|
# File 'lib/micro/case/result.rb', line 77
def failure?
!success?
end
|
#inspect ⇒ Object
36
37
38
39
40
41
42
43
|
# File 'lib/micro/case/result.rb', line 36
def inspect
pretty_type = @__success ? 'Success' : 'Failure'
instance_info = '%s (%s) type=:%s data=%s' % [pretty_type, self.class, @type, data]
transitions_info = ' transitions=%d' % [@__transitions.size] if Micro::Case::Result.transitions_enabled?
"#<#{instance_info}#{transitions_info}>"
end
|
#key?(key) ⇒ Boolean
61
62
63
|
# File 'lib/micro/case/result.rb', line 61
def key?(key)
data.key?(key)
end
|
#on_exception(expected_exception = nil) ⇒ Object
111
112
113
114
115
116
117
118
119
120
121
|
# File 'lib/micro/case/result.rb', line 111
def on_exception(expected_exception = nil)
return self unless __failure_type?(:exception)
if !expected_exception || (Kind.is?(Exception, expected_exception) && data.fetch(:exception).is_a?(expected_exception))
@__is_unknown = false
yield(data, @use_case)
end
self
end
|
#on_failure(expected_type = nil) {|hook_data, @use_case| ... } ⇒ Object
100
101
102
103
104
105
106
107
108
109
|
# File 'lib/micro/case/result.rb', line 100
def on_failure(expected_type = nil)
return self unless __failure_type?(expected_type)
@__is_unknown = false
hook_data = expected_type.nil? ? self : data
yield(hook_data, @use_case)
self
end
|
#on_success(expected_type = nil) {|hook_data, @use_case| ... } ⇒ Object
89
90
91
92
93
94
95
96
97
98
|
# File 'lib/micro/case/result.rb', line 89
def on_success(expected_type = nil)
return self unless __success_type?(expected_type)
@__is_unknown = false
hook_data = expected_type.nil? ? self : data
yield(hook_data, @use_case)
self
end
|
#on_unknown {|_self, @use_case| ... } ⇒ Object
123
124
125
126
127
128
129
|
# File 'lib/micro/case/result.rb', line 123
def on_unknown
return self unless unknown?
yield(self, @use_case)
self
end
|
#slice(*keys) ⇒ Object
69
70
71
|
# File 'lib/micro/case/result.rb', line 69
def slice(*keys)
Utils::Hashes.slice(data, keys)
end
|
#success? ⇒ Boolean
73
74
75
|
# File 'lib/micro/case/result.rb', line 73
def success?
@__success
end
|
#then(use_case = nil, attributes = nil, &block) ⇒ Object
131
132
133
134
135
136
137
138
139
140
141
142
143
|
# File 'lib/micro/case/result.rb', line 131
def then(use_case = nil, attributes = nil, &block)
can_yield_self = respond_to?(:yield_self)
if block
raise INVALID_INVOCATION_OF_THE_THEN_METHOD if use_case
raise NotImplementedError if !can_yield_self
yield_self(&block)
else
return yield_self if !use_case && can_yield_self
return failure? ? self : __call_use_case(use_case, attributes)
end
end
|
#to_ary ⇒ Object
45
46
47
|
# File 'lib/micro/case/result.rb', line 45
def to_ary
[data, type]
end
|
#to_sym ⇒ Object
49
50
51
|
# File 'lib/micro/case/result.rb', line 49
def to_sym
@__success ? :success : :failure
end
|
#transitions ⇒ Object
149
150
151
|
# File 'lib/micro/case/result.rb', line 149
def transitions
@__transitions.dup
end
|
#unknown? ⇒ Boolean
81
82
83
|
# File 'lib/micro/case/result.rb', line 81
def unknown?
@__is_unknown
end
|
#value?(value) ⇒ Boolean
65
66
67
|
# File 'lib/micro/case/result.rb', line 65
def value?(value)
data.value?(value)
end
|
#values_at(*keys) ⇒ Object
57
58
59
|
# File 'lib/micro/case/result.rb', line 57
def values_at(*keys)
data.values_at(*keys)
end
|
#|(arg) ⇒ Object
145
146
147
|
# File 'lib/micro/case/result.rb', line 145
def |(arg)
failure? ? self : __call_use_case(arg)
end
|