levenshtein_lite 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27f636a2c32c7603879234434d8fc128514448efc77e25cd7dd921ee5cc77e54
-  data.tar.gz: 6be6e75c4622230a2d7ebc63942bac4353c35c011c7a47851416b704194cf9bb
+  metadata.gz: 8ff593c873777192903631e7000215c6953b85ce530f30382d1da7d55fc15661
+  data.tar.gz: a06997d04cef02c7e4390c6c6f2ba4082f064c72a76759403106451d835722c7
 SHA512:
-  metadata.gz: d2f72d0652980d0ac28442101c61370f341d9e1ee1a0db3e25d0f0835eba8e68cb9adea088cfc67e7770d84d77dfc631abfb3a12d4cf85cc4f31da1fc4843cc0
-  data.tar.gz: 4ab59b1a3c781e27e04e5e889260ad700050f3f9ba0b136fa5603b1c1582d0a2f84ea8044e23952e20dfd6c8038c754189a81bfa705a7c225f61824482a2f92f
+  metadata.gz: 0dbceb45a6a8355a4546b1ebad2f8b19c43e34d784c3798cdcdbe3ea9e382db927f4deae7a9ac6a23764bcdd0b3b31e732412f01a6f0bfaf09121459580e42bf
+  data.tar.gz: d55d6cf258f729739732ca797e9fb8435d9bf4aad6229379efb5db866b32f4849b1264437f3f08565b9099ddd6eac8808b496f80f66fb698dae0e81ad2001c5b

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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 erin.paget@clio.com. All
+reported by contacting the project team at erin.dees@hey.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.

data/README.md

@@ -1,5 +1,8 @@
 # levenshtein_lite
 
