Module: Axn::Core::Contract::ClassMethods

Defined in:
lib/axn/core/contract.rb

Instance Method Summary collapse

Instance Method Details

#_build_instance_filter(action_instance) ⇒ Object 



153
154
155
 
# File 'lib/axn/core/contract.rb', line 153

def _build_instance_filter(action_instance)
  ActiveSupport::ParameterFilter.new(_resolve_sensitive_fields(action_instance))
end

#_context_slice(data:, direction: nil, action_instance: nil) ⇒ Object

Internal method for filtering context data by direction Used by instance methods (inputs_for_logging, outputs_for_logging) and async exception reporting When action_instance is provided, dynamic sensitive fields are resolved against that instance.



172
173
174
175
176
177
178
179
 
# File 'lib/axn/core/contract.rb', line 172

def _context_slice(data:, direction: nil, action_instance: nil)
  filter = if action_instance && _has_dynamic_sensitive_fields?
             _build_instance_filter(action_instance)
           else
             inspection_filter
           end
  filter.filter(data.slice(*_declared_fields(direction)))
end

#_declared_fields(direction) ⇒ Object

Raises:

  • (ArgumentError) 


157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/axn/core/contract.rb', line 157

def _declared_fields(direction)
  raise ArgumentError, "Invalid direction: #{direction}" unless direction.nil? || %i[inbound outbound].include?(direction)

  configs = case direction
            when :inbound then internal_field_configs
            when :outbound then external_field_configs
            else (internal_field_configs + external_field_configs)
            end

  configs.map(&:field)
end

#_has_dynamic_sensitive_fields? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
129
130
 
# File 'lib/axn/core/contract.rb', line 126

def _has_dynamic_sensitive_fields?
  @_has_dynamic_sensitive_fields ||= (internal_field_configs + external_field_configs + subfield_configs).any? do |config|
    config.sensitive.is_a?(Proc) || config.sensitive.is_a?(Symbol)
  end
end

#_resolve_sensitive_fields(action_instance) ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/axn/core/contract.rb', line 132

def _resolve_sensitive_fields(action_instance)
  return _static_sensitive_fields unless _has_dynamic_sensitive_fields?

  (internal_field_configs + external_field_configs + subfield_configs).select do |config|
    _resolve_sensitive_value(config.sensitive, action_instance)
  end.map(&:field)
end

#_resolve_sensitive_value(sensitive, action_instance) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/axn/core/contract.rb', line 140

def _resolve_sensitive_value(sensitive, action_instance)
  case sensitive
  when true, false
    sensitive
  when Symbol
    !!action_instance.send(sensitive)
  when Proc
    !!action_instance.instance_exec(&sensitive)
  else
    !!sensitive
  end
end

#_static_sensitive_fields ⇒ Object 



122
123
124
 
# File 'lib/axn/core/contract.rb', line 122

def _static_sensitive_fields
  (internal_field_configs + external_field_configs + subfield_configs).select { |c| c.sensitive == true }.map(&:field)
end

#expects(*fields, on: nil, readers: true, allow_blank: false, allow_nil: false, optional: false, default: nil, preprocess: nil, sensitive: false, &block) ⇒ Object

Raises:

  • (ArgumentError) 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/axn/core/contract.rb', line 47

def expects(
  *fields,
  on: nil,
  readers: true,
  allow_blank: false,
  allow_nil: false,
  optional: false,
  default: nil,
  preprocess: nil,
  sensitive: false,
  **,
  &block
)
  fields.each do |field|
    raise ContractViolation::ReservedAttributeError, field if RESERVED_FIELD_NAMES_FOR_EXPECTATIONS.include?(field.to_s)
  end

  raise ArgumentError, "readers: false is only valid for subfields (use with on:)" if readers == false && on.nil?

  validations, metadata = _partition_field_options(fields, **)

  if on.present?
    raise ArgumentError, "a shape block is not supported with `on:`" if block

    return _expects_subfields(*fields, on:, readers:, allow_blank:, allow_nil:, optional:, default:, preprocess:, sensitive:, metadata:,
                                       **validations)
  end

  validations[:shape] = _build_shape(fields, validations:, &block) if block

  _parse_field_configs(*fields, allow_blank:, allow_nil:, optional:, default:, preprocess:, sensitive:, metadata:,
                                define_readers: true, **validations).tap do |configs|
    duplicated = internal_field_configs.map(&:field) & configs.map(&:field)
    raise Axn::DuplicateFieldError, "Duplicate field(s) declared: #{duplicated.join(', ')}" if duplicated.any?

    # NOTE: avoid <<, which would update value for parents and children
    self.internal_field_configs += configs
  end
end

#exposes(*fields, allow_blank: false, allow_nil: false, optional: false, default: nil, sensitive: false, &block) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/axn/core/contract.rb', line 87

def exposes(
  *fields,
  allow_blank: false,
  allow_nil: false,
  optional: false,
  default: nil,
  sensitive: false,
  **,
  &block
)
  fields.each do |field|
    raise ContractViolation::ReservedAttributeError, field if RESERVED_FIELD_NAMES_FOR_EXPOSURES.include?(field.to_s)
  end

  validations, metadata = _partition_field_options(fields, **)

  validations[:shape] = _build_shape(fields, validations:, &block) if block

  _parse_field_configs(*fields, allow_blank:, allow_nil:, optional:, default:, preprocess: nil, sensitive:, metadata:, **validations).tap do |configs|
    duplicated = external_field_configs.map(&:field) & configs.map(&:field)
    raise Axn::DuplicateFieldError, "Duplicate field(s) declared: #{duplicated.join(', ')}" if duplicated.any?

    # NOTE: avoid <<, which would update value for parents and children
    self.external_field_configs += configs
  end
end

#inspection_filter ⇒ Object 



114
115
116
 
# File 'lib/axn/core/contract.rb', line 114

def inspection_filter
  @inspection_filter ||= ActiveSupport::ParameterFilter.new(sensitive_fields)
end

#sensitive_fields ⇒ Object 



118
119
120
 
# File 'lib/axn/core/contract.rb', line 118

def sensitive_fields
  _static_sensitive_fields
end