erlang-etf 1.0.0 → 1.0.1

data/lib/erlang/etf/nil.rb

@@ -2,11 +2,15 @@ module Erlang
   module ETF
 
     #
-    # 1
-    # ---
-    # 106
+    # | 1   |
+    # | --- |
+    # | 106 |
     #
-    # The representation for an empty list, i.e. the Erlang syntax [].
+    # The representation for an empty list, i.e. the Erlang syntax `[]`.
+    #
+    # (see [`NIL_EXT`])
+    #
+    # [`NIL_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#NIL_EXT
     #
     class Nil
       include Term

data/lib/erlang/etf/pid.rb

@@ -2,14 +2,20 @@ module Erlang
   module ETF
 
     #
-    # 1   | N    | 4  | 4      | 1
-    # --- | ---- | -- | ------ | --------
-    # 103 | Node | ID | Serial | Creation
+    # 1   | N    | 4   | 4      | 1
+    # --- | ---- | --- | ------ | --------
+    # 103 | Node | ID  | Serial | Creation
     #
-    # Encode a process identifier object (obtained from spawn/3 or
-    # friends). The ID and Creation fields works just like in
-    # REFERENCE_EXT, while the Serial field is used to improve safety.
-    # In ID, only 15 bits are significant; the rest should be 0.
+    # Encode a process identifier object (obtained from [`spawn/3`] or
+    # friends). The `ID` and `Creation` fields works just like in
+    # [`REFERENCE_EXT`], while the `Serial` field is used to improve safety.
+    # In `ID`, only 15 bits are significant; the rest should be 0.
+    #
+    # (see [`PID_EXT`])
+    #
+    # [`spawn/3`]: http://erlang.org/doc/man/erlang.html#spawn-3
+    # [`REFERENCE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#REFERENCE_EXT
+    # [`PID_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#PID_EXT
     #
     class Pid
       include Term

data/lib/erlang/etf/port.rb

@@ -2,14 +2,20 @@ module Erlang
   module ETF
 
     #
-    # 1   | N    | 4  | 1
-    # --- | ---- | -- | --------
-    # 102 | Node | ID | Creation
+    # 1   | N    | 4   | 1
+    # --- | ---- | --- | --------
+    # 102 | Node | ID  | Creation
     #
-    # Encode a port object (obtained form open_port/2). The ID is a
+    # Encode a port object (obtained form [`open_port/2`]). The `ID` is a
     # node specific identifier for a local port. Port operations are
-    # not allowed across node boundaries. The Creation works just like
-    # in REFERENCE_EXT.
+    # not allowed across node boundaries. The `Creation` works just like
+    # in [`REFERENCE_EXT`].
+    #
+    # (see [`PORT_EXT`])
+    #
+    # [`open_port/2`]: http://erlang.org/doc/man/erlang.html#open_port-2
+    # [`REFERENCE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#REFERENCE_EXT
+    # [`PORT_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#PORT_EXT
     #
     class Port
       include Term

data/lib/erlang/etf/reference.rb

@@ -2,21 +2,30 @@ module Erlang
   module ETF
 
     #
-    # 1   | N    | 4  | 1
-    # --- | ---- | -- | --------
-    # 101 | Node | ID | Creation
+    # 1   | N    | 4   | 1
+    # --- | ---- | --- | --------
+    # 101 | Node | ID  | Creation
     #
-    # Encode a reference object (an object generated with make_ref/0).
-    # The Node term is an encoded atom, i.e. ATOM_EXT, SMALL_ATOM_EXT
-    # or ATOM_CACHE_REF. The ID field contains a big-endian unsigned
+    # Encode a reference object (an object generated with [`make_ref/0`]).
+    # The `Node` term is an encoded atom, i.e. [`ATOM_EXT`], [`SMALL_ATOM_EXT`]
+    # or [`ATOM_CACHE_REF`]. The `ID` field contains a big-endian unsigned
     # integer, but should be regarded as uninterpreted data since this
-    # field is node specific. Creation is a byte containing a node
+    # field is node specific. `Creation` is a byte containing a node
     # serial number that makes it possible to separate old (crashed)
     # nodes from a new one.
     #
-    # In ID, only 18 bits are significant; the rest should be 0.
-    # In Creation, only 2 bits are significant; the rest should be 0.
-    # See NEW_REFERENCE_EXT.
+    # In `ID`, only 18 bits are significant; the rest should be 0.
+    # In `Creation`, only 2 bits are significant; the rest should be 0.
+    # See [`NEW_REFERENCE_EXT`].
+    #
+    # (see [`REFERENCE_EXT`])
+    #
+    # [`make_ref/0`]: http://erlang.org/doc/man/erlang.html#make_ref-0
+    # [`ATOM_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#ATOM_EXT
+    # [`SMALL_ATOM_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_ATOM_EXT
+    # [`ATOM_CACHE_REF`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#ATOM_CACHE_REF
+    # [`NEW_REFERENCE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#NEW_REFERENCE_EXT
+    # [`REFERENCE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#REFERENCE_EXT
     #
     class Reference
       include Term

