erlang-terms 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd479ee089887c3af964c5fc23c5ef4d1bec8072
-  data.tar.gz: 05cea00a4d7663b1ab9e80114fa8404acd891471
+  metadata.gz: 3601d91c1507e3949f9c60b571091b9a959419d0
+  data.tar.gz: 39d79df7d50eb719fe6dabb77640a14041135811
 SHA512:
-  metadata.gz: 5b2e3165e979b23f2fcf83e1018c3ddc306967a0f5634146a1476ee94e0ba2af9854b1c5778aa09dccd3c0ec369281dd0034374c48493dfe31d32adcfd92403e
-  data.tar.gz: ca3941286ddadff6b183a027f81690cad2c041d07d4e760f08ffa1cc3eeb1b2b6e018a153c5ec439fca653f37ca2807ddc17aa0715a89842d4a74b96fea94934
+  metadata.gz: 3c3a3073708fc654cd4fe651e56baf379ff2a2f49726e5f648b891dfd16c8f18c0ae61500384212bcb8cd8a8ff76ad4c0fbf36eafc3753583340d0dedbe9254f
+  data.tar.gz: 4eaf82c1a4ec55cf0b73f37d2ac9dc15e2371235276630f41f1590bf3e2e7cf9bb31078180e84bb08e7efa617abddfbf29a07608a4c4206ebc7dcd046fd85579

data/README.md

@@ -1,24 +1,119 @@
 # Erlang::Terms
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/potatosalad/erlang-terms.png)](https://travis-ci.org/potatosalad/erlang-terms)
+
+Includes simple classes that represent Erlang's export, list, pid, string, and tuple.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'erlang-terms'
+```ruby
+gem 'erlang-terms', require: 'erlang/terms'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install erlang-terms
+```bash
+$ gem install erlang-terms
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+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.
+
+### Erlang::Export
+
+```erlang
+Module   = erlang,
+Function = now,
+Arity    = 0,
+Export   = fun Module:Function/Arity.
+```
+
+```ruby
+export = Erlang::Export.new(:erlang, :now, 0)
+# => #<Erlang::Export fun erlang:now/0>
+```
+
+### Erlang::List
+
+##### Improper List
+
+```erlang
+List = [a | b].
+```
+
+```ruby
+list = Erlang::List[:a].tail(:b)
+# => #<Erlang::List [:a | :b]">
+list.improper?
+# => true
+```
+
+##### Proper List
+
+```erlang
+List = [a, b].
+```
+
+```ruby
+list = Erlang::List[:a, :b]
+# => #<Erlang::List [:a, :b | []]">
+list.improper?
+# => false
+```
+
+### Erlang::Pid
+
+```erlang
+Pid = self().
+
+%% or
+
+Id     = 100,
+Serial = 5,
+Pid    = pid(0, Id, Serial).
+
+%% or
+
+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>
+```
+
+### Erlang::String
+
+```erlang
+String = "test".
+```
+
+```ruby
+string = Erlang::String.new("test")
+# => #<Erlang::String "test">
+```
+
+### Erlang::Tuple
+
+```erlang
+Tuple = {atom, 1}.
+```
+
+```ruby
+tuple = Erlang::Tuple[:atom, 1]
+# => #<Erlang::Tuple {:atom, 1}>
+```
 
 ## Contributing
 

data/lib/erlang/list.rb

@@ -6,8 +6,13 @@ module Erlang
       tail != []
     end
 
-    def tail
-      @tail ||= []
+    def tail(value = nil)
+      if value
+        self.tail = value
+        self
+      else
+        @tail ||= []
+      end
     end
 
     def inspect

data/lib/erlang/terms/version.rb

@@ -1,5 +1,5 @@
 module Erlang
   module Terms
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/erlang/list_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Erlang::List do
   describe '#inspect' do
     context 'improper list' do
-      subject { Erlang::List[:a].tap { |list| list.tail = :b } }
+      subject { Erlang::List[:a].tail(:b) }
 
       it { should be_improper }
       it 'formats as #<Erlang::List [:a | :b]>' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erlang-terms
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Bennett