#
# Ronin - A Ruby platform for exploit development and security research.
#
# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
#

require 'ronin/model'

module Ronin
  module Model
    module HasDescription
      include DataMapper::Types

      def self.included(base)
        base.module_eval do
          include Ronin::Model

          # The description of the model
          property :description, Text

          #
          # Finds models with descriptions containing the specified
          # _fragment_.
          #
          # @param [String] fragment
          #   The fragment of text to match descriptions with.
          #
          # @example
          #   Exploit.describing 'bypass'
          #
          def self.describing(fragment)
            self.all(:description.like => "%#{fragment}%")
          end

          #
          # Strips leading and trailing white-space from each line, then sets
          # the description property.
          #
          # @param [String] new_text
          #   The new description to use.
          #
          # @example
          #   self.description = %{
          #     Some text here.
          #
          #     More text.
          #   }
          #
          # @since 0.3.0
          #
          def description=(new_text)
            sanitized_lines = []

            new_text.to_s.each_line do |line|
              sanitized_lines << line.strip
            end

            attribute_set(:description,sanitized_lines.join("\n").strip)
          end
        end
      end
    end
  end
end