Class: FunctionalLightService::Context

Inherits:
Hash
  • Object
show all
Includes:
Prelude::Option, Prelude::Result
Defined in:
lib/functional-light-service/context.rb,
lib/functional-light-service/context/key_verifier.rb

Overview

rubocop:disable Metrics/ClassLength

Defined Under Namespace

Classes: ExpectedKeyVerifier, KeyVerifier, PromisedKeyVerifier, ReservedKeysVerifier

Constant Summary

Constants included from Prelude::Option

Prelude::Option::None, Prelude::Option::Option

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Prelude::Result

#Failure, #Success, #try!

Methods included from Prelude::Option

#None, #Option, #Some

Constructor Details

#initialize(context = {}, outcome = Success(:message => '', :error => nil)) ⇒ Context

rubocop:disable Lint/MissingSuper



13
14
15
16
17
18
19
 
# File 'lib/functional-light-service/context.rb', line 13

def initialize(context = {},
               outcome = Success(:message => '', :error => nil))
  @outcome = outcome
  @skip_remaining = false
  @skip_all_remaining = false
  context.to_hash.each { |k, v| self[k] = v }
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object 



143
144
145
146
147
148
 
# File 'lib/functional-light-service/context.rb', line 143

def method_missing(name, *args)
  accessor = @accessor_methods && @accessor_methods[name]
  return super unless accessor

  accessor[0] == :reader ? fetch(accessor[1]) : self[accessor[1]] = args.first
end

Instance Attribute Details

#current_action ⇒ Object

Returns the value of attribute current_action.



10
11
12
 
# File 'lib/functional-light-service/context.rb', line 10

def current_action
  @current_action
end

#organized_by ⇒ Object

Returns the value of attribute organized_by.



10
11
12
 
# File 'lib/functional-light-service/context.rb', line 10

def organized_by
  @organized_by
end

#outcome ⇒ Object (readonly)

Returns the value of attribute outcome.



9
10
11
 
# File 'lib/functional-light-service/context.rb', line 9

def outcome
  @outcome
end

Class Method Details

.make(context = {}) ⇒ Object

rubocop:enable Lint/MissingSuper



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/functional-light-service/context.rb', line 22

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

#[](key) ⇒ Object 



167
168
169
 
# File 'lib/functional-light-service/context.rb', line 167

def [](key)
  super(resolve_key(key))
end

#[]=(key, value) ⇒ Object 



171
172
173
 
# File 'lib/functional-light-service/context.rb', line 171

def []=(key, value)
  super(resolve_key(key), value)
end

#add_to_context(values) ⇒ Object 



34
35
36
 
# File 'lib/functional-light-service/context.rb', line 34

def add_to_context(values)
  merge! values
end

#aliases ⇒ Object 



163
164
165
 
# File 'lib/functional-light-service/context.rb', line 163

def aliases
  @aliases ||= {}
end

#assign_aliases(aliases) ⇒ Object 



154
155
156
157
158
159
160
161
 
# File 'lib/functional-light-service/context.rb', line 154

def assign_aliases(aliases)
  @aliases = aliases
  # Hash inverso precomputato: la risoluzione in lettura/scrittura
  # resta O(1) invece del reverse-scan di Hash#key
  @inverse_aliases = aliases.invert

  self
end

#define_accessor_methods_for_keys(keys) ⇒ Object

Registra le chiavi come accessor consentiti: la lettura/scrittura passa da method_missing con whitelist. Rispetto a define_singleton_method non materializza una singleton class per ogni context (audit, finding 3.3)



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/functional-light-service/context.rb', line 122

def define_accessor_methods_for_keys(keys)
  return if keys.nil?

  @accessor_methods ||= {}
  keys.each do |key|
    key = key.to_sym
    next if @accessor_methods.key?(key)

    # Prima il conflitto veniva saltato in silenzio e ctx.size (o :count,
    # :message, ...) ritornava il metodo di Hash invece del valore
    if respond_to?(key) || respond_to?("#{key}=")
      raise ReservedKeysInContextError,
            "expected or promised key :#{key} conflicts with an existing " \
            "#{self.class.name} method: rename the key or access it via ctx[:#{key}]"
    end

    @accessor_methods[key] = [:reader, key]
    @accessor_methods[:"#{key}="] = [:writer, key]
  end
