Exception: Purl::ValidationError

Inherits:

Error

• Object
• StandardError
• Error
• Purl::ValidationError

Defined in:

lib/purl/errors.rb

Overview

Validation errors for PURL components

Contains additional context about which component failed validation and what rule was violated.

Examples:

begin
  PackageURL.new(type: "123invalid", name: "test")
rescue ValidationError => e
  puts e.component  # :type
  puts e.rule       # "cannot start with number" 
end

Direct Known Subclasses

InvalidNameError, InvalidNamespaceError, InvalidQualifierError, InvalidSubpathError, InvalidTypeError, InvalidVersionError

Instance Attribute Summary

• #component ⇒ Symbol^? readonly

  The PURL component that failed validation.

• #rule ⇒ String^? readonly

  The validation rule that was violated.

• #value ⇒ Object^? readonly

  The value that failed validation.

Instance Method Summary

• #initialize(message, component: nil, value: nil, rule: nil) ⇒ ValidationError constructor

  A new instance of ValidationError.

Constructor Details

#initialize(message, component: nil, value: nil, rule: nil) ⇒ ValidationError

# File 'lib/purl/errors.rb', line 33

def initialize(message, component: nil, value: nil, rule: nil)
  super(message)
  @component = component
  @value = value
  @rule = rule
end

Instance Attribute Details

#component ⇒ Symbol^? (readonly)

# File 'lib/purl/errors.rb', line 21

def component
  @component
end

#rule ⇒ String^? (readonly)

# File 'lib/purl/errors.rb', line 27

def rule
  @rule
end

#value ⇒ Object^? (readonly)

# File 'lib/purl/errors.rb', line 24

def value
  @value
end