module ParamsChecker::Fields

Public Instance Methods

arr_field( required: true, default: nil, allow_empty: false, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 218
def arr_field(
  required: true,
  default: nil,
  allow_empty: false,
  allow_nil: false
)
  Helper.check_type(type: 'boolean', values: [required, allow_empty, allow_nil])

  {
    type: 'arr',
    default: default,
    required: required,
    allow_empty: allow_empty,
    allow_nil: allow_nil
  }
end
bigint_field( required: true, default: nil, min: -2_000_000_000_000, max: 2_000_000_000_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 93
def bigint_field(
  required: true,
  default: nil,
  min: -2_000_000_000_000,
  max: 2_000_000_000_000,
  allow_nil: false
)
  Helper.check_type(type: 'integer', values: [min, max])
  Helper.check_type(type: 'boolean', values: [required, allow_nil])
  raise 'Invalid integer value.' unless (min >= -2_000_000_000_000) && (max <= 2_000_000_000_000)

  {
    type: 'int',
    default: default,
    required: required,
    min: min,
    max: max,
    allow_nil: allow_nil
  }
end
bignum_field( required: true, default: nil, min: -2_000_000_000_000, max: 2_000_000_000_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 51
def bignum_field(
  required: true,
  default: nil,
  min: -2_000_000_000_000,
  max: 2_000_000_000_000,
  allow_nil: false
)
  Helper.check_type(type: 'numeric', values: [min, max])
  Helper.check_type(type: 'boolean', values: [required, allow_nil])
  raise 'Invalid numeric value.' unless (min >= -2_000_000_000_000) && (max <= 2_000_000_000_000)

  {
    type: 'num',
    default: default,
    required: required,
    min: min,
    max: max,
    allow_nil: allow_nil
  }
end
boolean_field( required: true, default: nil, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 295
def boolean_field(
  required: true,
  default: nil,
  allow_nil: false
)
  Helper.check_type(type: 'boolean', values: [required, allow_nil])

  {
    type: 'boolean',
    default: default,
    required: required,
    allow_nil: allow_nil
  }
end
char_field( required: true, default: nil, allow_blank: false, min_length: 0, max_length: 255, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 28
def char_field(
  required: true,
  default: nil,
  allow_blank: false,
  min_length: 0,
  max_length: 255,
  allow_nil: false
)
  Helper.check_type(type: 'integer', values: [min_length, max_length])
  Helper.check_type(type: 'boolean', values: [required, allow_blank, allow_nil])
  raise 'Invalid char length.' unless (min_length >= 0) && (max_length <= 255)

  {
    type: 'char',
    default: default,
    allow_blank: allow_blank,
    required: required,
    min_length: min_length,
    max_length: max_length,
    allow_nil: allow_nil
  }
end
date_field( required: true, default: nil, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 250
def date_field(
  required: true,
  default: nil,
  allow_nil: false
)
  Helper.check_type(type: 'boolean', values: [required, allow_nil])

  {
    type: 'date',
    default: default,
    required: required,
    allow_nil: allow_nil
  }
end
datetime_field( required: true, default: nil, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 280
def datetime_field(
  required: true,
  default: nil,
  allow_nil: false
)
  Helper.check_type(type: 'boolean', values: [required, allow_nil])

  {
    type: 'datetime',
    default: default,
    required: required,
    allow_nil: allow_nil
  }
end
hash_field( required: true, default: nil, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 235
def hash_field(
  required: true,
  default: nil,
  allow_nil: false
)
  Helper.check_type(type: 'boolean', values: [required, allow_nil])

  {
    type: 'hash',
    default: default,
    required: required,
    allow_nil: allow_nil
  }
end
int_field( required: true, default: nil, min: -2_000_000_000, max: 2_000_000_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 114
def int_field(
  required: true,
  default: nil,
  min: -2_000_000_000,
  max: 2_000_000_000,
  allow_nil: false
)
  Helper.check_type(type: 'integer', values: [min, max])
  Helper.check_type(type: 'boolean', values: [required, allow_nil])
  raise 'Invalid integer value.' unless (min >= -2_000_000_000) && (max <= 2_000_000_000)

  {
    type: 'int',
    default: default,
    required: required,
    min: min,
    max: max,
    allow_nil: allow_nil
  }
end
num_field( required: true, default: nil, min: -2_000_000_000, max: 2_000_000_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 72
def num_field(
  required: true,
  default: nil,
  min: -2_000_000_000,
  max: 2_000_000_000,
  allow_nil: false
)
  Helper.check_type(type: 'numeric', values: [min, max])
  Helper.check_type(type: 'boolean', values: [required, allow_nil])
  raise 'Invalid numeric value.' unless (min >= -2_000_000_000) && (max <= 2_000_000_000)

  {
    type: 'num',
    default: default,
    required: required,
    min: min,
    max: max,
    allow_nil: allow_nil
  }
end
positive_bigint_field( required: true, default: nil, min: 0, max: 2_000_000_000_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 176
def positive_bigint_field(
  required: true,
  default: nil,
  min: 0,
  max: 2_000_000_000_000,
  allow_nil: false
)
  Helper.check_type(type: 'integer', values: [min, max])
  Helper.check_type(type: 'boolean', values: [required, allow_nil])
  raise 'Invalid integer value.' unless (min >= 0) && (max <= 2_000_000_000_000)

  {
    type: 'int',
    default: default,
    required: required,
    min: min,
    max: max,
    allow_nil: allow_nil
  }
end
positive_bignum_field( required: true, default: nil, min: 0, max: 2_000_000_000_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 135
def positive_bignum_field(
  required: true,
  default: nil,
  min: 0, max: 2_000_000_000_000,
  allow_nil: false
)
  Helper.check_type(type: 'numeric', values: [min, max])
  Helper.check_type(type: 'boolean', values: [required, allow_nil])
  raise 'Invalid numeric value.' unless (min >= 0) && (max <= 2_000_000_000_000)

  {
    type: 'num',
    default: default,
    required: required,
    min: min,
    max: max,
    allow_nil: allow_nil
  }
end
positive_int_field( required: true, default: nil, min: 0, max: 2_000_000_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 197
def positive_int_field(
  required: true,
  default: nil,
  min: 0,
  max: 2_000_000_000,
  allow_nil: false
)
  Helper.check_type(type: 'integer', values: [min, max])
  Helper.check_type(type: 'boolean', values: [required, allow_nil])
  raise 'Invalid integer value.' unless (min >= 0) && (max <= 2_000_000_000)

  {
    type: 'int',
    default: default,
    required: required,
    min: min,
    max: max,
    allow_nil: allow_nil
  }
end
positive_num_field( required: true, default: nil, min: 0, max: 2_000_000_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 155
def positive_num_field(
  required: true,
  default: nil,
  min: 0,
  max: 2_000_000_000, 
  allow_nil: false
)
  Helper.check_type(type: 'numeric', values: [min, max])
  Helper.check_type(type: 'boolean', values: [required, allow_nil])
  raise 'Invalid numeric value.' unless (min >= 0) && (max <= 2_000_000_000)

  {
    type: 'num',
    default: default,
    required: required,
    min: min,
    max: max,
    allow_nil: allow_nil
  }
end
text_field( required: true, default: nil, allow_blank: false, min_length: 0, max_length: 30_000, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 5
def text_field(
  required: true,
  default: nil,
  allow_blank: false,
  min_length: 0,
  max_length: 30_000,
  allow_nil: false
)
  Helper.check_type(type: 'integer', values: [min_length, max_length])
  Helper.check_type(type: 'boolean', values: [required, allow_blank, allow_nil])
  raise 'Invalid text length.' unless (min_length >= 0) && (max_length <= 30_000)

  {
    type: 'char',
    default: default,
    allow_blank: allow_blank,
    required: required,
    min_length: min_length,
    max_length: max_length,
    allow_nil: allow_nil
  }
end
time_field( required: true, default: nil, allow_nil: false ) click to toggle source
# File lib/params_checker/fields.rb, line 265
def time_field(
  required: true,
  default: nil,
  allow_nil: false
)
  Helper.check_type(type: 'boolean', values: [required, allow_nil])

  {
    type: 'time',
    default: default,
    required: required,
    allow_nil: allow_nil
  }
end