bert 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/History.txt

@@ -0,0 +1,9 @@
+= 0.2.0 / 2009-10-15
+  * Major changes
+    * Use {time, MegaSecs, Secs, Microsecs} for time serialization
+    * Use array of options for regex serialization
+  * Tests
+    * Add roundtrip tests
+
+= 0.1.0 / 2009-10-08
+  * Birthday!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tom Preston-Werner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+BERT
+====
+
+BERT is a BERT (Binary ERlang Term) serialization library for Ruby. It can
+encode Ruby objects into BERT format and decode BERT binaries into Ruby
+objects.
+
+See the BERT specification at [bert-rpc.org](http://bert-rpc.org).
+
+Instances of the following Ruby classes will be automatically converted to the proper simple BERT type:
+
+* Fixnum
+* Float
+* Symbol
+* Array
+* String
+
+Instances of the following Ruby classes will be automatically converted to the proper complex BERT type:
+
+* NilClass
+* TrueClass
+* FalseClass
+* Hash
+* Time
+* Regexp
+
+To designate tuples, simply prefix an Array literal with a `t` or use the BERT::Tuple class:
+
+    t[:foo, [1, 2, 3]]
+    BERT::Tuple.new([:foo, [1, 2, 3]])
+
+Both of these will be converted to (in Erlang syntax):
+
+    {foo, [1, 2, 3]}
+
+
+Installation
+------------
+
+    gem install bert -s http://gemcutter.org
+
+
+Usage
+-----
+
+    require 'bert'
+    
+    bert = BERT.encode(t[:user, {:name => 'TPW', :nick => 'mojombo'}])
+    # => "\203h\002d\000\004userh\002d\000\004dictl\000\000\000\002h\002d
+          \000\004namem\000\000\000\003TPWh\002d\000\004nickm\000\000\000
+          \amojomboj"
+    
+    BERT.decode(bert)
+    # => t[:user, {:name=>"TPW", :nick=>"mojombo"}]
+
+
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+Copyright
+---------
+
+Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bert"
+    gem.summary = %Q{BERT Serializiation for Ruby}
+    gem.description = %Q{BERT Serializiation for Ruby}
+    gem.email = "tom@mojombo.com"
+    gem.homepage = "http://github.com/mojombo/bert"
+    gem.authors = ["Tom Preston-Werner"]
+    gem.add_dependency('erlectricity', '>= 1.1.0')
+    gem.add_development_dependency("thoughtbot-shoulda")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bert #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :console do
+  exec('irb -I lib -rbert')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bert.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bert}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Preston-Werner"]
+  s.date = %q{2009-10-15}
+  s.description = %q{BERT Serializiation for Ruby}
+  s.email = %q{tom@mojombo.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bert.gemspec",
+     "lib/bert.rb",
+     "lib/bert/decoder.rb",
+     "lib/bert/encoder.rb",
+     "test/bert_test.rb",
+     "test/decoder_test.rb",
+     "test/encoder_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mojombo/bert}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{BERT Serializiation for Ruby}
+  s.test_files = [
+    "test/bert_test.rb",
+     "test/decoder_test.rb",
+     "test/encoder_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<erlectricity>, [">= 1.1.0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<erlectricity>, [">= 1.1.0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<erlectricity>, [">= 1.1.0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/lib/bert.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'erlectricity'
+
+require 'bert/encoder'
+require 'bert/decoder'
+
+module BERT
+  def self.encode(ruby)
+    Encoder.encode(ruby)
+  end
+
+  def self.decode(bert)
+    Decoder.decode(bert)
+  end
+
+  def self.ebin(str)
+    bytes = []
+    str.each_byte { |b| bytes << b.to_s }
+    "<<" + bytes.join(',') + ">>"
+  end
+end
+
+module BERT
+  class Tuple < Array
+    def inspect
+      "t#{super}"
+    end
+  end
+end
+
+def t
+  BERT::Tuple
+end

data/lib/bert/decoder.rb

@@ -0,0 +1,63 @@
+module BERT
+  class Decoder
+    # Decode a BERT into a Ruby object.
+    #   +bert+ is the BERT String
+    #
+    # Returns a Ruby object
+    def self.decode(bert)
+      simple_ruby = Erlectricity::Decoder.decode(bert)
+      convert(simple_ruby)
+    end
+
+    # Convert Erlectricity representation of BERT complex types into
+    # corresponding Ruby types.
+    #   +item+ is the Ruby object to convert
+    #
+    # Returns the converted Ruby object
+    def self.convert(item)
+      case item
+        when TrueClass, FalseClass
+          item.to_s.to_sym
+        when Erl::List
+          item.map { |x| convert(x) }
+        when Array
+          if item[0] == :bert
+            convert_bert(item)
+          else
+            Tuple.new(item.map { |x| convert(x) })
+          end
+        else
+          item
+      end
+    end
+
+    # Convert complex types.
+    #   +item+ is the complex type array
+    #
+    # Returns the converted Ruby object
+    def self.convert_bert(item)
+      case item[1]
+        when :nil
+          nil
+        when :dict
+          item[2].inject({}) do |acc, x|
+            acc[convert(x[0])] = convert(x[1]); acc
+          end
+        when TrueClass
+          true
+        when FalseClass
+          false
+        when :time
+          Time.at(item[2] * 1_000_000 + item[3], item[4])
+        when :regex
+          options = 0
+          options |= Regexp::EXTENDED if item[3].include?(:extended)
+          options |= Regexp::IGNORECASE if item[3].include?(:caseless)
+          options |= Regexp::MULTILINE if item[3].include?(:multiline)
+          Regexp.new(item[2], options)
+        else
+          nil
+      end
+    end
+  end
+end

data/lib/bert/encoder.rb

@@ -0,0 +1,46 @@
+module BERT
+  class Encoder
+    # Encode a Ruby object into a BERT.
+    #   +ruby+ is the Ruby object
+    #
+    # Returns a BERT
+    def self.encode(ruby)
+      complex_ruby = convert(ruby)
+      Erlectricity::Encoder.encode(complex_ruby)
+    end
+
+    # Convert Ruby types into corresponding Erlectricity representation
+    # of BERT complex types.
+    #   +item+ is the Ruby object to convert
+    #
+    # Returns the converted Ruby object
+    def self.convert(item)
+      case item
+        when Hash
+          pairs = Erl::List[]
+          item.each_pair { |k, v| pairs << [convert(k), convert(v)] }
+          [:bert, :dict, pairs]
+        when Tuple
+          item.map { |x| convert(x) }
+        when Array
+          Erl::List.new(item.map { |x| convert(x) })
+        when nil
+          [:bert, :nil]
+        when TrueClass
+          [:bert, :true]
+        when FalseClass
+          [:bert, :false]
+        when Time
+          [:bert, :time, item.to_i / 1_000_000, item.to_i % 1_000_000, item.usec]
+        when Regexp
+          options = Erl::List[]
+          options << :caseless if item.options & Regexp::IGNORECASE > 0
+          options << :extended if item.options & Regexp::EXTENDED > 0
+          options << :multiline if item.options & Regexp::MULTILINE > 0
+          [:bert, :regex, item.source, options]
+        else
+          item
+      end
+    end
+  end
+end

data/test/bert_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+class BertTest < Test::Unit::TestCase
+  context "BERT" do
+    setup do
+      time = Time.at(1254976067)
+      @ruby = t[:user, {:name => 'TPW'}, [/cat/i, 9.9], time, nil, true, false, :true, :false]
+      @bert = "\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"
+      @ebin = "<<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 "encode" do
+      assert_equal @bert, BERT.encode(@ruby)
+    end
+
+    should "decode" do
+      assert_equal @ruby, BERT.decode(@bert)
+    end
+
+    should "ebin" do
+      assert_equal @ebin, BERT.ebin(@bert)
+    end
+
+    should "do roundtrips" do
+      dd = []
+      dd << 1
+      dd << 1.0
+      dd << :a
+      dd << t[]
+      dd << t[:a]
+      dd << t[:a, :b]
+      dd << t[t[:a, 1], t[:b, 2]]
+      dd << []
+      dd << [:a]
+      dd << [:a, 1]
+      dd << [[:a, 1], [:b, 2]]
+      dd << "a"
+
+      dd << nil
+      dd << true
+      dd << false
+      dd << {}
+      dd << {:a => 1}
+      dd << {:a => 1, :b => 2}
+      dd << Time.now
+      dd << /^c(a)t$/i
+
+      dd << :true
+      dd << :false
+      dd << :nil
+
+      dd.each do |d|
+        assert_equal d, BERT.decode(BERT.encode(d))
+      end
+    end
+
+    # should "let me inspect it" do
+    #   puts
+    #   p @ruby
+    #   ruby2 = BERT.decode(@bert)
+    #   p ruby2
+    #   bert2 = BERT.encode(ruby2)
+    #   ruby3 = BERT.decode(bert2)
+    #   p ruby3
+    # end
+  end
+end

data/test/decoder_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+class DecoderTest < Test::Unit::TestCase
+  context "BERT Decoder complex type converter" do
+    should "convert nil" do
+      before = [:bert, :nil]
+      after = nil
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "convert nested nil" do
+      before = [[:bert, :nil], [[:bert, :nil]]]
+      after = [nil, [nil]]
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "convert hashes" do
+      before = [:bert, :dict, [[:foo, 'bar']]]
+      after = {:foo => 'bar'}
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "convert empty hashes" do
+      before = [:bert, :dict, []]
+      after = {}
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "convert nested hashes" do
+      before = [:bert, :dict, [[:foo, [:bert, :dict, [[:baz, 'bar']]]]]]
+      after = {:foo => {:baz => 'bar'}}
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "convert true" do
+      before = [:bert, true]
+      after = true
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "convert false" do
+      before = [:bert, false]
+      after = false
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "convert times" do
+      before = [:bert, :time, 1254, 976067, 0]
+      after = Time.at(1254976067)
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "convert regexen" do
+      before = [:bert, :regex, '^c(a)t$', [:caseless, :extended]]
+      after = /^c(a)t$/ix
+      assert_equal after, BERT::Decoder.convert(before)
+    end
+
+    should "leave other stuff alone" do
+      before = [1, 2.0, [:foo, 'bar']]
+      assert_equal before, BERT::Decoder.convert(before)
+    end
+  end
+end

data/test/encoder_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+
+class EncoderTest < Test::Unit::TestCase
+  context "BERT Encoder complex type converter" do
+    should "convert nil" do
+      assert_equal [:bert, :nil], BERT::Encoder.convert(nil)
+    end
+
+    should "convert nested nil" do
+      before = [nil, [nil]]
+      after = [[:bert, :nil], [[:bert, :nil]]]
+      assert_equal after, BERT::Encoder.convert(before)
+    end
+
+    should "convert hashes" do
+      before = {:foo => 'bar'}
+      after = [:bert, :dict, [[:foo, 'bar']]]
+      assert_equal after, BERT::Encoder.convert(before)
+    end
+
+    should "convert nested hashes" do
+      before = {:foo => {:baz => 'bar'}}
+      after = [:bert, :dict, [[:foo, [:bert, :dict, [[:baz, "bar"]]]]]]
+      assert_equal after, BERT::Encoder.convert(before)
+    end
+
+    should "convert hash to tuple with array of tuples" do
+      arr = BERT::Encoder.convert({:foo => 'bar'})
+      assert arr.is_a?(Array)
+      assert arr[2].is_a?(Erl::List)
+      assert arr[2][0].is_a?(Array)
+    end
+
+    should "convert tuple to array" do
+      arr = BERT::Encoder.convert(t[:foo, 2])
+      assert arr.is_a?(Array)
+    end
+
+    should "convert array to erl list" do
+      list = BERT::Encoder.convert([1, 2])
+      assert list.is_a?(Erl::List)
+    end
+
+    should "convert an array in a tuple" do
+      arrtup = BERT::Encoder.convert(t[:foo, [1, 2]])
+      assert arrtup.is_a?(Array)
+      assert arrtup[1].is_a?(Erl::List)
+    end
+
+    should "convert true" do
+      before = true
+      after = [:bert, :true]
+      assert_equal after, BERT::Encoder.convert(before)
+    end
+
+    should "convert false" do
+      before = false
+      after = [:bert, :false]
+      assert_equal after, BERT::Encoder.convert(before)
+    end
+
+    should "convert times" do
+      before = Time.at(1254976067)
+      after = [:bert, :time, 1254, 976067, 0]
+      assert_equal after, BERT::Encoder.convert(before)
+    end
+
+    should "convert regexen" do
+      before = /^c(a)t$/ix
+      after = [:bert, :regex, '^c(a)t$', [:caseless, :extended]]
+      assert_equal after, BERT::Encoder.convert(before)
+    end
+
+    should "properly convert types" do
+      ruby = t[:user, {:name => 'TPW'}, [/cat/i, 9.9], nil, true, false, :true, :false]
+      cruby = BERT::Encoder.convert(ruby)
+      assert cruby.instance_of?(Array)
+      assert cruby[0].instance_of?(Symbol)
+      assert cruby[1].instance_of?(Array)
+    end
+
+    should "leave other stuff alone" do
+      before = [1, 2.0, [:foo, 'bar']]
+      assert_equal before, BERT::Encoder.convert(before)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bert'
+
+class Test::Unit::TestCase
+end
+
+# So I can easily see which arrays are Erl::List
+module Erl
+  class List
+    def inspect
+      "l#{super}"
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: bert
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Tom Preston-Werner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: erlectricity
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: BERT Serializiation for Ruby
+email: tom@mojombo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- History.txt
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bert.gemspec
+- lib/bert.rb
+- lib/bert/decoder.rb
+- lib/bert/encoder.rb
+- test/bert_test.rb
+- test/decoder_test.rb
+- test/encoder_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mojombo/bert
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: BERT Serializiation for Ruby
+test_files: 
+- test/bert_test.rb
+- test/decoder_test.rb
+- test/encoder_test.rb
+- test/test_helper.rb