Class: SPF::Mod

Inherits:
Term
  • Object
show all
Defined in:
lib/spf/model.rb

Direct Known Subclasses

GlobalMod, Exp, PositionalMod, UnknownMod

Defined Under Namespace

Classes: Exp, Redirect

Constant Summary

Constants inherited from Term

Term::DOMAIN_END_PATTERN, Term::DOMAIN_SPEC_PATTERN, Term::HEXWORD_PATTERN, Term::IPV4_ADDRESS_PATTERN, Term::IPV6_ADDRESS_PATTERN, Term::MACRO_DELIMITER, Term::MACRO_EXPAND_PATTERN, Term::MACRO_LITERAL_PATTERN, Term::MACRO_STRING_PATTERN, Term::MACRO_TRANSFORMERS_PATTERN, Term::NAME_PATTERN, Term::QNUM_PATTERN, Term::TOPLABEL_PATTERN, Term::TWO_HEXWORDS_OR_IPV4_ADDRESS_PATTERN

Instance Attribute Summary

Attributes inherited from Term

#domain_spec, #errors, #ip_address, #ip_netblocks, #ip_network, #ipv4_prefix_length, #ipv6_prefix_length

Instance Method Summary collapse

Methods inherited from Term

#domain, #error, new_from_string, #parse_domain_spec, #parse_ipv4_address, #parse_ipv4_ipv6_prefix_lengths, #parse_ipv4_network, #parse_ipv4_prefix_length, #parse_ipv6_address, #parse_ipv6_network, #parse_ipv6_prefix_length, #text

Constructor Details

#initialize(options = {}) ⇒ Mod

Returns a new instance of Mod.



595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/spf/model.rb', line 595

def initialize(options = {})
  super

  @parse_text  = options[:parse_text]
  @text        = options[:text]
  @domain_spec = options[:domain_spec]

  @parse_text = @text.dup unless @parse_text

  if @domain_spec and not SPF::MacroString === @domain_spec
    @domain_spec = SPF::MacroString.new({:text => @domain_spec})
  end
end

Instance Method Details

#parse ⇒ Object 



609
610
611
612
613
614
 
# File 'lib/spf/model.rb', line 609

def parse
  raise SPF::NothingToParseError('Nothing to parse for modifier') unless @parse_text
  self.parse_name
  self.parse_params(true)
  self.parse_end
end

#parse_end ⇒ Object 



637
638
639
640
641
642
 
# File 'lib/spf/model.rb', line 637

def parse_end
  unless @parse_text == ''
    raise SPF::JunkInTermError("Junk encountered in modifier #{@text}")
  end
  @parse_text = nil
end

#parse_name ⇒ Object 



616
617
618
619
620
621
622
623
624
 
# File 'lib/spf/model.rb', line 616

def parse_name
  @parse_text.sub!(/^(#{self.class::NAME})=/i, '')
  if $1
    @name = $1
  else
    raise SPF::InvalidModError.new(
      "Unexpected modifier name encoutered in #{@text}")
  end
end

#parse_params(required = false) ⇒ Object 



626
627
628
629
630
631
632
633
634
635
 
# File 'lib/spf/model.rb', line 626

def parse_params(required = false)
  # Parse generic macro string of parameters text (should be overridden in sub-classes):
  @parse_text.sub!(/^(#{MACRO_STRING_PATTERN})$/x, '')
  if $1
    @params_text = $1
  elsif required
    raise SPF::InvalidMacroStringError.new(
      "Invalid macro string encountered in #{@text}")
  end
end

#to_s ⇒ Object 



644
645
646
647
648
649
650
 
# File 'lib/spf/model.rb', line 644

def to_s
  return sprintf(
    '%s=%s',
    @name,
    @params ? @params : ''
  )
end