end

#error_code ⇒ Object 



63
64
65
 
# File 'lib/functional-light-service/context.rb', line 63

def error_code
  @outcome.value[:error]
end

#fail!(message = nil, options_or_error_code = {}) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/functional-light-service/context.rb', line 74

def fail!(message = nil, options_or_error_code = {})
  options_or_error_code ||= {}

  if options_or_error_code.is_a?(Hash)
    # dup: l'hash di opzioni appartiene al chiamante e non va mutato
    options = options_or_error_code.dup
    error_code = options.delete(: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 



93
94
95
96
 
# File 'lib/functional-light-service/context.rb', line 93

def fail_and_return!(*args)
  fail!(*args)
  throw(:jump_when_failed)
end

#fail_with_rollback!(message = nil, error_code = nil) ⇒ Object

Raises:



98
99
100
101
 
# File 'lib/functional-light-service/context.rb', line 98

def fail_with_rollback!(message = nil, error_code = nil)
  fail!(message, error_code)
  raise FailWithRollbackError
end

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/functional-light-service/context.rb', line 42

def failure?
  @outcome.failure?
end

#fetch(key) ⇒ Object 



175
176
177
 
# File 'lib/functional-light-service/context.rb', line 175

def fetch(key, ...)
  super(resolve_key(key), ...)
end

#inspect ⇒ Object 



187
188
189
190
191
 
# File 'lib/functional-light-service/context.rb', line 187

def inspect
  "#{self.class}(#{self}, success: #{success?}, message: #{check_nil(message)}, error_code: " \
    "#{check_nil(error_code)}, skip_remaining: #{@skip_remaining}, " \
    "skip_all_remaining: #{@skip_all_remaining}, aliases: #{aliases})"
end

#key?(key) ⇒ Boolean Also known as: has_key?, member?, include?

Returns:

  • (Boolean) 


179
180
181
 
# File 'lib/functional-light-service/context.rb', line 179

def key?(key)
  super(resolve_key(key))
end

#message ⇒ Object 



59
60
61
 
# File 'lib/functional-light-service/context.rb', line 59

def message
  @outcome.value[:message]
end

#reset_skip_remaining! ⇒ Object 



54
55
56
57
 
# File 'lib/functional-light-service/context.rb', line 54

def reset_skip_remaining!
  # Resetta soltanto il flag: l'esito (e il suo messaggio) non vanno persi
  @skip_remaining = false
end

#respond_to_missing?(name, _include_all = false) ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/functional-light-service/context.rb', line 150

def respond_to_missing?(name, _include_all = false)
  (!@accessor_methods.nil? && @accessor_methods.key?(name)) || super
end

#skip_all_remaining!(message = nil) ⇒ Object

Variante non azzerabile di skip_remaining!: salta tutto il resto dell'organizer, scope annidati compresi (scoped_reduce non la resetta)



110
111
112
113
 
# File 'lib/functional-light-service/context.rb', line 110

def skip_all_remaining!(message = nil)
  @outcome = Success(:message => message)
  @skip_all_remaining = true
end

#skip_all_remaining? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/functional-light-service/context.rb', line 50

def skip_all_remaining?
  @skip_all_remaining
end

#skip_remaining!(message = nil) ⇒ Object 



103
104
105
106
 
# File 'lib/functional-light-service/context.rb', line 103

def skip_remaining!(message = nil)
  @outcome = Success(:message => message)
  @skip_remaining = true
end

#skip_remaining? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/functional-light-service/context.rb', line 46

def skip_remaining?
  @skip_remaining
end

#stop_processing? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/functional-light-service/context.rb', line 115

def stop_processing?
  failure? || skip_remaining? || skip_all_remaining?
end

#succeed!(message = nil, options = {}) ⇒ Object 



67
68
69
70
71
72
 
# File 'lib/functional-light-service/context.rb', line 67

def succeed!(message = nil, options = {})
  message = Configuration.localization_adapter.success(message,
                                                       current_action,
                                                       options)
  @outcome = Success(:message => message)
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/functional-light-service/context.rb', line 38

def success?
  @outcome.success?
end