erlang-etf 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 195a05d3181de002ad6dff10e6994d94f722e8b2
-  data.tar.gz: 18a71520747f118760e31724f9dc135ebdc38dde
+  metadata.gz: 0df02c49c6d963c92a155665d854c29c64d4d506
+  data.tar.gz: 1f4365a62a0b2ee16b87fa688cba57ee0b4a89f9
 SHA512:
-  metadata.gz: c97cd0e64ceaf45946b042117c7cab7cb4654dcb325df611e4f35fdc323970b13b42317901d074ae1daaafff8901959332446e4737e53d37cdd5d874fafe0c5f
-  data.tar.gz: 2723c6b9376a9e1b235a5e195f30329f777f53b0c841f19bd4ebb44d975d2190d91b6fe2ab61be68711819c8fc5b8fbfe8c1ad83ad703d17fb000b1635d10972
+  metadata.gz: 40c84fcbf9312de7a5d9e0e057651743764fe6172e72c8c7e66a80fd4fd693b826235b83f010410f0ff086295f81186f3f4b9630b23276a432b6ad0a26af018b
+  data.tar.gz: f167a812a0f03ab72ea546cf3cf47947a9192e921de500439130932c11a33283fdad27f3a3d3b9e195c5b4b560d9a3b4f773d4b523598e421259d9ffdfba1b0a

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+--main README.md
+--markup markdown

data/Gemfile

@@ -1,4 +1,14 @@
 source 'https://rubygems.org'
 
