class SPF::Query::Macro
Represents an SPF
string macro.
Attributes
delimiters[R]
Macro
delimiter character.
@return [Array<String>]
digits[R]
Number of times the macro must be repeated.
@return [Integer, nil]
letter[R]
The macro letter.
@return [Symbol]
Public Class Methods
new(letter,options={})
click to toggle source
Initializes the macro.
@param [Symbol] letter
The macro letter.
@param [Hash] options
Additional options.
@option options [Integer] :digits
Number of times to repeat the macro.
@option options [Boolean] :reverse
Whether to reverse the value.
@option options [Array<String>, String] :delimiters
Delimiter characters.
# File lib/spf/query/macro.rb, line 41 def initialize(letter,options={}) @letter = letter @digits = options[:digits] @reverse = options[:reverse] @delimiters = Array(options[:delimiters]) end
Public Instance Methods
reverse?()
click to toggle source
Specifies if the macro should be reversed.
@return [Boolean]
# File lib/spf/query/macro.rb, line 53 def reverse? @reverse end
to_s()
click to toggle source
Converts the macro a String.
@return [String]
# File lib/spf/query/macro.rb, line 62 def to_s "%{#{@letter}#{@digits}#{@delimiters.join}}" end