zelkova 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86b06cdb9578edcaa80c633a1b2205d9a01fd231aaecbc3c8721482ab960da36
+  data.tar.gz: b94f3080271dc65a3c4f21c7e7bf95d1ea25f3b9509825278aeea819b13bd6f4
+SHA512:
+  metadata.gz: a2e6e47acd4da9b54db90a18039f6af0d7635cc54e630570bbbbf3e7f9da5ebc71c5fe7acbe7aa5f2eea40ae8a0ad2c53c1534ee77932649c03f3e04e355d4bd
+  data.tar.gz: f9f6a520545eeaf470729a6ad1332884b6753857b8fd7535c8c3088086b8fb308460dc742a1d791b813176a8ab5247945dd07ab09068603622b95a59f9378dab

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-version
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,57 @@
+require:
+  - rubocop-rails
+  - rubocop-performance
+
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+AllCops:
+  Exclude:
+    - db/schema.rb
+    - 'node_modules/**/*'
+    - 'redis-stable/**/*'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 3.1
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Temporarily turn this off
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: true
+
+Rails/HasAndBelongsToMany:
+  Enabled: true
+
+Style/NumericPredicate:
+  Enabled: true
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: 'never'
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: 'around'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 3.1.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cguess@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zelkova.gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+
+gem "byebug"
+gem "ruby_jard"
+
+gem "rubocop", "~> 1.27", require: false
+gem "rubocop-rails", require: false # Rails specific styles
+gem "rubocop-rails_config", require: false # More Rails stuff
+
+gem "sorbet-static-and-runtime"
+
+gem "tapioca", require: false
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,173 @@
+PATH
+  remote: .
+  specs:
+    zelkova (0.1.0)
+      eikon
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.2.4)
+      actionview (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.2.4)
+      activesupport (= 7.0.2.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.2.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    climate_control (0.2.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    eikon (0.1.1)
+      ruby-vips (~> 2.1)
+      sorbet-runtime (>= 0.5.9204)
+      terrapin (~> 0.6.0)
+    erubi (1.10.0)
+    ffi (1.15.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.16.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    nokogiri (1.13.4-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.4)
+      actionpack (= 7.0.2.4)
+      activesupport (= 7.0.2.4)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    rbi (0.0.14)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.3.1)
+    rexml (3.2.5)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.19.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-packaging (0.5.1)
+      rubocop (>= 0.89, < 2.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.14.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rails_config (1.9.2)
+      railties (>= 5.0)
+      rubocop (>= 1.25.1)
+      rubocop-ast (>= 1.0.1)
+      rubocop-minitest (~> 0.15)
+      rubocop-packaging (~> 0.5)
+      rubocop-performance (~> 1.11)
+      rubocop-rails (~> 2.0)
+    ruby-progressbar (1.11.0)
+    ruby-vips (2.1.4)
+      ffi (~> 1.12)
+    ruby_jard (0.3.1)
+      byebug (>= 9.1, < 12.0)
+      pry (~> 0.13.0)
+      tty-screen (~> 0.8.1)
+    sorbet (0.5.9944)
+      sorbet-static (= 0.5.9944)
+    sorbet-runtime (0.5.9944)
+    sorbet-static (0.5.9944-universal-darwin-21)
+    sorbet-static-and-runtime (0.5.9944)
+      sorbet (= 0.5.9944)
+      sorbet-runtime (= 0.5.9944)
+    spoom (1.1.11)
+      sorbet (>= 0.5.9204)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.7.1)
+      bundler (>= 1.17.3)
+      pry (>= 0.12.2)
+      rbi (~> 0.0.0, >= 0.0.14)
+      sorbet-runtime (>= 0.5.9204)
+      sorbet-static (>= 0.5.9204)
+      spoom (~> 1.1.0, >= 1.1.4)
+      thor (>= 1.2.0)
+      yard-sorbet
+    terrapin (0.6.0)
+      climate_control (>= 0.0.3, < 1.0)
+    thor (1.2.1)
+    tty-screen (0.8.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.6.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  byebug
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rubocop (~> 1.27)
+  rubocop-rails
+  rubocop-rails_config
+  ruby_jard
+  sorbet-static-and-runtime
+  tapioca
+  zelkova!
+
+BUNDLED WITH
+   2.3.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Christopher Guess
+
+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,53 @@
+# Zelkova
+
+This is a pure Ruby implementation of a BK-Tree (https://signal-to-noise.xyz/post/bk-tree/) which
+can be used for any sort of quick comparison for hamming distances. Usually this is for something
+like spell check or auto suggestions, but it can also be utilized for image similarity search as
+well.
+
+It runs completely in memory, which makes it very quick (even at 500,000 words), this takes up a
+little space, taking about 4MB for 400,000 words. Building the graph taking about 35 seconds for 400k
+elements and about 1-2 seconds to search depending on the length of the search query (longer query
+is longer time).
+
+Eventually it'd be faster to rewrite this in C and toss a Ruby wrapper over it, but for now this will
+work quite well for what we want it to.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zelkova'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install zelkova
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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`. 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/[USERNAME]/zelkova. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/zelkova/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Zelkova project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/zelkova/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zelkova"
+
+# 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/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/lib/zelkova/edge.rb

@@ -0,0 +1,26 @@
+# typed: strict
+
+require "sorbet-runtime"
+
+class Zelkova::Edge
+  extend T::Sig
+
+  sig { returns(Zelkova::Node) }
+  attr_reader :start_node
+  sig { returns(Zelkova::Node) }
+  attr_reader :end_node
+  sig { returns(Integer) }
+  attr_reader :weight
+
+  sig { params(start_node: Zelkova::Node, end_node: Zelkova::Node, weight: Integer).void }
+  def initialize(start_node, end_node, weight)
+    @start_node = T.let(start_node, Zelkova::Node)
+    @end_node = T.let(end_node, Zelkova::Node)
+    @weight = T.let(weight, Integer)
+  end
+
+  sig { returns(String) }
+  def inspect
+    "Start Word: #{self.start_node.word}, End Word: #{self.end_node.word}, Weight: #{weight}"
+  end
+end

data/lib/zelkova/graph.rb

@@ -0,0 +1,104 @@
+# typed: strict
+#
+require "sorbet-runtime"
+require "eikon"
+
+require_relative "node"
+require_relative "edge"
+
+class Zelkova::Graph
+  extend T::Sig
+
+  sig { returns(T.nilable(Zelkova::Node)) }
+  attr_reader :root_node
+
+  sig { returns(T::Array[Zelkova::Node]) }
+  attr_reader :nodes
+
+  sig { returns(Integer) }
+  attr_reader :depth
+
+  sig { void }
+  def initialize
+    @root_node = T.let(nil, T.nilable(Zelkova::Node))
+    @nodes = T.let([], T::Array[Zelkova::Node])
+    @depth = T.let(0, Integer)
+  end
+
+  sig { params(word: String).returns(Zelkova::Node) }
+  def add_node(word)
+    node = Zelkova::Node.new(word, self)
+    nodes << node
+
+    if @root_node.nil?
+      @root_node = node
+      @depth = 1
+      return node
+    end
+
+    current_node = T.let(@root_node, Zelkova::Node)
+    node_depth = 1
+
+    loop do
+      distance = Eikon::Comparator.compare(current_node.word, word)
+      break if distance.zero? # don't add if it's already in the graph
+
+      edge = current_node.edges.select { |edge| edge.weight == distance }
+
+      unless edge.empty?
+        current_node = T.must(edge.first).end_node
+        node_depth += 1
+        next
+      end
+
+      current_node.add_edge(node, distance)
+      break
+    end
+
+    @depth = node_depth if node_depth > @depth
+
+    node
+  end
+
+  sig { params(query: String).returns(T::Array[String]) }
+  def search(query)
+    radius = 2
+    candidate_nodes = []
+    candidate_edges = []
+
+    # just so we can start this out
+    candidate_edges << Zelkova::Edge.new(T.must(@root_node), T.must(@root_node), 0)
+
+    loop do
+      node = candidate_edges.pop.end_node
+
+      distance = Eikon::Comparator.compare(query, node.word)
+      candidate_nodes << { node: node, distance: distance } if distance <= radius
+
+      node.edges.each do |edge|
+        if edge.weight > (distance - radius) || edge.weight < (distance + radius)
+          candidate_edges << edge
+        end
+      end
+
+      break if candidate_edges.empty?
+    end
+
+    candidate_nodes.sort_by! { |candidate_node| candidate_node[:distance] }
+    candidate_nodes.map { |candidate_node| candidate_node[:node].word }
+  end
+end
+
+# class Comparator
+#   extend T::Sig
+
+#   sig { params(dhash_1: String, dhash_2: String).returns(Integer) }
+#   def self.compare(dhash_1, dhash_2)
+#     hamming_distance = 0
+#     dhash_1.chars.each_with_index do |character, index|
+#       hamming_distance += 1 if character != dhash_2.chars[index]
+#     end
+
+#     hamming_distance + (dhash_1.length - dhash_2.length).abs
+#   end
+# end

data/lib/zelkova/node.rb

@@ -0,0 +1,32 @@
+# typed: strict
+
+require "sorbet-runtime"
+
+class Zelkova::Node
+  extend T::Sig
+
+  sig { returns(String) }
+  attr_reader :word
+  sig { returns(T::Array[Zelkova::Edge]) }
+  attr_reader :edges
+  sig { returns(Zelkova::Graph) }
+  attr_reader :graph
+
+  sig { params(word: String, graph: Zelkova::Graph).void }
+  def initialize(word, graph)
+    @word = T.let(word, String)
+    @graph = T.let(graph, Zelkova::Graph)
+
+    @edges = T.let([], T::Array[Zelkova::Edge])
+  end
+
+  sig { returns(String) }
+  def inspect
+    "Word: #{self.word}, Number of Edges: #{self.edges.count}"
+  end
+
+  sig { params(node: Zelkova::Node, weight: Integer).void }
+  def add_edge(node, weight)
+    @edges << Zelkova::Edge.new(self, node, weight)
+  end
+end

data/lib/zelkova/version.rb

@@ -0,0 +1,4 @@
+# typed: strict
+module Zelkova
+  VERSION = "0.1.0"
+end

data/lib/zelkova.rb

@@ -0,0 +1,10 @@
+# typed: strict
+require "zelkova/version"
+require "sorbet-runtime"
+require "eikon"
+
+require_relative "zelkova/graph"
+
+module Zelkova
+  class Error < StandardError; end
+end

data/sorbet/config

@@ -0,0 +1,3 @@
+--dir
+.
+--ignore=/vendor/bundle