graphed_fuzzy_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd030d3d31c4838402d85fb1cb7ec8e65f641afca3f9c395294e14192bb74938
+  data.tar.gz: 454a974ca7e1c1c7a479b881024227128d3ab32470be050ef1777bc30d02e653
+SHA512:
+  metadata.gz: 220d763cff6b305ff3627d591c8f99f1242f3ac761c15651bbfbaa21d2fac568777ede19c9d37b4bf4f76884a13ea4e3576076a1d65da9806c829cd6d3e7006d
+  data.tar.gz: 52a98f177ea3bcf4688a390c922b8babedb732b154ae06355d847bf35ad9a54e805cc10ff262e86aa04fa13325d5d01051a7ee8896728c134a560ff1e7483d88

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in graphed_fuzzy_search.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    graphed_fuzzy_search (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  graphed_fuzzy_search!
+  rake
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sorah Fukumori
+
+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,103 @@
+# GraphedFuzzySearch: filter items like Slack switcher, Atom command palette can
+
+
+``` ruby
+s = GraphedFuzzySearch.new(%w(john-appleseed john-doe jonathan-doe alice-eve eve-doe))
+p s.query('d') #=> ["john-doe", "jonathan-doe", "eve-doe"]
+p s.query('dj') #=> ["john-doe", "jonathan-doe"]
+p s.query('djoh') #=> ["john-doe"]
+p s.query('a') #=> ["alice-eve", "john-appleseed"]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphed_fuzzy_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphed_fuzzy_search
+
+## Usage
+
+### Basic
+
+``` ruby
+s = GraphedFuzzySearch.new(%w(john-appleseed john-doe jonathan-doe alice-eve eve-doe))
+p s.query('d') #=> ["john-doe", "jonathan-doe", "eve-doe"]
+p s.query('dj') #=> ["john-doe", "jonathan-doe"]
+p s.query('djoh') #=> ["john-doe"]
+p s.query('a') #=> ["alice-eve", "john-appleseed"]
+```
+
+### Multiple attributes
+
+``` ruby
+Item = Struct.new(:name, :email)
+items = [Item.new('John Doe', 'john-doe@example.com')]
+s = GraphedFuzzySearch.new(items, attributes: %i(name email))
+# Hint: default +attributes:+ is %i(name)
+```
+
+### Custom tokenize
+
+``` ruby
+p GraphedFuzzySearch.new(["token_one token_two"]).query('one') #=> ["token_one token_two"]
+p GraphedFuzzySearch.new(["token_one token_two"], token_regex: /\w+/).query('one') #=> []
+```
+
+## Internal
+
+- index
+  1. Split into tokens (substring determined by `token_regex` defaults to `/[^\p{Punct}\p{Space}]+/`)
+  2. construct a trie for tokens. each trie is independent for each item.
+- query
+  1. walk all tries by every character of a given query.
+
+```
+Items:
+  ax-by
+  cy-ax
+  by
+  bye
+
+Tokens:
+  ax by
+  cy ax
+  by
+  bye
+
+Tries:
+  a->x b->y, a->b x->b, b->a y->a
+  c->y a->x, c->a y->a, a->c x->c
+  b->y
+  b->y->e
+```
+
+## Plans
+
+Pull Requests are welcomed.
+
+- Dump/Load an index (tree)
+- Compressing an index
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sorah/graphed_fuzzy_search.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphed_fuzzy_search"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphed_fuzzy_search.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphed_fuzzy_search/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphed_fuzzy_search"
+  spec.version       = GraphedFuzzySearch::VERSION
+  spec.authors       = ["Sorah Fukumori"]
+  spec.email         = ["sorah@cookpad.com"]
+
+  spec.summary       = %q{filter items like Slack switcher, Atom command palette}
+  spec.homepage      = "https://github.com/sorah/graphed_fuzzy_search"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/graphed_fuzzy_search.rb

@@ -0,0 +1,131 @@
+#require "graphed_fuzzy_search/version"
+
+module GraphedFuzzySearch
+  def self.new(*args, **kwargs)
+    Collection.new(*args, **kwargs)
+  end
+
+  DEFAULT_TOKEN_REGEX = /[^\p{Punct}\p{Space}]+/
+
+  class Collection
+    def initialize(objects, attributes: [:to_s], token_regex: DEFAULT_TOKEN_REGEX, normal_weight: 1, different_token_weight: 5)
+      @objects = objects
+      @attributes = attributes
+      @token_regex = token_regex
+      @normal_weight = normal_weight
+      @different_token_weight = different_token_weight
+      trees
+    end
+
+    def inspect
+      "#<#{self.class.name}>"
+    end
+
+    attr_reader :objects, :attributes, :token_regex
+    attr_reader :normal_weight, :different_token_weight
+
+    def query(*args, **kwargs)
+      query_raw(*args, **kwargs).map{ |(node, _)| node.item.object }
+    end
+
+    def query_raw(str, max_scan: str.size)
+      str = str.downcase
+      chars = str.chars
+      i = 0
+      needles = trees.map { |root| [root, 0] }
+      while i < chars.size && i < max_scan && !needles.empty?
+        char = chars[i]
+        needles.map! { |(node, weight)| [node[char], weight] }
+        needles.select!(&:first)
+        needles.map! { |(conn, weight)| [conn.node, weight + conn.weight] }
+        i += 1
+      end
+      needles.map! { |(conn, weight)|
+        if conn.item.key.start_with?(str)
+          weight *= 0.7
+        end
+        [conn, weight]
+      }
+      needles.sort_by(&:last)
+    end
+
+    def items
+      @items ||= objects.map do |obj|
+        attrs = attributes.flat_map do |k|
+          [*obj.send(k)]
+        end
+        tokens = attrs.flat_map do |attr|
+          attr.to_s.downcase.scan(token_regex)
+        end
+        Item.new(obj, attrs[0], tokens)
+      end
+    end
+
+    def trees
+      @trees ||= items.map do |item|
+        root = Node.new(nil, [], item)
+        token_and_heads = item.tokens.map do |token|
+          root.mine(normal_weight, token)
+          [token, root[token[0]].node]
+        end
+        token_and_heads.each do |(_, ah)|
+          token_and_heads.each do |(bt, _)|
+            root.walk(bt.each_char) do |n|
+              n.connect(different_token_weight, ah)
+            end
+          end
+        end
+        root
+      end
+    end
+  end
+
+  Item = Struct.new(:object, :key, :tokens)
+  Connection = Struct.new(:weight, :node)
+
+  Node = Struct.new(:str, :adjacents, :item) do
+    def inspect
+      "#<#{self.class.name} @item=#{item.inspect} @str=#{str.inspect} adjacents=#{adjacents.map(&:first).join}>"
+    end
+    def head
+      str[0]
+    end
+
+    def length
+      str.size
+    end
+
+    def [](k)
+      self.adjacents ||= []
+      _, adjacent = adjacents.find { |c, _| c == k }
+      adjacent
+    end
+
+    def walk(enum)
+      weight = 0
+      enum.inject(self) do |r, i|
+        c = r[i]
+        raise unless c
+        weight += c.weight
+        yield c.node
+        c.node
+      end
+      weight
+    end
+
+    def mine(weight, str)
+      str.each_char.inject(self) do |r, i|
+        r.connect(weight, Node.new(i, [], self.item))
+      end
+    end
+
+    def connect(weight, node)
+      return nil if node.__id__ == self.__id__
+      self.adjacents ||= []
+      connection = self[node.str]
+      return connection.node if connection
+      adjacents << [node.head, Connection.new(weight, node)]
+      node
+    end
+  end
+end

data/lib/graphed_fuzzy_search/version.rb

@@ -0,0 +1,3 @@
+module GraphedFuzzySearch
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: graphed_fuzzy_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sorah Fukumori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- sorah@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphed_fuzzy_search.gemspec
+- lib/graphed_fuzzy_search.rb
+- lib/graphed_fuzzy_search/version.rb
+homepage: https://github.com/sorah/graphed_fuzzy_search
+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.7.3
+signing_key: 
+specification_version: 4
+summary: filter items like Slack switcher, Atom command palette
+test_files: []