erlang-terms 1.1.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ad4212bcd8edbea5fe3b917196d48759c4ad6bc
-  data.tar.gz: be6f85104ebcbce57e7cfb20434ab1290ae77ce2
+  metadata.gz: 330f0b2d72a95763b12eb4e0800ce000fe082ef2
+  data.tar.gz: '093515a52861b5b85f231c2820b92ff255e3e131'
 SHA512:
-  metadata.gz: 1367b7b5d0bd9d47b65540248f7189ba292d234dc1e6844729f7194e171e97589f45522444c0812e44033c1502b2a4aa3288ab97370e86cf31bb1b6a8c9b429d
-  data.tar.gz: 0e7cf956bd8531328fed8ce033fe4bb688700b17eb520d44f326b0659e80b58fb5ac62204dff8445595097d0aea26c66c4d2b7eea9de12dbbbf3c2414b30fcbc
+  metadata.gz: 9eb9eeb7f97cb07e0000d6c5c56af10bf32088750f5a526ada4836ea34f8deb447abf7c0a129dbabdddbb26f2e8eed3b00f96bba3d75dc907737f2e146fb84e5
+  data.tar.gz: 0ab40ae9809810f16d4bfcd2c352a6fa827cd95be3a75477b78f9f47c5d7433ed875631fdcf4d9d4193314aa1cae8f6fa4ae849c41a80fea15b9329eae5696fd

data/.coveralls.yml

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

data/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -1,18 +1,10 @@
-*.gem
-*.rbc
-.bundle
-.config
-.rvmrc
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.minitest-perf.db
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+erlang-terms

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -1,5 +1,17 @@
 language: ruby