+- [![CI](https://github.com/undees/levenshtein_lite/actions/workflows/ci.yml/badge.svg)](https://github.com/undees/levenshtein_lite/actions/workflows/ci.yml)
+- [![Gem Version](https://img.shields.io/gem/v/levenshtein_lite.svg)](https://rubygems.org/gems/levenshtein_lite)
+
 A fast, hand-tuned, Unicode-aware, allocation-savvy implementation of the Levenshtein string distance algorithm.
 
 ## Installation

data/lib/levenshtein_lite/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LevenshteinLite
-  VERSION = "0.1.0"
+  VERSION = "1.0.1"
 end

data/lib/levenshtein_lite.rb

@@ -1,34 +1,46 @@
+# frozen_string_literal: true
+
 require "levenshtein_lite/version"
 
+# Pure-Ruby implementation of the Levenshtein algorithm,
+# tuned for speed and minimal allocations.
 module LevenshteinLite
-  def self.distance(s1, s2)
-    return s1.length if s2.empty?
-    return s2.length if s1.empty?
-    return 0 if s1 == s2
+  # Computes the Levenshtein distance between two strings.
+  #
+  # @param str1 [String]
+  # @param str2 [String]
+  # @return [Integer] number of changes to transform str1 to str2
+
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  def self.distance(str1, str2)
+    return str1.length if str2.empty?
+    return str2.length if str1.empty?
+    return 0 if str1 == str2
 
-    # Distance from a prefix of s1 to each prefix in s2.
+    # Distance from a prefix of str1 to each prefix in str2.
     #
-    # On the first iteration, the prefix of s1 is just "",
-    # and so the distance measurement for any prefix of s2
+    # On the first iteration, the prefix of str1 is just '',
+    # and so the distance measurement for any prefix of str2
     # is the prefix's length. For example, the distance from
-    # "abc" to "" is 3.
+    # 'abc' to '' is 3.
     #
-    # So, we initialize the array to [0, 1, 2,.. s2.length].
+    # So, we initialize the array to [0, 1, 2,.. str2.length].
     #
-    distances = Array.new(s2.length + 1) { _1 }
+    distances = Array.new(str2.length + 1) { _1 }
 
     # Workspace for calculating the next set of prefix distances.
-    workspace = Array.new(s2.length + 1)
+    workspace = Array.new(str2.length + 1)
 
     i = 0 # avoid allocations from each_with_index
-    s1.each_codepoint do |c1|
+    str1.each_codepoint do |c1|
       workspace[0] = i + 1
 
       j = 0 # avoid allocation from each_with_index
-      s2.each_codepoint do |c2|
+      str2.each_codepoint do |c2|
         deletion_cost = distances[j + 1] + 1
         insertion_cost = workspace[j] + 1
-        substitution_cost = distances[j] + (c1 == c2 ? 0 : 1)
+        substitution_cost = distances[j] + ((c1 == c2) ? 0 : 1)
 
         min = deletion_cost
         min = insertion_cost if insertion_cost < min
@@ -45,13 +57,17 @@ module LevenshteinLite
       #
       # Swap them the old-fashioned way to avoid an Array allocation.
       #
+      # rubocop:disable Style/SwapValues
       tmp = distances
       distances = workspace
       workspace = tmp
+      # rubocop:enable Style/SwapValues
 
       i += 1
     end
 
     distances[-1]
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 end

data/sig/levenshtein_lite/version.rbs

@@ -0,0 +1,4 @@
+# lib/levenshtein_lite/version.rb
+module LevenshteinLite
+  VERSION: String
+end

data/sig/levenshtein_lite.rbs

@@ -0,0 +1,4 @@
+# lib/levenshtein_lite.rb
+module LevenshteinLite
+  def self.distance: (String, String) -> Integer
+end

metadata

@@ -1,98 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: levenshtein_lite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Erin Paget
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.13'
-- !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: allocation_tracer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
+dependencies: []
 email:
 - erin.dees@hey.com
 executables: []
@@ -100,17 +16,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- levenshtein_lite.gemspec
 - lib/levenshtein_lite.rb
 - lib/levenshtein_lite/version.rb
+- sig/levenshtein_lite.rbs
+- sig/levenshtein_lite/version.rbs
 homepage: https://github.com/undees/levenshtein_lite
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  ruby-signature: RBS
 rdoc_options: []
 require_paths:
 - lib

data/Gemfile

@@ -1,9 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-gemspec
-
-group :development do
-  gem "allocation_tracer", git: "https://github.com/undees/allocation_tracer.git", ref: "57652f67085bb208abe4c34d21229f06efd05856"
-end

data/Gemfile.lock

@@ -1,52 +0,0 @@
-GIT
-  remote: https://github.com/undees/allocation_tracer.git
-  revision: 57652f67085bb208abe4c34d21229f06efd05856
-  ref: 57652f67085bb208abe4c34d21229f06efd05856
-  specs:
-    allocation_tracer (0.6.3)
-
-PATH
-  remote: .
-  specs:
-    levenshtein_lite (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    benchmark-ips (2.14.0)
-    concurrent-ruby (1.3.5)
-    diff-lcs (1.6.2)
-    faker (3.5.1)
-      i18n (>= 1.8.11, < 2)
-    i18n (1.14.7)
-      concurrent-ruby (~> 1.0)
-    rake (13.2.1)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.3)
-
-PLATFORMS
-  arm64-darwin-24
-  ruby
-
-DEPENDENCIES
-  allocation_tracer!
-  benchmark-ips (~> 2.14)
-  bundler (~> 2.6)
-  faker (~> 3.5)
-  levenshtein_lite!
-  rake (~> 13.2)
-  rspec (~> 3.13)
-
-BUNDLED WITH
-   2.6.7

data/levenshtein_lite.gemspec

@@ -1,40 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "levenshtein_lite/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "levenshtein_lite"
-  spec.version       = LevenshteinLite::VERSION
-  spec.authors       = ["Erin Paget"]
-  spec.email         = ["erin.dees@hey.com"]
-
-  spec.summary       = %q{Fast, allocation-lite, Unicode-aware Levenshtein distance in pure Ruby.}
-  spec.homepage      = "https://github.com/undees/levenshtein_lite"
-  spec.license       = "MIT"
-
-  spec.required_ruby_version = "~> 3.0"
-
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(spec|bin|benchmark)/}) ||
-        %w[
-          .rspec
-          .gitignore
-          .travis.yml
-          .ruby-version
-          Rakefile
-          ].include?(f)
-    end
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 2.6"
-  spec.add_development_dependency "rake", "~> 13.2"
-  spec.add_development_dependency "rspec", "~> 3.13"
-  spec.add_development_dependency "faker", "~> 3.5"
-  spec.add_development_dependency "benchmark-ips", "~> 2.14"
-  spec.add_development_dependency "allocation_tracer", "~> 0.6"
-end