erlang-etf 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c065a1c33b75cf6235b7911022718a22fa44204c
-  data.tar.gz: 57fb1fc1ce89f1826ac5bcef122f1eb085430baa
+  metadata.gz: 320c12034e0d50d1f92aeeadcc0042a121f972de
+  data.tar.gz: c739e92472dbdef20ab555ddfb53b8404a7100d0
 SHA512:
-  metadata.gz: 3979a241f92a3f08a19e81042c266381fc8e17837e08f7f7dd7be0d34d637bacc051d0fff6a808237c57386b23fed4cc13970247efb70054c7f3ba0355668f79
-  data.tar.gz: 8947fad90e772020fff53c997d7c5240b73cb9cd298e4ab0f3f951d76aefc90ab193225a4241b4636f022c2031fecdb4d29f12bab2fdeb02e4003fc7795e6189
+  metadata.gz: d793115fb5b5bfe1694c0a23a0b0819435e206c91f8c55876cdbd0327e4bec433f0eafa9a4893e6e292832fb0a698e63c95db38c56d0a69857c3a87e4f2e34bd
+  data.tar.gz: 6d05ec4e5619e8eedc9d95dadb904b2b4d6aaef75c857572f5aa21cb9e2573ab37e88e09d31336ef7b6d46d14d7b29b36f5ed7e2be3dc0f826031503bc5bdd89

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -2,3 +2,5 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.1
+env: CI="travis"

data/Gemfile

@@ -5,10 +5,16 @@ platforms :ruby do
     gem "pry"
     gem "pry-doc"
     gem "redcarpet"
-    gem "simplecov", require: false
     gem "yard"
   end
 end
 
+group :test do
+  gem "simplecov", require: false
+  if ENV['CI']
+    gem 'coveralls', require: false
+  end
+end
+
 # Specify your gem's dependencies in erlang-etf.gemspec
 gemspec

data/README.md

