Exception: Roda::RodaPlugins::TypecastParams::Error

Inherits:
Roda::RodaError
  • Object
show all
Defined in:
lib/roda/plugins/typecast_params.rb

Overview

Exception class for errors that are due to the submitted parameters not matching what is expected. Should probably be treated as a 4xx error.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#all_errors ⇒ Object 



351
352
353
 
# File 'lib/roda/plugins/typecast_params.rb', line 351

def all_errors
  @all_errors ||= [self]
end

#keys ⇒ Object

The keys used to access the parameter that caused the error. This is an array that can be splatted to dig to get the value of the parameter causing the error.



340
341
342
 
# File 'lib/roda/plugins/typecast_params.rb', line 340

def keys
  @keys
end

#reason ⇒ Object

The reason behind this error. If this error was caused by a conversion method, this will be the conversion method symbol. If this error was caused because a value was missing, then it will be :missing. If this error was caused because a value was not the correct type, then it will be :invalid_type.



359
360
361
 
# File 'lib/roda/plugins/typecast_params.rb', line 359

def reason
  @reason
end

Class Method Details

.create(keys, reason, e) ⇒ Object

Set the keys in the given exception. If the exception is not already an instance of the class, create a new instance to wrap it.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/roda/plugins/typecast_params.rb', line 323

def self.create(keys, reason, e)
  if e.is_a?(self)
    e.keys ||= keys
    e.reason ||= reason
    e
  else
    backtrace = e.backtrace
    e = new("#{e.class}: #{e.message}")
    e.keys = keys
    e.reason = reason
    e.set_backtrace(backtrace) if backtrace
    e
  end
end

Instance Method Details

#param_name ⇒ Object

The likely parameter name where the contents were not expected. This is designed for cases where the parameter was submitted with the typical application/x-www-form-urlencoded or multipart/form-data content types, and assumes the typical rack parsing of these content types into parameters. # If the parameters were submitted via JSON, #keys should be used directly.

Example:

# keys: ['page']
param_name => 'page'

# keys: ['artist', 'name']
param_name => 'artist[name]'

# keys: ['album', 'artist', 'name']
param_name => 'album[artist][name]'



378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/roda/plugins/typecast_params.rb', line 378

def param_name
  if keys.length > 1
    first, *rest = keys
    v = first.dup
    rest.each do |param|
      v << "["
      v << param unless param.is_a?(Integer)
      v << "]"
    end
    v
  else
    keys.first
  end
end

#param_names ⇒ Object

An array of all parameter names for parameters where the context were not expected. If Params#convert! was not used, this will be an array containing #param_name. If Params#convert! was used and multiple exceptions were captured inside the convert! block, this will contain the parameter names related to all captured exceptions.



398
399
400
 
# File 'lib/roda/plugins/typecast_params.rb', line 398

def param_names
  all_errors.map(&:param_name)
end