rapid7/metasploit_data_models

# A comma separated list of {MetasploitDataModels::IPAddress::V4::Segment::Single segment numbers} and
# {MetasploitDataModels::IPAddress::V4::Segment::Nmap::Range range of segment numbers} making up one segment of
# {MetasploitDataModels::IPAddress::V4::Nmap}.
class MetasploitDataModels::IPAddress::V4::Segment::Nmap::List < Metasploit::Model::Base

  include MetasploitDataModels::Match::Parent

  #
  # CONSTANTS
  #

  # Either an individual {MetasploitDataModels::IPAddress::V4::Segment::Single segment number} or a
  # {MetasploitDataModels::IPAddress::V4::Segment::Nmap::Range segment range}.
  RANGE_OR_NUMBER_REGEXP = %r{
      (?<range>#{module_parent::Range.regexp})
      |
      # range first because it contains a segment and if the range isn't first only the first part of the range will
      # match.
      (?<number>#{MetasploitDataModels::IPAddress::V4::Segment::Single::REGEXP})
  }x
  # Separator between number or ranges
  SEPARATOR = ','
  # Segment of an NMAP address, composed of comma separated {RANGE_OR_NUMBER_REGEXP segment numbers or ranges}.
  REGEXP = /#{RANGE_OR_NUMBER_REGEXP}(#{SEPARATOR}#{RANGE_OR_NUMBER_REGEXP})*/

  # Matches exactly an Nmap comma separated list of segment numbers and ranges.
  MATCH_REGEXP = /\A#{REGEXP}\z/

  #
  # Attributes
  #

  # @!attribute value
  #   The NMAP IPv4 octect range.
  #
  #   @return [Array<MetasploitDataModels::IPAddress::V4::Segment::Number, MetasploitDataModels::IPAddress::V4::Segment::Range>]
  #     number and range in the order they appeared in formatted value.
  attr_reader :value

  #
  # Match Children
  #

  match_children_named %w{
    MetasploitDataModels::IPAddress::V4::Segment::Single
    MetasploitDataModels::IPAddress::V4::Segment::Nmap::Range
  }

  #
  #
  # Validations
  #
  #

  #
  # Method Validations
  #

  validate :value_elements_valid
  validate :value_is_array

  #
  # Attribute Validations
  #

  validates :value,
            presence: true

  #
  # Instance Methods
  #

  # @return [String]
  def to_s
    if value.is_a? Array
      value.map(&:to_s).join(SEPARATOR)
    else
      value.to_s
    end
  end

  # Set {#value} to an `Array` of segment numbers and ranges.
  #
  # @param formatted_value [#to_s]
  # @return [Array<MetasploitDataModels::IPAddress::V4::Segment::Single, MetasploitDataModels::IPAddress::V4::Segment::Nmap::Range>] a parsed `Array` of segment numbers and ranges.
  # @return [#to_s] if `formatted_value` does not match {MATCH_REGEXP}.
  def value=(formatted_value)
    string = formatted_value.to_s
    match = MATCH_REGEXP.match(string)

    if match
      ranges_or_numbers = string.split(SEPARATOR)

      @value = ranges_or_numbers.map { |range_or_number|
        match_child(range_or_number) || range_or_number
      }
    else
      @value = formatted_value
    end
  end

  private

  # Validates that {#value}'s elements are all valid.
  #
  # @return [void]
  def value_elements_valid
    if value.is_a? Array
      value.each_with_index do |element, index|
        unless element.valid?
          errors.add(:value, :element, element: element, index: index)
        end
      end
    end
  end

  # Validates that {#value} is an `Array`.
  #
  # @return [void]
  def value_is_array
    unless value.is_a? Array
      errors.add(:value, :array)
    end
  end
end