ronin-rb/ronin-db-activerecord

# frozen_string_literal: true
#
# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
#
# Copyright (c) 2022-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# ronin-db-activerecord is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ronin-db-activerecord is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/db/model/has_unique_name'
require 'ronin/db/model'

require 'active_record'

module Ronin
  module DB
    #
    # Represents the name of a {URLQueryParam}.
    #
    class URLQueryParamName < ActiveRecord::Base

      include Model
      include Model::HasUniqueName

      # @!attribute [rw] id
      #   The primary-key of the URL query param.
      #
      #   @return [Integer]
      attribute :id, :integer

      # @!attribute [rw] name
      #   The name of the URL query param.
      #
      #   @return [String]
      attribute :name, :string # length:   256
      validates :name, presence: true, uniqueness: true

      # @!attribute [rw] query_params
      #   The URL query params.
      #
      #   @return [Array<URLQueryParam>]
      has_many :query_params, class_name:  'URLQueryParam',
                              foreign_key: :name_id

      # @!attribute [r] created_at
      #   When the URL query param name was first created.
      #
      #   @return [Time]
      attribute :created_at, :datetime

      #
      # Converts the URL query param name to a String.
      #
      # @return [String]
      #   The name of the URL query param
      #
      # @api public
      #
      def to_s
        self.name.to_s
      end

    end
  end
end