liqrrdmetal 0.5.1 → 0.6

data/lib/liqrrdmetal.rb

@@ -1,2 +1,2 @@
-# encoding: UTF-8
+# encoding: UTF-8
 require_relative 'liqrrdmetal/liqrrdmetal'

data/lib/liqrrdmetal/liqrrdmetal.rb

@@ -80,7 +80,7 @@ require 'strscan'
 # 
 # Copyright (c) 2011, Gavin Kistner (!@phrogz.net)
 module LiqrrdMetal
-	VERSION = "0.5.1"
+	VERSION = "0.6"
 
   # If you want score_with_parts to be accurate, the MATCH score must be unique
 	MATCH                =  0.00  #:nodoc:
@@ -89,6 +89,7 @@ module LiqrrdMetal
 	BUFFER               = [0.15] #:nodoc:
 	TRAILING             = [0.20] #:nodoc:
 	NO_MATCH             = [1.00] #:nodoc:
+	RE_CACHE             = {}     #:nodoc:
 
 	# Used to identify substrings and whether or not they were matched directly by the search string.
 	class MatchPart
@@ -147,6 +148,8 @@ module LiqrrdMetal
 	# using the supplied block to find the string to match against,
 	# receiving an array of your objects with the MatchResult module mixed in.
 	#
+	# Non-matching entries (score of 1.0) will never be included in the results, no matter the value of score_threshold
+	#
 	#  User = Struct.new :name, :email, :id
 	#  users = [ User.new( "Gavin Kistner",   "!@phrogz.net",          42 ),
 	#            User.new( "David Letterman", "lateshow@pipeline.com", 17 ),
@@ -163,21 +166,27 @@ module LiqrrdMetal
 	#  #=> ["<span class='match'>s</span>cottadams@aol<span class='match'>.com</span>",
 	#  #=>  "late<span class='match'>s</span>how@pipeline<span class='match'>.com</span>"]
 	def results_by_score( search, objects, score_threshold=1.0 )
