erlang-etf 1.0.0 → 1.0.1

data/lib/erlang/etf/extensions/erlang-string.rb

@@ -6,16 +6,25 @@ module Erlang
 
       module ErlangString
 
+        STRING_MAX = (+1 << 16) - 1
+
         def __erlang_type__
-          :string
+          if bytesize > STRING_MAX
+            :list
+          else
+            :string
+          end
         end
 
         def __erlang_evolve__
-          ETF::String.new(self)
+          case __erlang_type__
+          when :list
+            ETF::List.new(unpack('C*'))
+          when :string
+            ETF::String.new(self)
+          end
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/erlang-tuple.rb

@@ -23,8 +23,6 @@ module Erlang
           end
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/false_class.rb

@@ -20,8 +20,6 @@ module Erlang
           ::Erlang::Tuple[:bert, :false].__erlang_evolve__
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/float.rb

@@ -12,8 +12,6 @@ module Erlang
           ETF::NewFloat.new(self)
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/hash.rb

@@ -24,8 +24,6 @@ module Erlang
           end].__erlang_evolve__
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/integer.rb

@@ -40,8 +40,6 @@ module Erlang
           end
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/nil_class.rb

@@ -21,8 +21,6 @@ module Erlang
           ::Erlang::Tuple[:bert, :nil].__erlang_evolve__
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/object.rb

@@ -16,8 +16,6 @@ module Erlang
           __erlang_evolve__.serialize(buffer)
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/regexp.rb

@@ -26,8 +26,6 @@ module Erlang
           ::Erlang::Tuple[:bert, :regex, source, opts].__erlang_evolve__
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/string.rb

@@ -27,8 +27,6 @@ module Erlang
           force_encoding(UTF8_ENCODING).encode!
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/symbol.rb

@@ -37,8 +37,6 @@ module Erlang
           to_s.to_utf8_binary
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/time.rb

@@ -21,8 +21,6 @@ module Erlang
           ::Erlang::Tuple[:bert, :time, to_i / 1_000_000, to_i % 1_000_000, usec].__erlang_evolve__
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/extensions/true_class.rb

@@ -20,8 +20,6 @@ module Erlang
           ::Erlang::Tuple[:bert, :true].__erlang_evolve__
         end
 
-        module ClassMethods
-        end
       end
     end
   end

data/lib/erlang/etf/float.rb

@@ -4,9 +4,9 @@ module Erlang
   module ETF
 
     #
-    # 1  | 31
-    # -- | ------------
-    # 99 | Float String
+    # 1   | 31
+    # --- | ------------
+    # 99  | Float String
     #
     # A float is stored in string format. the format used in sprintf
     # to format the float is "%.20e" (there are more bytes allocated
@@ -14,7 +14,12 @@ module Erlang
     # "%lf".
     #
     # This term is used in minor version 0 of the external format; it
-    # has been superseded by NEW_FLOAT_EXT .
+    # has been superseded by [`NEW_FLOAT_EXT`].
+    #
+    # (see [`FLOAT_EXT`])
+    #
+    # [`NEW_FLOAT_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#NEW_FLOAT_EXT
+    # [`FLOAT_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#FLOAT_EXT
     #
     class Float
       include Term

data/lib/erlang/etf/fun.rb

@@ -6,23 +6,37 @@ module Erlang
     # --- | ------- | --- | ------ | ----- | ---- | -------------
     # 117 | NumFree | Pid | Module | Index | Uniq | Free vars ...
     #
-    # Pid
-    #   is a process identifier as in PID_EXT. It represents the
+    # `Pid`
+    # > is a process identifier as in [`PID_EXT`]. It represents the
     #   process in which the fun was created.
-    # Module
-    #   is an encoded as an atom, using ATOM_EXT, SMALL_ATOM_EXT or
-    #   ATOM_CACHE_REF. This is the module that the fun is
+    #
+    # `Module`
+    # > is an encoded as an atom, using [`ATOM_EXT`], [`SMALL_ATOM_EXT`] or
+    #   [`ATOM_CACHE_REF`]. This is the module that the fun is
     #   implemented in.
-    # Index
-    #   is an integer encoded using SMALL_INTEGER_EXT or INTEGER_EXT.
+    #
+    # `Index`
+    # > is an integer encoded using [`SMALL_INTEGER_EXT`] or [`INTEGER_EXT`].
     #   It is typically a small index into the module's fun table.
-    # Uniq
-    #   is an integer encoded using SMALL_INTEGER_EXT or INTEGER_EXT.
-    #   Uniq is the hash value of the parse for the fun.
-    # Free vars
-    #   is NumFree number of terms, each one encoded according to its
+    #
+    # `Uniq`
+    # > is an integer encoded using [`SMALL_INTEGER_EXT`] or [`INTEGER_EXT`].
+    #   `Uniq` is the hash value of the parse for the fun.
+    #
+    # `Free vars`
+    # > is `NumFree` number of terms, each one encoded according to its
     #   type.
     #
