default encoder to version 1, enable version 2 with a flag

This commit makes the encoder default to version 1 of the BERT encoding
scheme, but allows you to turn on version 2 via a feature flag.

Author: tenderlove

lib/bert.rb

@@ -8,7 +8,6 @@
 
 begin
   # try to load the C extension
-  raise LoadError
   require 'bert/c/decode'
 rescue LoadError
   # fall back on the pure ruby version

lib/bert/encode.rb

@@ -2,6 +2,27 @@ module BERT
   class Encode
     include Types
 
+    class V2 < Encode
+      def write_binary(data)
+        super
+        enc = data.encoding.name
+        write_1 BIN
+        write_4 enc.bytesize
+        write_string enc
+      end
+
+      private
+
+      def version_header
+        VERSION_2
+      end
+    end
+
+    class << self
+      attr_accessor :version
+    end
+    self.version = :v1
+
     attr_accessor :out
 
     def initialize(out)
@@ -11,12 +32,18 @@ def initialize(out)
     def self.encode(data)
       io = StringIO.new
       io.set_encoding('binary') if io.respond_to?(:set_encoding)
-      self.new(io).write_any(data)
+
+      if version == :v2
+        Encode::V2.new(io).write_any(data)
+      else
+        new(io).write_any(data)
+      end
+
       io.string
     end
 
     def write_any obj
-      write_1 VERSION_2
+      write_1 version_header
       write_any_raw obj
     end
 
@@ -128,14 +155,14 @@ def write_binary(data)
       write_1 BIN
       write_4 data.bytesize
       write_string data
-      enc = data.encoding.name
-      write_1 BIN
-      write_4 enc.bytesize
-      write_string enc
     end
 
     private
 
+    def version_header
+      MAGIC
+    end
+
     def fail(obj)
       raise "Cannot encode to erlang external format: #{obj.inspect}"
     end

test/bert_test.rb

@@ -5,40 +5,55 @@ class BertTest < Test::Unit::TestCase
     setup do
       time = Time.at(1254976067)
       @ruby = t[:user, {:name => 'TPW'}, [/cat/i, 9.9], time, nil, true, false, :true, :false]
-      @bert = "\x84h\td\x00\x04userh\x03d\x00\x04bertd\x00\x04dictl\x00\x00\x00\x01h\x02d\x00\x04namem\x00\x00\x00\x03TPWm\x00\x00\x00\x05UTF-8jl\x00\x00\x00\x02h\x04d\x00\x04bertd\x00\x05regexm\x00\x00\x00\x03catm\x00\x00\x00\bUS-ASCIIl\x00\x00\x00\x01d\x00\bcaselessjc9.900000000000000e+00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00jh\x05d\x00\x04bertd\x00\x04timeb\x00\x00\x04\xE6b\x00\x0E\xE4\xC3a\x00h\x02d\x00\x04bertd\x00\x03nilh\x02d\x00\x04bertd\x00\x04trueh\x02d\x00\x04bertd\x00\x05falsed\x00\x04trued\x00\x05false".b
       @bert_old = "\203h\td\000\004userh\003d\000\004bertd\000\004dictl\000\000\000\001h\002d\000\004namem\000\000\000\003TPWjl\000\000\000\002h\004d\000\004bertd\000\005regexm\000\000\000\003catl\000\000\000\001d\000\bcaselessjc9.900000000000000e+00\000\000\000\000\000\000\000\000\000\000jh\005d\000\004bertd\000\004timeb\000\000\004\346b\000\016\344\303a\000h\002d\000\004bertd\000\003nilh\002d\000\004bertd\000\004trueh\002d\000\004bertd\000\005falsed\000\004trued\000\005false".b
