goto_string 0.1.1 → 0.1.2

data/History.txt

@@ -1,5 +1,9 @@
 == 0.1.1 / 2007-07-20
 
+* usage doc added to README
+
+== 0.1.1 / 2007-07-20
+
 * fixed up tests
 
 == 0.1.0 / 2007-07-20

data/README.txt

@@ -12,8 +12,23 @@ goto_string is a small library that implements a substring matching and ranking
 * The algorithm is not particularly performant
 
 == SYNOPSIS:
-
-  [""]
+  
+  s = %w(goto_string is a small library that implements a substring matching and ranking algorithm. The matching and ranking is similar to that found in Quicksilver or TextMate)
+  GotoString::Matcher.match('string', s) #=> [["goto_string", "goto_string", 0.679259259259259, [["string", 5]]], ["substring", "substring", 0.461481481481481, [["s", 0], ["tring", 4]]]]
+  
+  An array is returned which contains one entry for each match. Matches are ordered by rank.
+  
+  Each match is itself an array, containing the following elements:
+  
+  [ "matched string", "original candidate", rank, [["substring_1", offset], ["substring_2", offset], ... ] ]
+  
+  You can optionally pass a block to the match method which will get each candidate passed to it. The return value of the block is what will be used for matching. This is so you can pass in arrays of complex objects as candidates:
+  
+  GotoString::Matcher.matching( "goto", Project.find(:all) ) do |p|
+    p.name
+  end
+  
+  The resulting matches will contain a reference to the matched string (the project name) as well as the project (the original candidate)
 
 == REQUIREMENTS:
 

data/lib/goto_string.rb

@@ -2,7 +2,7 @@ require 'enumerator'
 require 'jcode'
 
 module GotoString
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
   
   class Matcher
     

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: goto_string
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 date: 2007-07-20 00:00:00 +10:00
 summary: Quicksilver-like partial string matching
 require_paths: 
@@ -11,7 +11,7 @@ require_paths:
 email: max@muermann.org
 homepage: "    by Max Muermann"
 rubyforge_project: goto_string
-description: "== FEATURES/PROBLEMS:  * Partial string matching * The algorithm is not particularly performant  == SYNOPSIS:  [\"\"]  == REQUIREMENTS:"
+description: "== FEATURES/PROBLEMS:  * Partial string matching * The algorithm is not particularly performant  == SYNOPSIS:  s = %w(goto_string is a small library that implements a substring matching and ranking algorithm. The matching and ranking is similar to that found in Quicksilver or TextMate) GotoString::Matcher.match('string', s) #=> [[\"goto_string\", \"goto_string\", 0.679259259259259, [[\"string\", 5]]], [\"substring\", \"substring\", 0.461481481481481, [[\"s\", 0], [\"tring\", 4]]]]  An array is returned which contains one entry for each match. Matches are ordered by rank.  Each match is itself an array, containing the following elements:  [ \"matched string\", \"original candidate\", rank, [[\"substring_1\", offset], [\"substring_2\", offset], ... ] ]  You can optionally pass a block to the match method which will get each candidate passed to it. The return value of the block is what will be used for matching. This is so you can pass in arrays of complex objects as candidates:  GotoString::Matcher.matching( \"goto\", Project.find(:all) ) do |p| p.name end  The resulting matches will contain a reference to the matched string (the project name) as well as the project (the original candidate)  == REQUIREMENTS:  * None"
 autorequire: 
 default_executable: 
 bindir: bin