+    # (see [`FUN_EXT`])
+    #
+    # [`PID_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#PID_EXT
+    # [`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
+    # [`SMALL_INTEGER_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_INTEGER_EXT
+    # [`INTEGER_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#INTEGER_EXT
+    # [`FUN_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#FUN_EXT
+    #
     class Fun
       include Term
 

data/lib/erlang/etf/integer.rb

@@ -2,12 +2,16 @@ module Erlang
   module ETF
 
     #
-    # 1  | 4
-    # -- | ---
-    # 98 | Int
+    # 1   | 4
+    # --- | ---
+    # 98  | Int
     #
     # Signed 32 bit integer in big-endian format (i.e. MSB first)
     #
+    # (see [`INTEGER_EXT`])
+    #
+    # [`INTEGER_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#INTEGER_EXT
+    #
     class Integer
       include Term
 

data/lib/erlang/etf/large_big.rb

@@ -2,12 +2,17 @@ module Erlang
   module ETF
 
     #
-    # 1   | 4 | 1    | n
-    # --- | - | ---- | ---------------
-    # 111 | n | Sign | d(0) ... d(n-1)
+    # 1   | 4   | 1    | n
+    # --- | --- | ---- | ---------------
+    # 111 | n   | Sign | d(0) ... d(n-1)
     #
-    # Same as SMALL_BIG_EXT with the difference that the length field
-    # is an unsigned 4 byte integer.
+    # Same as [`SMALL_BIG_EXT`] with the difference that the length
+    # field is an unsigned 4 byte integer.
+    #
+    # (see [`LARGE_BIG_EXT`])
+    #
+    # [`SMALL_BIG_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_BIG_EXT
+    # [`LARGE_BIG_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#LARGE_BIG_EXT
     #
     class LargeBig
       include Term

data/lib/erlang/etf/large_tuple.rb

@@ -6,9 +6,14 @@ module Erlang
     # --- | ----- | --------
     # 105 | Arity | Elements
     #
-    # Same as SMALL_TUPLE_EXT with the exception that Arity is an
+    # Same as [`SMALL_TUPLE_EXT`] with the exception that `Arity` is an
     # unsigned 4 byte integer in big endian format.
     #
+    # (see [`LARGE_TUPLE_EXT`])
+    #
+    # [`SMALL_TUPLE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_TUPLE_EXT
+    # [`LARGE_TUPLE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#LARGE_TUPLE_EXT
+    #
     class LargeTuple
       include Term
 

data/lib/erlang/etf/list.rb

@@ -2,14 +2,19 @@ module Erlang
   module ETF
 
     #
-    # 1   | 4   | Len      |
+    # 1   | 4   | Len      | N1
     # --- | --- | -------- | ----
     # 108 | Len | Elements | Tail
     #
-    # Length is the number of elements that follows in the Elements
-    # section. Tail is the final tail of the list; it is NIL_EXT for a
+    # `Length` is the number of elements that follows in the `Elements`
+    # section. `Tail` is the final tail of the list; it is [`NIL_EXT`] for a
     # proper list, but may be anything type if the list is improper
-    # (for instance [a|b]).
+    # (for instance `[a|b]`).
+    #
+    # (see [`LIST_EXT`])
+    #
+    # [`NIL_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#NIL_EXT
+    # [`LIST_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#LIST_EXT
     #
     class List
       include Term
@@ -18,7 +23,7 @@ module Erlang
 
       uint32be :len, always: -> { elements.size }
 
-      term :elements, type: :array
+      term :elements, type: :array, allow_char: true
       term :tail
 
       deserialize do |buffer|

data/lib/erlang/etf/new_float.rb

@@ -4,14 +4,18 @@ module Erlang
   module ETF
 
     #
-    # 1  | 8
-    # -- | ----------
-    # 70 | IEEE Float
+    # 1   | 8
+    # --- | ----------
+    # 70  | IEEE Float
     #
     # A float is stored as 8 bytes in big-endian IEEE format.
     #
     # This term is used in minor version 1 of the external format.
     #
+    # (see [`NEW_FLOAT_EXT`])
+    #
+    # [`NEW_FLOAT_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#NEW_FLOAT_EXT
+    #
     class NewFloat
       include Term
 

data/lib/erlang/etf/new_fun.rb

@@ -7,36 +7,58 @@ module Erlang
     # 112 | Size | Arity | Uniq | Index | NumFree | Module | Oldindex | OldUniq | Pid | Free Vars
     #
     # This is the new encoding of internal funs:
