class RediPress::Parameter

This class holds all paramaters required by a configuration.

Attributes

options[R]
required[R]
slug[R]

Public Class Methods

new(slug) click to toggle source

Setup an instance of the parameters class.

Arguments:

slug: (String|Symbol)

Example:

>> RediPress::Parameter.new(:username)
=> #<RediPress::Parameter:0x00000000000000>
# File lib/redipress/parameter.rb, line 20
def initialize(slug)
  @slug = slug
  @name = slug.to_s
  @required = true
  @type = :text
end

Public Instance Methods

default(default = nil) click to toggle source

Set the default value

Available With types:

:text

Arguments:

default: (String)

Example:

>> parameter.default('rediwebhosting')
=> "rediwebhosting"
# File lib/redipress/parameter.rb, line 81
def default(default = nil)
  default.nil? ? @default : @default = default
end
name(name = nil) click to toggle source

Set the name of the parameter

Arguments:

name: (String)

Example:

>> parameter.name("Username")
=> "Username"
# File lib/redipress/parameter.rb, line 36
def name(name = nil)
  name.nil? ? @name : @name = name
end
option(option) click to toggle source

Add an option

Available With types:

:select
:multi_select

Arguments:

option: (String)

Example:

>> parameter.option('rediweb')
=> nil
>> parameter.option('rediwebhosting')
=> nil
# File lib/redipress/parameter.rb, line 116
def option(option)
  @options ||= []
  @options << option
  nil
end
type(type = nil) click to toggle source

Set the type of the parameter

Arguments:

type: (Symbol)

Example:

>> parameter.type(:text)
=> :text
# File lib/redipress/parameter.rb, line 65
def type(type = nil)
  type.nil? ? @type : @type = type
end
validation(validation = nil) click to toggle source

Set the validation regex

Available With types:

:text

Arguments:

validation: (Regex)

Example:

>> parameter.validation(/^[a-z]{4,}$/)
=> /^[a-z]{4,}$/
# File lib/redipress/parameter.rb, line 97
def validation(validation = nil)
  validation.nil? ? @validation : @validation = validation
end