mini-levenshtein 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a780c4f86bb3ef04672b62bb2e4eca2059af8e86a698a0dfb8030d38d7559f
-  data.tar.gz: 036ca28be4f4a770e13015596ac3379287486386b93de221f4a60a27122277bd
+  metadata.gz: 72484523445a8c05ff3be19bf9043bec3e7e5a1ddcd98cafa6f7eea96517e5c3
+  data.tar.gz: b52cdebc6caa82a3dba2152a7fef78e5509cb4b6a288bd1db7830d9f9192ced3
 SHA512:
-  metadata.gz: 5706d550af3c94f592bf1359ea14b9efe0123241c6529628c94a46ac7bfa772af1cffe6523a86bc7d2bba71c8d2888cb4e2e546d3aa8b20a68aac048f64f2127
-  data.tar.gz: ad0d95b68d6113b1eb69a2a50bdfba73e287fb8a191aba23e68e705ddc1c787bbdfbc41502367a85b8c26bc511217696f60229c7d75916f9bc6b1e890a37445b
+  metadata.gz: 27479145fb061c23d178b42215121fdbe1b05a701fdd8c832b7df3ac28af01a6973201bed2b8d5350549e1e768642c0ee6c45d5cf4301c6aa89db3c4c94667b1
+  data.tar.gz: e2c95da36b1ec84593fe297360c9b8a029c1744d3c0a64b98eb19962e4b27b67113b04e525cbe60ad7fdfc3597f823ca81490d60af636baabc9716849789a1ac

data/README.md

@@ -10,6 +10,21 @@ MiniLevenshtein.distance("levenshtein", "levenstien") # => 3
 MiniLevenshtein.ratio("levenshtein", "levenstien") # 0.857142...
 ```
 
-# Author
+# Credits
+
+## Ruby Bindings
 
 Delon Newman <contact@delonnewman.name>
+
+## Original C Code
+
+- David Necas (Yeti) <yeti@physics.muni.cz>
+- Atakan Gurkan
+- James Theiler
+- Brian Gough
+
+(see [ext/mini_levenshtein/levenshtein.c](https://github.com/delonnewman/mini-levenshtein/blob/master/ext/mini_levenshtein/levenshtein.c) for more)
+
+# License
+
+[GPL](https://opensource.org/licenses/GPL-2.0)

data/lib/mini-levenshtein/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniLevenshtein
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/mini-levenshtein.rb

@@ -4,14 +4,42 @@ module MiniLevenshtein
   extend MiniLevenshteinInternal
 
   class << self
-    def distance(string1, string2)
+    # Compute absolute Levenshtein distance of two strings.
+    #
+    # @example (it's hard to spell Levenshtein correctly):
+    #   distance('Levenshtein', 'Lenvinsten')  # => 4
+    #   distance('Levenshtein', 'Levensthein') # => 2
+    #   distance('Levenshtein', 'Levenshten')  # => 1
+    #   distance('Levenshtein', 'Levenshtein') # => 0
+    #   "Yeah, we've managed it at last."
+    #
+    # @param string1 [String]
+    # @param string2 [String]
+    #
+    # @return [Integer]
+    def edit_distance(string1, string2)
       validate_string!(string1)
       validate_string!(string2)
       
       internal_distance(string1, string2, 0)
     end
-  
-    def ratio(string1, string2)
+    alias distance edit_distance
+
+    # Compute similarity of two strings.
+    #
+    # The similarity is a number between 0 and 1.
+    #
+    # @example
+    #   similarity('Hello World!', 'Holly grail!') # => 0.5833...
+    #
+    # @example
+    #   similarity('Holmes', 'Jack') # => 0.0
+    #
+    # @param string1 [String]
+    # @param string2 [String]
+    #
+    # @return [Float]
+    def similarity(string1, string2)
       validate_string!(string1)
       validate_string!(string2)
 
@@ -23,6 +51,7 @@ module MiniLevenshtein
   
       (lensum - distance) / lensum.to_f
     end
+    alias ratio similarity
 
     private
 

data/lib/mini_levenshtein.rb

@@ -0,0 +1 @@
+require 'mini-levenshtein'

data/mini-levenshtein.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.summary = 'Simple, fast, levenshtein distance'
   s.description = s.summary
   s.homepage = 'https://github.com/delonnewman/mini-levenshtein'
-  s.license = 'MIT'
+  s.license = 'GPL'
 
   if s.respond_to?(:metadata)
     s.metadata['allowed_push_host'] = 'https://rubygems.org'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini-levenshtein
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Delon Newman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-29 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies: []
 description: Simple, fast, levenshtein distance
 email: contact@delonnewman.name
@@ -31,10 +31,11 @@ files:
 - ext/mini_levenshtein/mini_levenshtein.c
 - lib/mini-levenshtein.rb
 - lib/mini-levenshtein/version.rb
+- lib/mini_levenshtein.rb
 - mini-levenshtein.gemspec
 homepage: https://github.com/delonnewman/mini-levenshtein
 licenses:
-- MIT
+- GPL
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/delonnewman/mini-levenshtein