-      @ebin = "<<132,104,9,100,0,4,117,115,101,114,104,3,100,0,4,98,101,114,116,100,0,4,100,105,99,116,108,0,0,0,1,104,2,100,0,4,110,97,109,101,109,0,0,0,3,84,80,87,109,0,0,0,5,85,84,70,45,56,106,108,0,0,0,2,104,4,100,0,4,98,101,114,116,100,0,5,114,101,103,101,120,109,0,0,0,3,99,97,116,109,0,0,0,8,85,83,45,65,83,67,73,73,108,0,0,0,1,100,0,8,99,97,115,101,108,101,115,115,106,99,57,46,57,48,48,48,48,48,48,48,48,48,48,48,48,48,48,101,43,48,48,0,0,0,0,0,0,0,0,0,0,106,104,5,100,0,4,98,101,114,116,100,0,4,116,105,109,101,98,0,0,4,230,98,0,14,228,195,97,0,104,2,100,0,4,98,101,114,116,100,0,3,110,105,108,104,2,100,0,4,98,101,114,116,100,0,4,116,114,117,101,104,2,100,0,4,98,101,114,116,100,0,5,102,97,108,115,101,100,0,4,116,114,117,101,100,0,5,102,97,108,115,101>>"
       @ebin_old = "<<131,104,9,100,0,4,117,115,101,114,104,3,100,0,4,98,101,114,116,100,0,4,100,105,99,116,108,0,0,0,1,104,2,100,0,4,110,97,109,101,109,0,0,0,3,84,80,87,106,108,0,0,0,2,104,4,100,0,4,98,101,114,116,100,0,5,114,101,103,101,120,109,0,0,0,3,99,97,116,108,0,0,0,1,100,0,8,99,97,115,101,108,101,115,115,106,99,57,46,57,48,48,48,48,48,48,48,48,48,48,48,48,48,48,101,43,48,48,0,0,0,0,0,0,0,0,0,0,106,104,5,100,0,4,98,101,114,116,100,0,4,116,105,109,101,98,0,0,4,230,98,0,14,228,195,97,0,104,2,100,0,4,98,101,114,116,100,0,3,110,105,108,104,2,100,0,4,98,101,114,116,100,0,4,116,114,117,101,104,2,100,0,4,98,101,114,116,100,0,5,102,97,108,115,101,100,0,4,116,114,117,101,100,0,5,102,97,108,115,101>>"
     end
 
-    should "decode the old format" do
-      assert_equal @ruby, BERT.decode(@bert_old)
-    end
+    context "v2 encoder" do
+      setup do
+        @old_version = BERT::Encode.version
+        BERT::Encode.version = :v2
+        @bert = "\x84h\td\x00\x04userh\x03d\x00\x04bertd\x00\x04dictl\x00\x00\x00\x01h\x02d\x00\x04namem\x00\x00\x00\x03TPWm\x00\x00\x00\x05UTF-8jl\x00\x00\x00\x02h\x04d\x00\x04bertd\x00\x05regexm\x00\x00\x00\x03catm\x00\x00\x00\bUS-ASCIIl\x00\x00\x00\x01d\x00\bcaselessjc9.900000000000000e+00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00jh\x05d\x00\x04bertd\x00\x04timeb\x00\x00\x04\xE6b\x00\x0E\xE4\xC3a\x00h\x02d\x00\x04bertd\x00\x03nilh\x02d\x00\x04bertd\x00\x04trueh\x02d\x00\x04bertd\x00\x05falsed\x00\x04trued\x00\x05false".b
+        @ebin = "<<132,104,9,100,0,4,117,115,101,114,104,3,100,0,4,98,101,114,116,100,0,4,100,105,99,116,108,0,0,0,1,104,2,100,0,4,110,97,109,101,109,0,0,0,3,84,80,87,109,0,0,0,5,85,84,70,45,56,106,108,0,0,0,2,104,4,100,0,4,98,101,114,116,100,0,5,114,101,103,101,120,109,0,0,0,3,99,97,116,109,0,0,0,8,85,83,45,65,83,67,73,73,108,0,0,0,1,100,0,8,99,97,115,101,108,101,115,115,106,99,57,46,57,48,48,48,48,48,48,48,48,48,48,48,48,48,48,101,43,48,48,0,0,0,0,0,0,0,0,0,0,106,104,5,100,0,4,98,101,114,116,100,0,4,116,105,109,101,98,0,0,4,230,98,0,14,228,195,97,0,104,2,100,0,4,98,101,114,116,100,0,3,110,105,108,104,2,100,0,4,98,101,114,116,100,0,4,116,114,117,101,104,2,100,0,4,98,101,114,116,100,0,5,102,97,108,115,101,100,0,4,116,114,117,101,100,0,5,102,97,108,115,101>>"
+      end
 
-    should "roundtrip string and maintain encoding" do
-      str = "日本語".encode 'EUC-JP'
-      round = BERT.decode(BERT.encode(str))
-      assert_equal str, round
-      assert_equal str.encoding, round.encoding
-    end
+      teardown do
+        BERT::Encode.version = @old_version
+      end
 