-    #   fun F/A and fun(Arg1,..) -> ... end.
-    #
-    # Size
-    #   is the total number of bytes, including the Size field.
-    # Arity
-    #   is the arity of the function implementing the fun.
-    # Uniq
-    #   is the 16 bytes MD5 of the significant parts of the Beam file.
-    # Index
-    #   is an index number. Each fun within a module has an unique
-    #   index. Index is stored in big-endian byte order.
-    # NumFree
-    #   is the number of free variables.
-    # Module
-    #   is an encoded as an atom, using ATOM_EXT, SMALL_ATOM_EXT or
-    #   ATOM_CACHE_REF. This is the module that the fun is implemented
+    #
+    # ```erlang
+    # fun F/A and fun(Arg1,..) -> ... end.
+    # ```
+    #
+    # `Size`
+    # > is the total number of bytes, including the `Size` field.
+    #
+    # `Arity`
+    # > is the arity of the function implementing the fun.
+    #
+    # `Uniq`
+    # > is the 16 bytes MD5 of the significant parts of the Beam file.
+    #
+    # `Index`
+    # > is an index number. Each fun within a module has an unique
+    #   index. `Index` is stored in big-endian byte order.
+    #
+    # `NumFree`
+    # > is the number of free variables.
+    #
+    # `Module`
+    # > is an encoded as an atom, using [`ATOM_EXT`], [`SMALL_ATOM_EXT`] or
+    #   [`ATOM_CACHE_REF`]. This is the module that the fun is implemented
     #   in.
-    # OldIndex
-    #   is an integer encoded using SMALL_INTEGER_EXT or INTEGER_EXT.
+    #
+    # `OldIndex`
+    # > is an integer encoded using [`SMALL_INTEGER_EXT`] or [`INTEGER_EXT`].
     #   It is typically a small index into the module's fun table.
-    # OldUniq
-    #   is an integer encoded using SMALL_INTEGER_EXT or INTEGER_EXT.
-    #   Uniq is the hash value of the parse tree for the fun.
-    # Pid
-    #   is a process identifier as in PID_EXT. It represents the
+    #
+    # `OldUniq`
+    # > is an integer encoded using [`SMALL_INTEGER_EXT`] or [`INTEGER_EXT`].
+    #   `Uniq` is the hash value of the parse tree for the fun.
+    #
+    # `Pid`
+    # > is a process identifier as in [`PID_EXT`]. It represents the
     #   process in which the fun was created.
-    # Free vars
-    #   is NumFree number of terms, each one encoded according to its
+    #
+    # `Free vars`
+    # > is `NumFree` number of terms, each one encoded according to its
     #   type.
     #
+    # (see [`NEW_FUN_EXT`])
+    #
+    # [`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
+    # [`SMALL_INTEGER_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#SMALL_INTEGER_EXT
+    # [`INTEGER_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#INTEGER_EXT
+    # [`PID_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#PID_EXT
+    # [`NEW_FUN_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#NEW_FUN_EXT
+    #
     class NewFun
       include Term
 

data/lib/erlang/etf/new_reference.rb

@@ -6,22 +6,27 @@ module Erlang
     # --- | --- | ---- | -------- | ------
     # 114 | Len | Node | Creation | ID ...
     #
-    # Node and Creation are as in REFERENCE_EXT.
+    # `Node` and `Creation` are as in [`REFERENCE_EXT`].
     #
-    # ID contains a sequence of big-endian unsigned integers (4 bytes
-    # each, so N' is a multiple of 4), but should be regarded as
+    # `ID` contains a sequence of big-endian unsigned integers (4 bytes
+    # each, so `N'` is a multiple of 4), but should be regarded as
     # uninterpreted data.
     #
-    # N' = 4 * Len.
+    # `N' = 4 * Len.`
     #
-    # In the first word (four bytes) of ID, only 18 bits are
-    # significant, the rest should be 0. In Creation, only 2 bits are
+    # In the first word (four bytes) of `ID`, only 18 bits are
+    # significant, the rest should be 0. In `Creation`, only 2 bits are
     # significant, the rest should be 0.
     #
-    # NEW_REFERENCE_EXT was introduced with distribution version 4. In
-    # version 4, N' should be at most 12.
+    # [`NEW_REFERENCE_EXT`] was introduced with distribution version 4. In
+    # version 4, `N'` should be at most 12.
     #
-    # See REFERENCE_EXT).
+    # See [`REFERENCE_EXT`]).
+    #
+    # (see [`NEW_REFERENCE_EXT`])
+    #
+    # [`REFERENCE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#REFERENCE_EXT
+    # [`NEW_REFERENCE_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#NEW_REFERENCE_EXT
     #
     class NewReference
       include Term