string-similarity 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b89926f7398486de02d94f5f1d8742834a95d54f
-  data.tar.gz: 0493548d9494e4855b648551848da77fbef6945d
+  metadata.gz: cd97efdcd76434ae400e6382b55e54d44ce003d8
+  data.tar.gz: 1ca9a5eb0075b86d30afd03669226425161d510f
 SHA512:
-  metadata.gz: 8af14a673396cf5b7b20df9e279621e4301fb5c8c52f14b1a8aae3b096d1ad5a480ce6e4cc64c0b5ba6bef1c0fe72f6b530f8a10aef21bfe1c7f932d00007e3a
-  data.tar.gz: a89455cf5807fb41749d4f4b86e4642e50cf1ff8620d278e8e3b43c2abf6cd3454e740a81337e1fa7d7d3c76704a17b271a1cd61558362d37e109ca01835be6b
+  metadata.gz: d904adf7b09fc53dadee2e47f3111f4bcce52d4cabfad7c1b7fee542d9af5c65298cbf7fa1be95d729dfb2672b21994c6f7e28ad0498a5f147311f7dc3e2418f
+  data.tar.gz: d849740e7fb49897439baf66f06f3cafd4677f01c6530bb212bb9b406c5c8c974716b3af562fb72c8bcffeaa1602a4d880bed35b5f5289381e01dd57200b313c

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  Exclude:
+    - lib/string/similarity/version.rb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+**1.1.1** (2016-02-19)
+
+* added: `require 'string-similarity'` now works aswell.

data/README.md

@@ -10,9 +10,9 @@ Library for calculating the similarity of two strings.
 
 ## State
 
-- Cosine: **done**
-- Hamming: _todo_
-- Levenshtein: _todo_
+- [x] Cosine
+- [ ] Hamming
+- [x] Levenshtein
 
 ## Installation
 
@@ -33,7 +33,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-require 'string-similarity'
+require 'string/similarity'
 
 # Call the methods on the module
 String::Similarity.cosine 'foo', 'bar'

data/lib/string-similarity.rb

@@ -0,0 +1 @@
+# require 'string/similarity'

data/lib/string/similarity.rb

@@ -1,5 +1,6 @@
 require 'string/similarity/version'
 
+# For convenience, String is extended by a couple of helper methods
 class String
   # Returns the cosine similarity to +other+
   # @see String::Similarity#cosine
@@ -21,7 +22,7 @@ class String
 
   # +String::Similarity+ provides various methods for
   # calculating string distances.
-  module Similarity extend self
+  module Similarity
     # Calcuate the {https://en.wikipedia.org/wiki/Cosine_similarity
     # Cosine similarity} of two strings.
     #
@@ -34,12 +35,13 @@ class String
     #   - +1.0+ if the strings are identical
     #   - +0.0+ if the strings are completely different
     #   - +0.0+ if one of the strings is empty
-    def cosine(str1, str2)
+    def self.cosine(str1, str2)
       return 1.0 if str1 == str2
       return 0.0 if str1.empty? || str2.empty?
 
       # convert both texts to vectors
-      v1, v2 = vector(str1), vector(str2)
+      v1 = vector(str1)
+      v2 = vector(str2)
 
       # calculate the dot product
       dot_product = dot(v1, v2)
@@ -60,7 +62,7 @@ class String
     #   - +1.0+ if the strings are identical
     #   - +0.0+ if one of the strings is empty
     # @see #levenshtein_distance
-    def levenshtein(str1, str2)
+    def self.levenshtein(str1, str2)
       return 1.0 if str1.eql?(str2)
       return 0.0 if str1.empty? || str2.empty?
       1.0 / levenshtein_distance(str1, str2)
@@ -73,11 +75,10 @@ class String
     # @param str2 [String] second string
     # @return [Fixnum] edit distance between the two strings
     #   - +0+ if the strings are identical
-    def levenshtein_distance(str1, str2)
+    def self.levenshtein_distance(str1, str2)
       # base cases
-      return 0 if str1.eql?(str2)
-      return str2.length if str1.empty?
-      return str1.length if str2.empty?
+      result = base_case?(str1, str2)
+      return result if result
 
       # Initialize cost-matrix rows
       previous = (0..str2.length).to_a
@@ -87,11 +88,11 @@ class String
         # first element is always the edit distance from an empty string.
         current[0] = i + 1
         (0...str2.length).each do |j|
-          current[j+1] = [
+          current[j + 1] = [
             # insertion
             current[j] + 1,
             # deletion
-            previous[j+1] + 1,
+            previous[j + 1] + 1,
             # substitution or no operation
             previous[j] + (str1[i].eql?(str2[j]) ? 0 : 1)
           ].min
@@ -104,19 +105,26 @@ class String
 
     private
 
+    def self.base_case?(str1, str2)
+      return 0 if str1.eql?(str2)
+      return str2.length if str1.empty?
+      return str1.length if str2.empty?
+      false
+    end
+
     # create a vector from +str+
     #
     # @example
     #     v1 = vector('hello') # => {"h"=>1, "e"=>1, "l"=>2, "o"=>1}
     #     v1["x"] # => 0
-    def vector(str)
+    def self.vector(str)
       v = Hash.new(0)
       str.each_char { |c| v[c] += 1 }
       v
     end
 
     # calculate the dot product of +vector1+ and +vector2+
-    def dot(vector1, vector2)
+    def self.dot(vector1, vector2)
       product = 0
       vector1.each do |k, v|
         product += v * vector2[k]
@@ -125,9 +133,9 @@ class String
     end
 
     # calculate the magnitude for +vector+
-    def mag(vector)
+    def self.mag(vector)
       # calculate the sum of squares
-      sq = vector.inject(0) { |s, n| s + n**2 }
+      sq = vector.inject(0) { |a, e| a + e**2 }
       Math.sqrt(sq)
     end
   end

data/lib/string/similarity/version.rb

@@ -1,6 +1,6 @@
 class String
   module Similarity
     # Gem version
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: string-similarity
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Manuel Hutter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -95,6 +97,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/string-similarity.rb
 - lib/string/similarity.rb
 - lib/string/similarity/version.rb
 - string-similarity.gemspec
@@ -118,9 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Various methods for calculating string similarities.
 test_files: []
-has_rdoc: