trie_matcher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4825d60fa8f9fc8493b6ba2d420306ba24a157c5
+  data.tar.gz: 31cf3a39e649f988e711bbff24dc3af0318b9f45
+SHA512:
+  metadata.gz: d0f0695f7791ab6c9d7e814ddc38119a9d13eb9786b8c51a93ec4f59807f709117c638f163c9d161a0aa86b6dcdffd47396b908b0e068348e9cd869bfbfc4850
+  data.tar.gz: 2311159b3187eae2a82650641a510f7830a21f2756b886a1971c754d1c4423fb7ca43bc808193dbc2e2409fcfc84bdb7a45fd7e564c4901c0bb9f443b0cebb06

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Steven Karas
+
+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,40 @@
+# TrieMatcher
+
+Prefix matching in Ruby using a trie
+
+I built this after needing to match user agents quickly, and found that existing trie implementations did not provide suitable interfaces.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trie_matcher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trie_matcher
+
+## Usage
+
+```ruby
+t = TrieMatcher.new
+t["cat"] = "feline"
+t["car"] = "automobile"
+t["bar"] = "exam"
+
+t["cat"] # "feline"
+t["catch"] # "feline"
+t["ca"] # nil
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/trie_matcher/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/trie_matcher/version.rb

@@ -0,0 +1,3 @@
+class TrieMatcher
+  VERSION = "1.0.0"
+end

data/lib/trie_matcher.rb

@@ -0,0 +1,87 @@
+require File.expand_path("trie_matcher/version", __dir__)
+
+class TrieMatcher
+  def initialize
+    @root = { nodes: {}, value: nil}
+  end
+
+  def []=(key, value)
+    current = @root
+    current_key = key
+
+    while current_key != ""
+      current, current_key = find_canididate_insertion_node(current, current_key)
+    end
+
+    current[:value] = value
+    return value
+  end
+
+
+  def [](key)
+    current = @root
+    current_key = key
+
+    while current != nil && current_key != ""
+      previous = current
+      current, current_key = next_node(current, current_key)
+    end
+
+    return current[:value] if current
+    return previous[:value]
+  end
+
+  private
+  def find_canididate_insertion_node(current, key)
+    # look for a common prefix
+    current[:nodes].keys.find do |prefix|
+      common_prefix = shared_prefix(key, prefix)
+      next unless common_prefix
+
+      if common_prefix == prefix
+        return current[:nodes][prefix], key[common_prefix.length..-1]
+      else
+        old = current[:nodes].delete(prefix)
+        new_node = {
+          nodes: {
+            prefix[common_prefix.length..-1] => old
+          },
+          value: nil
+        }
+        current[:nodes][common_prefix] = new_node
+        return new_node, key[common_prefix.length..-1]
+      end
+    end
+
+    new_node = {
+      nodes: {},
+      value: nil
+    }
+    current[:nodes][key] = new_node
+    return new_node, ""
+  end
+
+  # find the next node from the current one based on the given key
+  def next_node(current, key)
+    key.length.times do |l|
+      if current[:nodes].has_key?(key[0..-l-1])
+        return current[:nodes][key[0..-l-1]], key[-l,l]
+      end
+    end
+    return nil, nil
+  end
+
+  # finds a shared prefix between the two strings, or nil if there isn't any
+  def shared_prefix(a, b)
+    shared_prefix_length = [a.length, b.length].min
+    while shared_prefix_length >= 0
+      a_prefix = a[0..shared_prefix_length]
+      b_prefix = b[0..shared_prefix_length]
+      return a_prefix if a_prefix == b_prefix
+
+      shared_prefix_length -= 1
+    end
+
+    return nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'trie_matcher'

data/spec/trie_matcher_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe TrieMatcher do
+  it 'has a version number' do
+    expect(TrieMatcher::VERSION).not_to be nil
+  end
+
+  it 'should store values' do
+    t = TrieMatcher.new
+    t["foo"] = "bar"
+  end
+
+  it 'should retrieve stored values' do
+    t = TrieMatcher.new
+    value = "bar"
+    t["foo"] = value
+    expect(t["foo"]).to be value
+  end
+
+  it 'should return the stored value' do
+    t = TrieMatcher.new
+    value = "bar"
+    expect(t["foo"] = value).to be value
+  end
+
+  it 'should store values with shared prefixes' do
+    t = TrieMatcher.new
+    t["cat"] = 1
+    t["car"] = 2
+    expect(t["cat"]).to be 1
+    expect(t["car"]).to be 2
+  end
+
+  it 'should store keys that are a prefix of other keys' do
+    t = TrieMatcher.new
+    t["catch"] = 1
+    t["cat"] = 2
+    expect(t["catch"]).to be 1
+    expect(t["cat"]).to be 2
+  end
+
+  it 'should store keys that have a prefix of another key' do
+    t = TrieMatcher.new
+    t["cat"] = 1
+    t["catch"] = 2
+    expect(t["cat"]).to be 1
+    expect(t["catch"]).to be 2
+  end
+
+  it 'should do prefix searching' do
+    t = TrieMatcher.new
+    t["cat"] = 1
+    expect(t["cats"]).to be 1
+  end
+
+  it 'should do partial prefix matching' do
+    t = TrieMatcher.new
+    t["cat"] = 1
+    t["cats in the cradle"] = 2
+    expect(t["cats"]).to be 1
+  end
+
+end

data/trie_matcher.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trie_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trie_matcher"
+  spec.version       = TrieMatcher::VERSION
+  spec.authors       = ["Steven Karas"]
+  spec.email         = ["steven.karas@gmail.com"]
+  spec.summary       = %q{Fast prefix matching}
+  spec.description   = %q{Fast prefix matching using a trie-like structure}
+  spec.homepage      = "https://github.com/stevenkaras/trie_matcher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: trie_matcher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steven Karas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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'
+description: Fast prefix matching using a trie-like structure
+email:
+- steven.karas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/trie_matcher.rb
+- lib/trie_matcher/version.rb
+- spec/spec_helper.rb
+- spec/trie_matcher_spec.rb
+- trie_matcher.gemspec
+homepage: https://github.com/stevenkaras/trie_matcher
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Fast prefix matching
+test_files:
+- spec/spec_helper.rb
+- spec/trie_matcher_spec.rb