highscore 0.4.1 → 0.4.2

data/History.txt

@@ -1,3 +1,8 @@
+== 0.4.2 / 2012-02-07
+
+* added a simple example that also shows return values in README.md
+* #7 fixed handling of keywords for Ruby 1.8.7 (thanks to undecided)
+
 == 0.4.1 / 2012-02-06
 
 * fixed handling of keywords that are actually Fixnums

data/README.md

@@ -6,7 +6,7 @@ Find and rank keywords in long texts.
 Features
 --------
 
-* configureable to rank different types of words different (uppercase, long words, etc.)
+* configurable 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
@@ -26,20 +26,33 @@ end
 # get all keywords
 text.keywords.rank => Array
 
-# get the top 50 keywords
+# get only the top 50 keywords
 text.keywords.top(50).each do |keyword|
   keyword.text   # => keyword text
   keyword.weight # => rank weight (float)
 end
 
-# you could simply just use a string
-text = "foo bar".keywords(blacklist) do
+# you could just use a string
+keywords = "Foo bar baz".keywords(blacklist) do
   set :multiplier, 10
 end
-
-text.keywords
 ```
 
+The result is either a Highscore::Keywords object or an Array (depending on whether it's sorted or not) that you
+can iterate over. Each object in there is a Highscore::Keyword that has methods `text` and `weight`.
+
+```ruby
+keywords = "Foo bar is not bar baz".keywords(Highscore::Blacklist.load(['baz']))
+
+keywords.each do |k|
+  puts "#{k.text} #{k.weight}"
+end
+
+# prints:
+# Foo 3.0
+# bar 2.0
+# not 1.0
+```
 
 Using a custom blacklist to ignore keywords
 -------------------------------------------

data/lib/highscore/content.rb

@@ -50,7 +50,7 @@ module Highscore
           weight *= @emphasis[:long_words]
         end
 
-        if text[0] == text[0].upcase
+        if text[0,1] == text[0,1].upcase
           weight *= @emphasis[:upper_case]
         end
 

data/test/highscore/test_blacklist.rb

@@ -60,4 +60,17 @@ class TestBlacklist < Test::Unit::TestCase
     assert blacklist.include?("foobar")
     assert !blacklist.include?("bla")
   end
+
+  def test_blacklisting_content
+    keywords = "Foo bar is not bar baz".keywords(Highscore::Blacklist.load(['baz']))
+
+    keyword_list = []
+    keywords.each do |k|
+      keyword_list << k.text
+    end
+
+    expected_keywords = ['Foo', 'bar', 'not']
+
+    assert_equal expected_keywords, keyword_list
+  end
 end

data/version.txt

@@ -1 +1 @@
-0.4.1
+0.4.2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: highscore
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &70092474871020 !ruby/object:Gem::Requirement
+  requirement: &70117716241580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 3.7.3
   type: :development
   prerelease: false
-  version_requirements: *70092474871020
+  version_requirements: *70117716241580
 description: Find and rank keywords in long texts.
 email: liebler.dominik@googlemail.com
 executables: