Class: Iry::Constraint::Exclusion

Inherits:
Object
  • Object
show all
Defined in:
lib/iry/constraint/exclusion.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key, name:, message: :taken) ⇒ Exclusion

Returns a new instance of Exclusion.

Parameters:

  • key (Symbol)

    key to apply error message for exclusion constraint to

  • message (Symbol, String) (defaults to: :taken)

    the validation error message

  • name (String)

    constraint name



22
23
24
25
26
27
28
29
30
# File 'lib/iry/constraint/exclusion.rb', line 22

def initialize(
  key,
  name:,
  message: :taken
)
  @key = key
  @message = message
  @name = name
end

Instance Attribute Details

#keySymbol

Returns:

  • (Symbol)


13
14
15
# File 'lib/iry/constraint/exclusion.rb', line 13

def key
  @key
end

#messageSymbol, String

Returns:

  • (Symbol, String)


15
16
17
# File 'lib/iry/constraint/exclusion.rb', line 15

def message
  @message
end

#nameString

Returns:

  • (String)


17
18
19
# File 'lib/iry/constraint/exclusion.rb', line 17

def name
  @name
end

Class Method Details

.infer_name(key, table_name) ⇒ String

Infers the exclusion constraint name based on key and table name

Parameters:

  • key (Symbol)
  • table_name (String)

Returns:

  • (String)


8
9
10
# File 'lib/iry/constraint/exclusion.rb', line 8

def self.infer_name(key, table_name)
  "#{table_name}_#{key}_excl"
end

Instance Method Details

#apply(model) ⇒ ActiveModel::Error

Parameters:

Returns:

  • (ActiveModel::Error)


34
35
36
# File 'lib/iry/constraint/exclusion.rb', line 34

def apply(model)
  model.errors.add(key, message)
end