domnikl/highscore

module Highscore

  # keywords that were found in content
  #
  class Keywords
    include Enumerable

    # find keywords in a piece of content
    #
    # @param content String
    # @param wordlist Highscore::Wordlist
    # @param pattern Regex
    # @return Highscore::Keywords
    def self.find_keywords content, wordlist, pattern=/\w+/
      keywords = content.to_s.scan(pattern).flatten
      
      if not wordlist.nil? and wordlist.respond_to? :filter
        keywords = wordlist.filter(keywords)
      end
      
      keywords.sort
    end

    # init a new keyword collection
    #
    def initialize
      @keywords = {}
    end

    # ranks the keywords
    #
    # @return Array
    def rank
      sort
    end

    # get the top n keywords
    #
    # @param n Fixnum
    # @return Array
    def top n = 10
      tops = rank[0..(n - 1)]
      sum_all = sum(n)
      
      # set percentage values
      tops.each do |keyword|
        keyword.percent = keyword.weight * 100 / sum_all
      end
      
      tops
    end

    # add new keywords
    #
    # @param keyword Highscore::Keyword
    # @return Highscore::Keywords
    def <<(keyword)
      if @keywords.has_key?(keyword.text)
        @keywords[keyword.text].weight += keyword.weight
      else
        @keywords[keyword.text] = keyword
      end

      @keywords
    end

    # sort
    #
    # @return Array
    def sort
      sorted = @keywords.sort {|a,b| a[1] <=> b[1] }

      # convert Array from sort back to Array of Keyword objects
      sorted.collect {|x| x[1]}
    end

    # Enumerable
    #
    def each
      @keywords.each {|keyword| yield keyword[1] }
    end

    # number of Keywords given
    #
    # @return Fixnum
    def length
      @keywords.length
    end

    # get the keyword with the highest rank
    #
    # @return Highscore::Keyword
    def first
      sort.first
    end

    # get the keyword with the lowest rank
    #
    # @return Highscore::Keyword
    def last
      sort.reverse.first
    end

    # Returns the sum of the weight of the top n keywords
    #
    # @return Float
    def sum(n)
      top = rank[0..(n - 1)]
      top.map(&:weight).inject { |sum,weight| sum + weight }
    end

    # merge in another keyword list, operates on self
    #
    # @return Highscore::Keywords
    def merge!(other)
      other.each do |keyword|
        self << keyword
      end

      self
    end
  end
end