data/lib/erlang/etf/small_atom.rb

@@ -6,13 +6,20 @@ module Erlang
     # --- | --- | --------
     # 115 | Len | AtomName
     #
-    # An atom is stored with a 1 byte unsigned length, followed by Len
-    # numbers of 8 bit Latin1 characters that forms the AtomName.
-    # Longer atoms can be represented by ATOM_EXT.
+    # An atom is stored with a 1 byte unsigned length, followed by `Len`
+    # numbers of 8 bit Latin1 characters that forms the `AtomName`.
+    # Longer atoms can be represented by [`ATOM_EXT`].
     #
-    # Note the SMALL_ATOM_EXT was introduced in erts version 5.7.2 and
-    # require an exchange of the DFLAG_SMALL_ATOM_TAGS distribution
-    # flag in the distribution handshake.
+    # **Note** the [`SMALL_ATOM_EXT`] was introduced in erts version 5.7.2 and
+    # require an exchange of the [`DFLAG_SMALL_ATOM_TAGS`] distribution
+    # flag in the [distribution handshake].
+    #
+    # (see [`SMALL_ATOM_EXT`])
+    #
+    # [`ATOM_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#ATOM_EXT
+    # [`DFLAG_SMALL_ATOM_TAGS`]: http://erlang.org/doc/apps/erts/erl_dist_protocol.html#dflags
+    # [distribution handshake]: http://erlang.org/doc/apps/erts/erl_dist_protocol.html#distribution_handshake
+    # [`SMALL_ATOM_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_ATOM_EXT
     #
     class SmallAtom
       include Term

data/lib/erlang/etf/small_atom_utf8.rb

@@ -6,9 +6,14 @@ module Erlang
     # --- | --- | --------
     # 119 | Len | AtomName
     #
-    # An atom is stored with a 1 byte unsigned length, followed by Len
-    # bytes containing the AtomName encoded in UTF-8. Longer atoms
-    # encoded in UTF-8 can be represented using ATOM_UTF8_EXT.
+    # An atom is stored with a 1 byte unsigned length, followed by `Len`
+    # bytes containing the `AtomName` encoded in UTF-8. Longer atoms
+    # encoded in UTF-8 can be represented using [`ATOM_UTF8_EXT`].
+    #
+    # (see [`SMALL_ATOM_UTF8_EXT`])
+    #
+    # [`ATOM_UTF8_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#ATOM_UTF8_EXT
+    # [`SMALL_ATOM_UTF8_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_ATOM_UTF8_EXT
     #
     class SmallAtomUTF8
       include Term

data/lib/erlang/etf/small_big.rb

@@ -2,16 +2,24 @@ module Erlang
   module ETF
 
     #
-    # 1   | 1 | 1    | n
-    # --- | - | ---- | ---------------
-    # 110 | n | Sign | d(0) ... d(n-1)
+    # 1   | 1   | 1    | n
+    # --- | --- | ---- | ---------------
+    # 110 | n   | Sign | d(0) ... d(n-1)
     #
-    # Bignums are stored in unary form with a Sign byte that is 0 if
+    # Bignums are stored in unary form with a `Sign` byte that is 0 if
     # the binum is positive and 1 if is negative. The digits are
-    # stored with the LSB byte stored first. To calculate the integer
-    # the following formula can be used:
+    # stored with the LSB byte stored first.
+    #
+    # To calculate the integer the following formula can be used:
+    #
+    # ```
     # B = 256
     # (d0*B^0 + d1*B^1 + d2*B^2 + ... d(N-1)*B^(n-1))
+    # ```
+    #
+    # (see [`SMALL_BIG_EXT`])
+    #
+    # [`SMALL_BIG_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_BIG_EXT
     #
     class SmallBig
       include Term

data/lib/erlang/etf/small_integer.rb

@@ -2,12 +2,16 @@ module Erlang
   module ETF
 
     #
-    # 1  | 1
-    # -- | ---
-    # 97 | Int
+    # 1   | 1
+    # --- | ---
+    # 97  | Int
     #
     # Unsigned 8 bit integer.
     #
+    # (see [`SMALL_INTEGER_EXT`])
+    #
+    # [`SMALL_INTEGER_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_INTEGER_EXT
+    #
     class SmallInteger
       include Term
 

data/lib/erlang/etf/small_tuple.rb

@@ -6,9 +6,13 @@ module Erlang
     # --- | ----- | --------
     # 104 | Arity | Elements
     #
-    # SMALL_TUPLE_EXT encodes a tuple. The Arity field is an unsigned
+    # [`SMALL_TUPLE_EXT`] encodes a tuple. The `Arity` field is an unsigned
     # byte that determines how many element that follows in the
-    # Elements section.
+    # `Elements` section.
+    #
+    # (see [`SMALL_TUPLE_EXT`])
+    #
+    # [`SMALL_TUPLE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_TUPLE_EXT
     #
     class SmallTuple
       include Term

