similar_text 0.0.2 → 0.0.3

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.0.3, released 2011-09-19
+
+* Replaced method similar? with similar_chars.
+
 == 0.0.1, released 2011-09-12
 
 * Extended core String class by adding two methods: similar and similar?

data/README.markdown

@@ -1,7 +1,11 @@
 Ruby similar_text
 =================
 
-Port of PHP similar_text function to Ruby, built as a native extension.
+Calculate the similarity between two strings. Port of PHP similar_text function to Ruby, built as a native extension.
+
+Description from php.net:
+
+	This calculates the similarity between two strings as described in Oliver [1993]. Note that this implementation does not use a stack as in Oliver's pseudo code, but recursive calls which may or may not speed up the whole process. Note also that the complexity of this algorithm is O(N**3) where N is the length of the longest string.
 
 INSTALL
 =======
@@ -17,8 +21,8 @@ Load extension:
 
 	require 'similar_text'
 
-And use it by calling one of two methods (similar or similar?):
+And use it by calling one of two methods (similar or similar_chars):
 
-	"Hello, World!".similar("Hello World!") # 96.0
-	"Hello, World!".similar?(Hello World!") # false
+	"Hello, World!".similar("Hello World!") #=> 96.0
+	"Hello, World!".similar_chars("Hello World!") #=> 12
 

data/ext/similar_text/similar_text.c

@@ -55,6 +55,13 @@ int similar_text(const char *txt1, const char *txt2, double *percent)
   return sim;
 }
 
+/**
+ * Calculate the similarity between strings.
+ *
+ * "Hello, World!".similar("Hello, World!") #=> 100.0
+ *
+ * @return the percentage of similarity between two strings. Type of value Float from 0.0 to 100.0.
+ */
 static VALUE t_similar(VALUE str1, VALUE str2)
 {
   double percent;
@@ -64,24 +71,27 @@ static VALUE t_similar(VALUE str1, VALUE str2)
   return rb_float_new(percent);
 }
 
-static VALUE t_similar_bool(VALUE str1, VALUE str2)
+/**
+ * Calculate the similarity between strings.
+ *
+ * 'Hello WORLD!'.similar_chars 'Hello, World!' #=> 8
+ *
+ * @return number of matching chars between strings.
+ */
+static VALUE t_similar_chars(VALUE str1, VALUE str2)
 {
   double percent;
+  int sim;
 
-  similar_text(StringValueCStr(str1), StringValueCStr(str2), &percent);
+  sim = similar_text(StringValueCStr(str1), StringValueCStr(str2), &percent);
 
-  if (percent == 100.0) {
-    return Qtrue;
-  }
-  else {
-    return Qfalse;
-  }
+  return rb_int_new(sim);
 }
 
 void Init_similar_text()
 {
   rb_cString = rb_define_class("String", rb_cObject);
   rb_define_method(rb_cString, "similar", t_similar, 1);
-  rb_define_method(rb_cString, "similar?", t_similar_bool, 1);
+  rb_define_method(rb_cString, "similar_chars", t_similar_chars, 1);
 }
 

data/lib/similar_text.rb

@@ -2,7 +2,3 @@ $:.unshift File.dirname(__FILE__) + "/../lib/similar_text"
 require "similar_text/version"
 require 'similar_text.so'
 
-module SimilarText
-  # Your code goes here...
-end
-

data/lib/similar_text/version.rb

@@ -1,3 +1,3 @@
-module SimilarText
-  VERSION = "0.0.2"
+module SimilarText #:nodoc:
+  VERSION = "0.0.3"
 end

data/similar_text.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Arthur Murauskas"]
   s.email       = ["arthur.murauskas@gmail.com"]
   s.homepage    = "http://github.com/valcker/similar_text-ruby"
-  s.summary     = %q{Port of PHP function similar_text to Ruby as a native extension. Adds methods similar and similar? to core String class.}
-  s.description = %q{Port of PHP function similar_text to Ruby as a native extension. Adds methods similar and similar? to core String class.}
+  s.summary     = %q{Port of PHP function similar_text to Ruby as a native extension. Adds methods similar and similar_chars to core String class.}
+  s.description = %q{Port of PHP function similar_text to Ruby as a native extension. Adds methods similar and similar_chars to core String class.}
 
   s.rubyforge_project = "similar_text"
   

data/test/similar_text_test.rb

@@ -6,9 +6,9 @@ class SimilarTextTest < Test::Unit::TestCase
     assert_equal(96.0, "Hello, World!".similar("Hello World!"))
   end
 
-  def test_similar?
-    assert_equal(true, "Hello, World!".similar?("Hello, World!"))
-    assert_equal(false, "Hello WORLD!".similar?("Hello, World!"))
+  def test_similar_chars
+    assert_equal(13, "Hello, World!".similar_chars("Hello, World!"))
+    assert_equal(8, "Hello WORLD!".similar_chars("Hello, World!"))
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: similar_text
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-13 00:00:00.000000000Z
+date: 2011-09-19 00:00:00.000000000Z
 dependencies: []
 description: Port of PHP function similar_text to Ruby as a native extension. Adds
-  methods similar and similar? to core String class.
+  methods similar and similar_chars to core String class.
 email:
 - arthur.murauskas@gmail.com
 executables: []
@@ -59,5 +59,5 @@ rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Port of PHP function similar_text to Ruby as a native extension. Adds methods
-  similar and similar? to core String class.
+  similar and similar_chars to core String class.
 test_files: []