phonetics 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 551a25deff1697f690f93a1b0df33eb6c47800d4b77ac313be9a27583439d32f
-  data.tar.gz: 142a54e76defe55e5fbef13df79bc1d308ed46fa8cbcb8da3d4d1dde3a78447d
+  metadata.gz: 04d203a13c081a435c9d94accd6af2dc517d7992349cda641f415e35c5cc787d
+  data.tar.gz: b8c3376c2db3878a0d3c409814abf0bb70d6fc403ce3866a11d65e8bcb01c5c8
 SHA512:
-  metadata.gz: fa2d8c53d0536936b64e13ca6aae3ada7b75d327e399d2301424009264b53aeaacf961b1bdd39ab54af8e8f7087e2dd277b94d99f373f445e070999ba18535fa
-  data.tar.gz: 2b0c41e648878df94ff8b493e7484ecbee544cb430ebc0a87ea1a11323c8a546123c2d5b2e3f96211ccee2a04b7e19cdf20ab46abc5c7d6fe15ab6a13e9ed8aa
+  metadata.gz: 5dfc217801d09dd1d835debd6440886e56c790c8886291147302b4a7b16f4aafeda51943cc56657d743e9dfab62cd663fae3adb3ea48656e0a6b5ce0cd1130ab
+  data.tar.gz: 1e41e3f77efe3af5a8095a0be58767c3a6ceb3c51ef7add5bebc40db94e14c988e80de221943ef010b7c0818d34a63b84af2290c57c90c6c23a4e9a69f8f9eff

data/.gitignore

@@ -13,3 +13,4 @@
 .ruby-version
 *.so
 Gemfile.lock
+*.bundle

data/VERSION

@@ -1 +1 @@
-1.5.2
+1.5.3

data/ext/c_levenshtein/levenshtein.c

@@ -1,33 +1,31 @@
 #include "ruby.h"
+#include <stdbool.h>
 #include "./phonetic_cost.h"
 
-#define NDEBUG true
-#ifdef NDEBUG
-#define debug(M, ...)
-#else
-#define debug(M, ...) printf(M, ##__VA_ARGS__)
-#endif
+#define debug(M, ...) if (verbose) printf(M, ##__VA_ARGS__)
 
 VALUE Binding = Qnil;
 
 /* Function declarations */
 
 void Init_c_levenshtein();
-void set_initial(double *d, int *string1, int string1_length, int *string2, int string2_length);
-void print_matrix(double *d, int *string1, int string1_length, int *string2, int string2_length);
-VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _string2);
+
+void set_initial(double *d, int *string1, int string1_length, int *string2, int string2_length, bool verbose);
+void print_matrix(double *d, int *string1, int string1_length, int *string2, int string2_length, bool verbose);
+VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _string2, VALUE _verbose);
 
 /* Function implemitations */
 
 void Init_c_levenshtein() {
 	Binding = rb_define_module("PhoneticsLevenshteinCBinding");
-	rb_define_method(Binding, "internal_phonetic_distance", method_internal_phonetic_distance, 2);
+	rb_define_method(Binding, "internal_phonetic_distance", method_internal_phonetic_distance, 3);
 }
 
-VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _string2){
+VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _string2, VALUE _verbose){
 
   VALUE *string1_ruby = RARRAY_PTR(_string1);
   VALUE *string2_ruby = RARRAY_PTR(_string2);
+  bool verbose = _verbose;
   int string1_length = (int) RARRAY_LEN(_string1);
   int string2_length = (int) RARRAY_LEN(_string2);
   // We name them as 'strings' but in C-land we're representing our strings as
@@ -47,7 +45,7 @@ VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _strin
 
   // Guard clause for two empty strings
   if (string1_length == 0 && string2_length == 0)
-    return DBL2NUM(0.0d);
+    return DBL2NUM(0.0);
 
   //
   // Intial data setup
@@ -74,10 +72,10 @@ VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _strin
   
   // First, set the top row and left column of the matrix using the sequential
   // phonetic edit distance of string1 and string2, respectively
-  set_initial(d, string1, string1_length, string2, string2_length);
+  set_initial(d, string1, string1_length, string2, string2_length, verbose);
 
   debug("before:\n");
-  print_matrix(d, string1, string1_length, string2, string2_length);
+  print_matrix(d, string1, string1_length, string2, string2_length, verbose);
 
   // Then walk through the matrix and fill in each cell with the lowest-cost
   // phonetic edit distance for that matrix cell.
@@ -117,7 +115,7 @@ VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _strin
 
       d[(j * (string1_length+1)) + i] = min + cost;
       debug("\n");
-      print_matrix(d, string1, string1_length, string2, string2_length);
+      print_matrix(d, string1, string1_length, string2, string2_length, verbose);
     }
   }
 
