fuzzy_set 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8ca0bdbe55c19972e9df5c589d606a81b94270d
+  data.tar.gz: da1885c2d00aa8ba8043f72294cbad17e90bc8ec
+SHA512:
+  metadata.gz: b0b987aa8cd7d0143424fe6d6fcff33f90dccf7a1c7fb60d5bb23c699fb1df229119f0e8de97405bb682cd0ecbc631beed51a19800460e67c0e8f4385f690ff0
+  data.tar.gz: 18a257eb888a1feffbfecb9065116b19add560c5354a598f75605f1660a132d861abe86fd69f6afc641b2341647cbb0e64a4128fb70de3bf6f65d28b11df6556

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0-p647
+  - 2.1.7
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fuzzy_set.gemspec
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'growl'
+end

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Manuel Hutter
+
+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,51 @@
+# FuzzySet
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fuzzy_set`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fuzzy_set'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fuzzy_set
+
+## Usage
+
+```ruby
+require 'fuzzy_set'
+
+states = open('states.txt').read.split(/\n/)
+fs = FuzzySet.new(*states)
+
+fs.exact_match('michigan!') # => "Michigan"
+fs.exact_match('mischigen') # => nil
+
+fs.get('mischigen')
+# => ["Michigan", "Wisconsin", "Mississippi", "Minnesota", "Missouri"]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mhutter/fuzzy_set.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fuzzy_set'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/fuzzy_set.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fuzzy_set/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fuzzy_set'
+  spec.version       = FuzzySet::VERSION
+  spec.authors       = ['Manuel Hutter']
+  spec.email         = ['manuel@hutter.io']
+
+  spec.summary       = %q{FuzzySet allows you to fuzzy-search Strings!}
+  spec.description   = %q{FuzzySet allows you to fuzzy-search Strings!}
+  spec.homepage      = 'https://github.com/mhutter/fuzzy_set'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'string-similarity', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,14 @@
+class String
+  # break apart the string into strings of length `n`
+  #
+  # @example
+  #     'foobar'.ngram(3)
+  #     # => ["-fo", "foo", "oob", "oba", "bar", "ar-"]
+  def ngram(n)
+    fail ArgumentError, "n must be > 1, is #{n}" if n < 2
+    str = "-#{self}-"
+    (str.length - n + 1).times.map do |i|
+      str.slice(i, n)
+    end
+  end
+end

data/lib/fuzzy_set.rb

@@ -0,0 +1,106 @@
+require 'string/similarity'
+
+require 'fuzzy_set/version'
+require 'core_ext/string'
+
+# FuzzySet implements a fuzzy-searchable set of strings.
+#
+# As a set, it cannot contain duplicate elements.
+class FuzzySet
+  NGRAM_SIZE = 3
+
+  def initialize(*items)
+    @items = []
+    @denormalize = {}
+    @index = {}
+
+    add(*items)
+  end
+
+  # Normalizes +query+, and looks up an entry by its normalized value.
+  #
+  # @param query [String] search query
+  # @return [String] matched (denormalized) value or `nil`
+  def exact_match(query)
+    @denormalize[normalize(query)]
+  end
+
+  # Add one or more +items+ to the set.
+  #
+  # Each item will be converted into a string and indexed upon adding.
+  #
+  # @param items [#to_s] item(s) to add
+  # @return [FuzzySet] +self+
+  def add(*items)
+    items.each do |item|
+      item = item.to_s
+      return self if @items.include?(item)
+
+      id = _add(item)
+      calculate_grams_for(normalize(item), id)
+    end
+    self
+  end
+
+  # @see #add
+  def <<(item)
+    add(item)
+  end
+
+  # Fuzzy-find a string based on +query+
+  #
+  # 1. normalize +query+
+  # 2. check for an exact match and return, if present
+  # 3. find matches based on Ngrams
+  # 4. sort matches by their cosine similarity to +query+
+  def get(query)
+    query = normalize(query)
+
+    # check for exact match
+    return [@denormalize[query]] if @denormalize[query]
+
+    match_ids = query.ngram(NGRAM_SIZE).map { |ng| @index[ng] }
+    match_ids = match_ids.flatten.compact.uniq
+    matches = match_ids.map { |id| @items[id] }
+
+    # sort matches by their cosine distance to query
+    matches.sort_by { |match| 1.0 - String::Similarity.cosine(query, match) }
+  end
+
+  # @return [Boolean] +true+ if the given +item+ is present in the set.
+  def include?(item)
+    @items.include?(item)
+  end
+
+  # @return [Fixnum] Number of elements in the set.
+  def length
+    @items.length
+  end
+  alias_method :size, :length
+
+  # @return [Boolean] +true+, if there are no items yet.
+  def empty?
+    @items.empty?
+  end
+
+  private
+
+  # Normalize a string by removing all non-word characters
+  # except spaces and then converting it to lowercase.
+  def normalize(str)
+    str.gsub(/[^\w ]/, '').downcase
+  end
+
+  def _add(item)
+    @items.push(item)
+    normalized = normalize(item)
+    @denormalize[normalized] = item
+    @items.index(item)
+  end
+
+  def calculate_grams_for(string, id)
+    string.ngram(NGRAM_SIZE).each do |gram|
+      @index[gram] = (@index[gram] || []).push(id)
+    end
+  end
+end

data/lib/fuzzy_set/version.rb

@@ -0,0 +1,3 @@
+class FuzzySet
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: fuzzy_set
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Manuel Hutter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: string-similarity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: simplecov
+  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: FuzzySet allows you to fuzzy-search Strings!
+email:
+- manuel@hutter.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fuzzy_set.gemspec
+- lib/core_ext/string.rb
+- lib/fuzzy_set.rb
+- lib/fuzzy_set/version.rb
+homepage: https://github.com/mhutter/fuzzy_set
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: FuzzySet allows you to fuzzy-search Strings!
+test_files: []
+has_rdoc: