highscore 0.2.1

data/.gitignore

@@ -0,0 +1,11 @@
+# general
+.DS_Store
+
+# RubyMine
+.idea
+
+# bones
+announcement.txt
+coverage
+doc
+pkg

data/History.txt

@@ -0,0 +1,12 @@
+== 0.2.1 / 2012-01-15
+
+* added parameter multiplier to set a general multiplier for the ranking
+
+== 0.2.0 / 2012-01-14
+
+* added configure() and parameters to influence emphasizing
+
+== 0.1.0 / 2012-01-14
+
+* 1 major enhancement
+  * Birthday!

data/README.md

@@ -0,0 +1,64 @@
+highscore
+===========
+
+Rank keywords in long texts.
+
+Features
+--------
+
+* configureable to rank different types of words different (uppercase, long words, etc.)
+
+Examples
+--------
+
+    text = Highscore::Content.new "foo bar"
+    text.configure.do 
+      set :multiplier, 2
+      set :upper_case, 3
+      set :long_words, 2
+      set :long_words_threshold, 15
+    end
+
+    text.keywords # => Hash
+    text.keywords.top(50) # => Array
+
+Requirements
+------------
+
+(none)
+
+Install
+-------
+
+* sudo gem install highscore
+
+Author
+------
+
+Original author: Dominik Liebler <liebler.dominik@googlemail.com>
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2012 Dominik Liebler
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,18 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+task :default => 'test:run'
+task 'gem:release' => 'test:run'
+
+Bones {
+  name     'highscore'
+  authors  'Dominik Liebler'
+  email    'liebler.dominik@googlemail.com'
+  url      'http://thewebdev.de'
+  ignore_file '.gitignore'
+}
+

data/bin/highscore

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+root = File.expand_path('../..', __FILE__)
+require File.join(root, %w[lib highscore])
+
+# Put your code here
+

data/lib/highscore.rb

@@ -0,0 +1,60 @@
+
+module Highscore
+
+  # :stopdoc:
+  LIBPATH = ::File.expand_path('..', __FILE__) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  VERSION = ::File.read(PATH + 'version.txt').strip
+  # :startdoc:
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+    if block_given?
+      begin
+        $LOAD_PATH.unshift LIBPATH
+        rv = yield
+      ensure
+        $LOAD_PATH.shift
+      end
+    end
+    return rv
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
+    if block_given?
+      begin
+        $LOAD_PATH.unshift PATH
+        rv = yield
+      ensure
+        $LOAD_PATH.shift
+      end
+    end
+    return rv
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module Highscore
+
+Highscore.require_all_libs_relative_to(__FILE__)
+

data/lib/highscore/content.rb

@@ -0,0 +1,69 @@
+$:.unshift(File.join(File.dirname(__FILE__)))
+require 'keywords'
+
+module Highscore
+  class Content
+    attr_reader :content
+
+    def initialize content
+      @content = content
+
+      @emphasis = {
+        :multiplier => 1.0,
+        :upper_case => 3.0,
+        :long_words => 2.0,
+        :long_words_threshold => 15
+      }
+    end
+
+    # configure ranking
+    #
+    def configure(&block)
+      instance_eval(&block)
+    end
+
+    # set emphasis options to rank the content
+    #
+    def set(key, value)
+      @emphasis[key.to_sym] = value.to_f
+    end
+
+    # get the ranked keywords
+    #
+    # :call-seq:
+    #   keywords -> Keywords
+    #
+    def keywords
+      keywords = Keywords.new(0)
+
+      find_keywords.each do |k|
+        weight = @emphasis[:multiplier]
+
+        if k.length >= @emphasis[:long_words_threshold]
+          weight *= @emphasis[:long_words]
+        end
+
+        if k[0] == k[0].upcase
+          weight *= @emphasis[:upper_case]
+        end
+
+        keywords[k] += weight
+      end
+
+      keywords
+    end
+
+    private
+
+    # find keywords in the content and rate them
+    #
+    def find_keywords
+      keywords = @content.scan(/\w+/)
+      keywords.delete_if do |x|
+        x.match(/^[\d]+(\.[\d]+){0,1}$/) or x.length <= 2
+      end
+
+      keywords.sort
+    end
+  end
+end

data/lib/highscore/keywords.rb