@@ -141,7 +139,7 @@ VALUE method_internal_phonetic_distance(VALUE self, VALUE _string1, VALUE _strin
 // Subsequent values are the cumulative phonetic distance between each
 // phoneme within the same string.
 // "aek" -> [0.0, 1.0, 1.61, 2.61]
-void set_initial(double *d, int *string1, int string1_length, int *string2, int string2_length) {
+void set_initial(double *d, int *string1, int string1_length, int *string2, int string2_length, bool verbose) {
 
   double distance_between_first_phonemes;
   int i, j;
@@ -154,6 +152,7 @@ void set_initial(double *d, int *string1, int string1_length, int *string2, int
     distance_between_first_phonemes = phonetic_cost(string1[0], string2[0]);
   }
 
+  d[0] = (double) 0.0;
   // Set the first value of string1's sequential phonetic calculation (maps to
   // cell x=1, y=0)
   d[1] = distance_between_first_phonemes;
@@ -176,7 +175,7 @@ void set_initial(double *d, int *string1, int string1_length, int *string2, int
 }
 
 // A handy visualization for developers
-void print_matrix(double *d, int *string1, int string1_length, int *string2, int string2_length) {
+void print_matrix(double *d, int *string1, int string1_length, int *string2, int string2_length, bool verbose) {
   int i, j;
   debug("              ");
   for (i=0; i < string1_length; i++) {

data/lib/phonetics/levenshtein.rb

@@ -15,11 +15,12 @@ module Phonetics
   module Levenshtein
     extend ::PhoneticsLevenshteinCBinding
 
-    def self.distance(str1, str2)
+    def self.distance(str1, str2, verbose = false)
       ensure_is_phonetic!(str1, str2)
       internal_phonetic_distance(
         Phonetics.as_utf_8_long(str1),
-        Phonetics.as_utf_8_long(str2)
+        Phonetics.as_utf_8_long(str2),
+        verbose
       )
     end
 

data/lib/phonetics/ruby_levenshtein.rb

@@ -34,8 +34,8 @@ module Phonetics
       walk.last[:distance]
     end
 
-    def self.distance(str1, str2)
-      new(str1, str2).distance
+    def self.distance(str1, str2, verbose = false)
+      new(str1, str2, verbose).distance
     end
 
     private

data/phonetics.gemspec

@@ -11,12 +11,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/JackDanger/phonetics'
   spec.license       = 'MIT'
 
-
-  spec.extensions = ["ext/c_levenshtein/extconf.rb"]
+  spec.extensions = ['ext/c_levenshtein/extconf.rb']
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ['lib']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phonetics
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Jack Danger
@@ -113,12 +113,13 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- _site/orthographic_example.png
+- _site/phonetic_example.png
 - ext/c_levenshtein/extconf.rb
 - ext/c_levenshtein/levenshtein.c
 - ext/c_levenshtein/phonetic_cost.c
 - ext/c_levenshtein/phonetic_cost.h
 - lib/phonetics.rb
-- lib/phonetics/c_levenshtein.bundle
 - lib/phonetics/levenshtein.rb
 - lib/phonetics/ruby_levenshtein.rb
 - lib/phonetics/version.rb