highscore 0.3.2 → 0.4.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.4.0 / 2012-02-04
+
+* monkey-patched String to have a keywords method on it that takes the same arguments as Highscore::Content.new
+* merge multiple Keywords objects to one (e.g. from different sources)
+
 == 0.3.2 / 2012-01-27
 
 * use custom lists of ignored words (blacklist), fallback to a default list

data/README.md

@@ -1,12 +1,15 @@
 highscore
 ===========
 
-Rank keywords in long texts.
+Find and rank keywords in long texts.
 
 Features
 --------
 
 * configureable to rank different types of words different (uppercase, long words, etc.)
+* directly get keywords from String objects
+* blacklist words via a plain text file, String or an Array of words
+* merge together Keywords from multiple sources
 
 Examples
 --------
@@ -28,6 +31,13 @@ Examples
       keyword.weight # => rank weight (float)
     end
 
+    # you could simply just use a string
+    text = "foo bar".keywords(blacklist) do
+      set :multiplier, 10
+    end
+
+    text.keywords
+
 
 Using a custom blacklist to ignore keywords
 -------------------------------------------

data/lib/highscore/keywords.rb

@@ -67,12 +67,31 @@ module Highscore
     # Enumerable
     #
     def each &block
-      @keywords.each {|keyword| keyword.call(keyword)}
+      @keywords.each {|keyword| yield keyword[1] }
     end
 
     # number of Keywords given
     def length
       @keywords.length
     end
+
+    # get the keyword with the highest rank
+    def first
+      sort.first
+    end
+
+    # get the keyword with the lowest rank
+    def last
+      sort.reverse.first
+    end
+
+    # merge in another keyword list, operates on self
+    def merge!(other)
+      other.each do |keyword|
+        self << keyword
+      end
+
+      self
+    end
   end
 end

data/lib/highscore/string.rb

@@ -0,0 +1,18 @@
+# monkey patch to define a keywords method on arbitrary strings
+#
+class String
+
+  # get keywords from the string
+  #
+  def keywords(blacklist = nil, &block)
+    content = Highscore::Content.new(self, blacklist)
+
+    if block_given?
+      content.configure do
+        content.instance_eval(&block)
+      end
+    end
+
+    content.keywords
+  end
+end

data/test/highscore/test_keywords.rb

@@ -16,6 +16,20 @@ class TestKeywords < Test::Unit::TestCase
     assert Highscore::Keywords.new.length == 0
   end
 
+  def test_each
+    @keywords.each do |x|
+      assert(x.instance_of?(Highscore::Keyword), "should contain Highscore::Keyword instances, is #{x.class}")
+    end
+  end
+
+  def test_first
+    assert_equal 'the', @keywords.first.text
+  end
+
+  def test_last
+    assert_equal 'Highscore', @keywords.last.text
+  end
+
   def test_rank
     assert @keywords.length == 4
 
@@ -47,4 +61,14 @@ class TestKeywords < Test::Unit::TestCase
   def test_top_empty
     assert_equal [], Highscore::Keywords.new.top(0)
   end
+
+  def test_merge!
+    other = Highscore::Keywords.new
+    other << Highscore::Keyword.new('Ruby', 100.3)
+
+    @keywords.merge!(other)
+
+    assert_equal 102.3, @keywords.first.weight
+    assert_equal 'Ruby', @keywords.first.text
+  end
 end

data/test/highscore/test_string.rb

@@ -0,0 +1,38 @@
+$:.unshift(File.join(File.dirname(__FILE__), %w{.. .. lib}))
+require 'highscore'
+require "test/unit"
+
+class TestString < Test::Unit::TestCase
+  def setup
+    blacklist_file = File.join(File.dirname(__FILE__), %w{.. fixtures blacklist.txt})
+    @blacklist = Highscore::Blacklist.load_file(blacklist_file)
+  end
+
+  def test_init
+    keywords = "".keywords
+    assert_equal 0, keywords.length
+  end
+
+  def test_default_blacklist
+    keywords = "the Ruby Ruby Ruby Hacker".keywords
+    assert_equal 2, keywords.length
+  end
+
+  def test_custom_blacklist
+    keywords = "this is the test Ruby Ruby Ruby Hacker".keywords(@blacklist)
+
+    assert_equal 2, keywords.length
+
+    assert_equal 9, keywords.first.weight
+    assert_equal 3, keywords.last.weight
+  end
+
+  def test_with_block
+    keywords = "this is the test Ruby Ruby Ruby Hacker".keywords(@blacklist) do
+      set :multiplier, 10
+    end
+
+    assert_equal 90, keywords.first.weight
+    assert_equal 30, keywords.last.weight
+  end
+end

data/version.txt

@@ -1 +1 @@
-0.3.2
+0.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: highscore
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000 Z
+date: 2012-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &70200855600060 !ruby/object:Gem::Requirement
+  requirement: &70220913110960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,8 +21,8 @@ dependencies:
         version: 3.7.3
   type: :development
   prerelease: false
-  version_requirements: *70200855600060
-description: Rank keywords in long texts.
+  version_requirements: *70220913110960
+description: Find and rank keywords in long texts.
 email: liebler.dominik@googlemail.com
 executables:
 - highscore
@@ -45,11 +45,13 @@ files:
 - lib/highscore/content.rb
 - lib/highscore/keyword.rb
 - lib/highscore/keywords.rb
+- lib/highscore/string.rb
 - test/fixtures/blacklist.txt
 - test/highscore/test_blacklist.rb
 - test/highscore/test_content.rb
 - test/highscore/test_keyword.rb
 - test/highscore/test_keywords.rb
+- test/highscore/test_string.rb
 - test/test_highscore.rb
 - version.txt
 homepage: http://thewebdev.de
@@ -77,10 +79,11 @@ rubyforge_project: highscore
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Rank keywords in long texts.
+summary: Find and rank keywords in long texts.
 test_files:
 - test/highscore/test_blacklist.rb
 - test/highscore/test_content.rb
 - test/highscore/test_keyword.rb
 - test/highscore/test_keywords.rb
+- test/highscore/test_string.rb
 - test/test_highscore.rb