@@ -0,0 +1,59 @@
+module Highscore
+  # keywords that were found in content
+  #
+  class Keywords < Hash
+
+    # ranks the keywords and removes keywords that have a low ranking
+    # or are blacklisted
+    #
+    # :call-seq:
+    #   rank -> array
+    #
+    def rank
+      filter
+      sort_it
+    end
+
+    # get the top n keywords
+    #
+    def top n = 10
+      filter
+      rank[0..(n - 1)]
+    end
+
+    # sorts the keywords and returns a array of arrays
+    #
+    # :call-seq:
+    #   sort_it -> array
+    #
+    def sort_it
+      sort {|x,y| y[1] <=> x[1]}
+    end
+
+    private
+
+    # filter out unwanted results
+    #
+    def filter
+      run_blacklist
+      filter_low
+    end
+
+    # filter low ranked keywords
+    #
+    def filter_low
+      delete_if do |key, value|
+        value <= 0
+      end
+    end
+
+    # remove blacklisted keywords
+    #
+    def run_blacklist
+      # FIXME: add more keywords!
+      delete_if do |key, value|
+        %w{the and that post add not see about using some something under our comments comment run you want for will file are with end new this use all but can your just get very data blog format out first they posts second}.include? key.downcase
+      end
+    end
+  end
+end

data/test/highscore/test_content.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.join(File.dirname(__FILE__), %w{.. .. lib highscore}))
+require "content"
+require "test/unit"
+
+class TestContent < Test::Unit::TestCase
+  def setup
+    @text = "This is some text"
+    @content = Highscore::Content.new(@text)
+  end
+
+  def test_content
+    assert_equal @text, @content.content
+  end
+
+  def test_keywords
+    assert_instance_of(Highscore::Keywords, @content.keywords)
+  end
+end

data/test/highscore/test_keywords.rb

@@ -0,0 +1,48 @@
+$:.unshift(File.join(File.dirname(__FILE__), %w{.. .. lib highscore}))
+require "keywords"
+require "test/unit"
+
+class TestKeywords < Test::Unit::TestCase
+  def setup
+    @keywords = Highscore::Keywords.new
+    @keywords['Ruby'] = 2
+    @keywords['Sinatra'] = 3
+    @keywords['Highscore'] = 1
+    @keywords['the'] = 10
+  end
+
+  def test_init
+    assert Highscore::Keywords.new.length == 0
+  end
+
+  def test_rank
+    assert @keywords.length == 4
+
+    ranked = @keywords.rank
+
+    assert_instance_of(Array, ranked)
+
+    should_rank = [['Sinatra', 3], ['Ruby', 2], ['Highscore', 1]]
+    assert_equal should_rank, ranked
+  end
+
+  def test_rank_empty
+    assert_equal [], Highscore::Keywords.new.rank
+  end
+
+  def test_top
+    assert_equal [['Sinatra', 3]], @keywords.top(1)
+  end
+
+  def test_top_empty
+    assert_equal [], Highscore::Keywords.new.top(0)
+  end
+
+  def test_sort
+    keywords = Highscore::Keywords.new
+    keywords['Test'] = 1
+    keywords['Foobar'] = 2
+
+    assert_equal [['Foobar', 2], ['Test', 1]], keywords.sort_it
+  end
+end

data/version.txt

@@ -0,0 +1 @@
+0.2.1

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: highscore
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Dominik Liebler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bones
+  requirement: &70306539324720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.7.3
+  type: :development
+  prerelease: false
+  version_requirements: *70306539324720
+description: Rank keywords in long texts.
+email: liebler.dominik@googlemail.com
+executables:
+- highscore
+extensions: []
+extra_rdoc_files:
+- History.txt
+- bin/highscore
+files:
+- .gitignore
+- History.txt
+- README.md
+- Rakefile
+- bin/highscore
+- lib/highscore.rb
+- lib/highscore/content.rb
+- lib/highscore/keywords.rb
+- test/highscore/test_content.rb
+- test/highscore/test_keywords.rb
+- test/test_highscore.rb
+- version.txt
+homepage: http://thewebdev.de
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: highscore
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Rank keywords in long texts.
+test_files:
+- test/highscore/test_content.rb
+- test/highscore/test_keywords.rb
+- test/test_highscore.rb