rapid7/metasploit_data_models

# Common behavior for ranges under {MetasploitDataModels::IPAddress}, including ranges of addresses and segments.
module MetasploitDataModels::IPAddress::Range
  # so that translations for error messages can be filed under metasploit_data_models/ip_address/range
  extend ActiveModel::Naming
  extend ActiveSupport::Concern

  #
  # CONSTANTS
  #

  # Separator between the {#begin} and {#end} in the formatted value.
  SEPARATOR = '-'

  #
  # Attributes
  #

  # @!attribute value
  #   The range.
  #
  #   @return [Range<Object, Objectr>] Range with {ClassMethods#extreme_class} instances for `Range#begin` and
  #     `Range#end`.
  #   @return [String] if `formatted_value` cannot be parsed into a Range.
  attr_reader :value

  included do
    include ActiveModel::Validations

    #
    #
    # Validations
    #
    #

    #
    # Validation Methods
    #

    validate :extremes_valid
    validate :order

    #
    # Validation Attributes
    #

    validates :begin,
              presence: true
    validates :end,
              presence: true

  end


  # Class methods added to the including `Class`.
  module ClassMethods
    # @note Call {#extremes} first to set {#extreme_class_name}.
    #
    # Regular expression that matches a string exactly when it contains an IP address range with the correct
    # {#extreme_class}.
    #
    # @return [Regexp] {#regexp} pinned with `'\A'` and `'\z'` to the whole `String`.
    def match_regexp
      @match_regexp ||= /\A#{regexp}\z/
    end

    # @note Call {#extremes} first to set {#extreme_class_name}.
    #
    # The `Class` for each extreme (`Range#begin` and `Range#end`) of the range.
    #
    # @return [Class]
    def extreme_class
      @extreme_class ||= extreme_class_name.constantize
    end

    # The name of {#extreme_class}.
    #
    # @return [String] `Class#name` passed to :class_name key when {#extremes} was called.
    # @return [nil] if {#extremes} has not been called.
    def extreme_class_name
      @extreme_class_name
    end

    # Sets {#extreme_class_name}.
    #
    # @example Setting extremes class name
    #   extremes class_name: 'MetasploitDataModels::IPAddress::V4::Single'
    #
    # @param options [Hash{Symbol => String}]
    # @option options [String] :class_name {#extreme_class_name}.
    # @return [void]
    def extremes(options={})
      options.assert_valid_keys(:class_name)

      @extreme_class_name = options.fetch(:class_name)
    end

    # @note Call {#extremes} first to set {#extreme_class_name}.
    #
    # Regular expression match a {SEPARATOR} separated range with {#extreme_class} parseable `Range#begin` and
    # `Range#end`.
    #
    # @return [Regexp]
    def regexp
      @regexp ||= /#{extreme_class.regexp}#{SEPARATOR}#{extreme_class.regexp}/
    end
  end

  #
  # Instance Methods
  #

  # Begin of segment range.
  #
  # @return [MetasploitDataModels::IPAddress::V4::NMAP::Segment::Number] if {#value} is a `Range`.
  # @return [nil] if {#value} is not a `Range`.
  def begin
    if value.respond_to? :begin
      value.begin
    end
  end

  # End of segment range.
  #
  # @return [MetasploitDataModels::IPAddress::V4::NMAP::Segment::Number] if {#value} is a `Range`.
  # @return [nil] if {#value} is not a `Range`.
  def end
    if value.respond_to? :end
      value.end
    end
  end

  # This range as a string.  Equivalent to the original `formatted_value` passed to {#value}.
  #
  # @return [String]
  def to_s
    "#{self.begin}#{SEPARATOR}#{self.end}"
  end

  # Sets {#value} by breaking up the range into its begin and end Integers.
  #
  # @param formatted_value [#to_s]
  # @return [Range<Integer, Integer>] if {SEPARATOR} is used and both extremes are Integers.
  # @return [#to_s] `formatted_value` if it could not be converted
  def value=(formatted_value)
    formatted_extremes = formatted_value.to_s.split(SEPARATOR, 2)

    extremes = formatted_extremes.map { |formatted_extreme|
      self.class.extreme_class.new(value: formatted_extreme)
    }

    begin
      @value = Range.new(*extremes)
    rescue ArgumentError
      @value = formatted_value
    end
  end

  private

  # Validates that {#begin} and {#end} are valid.
  #
  # @return [void]
  def extremes_valid
    [:begin, :end].each do |extreme_name|
      extreme_value = send(extreme_name)

      unless extreme_value.respond_to?(:valid?) && extreme_value.valid?
        errors.add(extreme_name, :invalid)
      end
    end
  end

  # Validates that {#begin} is `<=` {#end}.
  #
  # @return [void]
  def order
    if self.begin && self.end && self.begin > self.end
      errors.add(:value, :order, begin: self.begin, end: self.end)
    end
  end
end