Class: Knight::Validator

Inherits:

Object

• Object
• Knight::Validator

Defined in:

lib/knight/validator.rb

Instance Attribute Summary

• #rules ⇒ Set(Rule) readonly

  Return validation rules.

Instance Method Summary

• #add(rule) ⇒ Set(Rule)

  Add a rule.

• #initialize(*rules) ⇒ Validator constructor

  Initialize a validator.

• #run(resource) ⇒ Result

  Run the validator.

Constructor Details

#initialize(*rules) ⇒ Validator

Initialize a validator

Examples:

Validator.new(Rule::Presence.new(:username))

Parameters:

• rules (Array(Rule))

# File 'lib/knight/validator.rb', line 27

def initialize(*rules)
  @rules = Set.new(rules)
end

Instance Attribute Details

#rules ⇒ Set(Rule) (readonly)

Return validation rules

Examples:

validator = Validator.new(Rule::Presence.new(:username))
validator.rules

Returns:

• (Set(Rule))

# File 'lib/knight/validator.rb', line 15

def rules
  @rules
end

Instance Method Details

#add(rule) ⇒ Set(Rule)

Add a rule

Examples:

validator = Validator.new
validator.add(Rule::Presence.new(:username))

Parameters:

• rule (Rule)

Returns:

• (Set(Rule))

# File 'lib/knight/validator.rb', line 42

def add(rule)
  rules << rule if rule
end

#run(resource) ⇒ Result

Run the validator

Examples:

user = User.new(username: 'john')

validator = Validator.new(Rule::Presence.new(:username))
validator.run(user)

Parameters:

• resource (Object)

Returns:

• (Result)

# File 'lib/knight/validator.rb', line 59

def run(resource)
  Result.new(resource, rules)
end