kingpong-bitwise_string_ops 0.1.2 → 0.1.3

data/README.rdoc

@@ -23,7 +23,7 @@ The operation is applied to each successive byte (not necessarily
 character) in the source strings in parallel.  For example, the result
 of "AB" & "CD" is ("A" & "C") + ("B" & "D").
 
-If the operands to a binary bitwise op are strings of different sizes, ⎪
+If the operands to a binary bitwise op are strings of different sizes, |
 and ^ ops act as though the shorter operand had additional zero bits on
 the right, while the & op acts as though the longer operand were
 truncated to the length of the shorter.  The granularity for such
@@ -67,7 +67,6 @@ AND truncates to the shorter of the two:
 
 = Known Issues
 
-* Largely untested
 * Completely untested with non-string rhs operands
 
 = Author

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake'
 require 'echoe'
 
 project = "bitwise_string_ops"
-version = "0.1.2"
+version = "0.1.3"
 
 Echoe.new(project, version) do |p|
   p.description = "Bitwise operations for Ruby strings"

data/bitwise_string_ops.gemspec

@@ -2,23 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bitwise_string_ops}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Philip Garrett"]
-  s.date = %q{2009-08-22}
+  s.date = %q{2009-08-23}
   s.description = %q{Bitwise operations for Ruby strings}
   s.email = %q{philip@pastemagazine.com}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = ["CHANGELOG", "ext/bitwise.c", "ext/bitwise_string_ops.c", "ext/bitwise_string_ops.h", "ext/extconf.rb", "lib/bitwise_string_ops.rb", "README.rdoc"]
