Class: CLIUtils::PrefValidator

Inherits:

Object

• Object
• CLIUtils::PrefValidator

Includes:

Messaging

Defined in:

lib/cliutils/prefs/pref_validators/pref_validator.rb

Overview

The generic base class for a Pref Validator.

Direct Known Subclasses

AlphabeticValidator, AlphanumericValidator, DateValidator, DatetimeValidator, FilepathExistsValidator, NonNilValidator, NumberValidator, TimeValidator, UrlValidator

Instance Attribute Summary

• #is_valid ⇒ Boolean

  Holds whether the validator returned successful or not.

• #message ⇒ String

  Holds the message to display to the user when the Validator fails.

Instance Method Summary

• #validate(text = nil) ⇒ void

  Validate the Validator!.

Methods included from Messaging

#messenger

Instance Attribute Details

#is_valid ⇒ Boolean

Holds whether the validator returned successful or not.

Returns:

• (Boolean)

# File 'lib/cliutils/prefs/pref_validators/pref_validator.rb', line 10

def is_valid
  @is_valid
end

#message ⇒ String

Holds the message to display to the user when the Validator fails.

Returns:

• (String)

# File 'lib/cliutils/prefs/pref_validators/pref_validator.rb', line 15

def message
  @message
end

Instance Method Details

#validate(text = nil) ⇒ void

This method returns an undefined value.

Validate the Validator!

Parameters:

• text (String) (defaults to: nil)

Raises:

• (StandardError) —

  if the subclass doesn’t implement this method.

# File 'lib/cliutils/prefs/pref_validators/pref_validator.rb', line 22

def validate(text = nil)
  fail "`validate` method not implemented on caller: #{ self.class }"
end