+platforms :ruby do
+  group :development do
+    gem "pry"
+    gem "pry-doc"
+    gem "redcarpet"
+    gem "simplecov", require: false
+    gem "yard"
+  end
+end
+
 # Specify your gem's dependencies in erlang-etf.gemspec
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-# Erlang::Etf
+# Erlang::ETF
 
 [![Build Status](https://travis-ci.org/potatosalad/erlang-etf.png)](https://travis-ci.org/potatosalad/erlang-etf)
 
@@ -26,14 +26,14 @@ $ gem install erlang-etf
 
 ## Usage
 
-### Erlang.term_to_binary(term)
+### `Erlang.term_to_binary(term)`
 
 ```ruby
 Erlang.term_to_binary(:atom)
 # => "\x83s\x04atom"
 ```
 
-### Erlang.binary_to_term(binary)
+### `Erlang.binary_to_term(binary)`
 
 ```ruby
 Erlang.binary_to_term("\x83s\x04atom")

data/Rakefile

@@ -1,5 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "yard"
+
+YARD::Rake::YardocTask.new(:doc)
 
 RSpec::Core::RakeTask.new(:spec)
 

data/erlang-etf.gemspec

@@ -22,9 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "erlang-terms"
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-doc"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "simplecov"
 end

data/lib/erlang/etf/atom.rb

@@ -7,10 +7,14 @@ module Erlang
     # 100 | Len | AtomName
     #
     # An atom is stored with a 2 byte unsigned length in big-endian
-    # order, followed by Len numbers of 8 bit Latin1 characters that
-    # forms the AtomName.
+    # order, followed by `Len` numbers of 8 bit Latin1 characters that
+    # forms the `AtomName`.
     #
-    # Note: The maximum allowed value for Len is 255.
+    # **Note:** The maximum allowed value for `Len` is 255.
+    #
+    # (see [`ATOM_EXT`])
+    #
+    # [`ATOM_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#ATOM_EXT
     #
     class Atom
       include Term
@@ -22,22 +26,43 @@ module Erlang
       end
 
       undef deserialize_atom_name
+      # @private
       def deserialize_atom_name(buffer)
         self.atom_name = buffer.read(len).from_utf8_binary
       end
 
       undef serialize_atom_name
+      # @private
       def serialize_atom_name(buffer)
         buffer << atom_name.to_utf8_binary
       end
 
       finalize
 
+      # Instantiate the new atom.
+      #
+      # @example Instantiate the atom.
+      #   Erlang::ETF::Atom.new("test")
+      #   # => #<Erlang::ETF::Atom @tag=100 @len=4 @atom_name="test">
+      #
+      # @param [ ::String ] atom_name The `AtomName` as a string.
+      #
+      # @since 1.0.0
       def initialize(atom_name)
         @atom_name = atom_name
         @len = atom_name.to_s.bytesize
       end
 
+      # Evolve to native ruby.
+      #
+      # @example Evolve to native ruby.
+      #   atom = Erlang::ETF::Atom.new("test")
+      #   atom.__ruby_evolve__
+      #   # => :test
+      #
+      # @return [ ::Symbol ] The `AtomName` as a symbol.
+      #
+      # @since 1.0.0
       def __ruby_evolve__
         atom_name.intern
       end

data/lib/erlang/etf/atom_utf8.rb

@@ -7,8 +7,12 @@ module Erlang
     # 118 | Len | AtomName
     #
     # An atom is stored with a 2 byte unsigned length in big-endian
-    # order, followed by Len bytes containing the AtomName encoded in
-    # UTF-8.
+    # order, followed by `Len` bytes containing the `AtomName` encoded
+    # in UTF-8.
+    #
+    # (see [`ATOM_UTF8_EXT`])
+    #
+    # [`ATOM_UTF8_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#ATOM_UTF8_EXT
     #
     class AtomUTF8
       include Term
@@ -20,22 +24,43 @@ module Erlang
       end
 
       undef deserialize_atom_name
+      # @private
       def deserialize_atom_name(buffer)
         self.atom_name = buffer.read(len).from_utf8_binary
       end
 
       undef serialize_atom_name
+      # @private
       def serialize_atom_name(buffer)
         buffer << atom_name.to_utf8_binary
       end
 
       finalize
 
+      # Instantiate the new UTF-8 atom.
+      #
+      # @example Instantiate the UTF-8 atom.
+      #   Erlang::ETF::AtomUTF8.new("Ωmega")
+      #   # => #<Erlang::ETF::AtomUTF8 @tag=118 @len=5 @atom_name="Ωmega">
+      #
+      # @param [ ::String ] atom_name The `AtomName` as a string.
+      #
+      # @since 1.0.0
       def initialize(atom_name)
         @atom_name = atom_name
         @len = atom_name.to_s.bytesize
       end
 
+      # Evolve to native ruby.
+      #
+      # @example Evolve to native ruby.
+      #   atom_utf8 = Erlang::ETF::AtomUTF8.new("Ωmega")
+      #   atom_utf8.__ruby_evolve__
+      #   # => :'Ωmega'
+      #
+      # @return [ ::Symbol ] The `AtomName` as a symbol.
+      #
+      # @since 1.0.0
       def __ruby_evolve__
         atom_name.intern
       end

data/lib/erlang/etf/binary.rb

@@ -7,9 +7,16 @@ module Erlang
     # 109 | Len | Data
     #
     # Binaries are generated with bit syntax expression or with
-    # list_to_binary/1, term_to_binary/1, or as input from binary
-    # ports.
-    # The Len length field is an unsigned 4 byte integer (big endian).
+    # [`list_to_binary/1`], [`term_to_binary/1`], or as input from
+    # binary ports.
+    #
+    # The `Len` length field is an unsigned 4 byte integer (big endian).
+    #
+    # (see [`BINARY_EXT`])
+    #
+    # [`list_to_binary/1`]: http://erlang.org/doc/man/erlang.html#list_to_binary-1
+    # [`term_to_binary/1`]: http://erlang.org/doc/man/erlang.html#term_to_binary-1
+    # [`BINARY_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#BINARY_EXT
     #
     class Binary
       include Term

data/lib/erlang/etf/bit_binary.rb

@@ -2,17 +2,21 @@ module Erlang
   module ETF
 
     #
-    # 1  | 4   | 1    | Len
-    # -- | --- | ---- | ----
-    # 77 | Len | Bits | Data
+    # 1   | 4   | 1    | Len
+    # --- | --- | ---- | ----
+    # 77  | Len | Bits | Data
     #
     # This term represents a bitstring whose length in bits is not a
     # multiple of 8 (created using the bit syntax in R12B and later).
-    # The Len field is an unsigned 4 byte integer (big endian).
-    # The Bits field is the number of bits that are used in the last
+    # The `Len` field is an unsigned 4 byte integer (big endian).
+    # The `Bits` field is the number of bits that are used in the last
     # byte in the data field, counting from the most significant bit
     # towards the least significant.
     #
+    # (see [`BIT_BINARY_EXT`])
+    #
+    # [`BIT_BINARY_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#BIT_BINARY_EXT
+    #
     class BitBinary
       include Term
 

data/lib/erlang/etf/export.rb

@@ -6,12 +6,20 @@ module Erlang
     # --- | ------ | -------- | -----
     # 113 | Module | Function | Arity
     #
-    # This term is the encoding for external funs: fun M:F/A.
+    # This term is the encoding for external funs: `fun M:F/A`.
     #
-    # Module and Function are atoms (encoded using ATOM_EXT,
-    # SMALL_ATOM_EXT or ATOM_CACHE_REF).
+    # `Module` and `Function` are atoms (encoded using [`ATOM_EXT`],
+    # [`SMALL_ATOM_EXT`] or [`ATOM_CACHE_REF`]).
     #
-    # Arity is an integer encoded using SMALL_INTEGER_EXT.
+    # `Arity` is an integer encoded using [`SMALL_INTEGER_EXT`].
+    #
+    # (see [`EXPORT_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
+    # [`EXPORT_EXT`]: http://erlang.org/doc/apps/erts/erl_ext_dist.html#EXPORT_EXT
     #
     class Export
       include Term

data/lib/erlang/etf/extensions.rb

@@ -6,7 +6,6 @@ module Erlang
 
       # @private
       class ::Object
-        extend  Erlang::ETF::Extensions::Object::ClassMethods
         include Erlang::ETF::Extensions::Object
       end
     end
@@ -26,37 +25,31 @@ module Erlang
 
       # @private
       class ::Erlang::Export
-        extend  Erlang::ETF::Extensions::ErlangExport::ClassMethods
         include Erlang::ETF::Extensions::ErlangExport
       end
 
       # @private
       class ::Erlang::List
-        extend  Erlang::ETF::Extensions::ErlangList::ClassMethods
         include Erlang::ETF::Extensions::ErlangList
       end
 
       # @private
       class ::Erlang::Nil
-        extend  Erlang::ETF::Extensions::ErlangNil::ClassMethods
         include Erlang::ETF::Extensions::ErlangNil
       end
 
       # @private
       class ::Erlang::Pid
-        extend  Erlang::ETF::Extensions::ErlangPid::ClassMethods
         include Erlang::ETF::Extensions::ErlangPid
       end
 
       # @private
       class ::Erlang::String
-        extend  Erlang::ETF::Extensions::ErlangString::ClassMethods
         include Erlang::ETF::Extensions::ErlangString
       end
 
       # @private
       class ::Erlang::Tuple
-        extend  Erlang::ETF::Extensions::ErlangTuple::ClassMethods
         include Erlang::ETF::Extensions::ErlangTuple
       end
     end
@@ -82,73 +75,61 @@ module Erlang
 
       # @private
       class ::Array
-        extend  Erlang::ETF::Extensions::Array::ClassMethods
         include Erlang::ETF::Extensions::Array
       end
 
       # @private
       class ::BigDecimal
-        extend  Erlang::ETF::Extensions::BigDecimal::ClassMethods
         include Erlang::ETF::Extensions::BigDecimal
       end
 
       # @private
       class ::FalseClass
-        extend  Erlang::ETF::Extensions::FalseClass::ClassMethods
         include Erlang::ETF::Extensions::FalseClass
       end
 
       # @private
       class ::Float
-        extend  Erlang::ETF::Extensions::Float::ClassMethods
         include Erlang::ETF::Extensions::Float
       end
 
       # @private
       class ::Hash
-        extend  Erlang::ETF::Extensions::Hash::ClassMethods
         include Erlang::ETF::Extensions::Hash
       end
 
       # @private
       class ::Integer
-        extend  Erlang::ETF::Extensions::Integer::ClassMethods
         include Erlang::ETF::Extensions::Integer
       end
 
       # @private
       class ::NilClass
-        extend  Erlang::ETF::Extensions::NilClass::ClassMethods
         include Erlang::ETF::Extensions::NilClass
       end
 
       # @private
       class ::Regexp
-        extend  Erlang::ETF::Extensions::Regexp::ClassMethods
         include Erlang::ETF::Extensions::Regexp
       end
 
       # @private
       class ::String
-        extend  Erlang::ETF::Extensions::String::ClassMethods
         include Erlang::ETF::Extensions::String
       end
 
       # @private
       class ::Symbol
-        extend  Erlang::ETF::Extensions::Symbol::ClassMethods
         include Erlang::ETF::Extensions::Symbol
       end
 
       # @private
       class ::Time
-        extend  Erlang::ETF::Extensions::Time::ClassMethods
         include Erlang::ETF::Extensions::Time
       end
 
       # @private
       class ::TrueClass
-        extend  Erlang::ETF::Extensions::TrueClass::ClassMethods
         include Erlang::ETF::Extensions::TrueClass
       end
 

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

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

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

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

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

@@ -18,8 +18,6 @@ module Erlang
           )
         end
 
-        module ClassMethods
-        end
       end
     end
   end

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

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

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

@@ -14,8 +14,6 @@ module Erlang
           ETF::Nil.new
         end
 
-        module ClassMethods
-        end
       end
     end
   end

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

@@ -14,8 +14,6 @@ module Erlang
           ETF::Pid.new(node.to_s.intern.__erlang_evolve__, id, serial, creation)
         end
 
-        module ClassMethods
-        end
       end
     end
   end