Class: Knight::Rule::MaximumLength

Inherits:
Knight::Rule show all
Defined in:
lib/knight/rule/maximum_length.rb

Overview

A rule for checking the length of a value

Constant Summary collapse

DEFAULT_MESSAGE = 
'%{attribute} is too long'.freeze

Instance Attribute Summary collapse

Attributes inherited from Knight::Rule

#attribute_name, #message, #options

Instance Method Summary collapse

Methods inherited from Knight::Rule

#error

Constructor Details

#initialize(attribute_name, maximum, options = {}) ⇒ undefined

Initialize an exact length rule

Examples:

rule = Knight::Rule::MaximumLength.new(:username, 20)

Parameters:

  • attribute_name (Symbol)
  • maximum (Fixnum)
  • options (Hash) (defaults to: {}) —

    for this rule

Options Hash (options):

  • :message (String) —

    error_message



31
32
33
34
 
# File 'lib/knight/rule/maximum_length.rb', line 31

def initialize(attribute_name, maximum, options = {})
  super(attribute_name, options)
  @maximum = maximum
end

Instance Attribute Details

#maximum ⇒ Fixnum (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Length value

Returns:

  • (Fixnum) 


15
16
17
 
# File 'lib/knight/rule/maximum_length.rb', line 15

def maximum
  @maximum
end

Instance Method Details

#matches?(value) ⇒ true, false

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Check length of the value

Parameters:

  • value (Object)

Returns:

  • (true) —

    if the length is matched

  • (false) —

    otherwise



44
45
46
 
# File 'lib/knight/rule/maximum_length.rb', line 44

def matches?(value)
  value.length <= maximum
end

#to_hash ⇒ Hash

Return the rule as a hash

Examples:

hash = rule.to_hash

Returns:

  • (Hash) 


56
57
58
59
60
 
# File 'lib/knight/rule/maximum_length.rb', line 56

def to_hash
  super.merge({
    maximum: maximum
  }).freeze
end