data/lib/erlang/etf/string.rb

@@ -11,7 +11,12 @@ module Erlang
     # range 0-255) more efficiently over the distribution. Since the
     # Length field is an unsigned 2 byte integer (big endian),
     # implementations must make sure that lists longer than 65535
-    # elements are encoded as LIST_EXT.
+    # elements are encoded as [`LIST_EXT`].
+    #
+    # (see [`STRING_EXT`])
+    #
+    # [`LIST_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#LIST_EXT
+    # [`STRING_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#STRING_EXT
     #
     class String
       include Term

data/lib/erlang/etf/version.rb

@@ -1,5 +1,5 @@
 module Erlang
   module ETF
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/spec/erlang/etf/extensions/erlang-string_spec.rb

@@ -11,15 +11,30 @@ describe Erlang::ETF::Extensions::ErlangString do
     describe '__erlang_type__' do
       subject { instance.__erlang_type__ }
 
-      let(:args) {[ "test" ]}
-      it { should eq(:string) }
+      context 'simple string' do
+        let(:args) {[ "test" ]}
+        it { should eq(:string) }
+      end
+
+      context 'when bytesize larger than 1 << 16' do
+        let(:args) {[ "a" * (1 << 16) ]}
+        it { should eq(:list) }
+      end
     end
 
     describe '__erlang_evolve__' do
       subject { instance.__erlang_evolve__ }
 
-      let(:args) {[ "test" ]}
-      it { should eq(Erlang::ETF::String.new("test")) }
+      context 'simple string' do
+        let(:args) {[ "test" ]}
+        it { should eq(Erlang::ETF::String.new("test")) }
+      end
+
+      context 'when bytesize larger than 1 << 16' do
+        let(:args) {[ "a" * (1 << 16) ]}
+        its(:len) { should eq(1 << 16) }
+        it { should be_a(Erlang::ETF::List) }
+      end
     end
   end
 

data/spec/erlang/etf/extensions/erlang-tuple_spec.rb

@@ -48,7 +48,8 @@ describe Erlang::ETF::Extensions::ErlangTuple do
       context 'when arity is greater than or equal to 256' do
         let(:elements) { [[]] * 256 }
 
-        it { should eq(Erlang::ETF::LargeTuple.new([Erlang::ETF::Nil.new] * 256)) }
+        its(:arity) { should eq(256) }
+        it { should be_a(Erlang::ETF::LargeTuple) }
       end
     end
   end

data/spec/erlang/etf/extensions/hash_spec.rb

@@ -36,7 +36,7 @@ describe Erlang::ETF::Extensions::Hash do
       context 'when empty' do
         let(:keyvalues) { [] }
 
-        it { should eq(
+        it("should eq {:bert, :dict, []}") { should eq(
           Erlang::ETF::SmallTuple.new([
             Erlang::ETF::SmallAtom.new("bert"),
             Erlang::ETF::SmallAtom.new("dict"),
@@ -48,7 +48,7 @@ describe Erlang::ETF::Extensions::Hash do
       context 'when arity is less than 256' do
         let(:keyvalues) { [:a, 1] }
 
-        it { should eq(
+        it("should eq {:bert, :dict, [{:a, 1}]}") { should eq(
           Erlang::ETF::SmallTuple.new([
             Erlang::ETF::SmallAtom.new("bert"),
             Erlang::ETF::SmallAtom.new("dict"),
@@ -76,7 +76,7 @@ describe Erlang::ETF::Extensions::Hash do
           elements
         }
 
-        it { should eq(
+        it("should eq {:bert, :dict, [{1, []}, {2, []}, ..., {256, []}]}") { should eq(
           Erlang::ETF::SmallTuple.new([
             Erlang::ETF::SmallAtom.new("bert"),
             Erlang::ETF::SmallAtom.new("dict"),

data/spec/erlang/etf/large_tuple_spec.rb

@@ -38,7 +38,7 @@ describe Erlang::ETF::LargeTuple do
         let(:bytes) { [0, 0, 1, 0, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106, 106] }
 
         its(:arity)    { should eq(256) }
-        its(:elements) { should eq([erlang_nil] * 256) }
+        # its(:elements) { should eq([erlang_nil] * 256) }
       end
     end
   end

data/spec/erlang_spec.rb

@@ -50,7 +50,8 @@ describe Erlang do
     Erlang::Tuple[:bert, :dict, :invalid],
     Erlang::Tuple[:bert, :dict],
     Erlang::Tuple[:bert, :dict, Erlang::Tuple[:a]],
-    Time.now,
+    # Time.now,
+    Time.at(1363190400, 31388),
     Erlang::Tuple[:bert, :time],
     Erlang::Tuple[:bert, :time, 1, 1],
     Erlang::Tuple[:bert, :time, 1, 1, 1, 1],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erlang-etf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrew Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binary-protocol
@@ -52,34 +52,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +80,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Erlang External Term Format (ETF) for Ruby
 email:
 - andrew@delorum.com
@@ -132,6 +90,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md