@@ -1,6 +1,4 @@
-# Erlang::ETF
-
-[![Build Status](https://travis-ci.org/potatosalad/erlang-etf.png)](https://travis-ci.org/potatosalad/erlang-etf)
+# Erlang::ETF [![Build Status](https://travis-ci.org/potatosalad/erlang-etf.png)](https://travis-ci.org/potatosalad/erlang-etf) [![Coverage Status](https://coveralls.io/repos/potatosalad/erlang-etf/badge.png)](https://coveralls.io/r/potatosalad/erlang-etf)
 
 Erlang [External Term Format](http://erlang.org/doc/apps/erts/erl_ext_dist.html) (ETF) for Ruby.
 
@@ -33,6 +31,13 @@ Erlang.term_to_binary(:atom)
 # => "\x83s\x04atom"
 ```
 
+Compression is optional and valid arguments are `false`, `true`, and integers `0-9`.
+
+```ruby
+Erlang.term_to_binary([1] * 100, compressed: true)
+# => "\x83P\x00\x00\x00\xCEx\x9C\xCBa``HId\x1C\x1E0\v\x00\xE85'\x83"
+```
+
 ### `Erlang.binary_to_term(binary)`
 
 ```ruby

data/lib/erlang/etf.rb

@@ -12,9 +12,13 @@ module Erlang
 
     ERLANG_MAGIC_BYTE = 131.chr.freeze
 
-    def encode(term, buffer = "")
+    def encode(term, buffer = "", options = {})
       buffer << ERLANG_MAGIC_BYTE
-      term.__erlang_dump__(buffer)
+      if options[:compressed]
+        Compressed.new(term.__erlang_evolve__, options[:compressed]).serialize(buffer)
+      else
+        term.__erlang_dump__(buffer)
+      end
     end
 
     def decode(buffer)
@@ -33,8 +37,15 @@ module Erlang
     ETF.decode(buffer)
   end
 
-  def self.term_to_binary(term, buffer = "")
-    ETF.encode(term, buffer)
+  def self.term_to_binary(term, buffer_or_options = "", options = nil)
+    if buffer_or_options.kind_of?(::Hash)
+      buffer = options || ""
+      options = buffer_or_options
+    else
+      buffer = buffer_or_options
+    end
+    options ||= {}
+    ETF.encode(term, buffer, options)
   end
 
 end

data/lib/erlang/etf/compressed.rb

@@ -0,0 +1,66 @@
+require 'zlib'
+
+module Erlang
+  module ETF
+
+    #
+    # 1   | 4                | N
+    # --- | ---------------- | -------------------
+    # 80  | UncompressedSize | Zlib-compressedData
+    #
+    # Uncompressed Size (unsigned 32 bit integer in big-endian 
+    # byte order) is the size of the data before it was compressed. 
+    # The compressed data has the following format when it has been expanded:
+    #
+    # 1    | Uncompressed Size
+    # ---- | -----------------
+    # Tag  | Data
+    #
+    # (see [`External Term Format`] and [`term_to_binary/2`])
+    #
+    # [`External Term Format`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#overall_format
+    # [`term_to_binary/2`]: http://www.erlang.org/doc/man/erlang.html#term_to_binary-2
+    #
+    class Compressed
+      include Term
+
+      uint8 :tag, always: Terms::COMPRESSED
+
+      uint32be :uncompressed_size, always: -> { data.serialize.bytesize }
+
+      term :data
+
+      deserialize do |buffer|
+        uncompressed_size, = buffer.read(BYTES_32).unpack(UINT32BE_PACK)
+        compressed_data = buffer.read()
+        uncompressed_data = ::Zlib::Inflate.inflate(compressed_data)
+        if uncompressed_size == uncompressed_data.bytesize
+          deserialize_data(::StringIO.new(uncompressed_data))
+        else
+          raise ::Zlib::DataError, "UncompressedSize value did not match the size of the uncompressed data"
+        end
+      end
+
+      undef serialize_data
+      def serialize_data(buffer)
+        uncompressed_data = data.serialize
+        compressed_data = ::Zlib::Deflate.deflate(uncompressed_data, @level)
+        buffer << compressed_data
+      end
+
+      finalize
+
+      LEVEL_RANGE = (0..9).freeze
+      LEVEL_DEFAULT = 6.freeze
+
+      def initialize(data, level = LEVEL_DEFAULT)
+        @data = data
+        @level = LEVEL_RANGE.include?(level) ? level : LEVEL_DEFAULT
+      end
+
+      def __ruby_evolve__
+        data.__ruby_evolve__
+      end
+    end
+  end
+end

data/lib/erlang/etf/terms.rb

@@ -1,7 +1,12 @@
 module Erlang
   module ETF
+
+    #
+    # See [`erts/emulator/beam/external.h`]
+    #
+    # [`erts/emulator/beam/external.h`]: https://github.com/erlang/otp/blob/master/erts/emulator/beam/external.h
+    #
     module Terms
-      ATOM_CACHE_REF      =  82.freeze # not implemented
       SMALL_INTEGER_EXT   =  97.freeze
       INTEGER_EXT         =  98.freeze
       FLOAT_EXT           =  99.freeze
@@ -27,6 +32,14 @@ module Erlang
       ATOM_UTF8_EXT       = 118.freeze
       SMALL_ATOM_UTF8_EXT = 119.freeze
       MAP_EXT             = 116.freeze
+
+      DIST_HEADER             =  68.freeze # not implemented
+      ATOM_CACHE_REF          =  82.freeze # not implemented
+      ATOM_INTERNAL_REF2      =  73.freeze # not implemented
+      ATOM_INTERNAL_REF3      =  75.freeze # not implemented
+      BINARY_INTERNAL_REF     =  74.freeze # not implemented
+      BIT_BINARY_INTERNAL_REF =  76.freeze # not implemented
+      COMPRESSED              =  80.freeze
     end
   end
 end
@@ -38,6 +51,7 @@ require "erlang/etf/atom"
 require "erlang/etf/atom_utf8"
 require "erlang/etf/binary"
 require "erlang/etf/bit_binary"
+require "erlang/etf/compressed"
 require "erlang/etf/export"
 require "erlang/etf/float"
 require "erlang/etf/fun"
@@ -64,7 +78,7 @@ module Erlang
   module ETF
     module Terms
       MAP = {}
-      # MAP[ATOM_CACHE_REF]    = undefined
+
       MAP[SMALL_INTEGER_EXT]   = ETF::SmallInteger
       MAP[INTEGER_EXT]         = ETF::Integer
       MAP[FLOAT_EXT]           = ETF::Float
@@ -91,6 +105,16 @@ module Erlang
       MAP[SMALL_ATOM_UTF8_EXT] = ETF::SmallAtomUTF8
       MAP[MAP_EXT]             = ETF::Map
 
+      # MAP[DIST_HEADER]             = NotImplementedError
+      # MAP[ATOM_CACHE_REF]          = NotImplementedError
+      # MAP[ATOM_INTERNAL_REF2]      = NotImplementedError
+      # MAP[ATOM_INTERNAL_REF3]      = NotImplementedError
+      # MAP[BINARY_INTERNAL_REF]     = NotImplementedError
+      # MAP[BIT_BINARY_INTERNAL_REF] = NotImplementedError
+      MAP[COMPRESSED]              = ETF::Compressed
+
+      MAP.freeze
+
       def self.deserialize(buffer)
         key, = buffer.read(1).unpack(::Binary::Protocol::UINT8_PACK)
         if MAP.key?(key)

data/lib/erlang/etf/version.rb

@@ -1,5 +1,5 @@
 module Erlang
   module ETF
-    VERSION = "1.1.0"
+    VERSION = "1.1.1"
   end
 end

data/spec/erlang/etf/compressed_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Erlang::ETF::Compressed do
+  let(:term_class) { Erlang::ETF::Compressed }
+
+  describe '[class]' do
+    describe 'deserialize' do
+      let(:buffer) { StringIO.new(bytes.pack('C*')) }
+      subject { term_class.deserialize(buffer) }
+
+      context "valid zlib bytes" do
+        let(:bytes) { [0, 0, 0, 18, 120, 218, 203, 102, 224, 103, 68, 5, 0, 9, 0, 0, 138] }
+
+        its(:uncompressed_size) { should eq(18) }
+        its(:data)              { should eq(::Erlang::ETF::String.new(([1] * 15).pack('C*').from_utf8_binary).tap { |s| s.len = 15 }) }
+        its(:__ruby_evolve__)   { should eq(::Erlang::String.new(([1] * 15).pack('C*').from_utf8_binary)) }
+      end
+
+      context "invalid zlib bytes" do
+        subject { -> { term_class.deserialize(buffer) } }
+        let(:bytes) { [0, 0, 0, 18, 120, 218, 203, 102, 224, 103, 68, 5, 0, 9, 0, 0] }
+
+        it { should raise_error(::Zlib::BufError) }
+      end
+
+      context "valid zlib bytes, invalid uncompressed size" do
+        subject { -> { term_class.deserialize(buffer) } }
+        let(:bytes) { [0, 0, 0, 17, 120, 218, 203, 102, 224, 103, 68, 5, 0, 9, 0, 0, 138] }
+
+        it { should raise_error(::Zlib::DataError) }
+      end
+    end
+  end
+
+end

data/spec/erlang_spec.rb

@@ -21,6 +21,10 @@ describe Erlang do
     expect(term).to eq(Erlang.binary_to_term(Erlang.term_to_binary(term)))
   end
 
+  def roundtrip_compressed(term, compression)
+    expect(term).to eq(Erlang.binary_to_term(Erlang.term_to_binary(term, compressed: compression)))
+  end
+
   roundtrip_variables = [
     1,
     1.0,
@@ -78,4 +82,14 @@ describe Erlang do
       roundtrip(roundtrip_variable)
     end
   end
+
+  [false, true, *Erlang::ETF::Compressed::LEVEL_RANGE].each do |compression|
+    context "when compression is #{compression}" do
+      roundtrip_variables.each do |roundtrip_variable|
+        it "roundtrips #{roundtrip_variable.inspect}" do
+          roundtrip_compressed(roundtrip_variable, compression)
+        end
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,31 @@
-if ENV["COVERAGE"]
+if ENV['CI']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+elsif ENV['COVERAGE']
   require 'simplecov'
   SimpleCov.start
 end
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'erlang/etf'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erlang-etf
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Bennett
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .rspec
 - .travis.yml
@@ -102,6 +103,7 @@ files:
 - lib/erlang/etf/bert.rb
 - lib/erlang/etf/binary.rb
 - lib/erlang/etf/bit_binary.rb
+- lib/erlang/etf/compressed.rb
 - lib/erlang/etf/export.rb
 - lib/erlang/etf/extensions.rb
 - lib/erlang/etf/extensions/array.rb
@@ -151,6 +153,7 @@ files:
 - spec/erlang/etf/atom_utf8_spec.rb
 - spec/erlang/etf/binary_spec.rb
 - spec/erlang/etf/bit_binary_spec.rb
+- spec/erlang/etf/compressed_spec.rb
 - spec/erlang/etf/export_spec.rb
 - spec/erlang/etf/extensions/array_spec.rb
 - spec/erlang/etf/extensions/big_decimal_spec.rb
@@ -226,6 +229,7 @@ test_files:
 - spec/erlang/etf/atom_utf8_spec.rb
 - spec/erlang/etf/binary_spec.rb
 - spec/erlang/etf/bit_binary_spec.rb
+- spec/erlang/etf/compressed_spec.rb
 - spec/erlang/etf/export_spec.rb
 - spec/erlang/etf/extensions/array_spec.rb
 - spec/erlang/etf/extensions/big_decimal_spec.rb