fuzzy-prompt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2126de9c18c2f17e0b24606812e0e2e91414aae7
+  data.tar.gz: 13c301285bd18cc56fd40719b29ada64ff523890
+SHA512:
+  metadata.gz: 7f46d6b58fce91375a5ae82e4ac9db89c5282d9b47ed5fb2c4987d2e44c21b5a099de570899e476dc451b0e967008a2a7044ae332bf74f86f5ca19fc5d27b9a8
+  data.tar.gz: 4e5fc6ec854fd3363c4016c7558896777616ed5a5c956405d6b8ebbd1f1baf0535ad62ea7fac2f76ea19548477bf033872d100c42a1e0ecbf386c87086ba7aa4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fuzzy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sudhir Jonathan
+
+MIT License
+
+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,29 @@
+# Fuzzy
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fuzzy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fuzzy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/fuzzy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fuzzy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fuzzy-prompt"
+  spec.version       = Fuzzy::VERSION
+  spec.authors       = ["Sudhir Jonathan"]
+  spec.email         = ["sudhir.j@gmail.com"]
+  spec.description   = %q{Tokenizes, fuzzes and scores strings - good for autocomplete}
+  spec.summary       = %q{Fuzzy tokenizer and ranker}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "i18n"
+  spec.add_dependency "active_support"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/fuzzy.rb

@@ -0,0 +1,63 @@
+require "fuzzy/version"
+
+module Fuzzy
+  class Scorer
+    Token = Struct.new(:token, :weight)
+
+    TermSet = Struct.new(:weight, :terms) do
+      def cleaned_terms
+        terms.flat_map{|t| t.parameterize.split('-')}.to_set
+      end
+
+      def token_weight total_weight
+        weight.fdiv(total_weight * terms.size)
+      end
+
+      def tokens total_weight
+        cleaned_terms.map do |term|
+          Token.new term, token_weight(total_weight)
+        end
+      end
+    end
+
+    def initialize corpus
+      corpus = (corpus || []).reject{|c| c[:weight].blank? or c[:terms].blank?}
+      @corpus = corpus.map{|c| TermSet.new(c[:weight], c[:terms].reject{|t| t.blank?})}
+      @total_weight = @corpus.sum {|c| c.weight}
+      @weighted_tokens = @corpus.flat_map{ |c| c.tokens @total_weight }
+    end
+
+    def rank query
+      scores = @weighted_tokens.map do |wt|
+        length_score = wt.token.starts_with?(query) ? query.length.fdiv(wt.token.length) : 0
+        length_score * wt.weight
+      end
+      score_count = scores.count{|s| s > 0}
+      return 0 unless score_count > 0
+      scores.sum / score_count
+    end
+
+    def tokenize
+      @corpus.flat_map{|c| c.cleaned_terms.to_a}.flat_map do |str|
+        (1..str.length).map { |len| str.slice(0, len) }
+      end.to_set
+    end
+
+    def tokens
+      tokenize.map{|t| Token.new(t, rank(t))}
+    end
+
+    def normalized_tokens
+      basic_tokens = tokens
+      max = basic_tokens.max_by(&:weight).weight
+      min = basic_tokens.min_by(&:weight).weight
+      # Calculate m and c values for the linear transform y=mx+c
+      # m = (y' - y)/(x' - x)
+      m = (1 - 0).fdiv(max - min)
+      # Substituting the max values in, we get 1 = m(max) + c
+      c = 1 - (m * max)
+      basic_tokens.map{|t| Token.new(t.token, (t.weight*m + c))}
+    end
+
+  end
+end

data/lib/fuzzy/version.rb

@@ -0,0 +1,3 @@
+module Fuzzy
+  VERSION = "0.0.1"
+end

data/test/fuzzy_test.rb

@@ -0,0 +1,59 @@
+require 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'active_support/all'
+require 'fuzzy'
+
+class TestFuzzy < Minitest::Test
+	def test_simple_whole_word_scoring
+		sc = Fuzzy::Scorer.new([
+			{weight: 4, terms: ['a', 'b']},
+			{weight: 2, terms: ['c', 'd']}
+		])
+		assert_in_delta 2.fdiv(6), sc.rank('a'), 0.001
+		assert_in_delta 1.fdiv(6), sc.rank('c'), 0.001
+	end
+
+	def test_partial_word_scoring
+		sc = Fuzzy::Scorer.new([
+			{weight: 4, terms: ['ab', 'efwx', nil]},
+			{weight: 2, terms: ['eflm', 'gh', '']},
+			{weight: 2, terms: []},
+			{terms: []},
+			{weight: 23},
+			{}
+		])
+		assert_in_delta 1.fdiv(6), sc.rank('a'), 0.001
+		assert_in_delta 2.fdiv(6), sc.rank('ab'), 0.001
+		assert_in_delta 1.fdiv(12), sc.rank('g'), 0.001
+		assert_in_delta [1.fdiv(6), 1.fdiv(12)].sum.fdiv(2), sc.rank('ef'), 0.001
+
+		assert sc.rank('a') > sc.rank('b')
+		assert sc.rank('ab') > sc.rank('ef')
+		assert_equal sc.rank('ab'), sc.rank('efwx')
+		assert_equal sc.rank('eflm'), sc.rank('gh')
+		assert sc.rank('ef') > sc.rank('g')
+		assert sc.rank('efwx') > sc.rank('gh')
+		assert sc.rank('gh') > sc.rank('e')
+	end
+
+	def test_tokenization
+		sc = Fuzzy::Scorer.new([
+			{weight: 4, terms: ['ab', 'cd']},
+			{weight: 2, terms: ['ef', 'gh']}
+		])
+		assert_equal sc.tokenize, ['a', 'ab', 'c', 'cd', 'e', 'ef', 'g', 'gh'].to_set
+		assert_equal sc.tokens, sc.tokenize.map{|t| Fuzzy::Scorer::Token.new(t, sc.rank(t))}
+	end
+
+	def test_normalization
+		sc = Fuzzy::Scorer.new([
+			{weight: 4, terms: ['ab', 'cd']},
+			{weight: 2, terms: ['ef', 'gh']}
+		])
+		assert_in_delta sc.normalized_tokens.max_by(&:weight).weight, 1, 0.1
+		assert_in_delta sc.normalized_tokens.min_by(&:weight).weight, 0, 0.1
+		assert_equal sc.tokens.map(&:token).to_set, sc.normalized_tokens.map(&:token).to_set
+	end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: fuzzy-prompt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sudhir Jonathan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tokenizes, fuzzes and scores strings - good for autocomplete
+email:
+- sudhir.j@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fuzzy.gemspec
+- lib/fuzzy.rb
+- lib/fuzzy/version.rb
+- test/fuzzy_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: Fuzzy tokenizer and ranker
+test_files:
+- test/fuzzy_test.rb