trie_matcher 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4825d60fa8f9fc8493b6ba2d420306ba24a157c5
-  data.tar.gz: 31cf3a39e649f988e711bbff24dc3af0318b9f45
+  metadata.gz: 5315d69c65616a5d7ff6d608f1bdeb6584ac1907
+  data.tar.gz: 97ee1b5ec00f18bd74d1c8773c593a6a02e8ce56
 SHA512:
-  metadata.gz: d0f0695f7791ab6c9d7e814ddc38119a9d13eb9786b8c51a93ec4f59807f709117c638f163c9d161a0aa86b6dcdffd47396b908b0e068348e9cd869bfbfc4850
-  data.tar.gz: 2311159b3187eae2a82650641a510f7830a21f2756b886a1971c754d1c4423fb7ca43bc808193dbc2e2409fcfc84bdb7a45fd7e564c4901c0bb9f443b0cebb06
+  metadata.gz: f7f960eb2dc46fab205c154ab44fb1159b2a70c4d0a434dd34e4af3de12529dc58b3165525d06f5fe5eaf639fcade2e95c183fb26d92f890414f4d6e23ca3a28
+  data.tar.gz: 46b3096cce0312b9b2ca9c76f1054278b042f3d3338cf16dcefa02e44ae79e2b2b5da3436f77a4c846017736a9de9037495e2a90a6e29eb471eda2e2c8851aef

data/lib/trie_matcher/pattern_matcher.rb

@@ -0,0 +1,37 @@
+require File.expand_path("../trie_matcher", __dir__)
+
+# Convenience class for matching specific patterns, accelerated by a static prefix.
+#
+# This is extremely useful for matching complex patterns such as user agents or url routes
+class TrieMatcher::PatternMatcher
+  # Build an empty pattern matcher
+  def initialize
+    @trie = TrieMatcher.new
+  end
+
+  # Register a pattern, along with a static prefix
+  #
+  # @param prefix [String] a static prefix that indicates this pattern should be tested
+  # @param pattern [Regexp] a pattern to test against
+  # @yield [match] executed if a positive match is made
+  # @yieldparam match [MatchData] the match data from the pattern
+  def add_pattern(prefix, pattern, &block)
+    @trie[prefix] ||= {}
+    @trie[prefix][pattern] = block
+  end
+
+  # Match a string against all registered patterns efficiently.
+  #
+  # Calls the block registered against any matching pattern, and passes in the match data
+  #
+  # @param string [String] the string to match against
+  def match(string)
+    result = @trie[string]
+    return nil unless result
+    result.each do |pattern, block|
+      match = pattern.match(string)
+      block.call(match) if match
+    end
+  end
+
+end

data/lib/trie_matcher/version.rb

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

data/lib/trie_matcher.rb

@@ -1,30 +1,43 @@
 require File.expand_path("trie_matcher/version", __dir__)
 
+# Trie implementation that acts as a weak mapping
+#
+# Values can be stored for a given prefix, and are returned for the longest prefix.
+# Lookup searches for longer prefixes optimistically, so saturated tries with many lexemes in them will be less efficient
 class TrieMatcher
+  # Build an empty trie
   def initialize
     @root = { nodes: {}, value: nil}
   end
 
-  def []=(key, value)
+  # Store a prefix in the trie, and associate a value with it
+  #
+  # @param prefix [String]
+  # @param value [Object] a value to return if prefix is the longest prefix on lookup
+  # @return [Object] the value that was set
+  def []=(prefix, value)
     current = @root
-    current_key = key
+    current_prefix = prefix
 
-    while current_key != ""
-      current, current_key = find_canididate_insertion_node(current, current_key)
+    while current_prefix != ""
+      current, current_prefix = find_canididate_insertion_node(current, current_prefix)
     end
 
     current[:value] = value
     return value
   end
 
-
-  def [](key)
+  # Perform a prefix search. Will return the value associated with the longest prefix
+  #
+  # @param prefix [String] what to check for a prefix in
+  # @return [Object] the value associated with the longest matching prefix in this trie
+  def [](prefix)
     current = @root
-    current_key = key
+    current_prefix = prefix
 
-    while current != nil && current_key != ""
+    while current != nil && current_prefix != ""
       previous = current
-      current, current_key = next_node(current, current_key)
+      current, current_prefix = next_node(current, current_prefix)
     end
 
     return current[:value] if current
@@ -32,6 +45,7 @@ class TrieMatcher
   end
 
   private
+  # get the node for insertion, splitting shared prefixes into subnodes if necessary
   def find_canididate_insertion_node(current, key)
     # look for a common prefix
     current[:nodes].keys.find do |prefix|

data/spec/trie_matcher_spec.rb

@@ -60,4 +60,11 @@ describe TrieMatcher do
     expect(t["cats"]).to be 1
   end
 
+  it 'should return the more specific prefix value' do
+    t = TrieMatcher.new
+    t["cat"] = 1
+    t["catch"] = 2
+    expect(t["catcher"]).to be 2
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trie_matcher
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Steven Karas
@@ -67,6 +67,7 @@ files:
 - README.md
 - Rakefile
 - lib/trie_matcher.rb
+- lib/trie_matcher/pattern_matcher.rb
 - lib/trie_matcher/version.rb
 - spec/spec_helper.rb
 - spec/trie_matcher_spec.rb