-    should "roundtrip binary string" do
-      str = "日本語".b
-      round = BERT.decode(BERT.encode(str))
-      assert_equal str, round
-      assert_equal str.encoding, round.encoding
-    end
+      should "decode new format" do
+        assert_equal @ruby, BERT.decode(@bert)
+      end
 
-    should "encode" do
-      assert_equal @bert, BERT.encode(@ruby)
+      should "roundtrip string and maintain encoding" do
+        str = "日本語".encode 'EUC-JP'
+        round = BERT.decode(BERT.encode(str))
+        assert_equal str, round
+        assert_equal str.encoding, round.encoding
+      end
+
+      should "roundtrip binary string" do
+        str = "日本語".b
+        round = BERT.decode(BERT.encode(str))
+        assert_equal str, round
+        assert_equal str.encoding, round.encoding
+      end
+
+      should "encode" do
+        assert_equal @bert, BERT.encode(@ruby)
+      end
+
+      should "ebin" do
+        assert_equal @ebin, BERT.ebin(@bert)
+      end
     end
 
-    should "decode" do
-      assert_equal @ruby, BERT.decode(@bert)
+    should "decode the old format" do
+      assert_equal @ruby, BERT.decode(@bert_old)
     end
 
     should "ebin" do
-      assert_equal @ebin, BERT.ebin(@bert)
+      assert_equal @ebin_old, BERT.ebin(@bert_old)
     end
 
     should "do roundtrips" do

test/encoder_test.rb

@@ -83,23 +83,53 @@ class EncoderTest < Test::Unit::TestCase
 
     should 'handle utf8 strings' do
       str = "été".encode 'UTF-8'
-      bert = [132, 109, 0, 0, 0, 5, 195, 169, 116, 195, 169, 109, 0, 0, 0, 5, 85, 84, 70, 45, 56].pack('C*')
+      bert = [131, 109, 0, 0, 0, 5, 195, 169, 116, 195, 169].pack('C*')
       assert_equal bert, BERT::Encoder.encode("été")
     end
 
     should 'handle utf8 symbols' do
-      bert = [132, 100, 0, 5, 195, 169, 116, 195, 169].pack('C*')
+      bert = [131, 100, 0, 5, 195, 169, 116, 195, 169].pack('C*')
       assert_equal bert, BERT::Encoder.encode(:'été')
     end
 
     should "handle bignums" do
-      bert = [132,110,8,0,0,0,232,137,4,35,199,138].pack('c*')
+      bert = [131,110,8,0,0,0,232,137,4,35,199,138].pack('c*')
       assert_equal bert, BERT::Encoder.encode(10_000_000_000_000_000_000)
 
-      bert = [132,110,8,1,0,0,232,137,4,35,199,138].pack('c*')
+      bert = [131,110,8,1,0,0,232,137,4,35,199,138].pack('c*')
       assert_equal bert, BERT::Encoder.encode(-10_000_000_000_000_000_000)
     end
 
+    context "v2" do
+      setup do
+        @old_version = BERT::Encode.version
+        BERT::Encode.version = :v2
+      end
+
+      teardown do
+        BERT::Encode.version = @old_version
+      end
+
+      should 'handle utf8 strings' do
+        str = "été".encode 'UTF-8'
+        bert = [132, 109, 0, 0, 0, 5, 195, 169, 116, 195, 169, 109, 0, 0, 0, 5, 85, 84, 70, 45, 56].pack('C*')
+        assert_equal bert, BERT::Encoder.encode("été")
+      end
+
+      should 'handle utf8 symbols' do
+        bert = [132, 100, 0, 5, 195, 169, 116, 195, 169].pack('C*')
+        assert_equal bert, BERT::Encoder.encode(:'été')
+      end
+
+      should "handle bignums" do
+        bert = [132,110,8,0,0,0,232,137,4,35,199,138].pack('c*')
+        assert_equal bert, BERT::Encoder.encode(10_000_000_000_000_000_000)
+
+        bert = [132,110,8,1,0,0,232,137,4,35,199,138].pack('c*')
+        assert_equal bert, BERT::Encoder.encode(-10_000_000_000_000_000_000)
+      end
+    end
+
     should "leave other stuff alone" do
       before = [1, 2.0, [:foo, 'bar']]
       assert_equal before, BERT::Encoder.convert(before)