-		objects.each{ |o|
-			o.extend MatchResult
-			o.liqrrd_match = yield(o)
-			o.liqrrd_score, o.liqrrd_parts = score_with_parts(search,o.liqrrd_match)
-		}.select{ |o|
-			o.liqrrd_score < score_threshold
-		}.sort_by{ |o|
+		re = RE_CACHE[search] ||= /#{[*search.chars].join('.*?')}/i
+		objects.map{ |o|
+			m = yield(o)
+			if m=~re
+				score,parts = score_with_parts(search,m)
+				if score<score_threshold
+					o.extend MatchResult
+					o.liqrrd_match = m
+					o.liqrrd_score, o.liqrrd_parts = score,parts
+					o
+				end				
+			end
+		}.compact.sort_by{ |o|
 			[ o.liqrrd_score, o.liqrrd_match ]
 		}
 	end
 
 	# Match a single search term against an array of possible results,
 	# receiving an array sorted by score (descending) of the matched text parts.
-	# By default non-matching entries are not included in the results; set the
-	# `score_threshold` below 0.0 to include them.
+	#
+	# Non-matching entries (score of 1.0) will never be included in the results, no matter the value of score_threshold
 	#
 	#  items = ["FooBar","Foo Bar","For the Love of Big Cars"]
 	#  hits  = LiqrrdMetal.parts_by_score( "foobar", items )
@@ -186,11 +195,15 @@ module LiqrrdMetal
   #  #=> _Foo_ _Bar_
   #  #=> _Fo_r the L_o_ve of _B_ig C_ar_s
 	def parts_by_score( search, actuals, score_threshold=1.0 )
+		re = RE_CACHE[search] ||= /#{[*search.chars].join('.*?')}/i
 		actuals.map{ |actual|
-			[ actual, *score_with_parts(search,actual) ]
-		}.select{ |actual,score,parts|
-			score < score_threshold
-		}.sort_by{ |actual,score,parts|
+			if actual=~re
+				score,parts = score_with_parts(search,actual)
+				if score<score_threshold
+					[ actual, score, parts ]
+				end
+			end
+		}.compact.sort_by{ |actual,score,parts|
 			[ score, actual ]
 		}.map{ |actual,score,parts|
 			parts
@@ -208,12 +221,13 @@ module LiqrrdMetal
 	#  p parts.map(&:to_html).join
 	#  #=> "A <span class='match'>Foo</span>l in Lo<span class='match'>v</span>e"
 	def score_with_parts( search, actual )
+		re = RE_CACHE[search] ||= /#{[*search.chars].join('.*?')}/i
 		if search.length==0
 			[ TRAILING[0], [MatchPart.new(actual)] ]
-		elsif search.length > actual.length
+		elsif (search.length > actual.length) || (search !~ re)
 			[ NO_MATCH[0], [MatchPart.new(actual)] ]
 		else
-			values = scores( search, actual )
+			values = letter_scores( search, actual )
 			score  = values.inject{ |sum,score| sum+score } / values.length
 			was_matching,start = nil
 			parts = []
@@ -229,23 +243,42 @@ module LiqrrdMetal
 			[ score, parts ]
 		end
 	end
+	
+	# Returns an array of score/string tuples, sorted by score, below the <code>score_threshold</code>
+	#
+	# Non-matching entries (score of 1.0) will never be included in the results, no matter the value of <code>score_threshold</code>
+	def sorted_with_scores( search, actuals, score_threshold=1.0 )
+		if search.length==0
+			[]
+		else
+			re = RE_CACHE[search] ||= /#{[*search.chars].join('.*?')}/i			
+			actuals.map{ |actual|
+				if actual=~re
+					values = letter_scores( search, actual )
+					score = values.inject{ |sum,score| sum+score } / values.length					
+					[score,actual] if score < score_threshold
+				end
+			}.compact.sort
+		end
+	end
 
 	# Return a score for matching the search term against the actual text.
 	# A score of <code>1.0</code> indicates no match. A score of <code>0.0</code> is a perfect match.
 	def score( search, actual )
+		re = RE_CACHE[search] ||= /#{[*search.chars].join('.*?')}/i
 		if search.length==0
 			TRAILING[0]
-		elsif search.length > actual.length
+		elsif (search.length > actual.length) || (search !~ re)
 			NO_MATCH[0]
 		else
-			values = scores( search, actual )
+			values = letter_scores( search, actual )
 			values.inject{ |sum,score| sum+score } / values.length
 		end
 	end
 
 	# Return an aray of scores for each letter in the actual text.
 	# Returns a single-value array of <code>[0.0]</code> if no match exists.
-	def scores( search, actual )
+	def letter_scores( search, actual )
 		actual_length = actual.length
 		scores = Array.new(actual_length)
 
@@ -270,6 +303,4 @@ module LiqrrdMetal
 		scores[ (last+1)...scores.length ] = (started ? TRAILING_BUT_STARTED : TRAILING) * (scores.length-last-1)
 		scores
 	end
-end
-
-
+end

metadata

@@ -1,52 +1,64 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: liqrrdmetal
-version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  version: "0.6"
 platform: ruby
-authors:
+authors: 
 - Gavin Kistner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-19 00:00:00.000000000 -06:00
+
+date: 2011-04-19 00:00:00 -06:00
 default_executable: 
 dependencies: []
-description: Derived from the LiquidMetal JavaScript library, LiqrrdMetal brings substring
-  scoring to Ruby. Similar to Quicksilver, LiqrrdMetal gives users the ability to
-  quickly find the most relevant items by typing in portions of the string, while
-  seeing the portions of the substring that are being matched.
+
+description: Derived from the LiquidMetal JavaScript library, LiqrrdMetal brings substring scoring to Ruby. Similar to Quicksilver, LiqrrdMetal gives users the ability to quickly find the most relevant items by typing in portions of the string, while seeing the portions of the substring that are being matched.
 email: gavin@phrogz.net
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/liqrrdmetal/liqrrdmetal.rb
 - lib/liqrrdmetal.rb
 has_rdoc: true
 homepage: http://github.com/Phrogz/liqrrdmetal
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-requirements:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
 - StringScanner (part of the Ruby Standard Library)
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Calculate scoring of autocomplete-style substring matches.
 test_files: []
+