Module: BetterController::ParamsHelpers

Extended by:
ActiveSupport::Concern
Defined in:
lib/better_controller/params_helpers.rb

Overview

Module providing enhanced parameter handling for controllers

Instance Method Summary collapse

Instance Method Details

#array_param(key, default: []) ⇒ Array

Get an array parameter

Parameters:

  • key (Symbol, String) —

    The parameter key

  • default (Array) (defaults to: []) —

    The default value if parameter is missing

Returns:

  • (Array) —

    The parameter value



97
98
99
 
# File 'lib/better_controller/params_helpers.rb', line 97

def array_param(key, default: [])
  param(key, type: :array, default: default)
end

#boolean_param(key, default: false) ⇒ Boolean

Get a boolean parameter

Parameters:

  • key (Symbol, String) —

    The parameter key

  • default (Boolean) (defaults to: false) —

    The default value if parameter is missing

Returns:

  • (Boolean) —

    The parameter value



57
58
59
 
# File 'lib/better_controller/params_helpers.rb', line 57

def boolean_param(key, default: false)
  param(key, type: :boolean, default: default)
end

#date_param(key, default: nil) ⇒ Date

Get a date parameter

Parameters:

  • key (Symbol, String) —

    The parameter key

  • default (Date) (defaults to: nil) —

    The default value if parameter is missing

Returns:

  • (Date) —

    The parameter value



81
82
83
 
# File 'lib/better_controller/params_helpers.rb', line 81

def date_param(key, default: nil)
  param(key, type: :date, default: default)
end

#datetime_param(key, default: nil) ⇒ DateTime

Get a datetime parameter

Parameters:

  • key (Symbol, String) —

    The parameter key

  • default (DateTime) (defaults to: nil) —

    The default value if parameter is missing

Returns:

  • (DateTime) —

    The parameter value



89
90
91
 
# File 'lib/better_controller/params_helpers.rb', line 89

def datetime_param(key, default: nil)
  param(key, type: :datetime, default: default)
end

#float_param(key, default: nil) ⇒ Float

Get a float parameter

Parameters:

  • key (Symbol, String) —

    The parameter key

  • default (Float) (defaults to: nil) —

    The default value if parameter is missing

Returns:

  • (Float) —

    The parameter value



73
74
75
 
# File 'lib/better_controller/params_helpers.rb', line 73

def float_param(key, default: nil)
  param(key, type: :float, default: default)
end

#integer_param(key, default: nil) ⇒ Integer

Get an integer parameter

Parameters:

  • key (Symbol, String) —

    The parameter key

  • default (Integer) (defaults to: nil) —

    The default value if parameter is missing

Returns:

  • (Integer) —

    The parameter value



65
66
67
 
# File 'lib/better_controller/params_helpers.rb', line 65

def integer_param(key, default: nil)
  param(key, type: :integer, default: default)
end

#json_param(key, default: {}) ⇒ Hash

Get a JSON parameter

Parameters:

  • key (Symbol, String) —

    The parameter key

  • default (Hash) (defaults to: {}) —

    The default value if parameter is missing

Returns:

  • (Hash) —

    The parameter value



105
106
107
 
# File 'lib/better_controller/params_helpers.rb', line 105

def json_param(key, default: {})
  param(key, type: :json, default: default)
end

#param(key, type: nil, default: nil) ⇒ Object

Get parameters with type casting

Parameters:

  • key (Symbol, String) —

    The parameter key

  • type (Class) (defaults to: nil) —

    The type to cast to

  • default (Object) (defaults to: nil) —

    The default value if parameter is missing

Returns:

  • (Object) —

    The parameter value



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/better_controller/params_helpers.rb', line 13

def param(key, type: nil, default: nil)
  value = params[key]
  return default if value.nil?

  case type
  when :integer, Integer
    value.to_i
  when :float, Float
    value.to_f
  when :string, String
    value.to_s
  when :boolean, :bool
    ActiveModel::Type::Boolean.new.cast(value)
  when :date, Date
    begin
      Date.parse(value)
    rescue ArgumentError
      default
    end
  when :datetime, DateTime
    begin
      DateTime.parse(value)
    rescue ArgumentError
      default
    end
  when :array, Array
    value.is_a?(Array) ? value : [value]
  when :hash, Hash
    value.is_a?(Hash) ? value : default
  when :json, :JSON
    begin
      value.is_a?(Hash) ? value : JSON.parse(value)
    rescue JSON::ParserError
      default
    end
  else
    value
  end
end