ruby-string-match-scorer 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+tmp
+.idea
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bodaniel Jeanes
+
+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/README.md

@@ -0,0 +1,58 @@
+# Usage
+
+Just require `string_scorer` into your Ruby code and use the `String#score`
+method to find out the score for a matching string. Especially useful for
+sorting arrays of strings in search results etc...
+
+    require 'string_scorer'
+
+    string = "Hello, World"
+
+    puts string.score("xyz")                        # => 0.0
+    puts string.score("Hello World")                # => 0.915384615384615
+    puts string.score("H,W")                        # => 0.642307692307692
+    puts string.score("orl")                        # => 0.353846153846154
+    puts string.score("ll")                         # => 0.707692307692308
+
+    puts string.score("xyz", :quicksilver)          # => 0.0
+    puts string.score("Hello World", :quicksilver)  # => 0.708333333333333
+    puts string.score("H,W", :quicksilver)          # => 0.568402777777778
+    puts string.score("orl", :quicksilver)          # => 0.75
+    puts string.score("ll", :quicksilver)           # => 0.766666666666667
+
+# Other Stuff
+
+You can use different scoring algorithms. Out of the box this comes with a 
+direct port of the [QuickSilver](http://is.gd/CUqC) algorithm and the adapted
+[LiquidMetal](http://github.com/rmm5t/liquidmetal) one.
+
+LiquidMetal scorer is faster with longer strings and also handles case
+differences better.
+
+It's easy to create other scoring algorithms, just look at any of the files
+in `lib/string_scorer/scorers` directory
+
+# License
+
+Copyright (c) 2009 Bodaniel Jeanes
+
+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,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-string-match-scorer"
+    gem.summary = "Quicksilver-like string match scoring"
+    gem.description = "Flex matching short abbreviations against longer strings is a boon in productivity for typists. Applications like Quicksilver, LaunchBar, and Launchy have made this method of keyboard entry a popular one."
+    gem.email = "me@bjeanes.com"
+    gem.homepage = "http://github.com/bjeanes/ruby-string-match-scorer"
+    gem.authors = ["Bodaniel Jeanes"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-string-match-scorer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/string_scorer.rb

@@ -0,0 +1,2 @@
+require 'string_scorer/scorer'
+require 'string_scorer/string_ext'

data/lib/string_scorer/scorer.rb

@@ -0,0 +1,25 @@
+module StringScorer
+  class << self
+    def register(id, klass)
+      scorers[id.to_sym] = klass
+    end
+
+    def []=(id, klass)
+      register(id, klass)
+    end
+
+    def [](id)
+      scorers[id.to_sym] || raise("No such scoring algorithm")
+    end
+
+    private
+    def scorers
+      @scorers ||= {}
+    end
+  end
+end
+
+scorers = File.expand_path(File.join(File.dirname(__FILE__), 'scorers', '*.rb'))
+Dir[scorers].each do |scorer|
+  load(scorer)
+end

data/lib/string_scorer/scorers/liquidmetal.rb

@@ -0,0 +1,76 @@
+class String
+  protected
+
+  # Algorithm from http://github.com/rmm5t/liquidmetal/blob/master/liquidmetal.js
+  module LiquidMetal
+    StringScorer.register(:liquid_metal, self)
+
+    class << self
+      SCORE_NO_MATCH             = 0.0;
+      SCORE_MATCH                = 1.0;
+      SCORE_TRAILING             = 0.8;
+      SCORE_TRAILING_BUT_STARTED = 0.9;
+      SCORE_BUFFER               = 0.85;
+
+      def score(string, abbreviation)
+        # Short circuits
+        return SCORE_TRAILING if abbreviation.length == 0
+        return SCORE_NO_MATCH if abbreviation.length > string.length
+        return SCORE_MATCH    if abbreviation == string
+
+        scores = score_array(string, abbreviation);
+        scores.inject(0) {|v,m| v + m} / scores.size
+      end
+
+      def score_array(string, abbreviation)
+        scores = Array.new(string.length)
+        lower  = string.downcase
+        chars  = abbreviation.downcase.split("")
+
+        last_index = -1
+        started    = false
+        chars.each do |c|
+          index = lower.index(c, last_index + 1)
+
+          return fill_array(scores, SCORE_NO_MATCH) if index.nil?
+          started = true if index == 0
+
+          if new_word?(string, index)
+            scores[index-1] = 1;
+            fill_array(scores, SCORE_BUFFER, last_index + 1, index - 1)
+          elsif uppercase?(string, index)
+            fill_array(scores, SCORE_BUFFER, last_index + 1, index)
+          else
+            fill_array(scores, SCORE_NO_MATCH, last_index + 1, index)
+          end
+
+          scores[index] = SCORE_MATCH
+          last_index = index
+        end
+
+        trailing_score = (started ? SCORE_TRAILING_BUT_STARTED : SCORE_TRAILING)
+        fill_array(scores, trailing_score, last_index + 1)
+        scores
+      end
+
+      def new_word?(string, index)
+        c = string[index - 1]
+        (index == 0 || c==32 || c == 9)
+      end
+
+      def uppercase?(string, index)
+        c = string[index]
+        (65..90).include?(c)
+      end
+
+      def fill_array(array, value, from=0, to=array.size)
+        from = 0 if from < 0
+        to   = 0 if to   < 0
+        size = 1 + (to - from)
+
+        array[from..to] = Array.new(size, value)
+        array
+      end
+    end
+  end
+end

data/lib/string_scorer/scorers/quicksilver.rb

@@ -0,0 +1,58 @@
+class String
+  protected
+
+  # Algorithm from http://is.gd/CUqC 
+  module Quicksilver
+    StringScorer.register(:quicksilver, self)
+
+    class << self
+      def score(string, abbreviation, offset = 0)
+        length = abbreviation.length
+
+        return 0.9 if length == 0
+        return 0.0 if length > string.length
+
+        abbreviation.length.downto(1) do |i|
+          sub   = abbreviation[0,i]
+          index = string.index(sub)
+
+          next if index.nil?
+          next if index + length > string.length + offset
+
+          next_string       = string[(index+sub.length)..-1]
+          next_abbreviation = (i >= abbreviation.length) ? '' : abbreviation[i..-1]
+
+          remaining_score   = score(string, next_abbreviation, offset + index)
+
+          if remaining_score > 0
+            score = string.length - next_string.length
+
+            if index != 0
+              c = string[index-1]
+
+              if (c==32 || c == 9)     # space or tab
+                (index-2).downto(0) do |j|
+                  c = string[j]
+                  score -= ((c == 32 || c == 9) ? 1 : 0.15)
+                end
+              elsif c >= 65 && c <= 90 # capital letter
+                (index-1).downto(0) do |j|
+                  c = string[j]
+                  score -= (c >= 65 && c <= 90 ? 1 : 0.15)
+                end
+              else
+                score -= index
+              end
+            end
+
+            score += remaining_score * next_string.length
+            score /= string.length
+            return score
+          end
+        end
+
+        0.0
+      end
+    end
+  end
+end

data/lib/string_scorer/string_ext.rb

@@ -0,0 +1,6 @@
+class String
+  
+  def score(abbreviation, method = :liquid_metal)
+    StringScorer[method].score(self, abbreviation)
+  end
+end

data/ruby-string-match-scorer.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-string-match-scorer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bodaniel Jeanes"]
+  s.date = %q{2009-12-10}
+  s.description = %q{Flex matching short abbreviations against longer strings is a boon in productivity for typists. Applications like Quicksilver, LaunchBar, and Launchy have made this method of keyboard entry a popular one.}
+  s.email = %q{me@bjeanes.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/string_scorer.rb",
+     "lib/string_scorer/scorer.rb",
+     "lib/string_scorer/scorers/liquidmetal.rb",
+     "lib/string_scorer/scorers/quicksilver.rb",
+     "lib/string_scorer/string_ext.rb",
+     "ruby-string-match-scorer.gemspec",
+     "test/helper.rb",
+     "test/test_ruby-string-match-scorer.rb"
+  ]
+  s.homepage = %q{http://github.com/bjeanes/ruby-string-match-scorer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Quicksilver-like string match scoring}
+  s.test_files = [
+    "test/test_ruby-string-match-scorer.rb",
+     "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ruby-string-match-scorer'
+
+class Test::Unit::TestCase
+end

data/test/test_ruby-string-match-scorer.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRubyStringMatchScorer < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-string-match-scorer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bodaniel Jeanes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-11 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Flex matching short abbreviations against longer strings is a boon in productivity for typists. Applications like Quicksilver, LaunchBar, and Launchy have made this method of keyboard entry a popular one.
+email: me@bjeanes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/string_scorer.rb
+- lib/string_scorer/scorer.rb
+- lib/string_scorer/scorers/liquidmetal.rb
+- lib/string_scorer/scorers/quicksilver.rb
+- lib/string_scorer/string_ext.rb
+- ruby-string-match-scorer.gemspec
+- test/helper.rb
+- test/test_ruby-string-match-scorer.rb
+has_rdoc: true
+homepage: http://github.com/bjeanes/ruby-string-match-scorer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Quicksilver-like string match scoring
+test_files: 
+- test/helper.rb
+- test/test_ruby-string-match-scorer.rb