-  s.files = ["bitwise_string_ops.gemspec", "CHANGELOG", "ext/bitwise.c", "ext/bitwise_string_ops.c", "ext/bitwise_string_ops.h", "ext/extconf.rb", "init.rb", "lib/bitwise_string_ops.rb", "Manifest", "Rakefile", "README.rdoc", "setup.rb", "test/test.rb", "test/test_helper.rb", "test/test_string_and.rb", "test/test_string_not.rb", "test/test_string_or.rb", "test/test_string_xor.rb"]
+  s.files = ["bitwise_string_ops.gemspec", "CHANGELOG", "ext/bitwise.c", "ext/bitwise_string_ops.c", "ext/bitwise_string_ops.h", "ext/extconf.rb", "init.rb", "lib/bitwise_string_ops.rb", "Manifest", "Rakefile", "README.rdoc", "setup.rb", "test/test.rb", "test/test_helper.rb", "test/test_string_and.rb", "test/test_string_not.rb", "test/test_string_or.rb", "test/test_string_xor.rb", "test/test_perl_equivalence.rb"]
   s.homepage = %q{http://github.com/kingpong/bitwise_string_ops}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bitwise_string_ops", "--main", "README.rdoc"]
   s.require_paths = ["lib", "ext"]
   s.rubyforge_project = %q{bitwise_string_ops}
   s.rubygems_version = %q{1.3.3}
-  s.summary = %q{bitwise_string_ops 0.1.2}
-  s.test_files = ["test/test_helper.rb", "test/test_string_and.rb", "test/test_string_not.rb", "test/test_string_or.rb", "test/test_string_xor.rb"]
+  s.summary = %q{bitwise_string_ops 0.1.3}
+  s.test_files = ["test/test_helper.rb", "test/test_perl_equivalence.rb", "test/test_string_and.rb", "test/test_string_not.rb", "test/test_string_or.rb", "test/test_string_xor.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/ext/bitwise_string_ops.c

@@ -29,6 +29,7 @@
 
 // Defining a space for information and references about the module to be stored internally
 VALUE BitwiseStringOps = Qnil;
+static ID ToString;
 
 // Prototype for the initialization method - Ruby calls this, not you
 void Init_bitwise_string_ops();
@@ -39,21 +40,32 @@ VALUE method_bit_xor(VALUE self, VALUE other);
 VALUE method_bit_and(VALUE self, VALUE other);
 VALUE method_bit_not(VALUE self);
 
+static VALUE to_s(VALUE o);
+
 // The initialization method for this module
 void Init_bitwise_string_ops()
 {
     BitwiseStringOps = rb_define_module("BitwiseStringOps");
-    rb_define_method(BitwiseStringOps, "bit_or",  method_bit_or,  1);
-    rb_define_method(BitwiseStringOps, "bit_xor", method_bit_xor, 1);
-    rb_define_method(BitwiseStringOps, "bit_and", method_bit_and, 1);
-    rb_define_method(BitwiseStringOps, "bit_not", method_bit_not, 0);
+	ToString = rb_intern("to_s");
+    rb_define_method(BitwiseStringOps, "|", method_bit_or,  1);
+    rb_define_method(BitwiseStringOps, "^", method_bit_xor, 1);
+    rb_define_method(BitwiseStringOps, "&", method_bit_and, 1);
+    rb_define_method(BitwiseStringOps, "~", method_bit_not, 0);
+}
+
+static VALUE to_s(VALUE o)
+{
+	return rb_obj_is_kind_of(o,rb_cString)
+		? o : rb_funcall(o, ToString, 0);
 }
 
 VALUE method_bit_or(VALUE self, VALUE other)
 {
-    VALUE left = StringValue(self), right = StringValue(other);
-    VALUE dest = rb_str_new(NULL,
-                            string_bitwise_or_result_len(RSTRING(left)->len,
+	VALUE left, right, right_s, dest;
+	left = StringValue(self);
+	right_s = to_s(other);
+	right = StringValue(right_s);
+    dest = rb_str_new(NULL, string_bitwise_or_result_len(RSTRING(left)->len,
                                                          RSTRING(right)->len));
     string_bitwise_or(RSTRING(left)->ptr, RSTRING(left)->len,
                       RSTRING(right)->ptr, RSTRING(right)->len,
@@ -63,9 +75,11 @@ VALUE method_bit_or(VALUE self, VALUE other)
 
 VALUE method_bit_xor(VALUE self, VALUE other)
 {
-    VALUE left = StringValue(self), right = StringValue(other);
-    VALUE dest = rb_str_new(NULL,
-                            string_bitwise_xor_result_len(RSTRING(left)->len,
+	VALUE left, right, right_s, dest;
+	left = StringValue(self);
+	right_s = to_s(other);
+	right = StringValue(right_s);
+    dest = rb_str_new(NULL, string_bitwise_xor_result_len(RSTRING(left)->len,
                                                           RSTRING(right)->len));
     string_bitwise_xor(RSTRING(left)->ptr, RSTRING(left)->len,
                        RSTRING(right)->ptr, RSTRING(right)->len,
@@ -75,9 +89,11 @@ VALUE method_bit_xor(VALUE self, VALUE other)
 
 VALUE method_bit_and(VALUE self, VALUE other)
 {
-    VALUE left = StringValue(self), right = StringValue(other);
-    VALUE dest = rb_str_new(NULL,
-                            string_bitwise_and_result_len(RSTRING(left)->len,
+	VALUE left, right, right_s, dest;
+	left = StringValue(self);
+	right_s = to_s(other);
+	right = StringValue(right_s);
+    dest = rb_str_new(NULL, string_bitwise_and_result_len(RSTRING(left)->len,
                                                           RSTRING(right)->len));
     string_bitwise_and(RSTRING(left)->ptr, RSTRING(left)->len,
                        RSTRING(right)->ptr, RSTRING(right)->len,

data/lib/bitwise_string_ops.rb

@@ -13,8 +13,4 @@
 require 'bitwise_string_ops.so'
 class String
   include BitwiseStringOps
-  alias :| :bit_or
-  alias :^ :bit_xor
-  alias :& :bit_and
-  alias :~ :bit_not
 end

data/test/test_perl_equivalence.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+require 'test/test_helper'
+require 'bitwise_string_ops'
+
+class TestPerlEquivalence < Test::Unit::TestCase
+
+  PATH_SEP  = RUBY_PLATFORM =~ /mswin/i ? ";" : ":"
+  GENERATOR = File.join(File.dirname(__FILE__),"testcases.pl")
+
+  def test_perl_equivalence
+    return unless perl = find_perl
+    pipe_reader(perl, GENERATOR) do |pipe|
+      while op = read_string(pipe)
+        case op
+        when "|"
+          result, left, right = read_strings(pipe,3)
+          assert_equal left | right, result
+        when "^"
+          result, left, right = read_strings(pipe,3)
+          assert_equal left ^ right, result
+        when "&"
+          result, left, right = read_strings(pipe,3)
+          assert_equal left & right, result
+        when "~"
+          result, operand = read_strings(pipe,2)
+          assert_equal ~operand, result
+        end
+      end
+    end
+  end
+  
+  private
+  
+  def find_perl
+    ENV["PATH"].split(PATH_SEP).
+      map  {|path| File.join(path,"perl") }.
+      find {|perl| File.executable?(perl) }
+  end
+
+  # Runs a command and yields an IO object opened for reading from the command.
+  # Does *NOT* do any shell expansion (that's the point).
+  # +args+ should be [program,arg1,...]
+  def pipe_reader(*args)
+    # avoid shell expansion using fork/exec
+    reader, writer = IO.pipe
+    pid = fork
+    if pid
+      writer.close
+      yield(reader)
+      Process.waitpid(pid)
+    else
+      begin
+        reader.close
+        STDIN.reopen("/dev/null")
+        STDOUT.reopen(writer)
+        exec(*args)
+      rescue => e
+        # prevent child from jumping out of this scope and continuing main program
+        STDERR.puts(e.to_s)
+      end
+      exit! # will only reach here if exec() failed
+    end
+  end
+    
+  def read_string(io)
+    length = io.read(4).unpack("N").first
+    io.read(length)
+  rescue => e
+    io.eof? ? nil : raise(e)
+  end
+
+  def read_strings(io,n)
+    ret = []
+    n.times { ret << read_string(io) }
+    ret
+  end
+
+end

data/test/test_string_and.rb

@@ -5,6 +5,37 @@ require 'bitwise_string_ops'
 
 class TestStringAnd < Test::Unit::TestCase
 
+  def test_empty
+    assert_equal "" & "", ""
+  end
+  
+  def test_single
+    assert_equal "0" & "1", "0"
+    assert_equal "a" & "A", "A"
+  end
+  
+  def test_multiple
+    assert_equal "01" & "10", "00"
+    assert_equal "aB" & "Ab", "AB"
+  end
+  
+  def test_overflow
+    assert_equal "111" & "00", "00"
+    assert_equal "00" & "111", "00"
+  end
+  
+  def test_non_string
+    assert_equal "1"  & 1, "1"  & "1"
+    assert_equal "10" & 1, "10" & "1"
+  end
+  
+  def test_truth_table
+    assert_equal "0" & "0", "0"
+    assert_equal "0" & "1", "0"
+    assert_equal "1" & "0", "0"
+    assert_equal "1" & "1", "1"
+  end
+
   def test_perldoc
     assert_equal "japh\nJunk" & "_____", "JAPH\n"
   end

data/test/test_string_not.rb

@@ -5,6 +5,20 @@ require 'bitwise_string_ops'
 
 class TestStringNot < Test::Unit::TestCase
 
+  def test_empty
+    assert_equal "" & "", ""
+  end
+  
+  def test_single
+    assert_equal ~"1", "\316"
+    assert_equal ~"a", "\236"
+  end
+
+  def test_multiple
+    assert_equal ~"01", "\317\316"
+    assert_equal ~"aB", "\236\275"
+  end
+
   def test_perldoc
     assert_equal ~"japh", "\225\236\217\227"
   end

data/test/test_string_or.rb

@@ -5,6 +5,38 @@ require 'bitwise_string_ops'
 
 class TestStringOr < Test::Unit::TestCase
 
+  def test_empty
+    assert_equal "" | "", ""
+  end
+  
+  def test_single
+    assert_equal "0" | "1", "1"
+    assert_equal "a" | "A", "a"
+  end
+
+  def test_multiple
+    assert_equal "01" | "10", "11"
+    assert_equal "aB" | "Ab", "ab"
+  end
+  
+  def test_overflow
+    assert_equal "111" | "00", "111"
+    assert_equal "00" | "111", "111"
+  end
+  
+  def test_non_string
+    assert_equal "1"  | 1, "1"  | "1"
+    assert_equal "10" | 1, "10" | "1"
+  end
+  
+  def test_truth_table
+    assert_equal "0" | "0", "0"
+    assert_equal "0" | "1", "1"
+    assert_equal "1" | "0", "1"
+    assert_equal "1" | "1", "1"
+  end
+  
+  # superficial test for perl equivalency
   def test_perldoc
     assert_equal "JA" | "  ph\n", "japh\n"
   end

data/test/test_string_xor.rb

@@ -5,6 +5,37 @@ require 'bitwise_string_ops'
 
 class TestStringXor < Test::Unit::TestCase
 
+  def test_empty
+    assert_equal "" ^ "", ""
+  end
+  
+  def test_single
+    assert_equal "0" ^ "1", "\001"
+    assert_equal "a" ^ "A", " "
+  end
+
+  def test_multiple
+    assert_equal "01" ^ "10", "\001\001"
+    assert_equal "aB" ^ "Ab", "  "
+  end
+  
+  def test_reversible
+    orig = "abc"
+    mask = "def"
+    assert_not_equal orig ^ mask, orig
+    assert_equal( (orig ^ mask) ^ mask, orig)
+  end
+  
+  def test_non_string
+    assert_equal "1"  ^ 1, "1"  ^ "1"
+    assert_equal "10" ^ 1, "10" ^ "1"
+  end
+  
+  def test_overflow
+    assert_equal "111" ^ "00",  "\001\0011"
+    assert_equal "00"  ^ "111", "\001\0011"
+  end
+  
   def test_perldoc
     assert_equal "j p \n" ^ " a h", "JAPH\n"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kingpong-bitwise_string_ops
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Philip Garrett
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-22 00:00:00 -07:00
+date: 2009-08-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -46,6 +46,7 @@ files:
 - test/test_string_not.rb
 - test/test_string_or.rb
 - test/test_string_xor.rb
+- test/test_perl_equivalence.rb
 has_rdoc: false
 homepage: http://github.com/kingpong/bitwise_string_ops
 licenses: 
@@ -78,9 +79,10 @@ rubyforge_project: bitwise_string_ops
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: bitwise_string_ops 0.1.2
+summary: bitwise_string_ops 0.1.3
 test_files: 
 - test/test_helper.rb
+- test/test_perl_equivalence.rb
 - test/test_string_and.rb
 - test/test_string_not.rb
 - test/test_string_or.rb