+
+sudo: required
+dist: trusty
+
+env:
+  global:
+    - RUBYOPT="-W0"
+
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.4.1
+
+notifications:
+  email: false
+
+before_install:
+  - "gem install bundler -v 1.15.1"

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--main README.md
+--markup markdown
+-
+docs/*.md
+*.md

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 2.0.1 (2017-06-03)
+
+* Fixed missing requirement error.
+
+## 2.0.0 (2017-06-03)
+
+* Major rewrite.  Support for atom, binary, bitstring, export, float, function, list, map, nil, pid, port, reference, string, and tuple added.

data/Gemfile

@@ -1,4 +1,24 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in erlang-terms.gemspec
+platforms :ruby do
+  group :development do
+    gem 'pry'
+    gem 'pry-doc'
+    # gem 'redcarpet'
+    gem 'yard'
+  end
+end
+
+group :test do
+  gem 'minitest-focus', require: false
+  gem 'minitest-perf', require: false
+  gem 'minitest-reporters', require: false
+  gem 'rantly', require: false
+  gem 'simplecov', require: false
+  if ENV['CI']
+    gem 'coveralls', require: false
+  end
+end
+
+# Specify your gem's dependencies in jose.gemspec
 gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Andrew Bennett
+Copyright (c) 2013-2017 Andrew Bennett
 
 MIT License
 

data/README.md

@@ -1,15 +1,15 @@
 # Erlang::Terms
 
-[![Build Status](https://travis-ci.org/potatosalad/erlang-terms.png)](https://travis-ci.org/potatosalad/erlang-terms)
+[![Travis](https://img.shields.io/travis/potatosalad/ruby-erlang-terms.svg?maxAge=86400)](https://travis-ci.org/potatosalad/ruby-erlang-terms) [![Coverage Status](https://coveralls.io/repos/github/potatosalad/ruby-erlang-terms/badge.svg?branch=master)](https://coveralls.io/github/potatosalad/ruby-erlang-terms?branch=master) [![Gem](https://img.shields.io/gem/v/erlang-terms.svg?maxAge=86400)](https://rubygems.org/gems/erlang-terms) [![Docs](https://img.shields.io/badge/yard-docs-blue.svg?maxAge=86400)](http://www.rubydoc.info/gems/erlang-terms) [![Inline docs](http://inch-ci.org/github/potatosalad/ruby-erlang-terms.svg?branch=master&style=shields)](http://inch-ci.org/github/potatosalad/ruby-erlang-terms)
 
-Includes simple classes that represent Erlang's export, list, pid, string, tuple, and map.
+Includes simple immutable classes that represent Erlang's atom, binary, bitstring, compressed, export, function, list, map, nil, pid, port, reference, string, and tuple.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'erlang-terms', require: 'erlang/terms'
+gem 'erlang-terms', '~> 2.0'
 ```
 
 And then execute:
@@ -28,7 +28,52 @@ $ gem install erlang-terms
 
 The following classes show the [Erlang](http://www.erlang.org/) representation followed by the corresponding [Ruby](http://www.ruby-lang.org/) representation.
 
-See [erlang-etf](https://github.com/potatosalad/erlang-etf) for more information.
+See [erlang-etf](https://github.com/potatosalad/ruby-erlang-etf) for more information.
+
+### Erlang::Atom
+
+```erlang
+Atom     = 'test',
+AtomUTF8 = 'Ω'.
+```
+
+```ruby
+atom = Erlang::Atom[:test]
+# => :test
+atom_utf8 = Erlang::Atom[:Ω, utf8: true]
+# => Erlang::Atom["Ω", utf8: true]
+```
+
+### Erlang::Binary
+
+```erlang
+Binary0 = <<>>,
+Binary1 = <<"test">>,
+Binary2 = <<0,1,2>>.
+```
+
+```ruby
+binary0 = Erlang::Binary[]
+# => ""
+binary1 = Erlang::Binary["test"]
+# => "test"
+binary2 = Erlang::Binary[0,1,2]
+# => "\x00\x01\x02"
+```
+
+### Erlang::Bitstring
+
+```erlang
+Bitstring0 = <<1:7>>,
+Bitstring1 = <<"test",2:3>>.
+```
+
+```ruby
+bitstring0 = Erlang::Bitstring[1, bits: 7]
+# => Erlang::Bitstring[1, bits: 7]
+bitstring1 = Erlang::Bitstring["test", 2, bits: 3]
+# => Erlang::Bitstring[116, 101, 115, 116, 2, bits: 3]
+```
 
 ### Erlang::Export
 
@@ -40,8 +85,19 @@ Export   = fun Module:Function/Arity.
 ```
 
 ```ruby
-export = Erlang::Export.new(:erlang, :now, 0)
-# => #<Erlang::Export fun erlang:now/0>
+export = Erlang::Export[:erlang, :now, 0]
+# => Erlang::Export[:erlang, :now, 0]
+```
+
+### Erlang::Float
+
+```erlang
+Float = 1.0e12.
+```
+
+```ruby
+float = Erlang::Float[1.0e12]
+# => 1.00000000000000000000e+12
 ```
 
 ### Erlang::List
@@ -53,8 +109,8 @@ List = [a | b].
 ```
 
 ```ruby
-list = Erlang::List[:a].tail(:b)
-# => #<Erlang::List [:a | :b]">
+list = Erlang::List[:a] + :b
+# => Erlang::List[:a] + :b
 list.improper?
 # => true
 ```
@@ -67,7 +123,7 @@ List = [a, b].
 
 ```ruby
 list = Erlang::List[:a, :b]
-# => #<Erlang::List [:a, :b | []]">
+# => [:a, :b]
 list.improper?
 # => false
 ```
@@ -80,7 +136,7 @@ Map = #{atom => 1}.
 
 ```ruby
 map = Erlang::Map[:atom, 1]
-# => #<Erlang::Map #{:atom => 1}>
+# => {:atom => 1}
 ```
 
 ### Erlang::Nil
@@ -90,8 +146,8 @@ Nil = [].
 ```
 
 ```ruby
-erlang_nil = Erlang::Nil.new
-# => #<Erlang::Nil []>
+erlang_nil = Erlang::Nil
+# => []
 ```
 
 ### Erlang::Pid
@@ -111,8 +167,30 @@ Pid = list_to_pid("<0.100.5>").
 ```
 
 ```ruby
-pid = Erlang::Pid.new('node@host', 100, 5, 0)
-# => #<Erlang::Pid <0.100.5> @node="node@host" @creation=0>
+pid = Erlang::Pid[:"node@host", 100, 5, 0]
+# => Erlang::Pid[:"node@host", 100, 5, 0]
+```
+
+### Erlang::Port
+
+```erlang
+Port = hd(erlang:ports()).
+```
+
+```ruby
+port = Erlang::Port[:"nonode@nohost", 0, 0]
+# => Erlang::Port[:"nonode@nohost", 0, 0]
+```
+
+### Erlang::Reference
+
+```erlang
+Reference = erlang:make_ref().
+```
+
+```ruby
+reference = Erlang::Reference[:"nonode@nohost", 0, [168, 2, 0]]
+# => Erlang::Reference[:"nonode@nohost", 0, [168, 2, 0]]
 ```
 
 ### Erlang::String
@@ -122,8 +200,8 @@ String = "test".
 ```
 
 ```ruby
-string = Erlang::String.new("test")
-# => #<Erlang::String "test">
+string = Erlang::String["test"]
+# => Erlang::String["test"]
 ```
 
 ### Erlang::Tuple
@@ -134,7 +212,7 @@ Tuple = {atom, 1}.
 
 ```ruby
 tuple = Erlang::Tuple[:atom, 1]
-# => #<Erlang::Tuple {:atom, 1}>
+# => Erlang::Tuple[:atom, 1]
 ```
 
 ## Contributing

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "rake/testtask"
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
 
-task :default => [:spec]
+task :default => :test

data/erlang-terms.gemspec

@@ -7,20 +7,23 @@ Gem::Specification.new do |spec|
   spec.name          = "erlang-terms"
   spec.version       = Erlang::Terms::VERSION
   spec.authors       = ["Andrew Bennett"]
-  spec.email         = ["andrew@pagodabox.com"]
-  spec.description   = %q{Includes simple classes that represent Erlang's export, list, pid, string, and tuple.}
+  spec.email         = ["andrew@pixid.com"]
+
+  spec.description   = <<-EOF
+    Includes simple classes that represent Erlang's atom, binary, bitstring,
+    compressed, export, function, list, map, nil, pid, port, reference,
+    string, and tuple.
+  EOF
   spec.summary       = %q{Erlang terms represented in Ruby}
-  spec.homepage      = "https://github.com/potatosalad/erlang-terms"
+  spec.homepage      = "https://github.com/potatosalad/ruby-erlang-terms"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest"
 end

data/lib/erlang-terms.rb

@@ -0,0 +1 @@
+require 'erlang/terms'

data/lib/erlang/associable.rb

@@ -0,0 +1,98 @@
+module Erlang
+  # Including `Associable` in your container class gives it an `update_in`
+  # method.
+  #
+  # To mix in `Associable`, your class must implement two methods:
+  #
+  # * `fetch(index, default = (missing_default = true))`
+  # * `put(index, item = yield(get(index)))`
+  # * `get(key)`
+  #
+  # See {Tuple#fetch}, {Tuple#put}, {Map#fetch}, and {Map#put} for examples.
+  #
+  # Licensing
+  # =========
+  #
+  # Portions taken and modified from https://github.com/hamstergem/hamster
+  #
+  #     Copyright (c) 2009-2014 Simon Harris
+  #
+  #     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.
+  #
+  module Associable
+    # Return a new container with a deeply nested value modified to the result
+    # of the given code block.  When traversing the nested containers
+    # non-existing keys are created with empty `Hash` values.
+    #
+    # The code block receives the existing value of the deeply nested key/index
+    # (or `nil` if it doesn't exist). This is useful for "transforming" the
+    # value associated with a certain key/index.
+    #
+    # Naturally, the original container and sub-containers are left unmodified;
+    # new data structure copies are created along the path as needed.
+    #
+    # @example
+    #   t = Erlang::Tuple[123, 456, 789, Erlang::Map["a" => Erlang::Tuple[5, 6, 7]]]
+    #   t.update_in(3, "a", 1) { |value| value + 9 }
+    #   # => Erlang::Tuple[123, 456, 789, Erlang::Map["a'" => Erlang::Tuple[5, 15, 7]]]
+    #   map = Erlang::Map["a" => Erlang::Map["b" => Erlang::Map["c" => 42]]]
+    #   map.update_in("a", "b", "c") { |value| value + 5 }
+    #   # => Erlang::Map["a" => Erlang::Map["b" => Erlang::Map["c" => 47]]]
+    #
+    # @param key_path [Object(s)] List of keys/indexes which form the path to the key to be modified
+    # @yield [value] The previously stored value
+    # @yieldreturn [Object] The new value to store
+    # @return [Associable]
+    def update_in(*key_path, &block)
+      if key_path.empty?
+        raise ArgumentError, "must have at least one key in path"
+      end
+      key = key_path[0]
+      if key_path.size == 1
+        new_value = block.call(fetch(key, nil))
+      else
+        value = fetch(key, EmptyMap)
+        new_value = value.update_in(*key_path[1..-1], &block)
+      end
+      return put(key, new_value)
+    end
+
+    # Return the value of successively indexing into a collection.
+    # If any of the keys is not present in the collection, return `nil`.
+    # keys that the Erlang type doesn't understand, raises an argument error
+    #
+    # @example
+    #   m = Erlang::Map[:a => 9, :b => Erlang::Tuple['a', 'b'], :e => nil]
+    #   m.dig(:b, 0)    # => "a"
+    #   m.dig(:b, 5)    # => nil
+    #   m.dig(:b, 0, 0) # => nil
+    #   m.dig(:b, :a)   # ArgumentError
+    # @param key to fetch from the collection
+    # @return [Object]
+    def dig(key, *rest)
+      value = get(key)
+      if rest.empty? || value.nil?
+        return value
+      elsif value.respond_to?(:dig)
+        return value.dig(*rest)
+      end
+    end
+  end
+end