Class: Highway::Steps::Types::String

Inherits:

Any

• Object
• Any
• Highway::Steps::Types::String

Defined in:

lib/highway/steps/types/string.rb

Overview

This class represents a string parameter type.

Direct Known Subclasses

Enum, Url

Class Method Summary

• .regex(regex) ⇒ Highway::Steps::Types::String

  Initialize an instance.

Instance Method Summary

• #typecheck(value) ⇒ String^?

  Typecheck and coerce a value if possible.

Methods inherited from Any

#initialize, #typecheck_and_validate, #validate

Constructor Details

This class inherits a constructor from Highway::Steps::Types::Any

Class Method Details

.regex(regex) ⇒ Highway::Steps::Types::String

Initialize an instance.

Parameters:

• regex (Regexp) —

  A regular expression string must match.

Returns:

• (Highway::Steps::Types::String)

# File 'lib/highway/steps/types/string.rb', line 22

def self.regex(regex)
  self.new(validate: lambda { |value| regex =~ value })
end

Instance Method Details

#typecheck(value) ⇒ String^?

Typecheck and coerce a value if possible.

This method returns a typechecked and coerced value or ‘nil` if value has invalid type and can’t be coerced.

Parameters:

• value (Object) —

  A value.

Returns:

• (String, nil)

# File 'lib/highway/steps/types/string.rb', line 34

def typecheck(value)
  case value
    when ::String then value
    when ::Numeric then value.to_s
    when ::TrueClass then "true"
    when ::FalseClass then "false"
  end
end