goto_string 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 / 2007-07-20
+
+* 1 major enhancement
+  * Gemification of goto_string library
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/goto_string.rb
+test/goto_string_test.rb

data/README.txt

@@ -0,0 +1,49 @@
+goto_string
+    by Max Muermann
+    
+
+== DESCRIPTION:
+  
+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
+
+== FEATURES/PROBLEMS:
+  
+* Partial string matching
+* The algorithm is not particularly performant
+
+== SYNOPSIS:
+
+  [""]
+
+== REQUIREMENTS:
+
+* None
+
+== INSTALL:
+
+* sudo gem install goto_string
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+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,13 @@
+require 'rubygems'
+require 'hoe'
+require './lib/goto_string.rb'
+
+Hoe.new('goto_string', GotoString::VERSION) do |p|
+  p.rubyforge_name = 'goto_string'
+  p.author = 'Max Muermann'
+  p.email = 'max@muermann.org'
+  p.summary = 'Quicksilver-like partial string matching'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end

data/lib/goto_string.rb

@@ -0,0 +1,82 @@
+require 'enumerator'
+require 'jcode'
+
+module GotoString
+  VERSION = "0.1.0"
+  
+  class Matcher
+    
+    @@weight_consecutive = 14
+    @@weight_positional = 1
+    
+    def Matcher.weight_consecutive= val
+      @@weight_consecutive=val
+    end
+
+    def Matcher.weight_positional= val
+      @@weight_positional=val
+    end  
+    
+    def Matcher.match( pattern, candidates, &block )
+      
+      pattern.gsub! "'",""
+      pattern.downcase!
+      
+      matches = []
+      candidates.each do |candidate_obj|
+        if block_given?
+          candidate = yield candidate_obj
+        else
+          candidate = candidate_obj
+        end
+        candidate = candidate.downcase
+        
+        pat = pattern.dup.unpack('c*')
+        can = candidate.dup
+        
+        pattern_len = pattern.size
+        matched_strings = []
+        current_pos = 0
+        consecutive = 0
+        sum_positions = 0
+        
+        while (s=pat.shift) && (index=can.index(s))
+          current_pos += index+1
+          can = can[index+1..-1]
+
+          if (0 != index || matched_strings.empty?)
+            matched_strings << [s.chr,current_pos-1]
+          else
+            matched_strings.last[0] << s.chr
+          end
+          
+        end
+        
+        next if !pat.empty?
+
+        sum_positions = 0
+        consecutive = 0
+
+        matched_strings.each do |m|
+          ms = m[0].size
+          consecutive += (ms-1)*(ms-1)
+          sum_positions += (m[1]+m[1]+ms-1)*ms/2
+        end
+
+        score_position = ((pattern_len.to_f)*(pattern_len.to_f+1)/2.0) / sum_positions
+        score_consecutive = consecutive.to_f / (pattern_len*pattern_len)
+        matches <<[ candidate_obj, candidate, ( score_consecutive * @@weight_consecutive + score_position *@@weight_positional)/(@@weight_consecutive+@@weight_positional), matched_strings]
+      end
+      matches.sort do |a,b|
+        if a[2]<b[2]
+          1
+        elsif a[2]>b[2]
+          -1
+        else
+          a[1].size <=> b[1].size
+        end
+      end
+    end
+    
+  end  
+end

data/test/goto_string_test.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GotoStringTest < Test::Unit::TestCase
+  fixtures :notes
+
+  def test_simple
+    s = %w( iamapala implementation impl simple nomatch )
+    a = GotoString::Matcher.match 'impl', s
+    assert a
+    assert_equal 4, a.size
+    assert_equal 'impl', a[0][0]
+    assert_equal 'implementation', a[1][0]
+    assert_equal 'simple', a[2][0]
+    assert_equal 'iamapala', a[3][0]
+  end
+  
+  def test_with_block
+    s = %w( iamapala implementation impl simple nomatch )
+    s = [1,2,3,4,5].zip(s)
+    a = GotoString::Matcher.match 'impl', s do |e| e[1] end
+    assert a
+    assert_equal 4, a.size
+    assert_equal [3, 'impl'], a[0][0]
+    assert_equal [2, 'implementation'], a[1][0]
+  end
+  
+  def test_weights
+    GotoString::Matcher.weight_consecutive = 0
+    GotoString::Matcher.weight_positional = 1
+    s = %w( iamapala implementation impl simple nomatch )
+    a = GotoString::Matcher.match 'impl', s
+    assert a
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: goto_string
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-07-20 00:00:00 +10:00
+summary: Quicksilver-like partial string matching
+require_paths: 
+- lib
+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:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Max Muermann
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/goto_string.rb
+- test/goto_string_test.rb
+test_files: []
+
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: