erlectricity 0.2.1 → 1.0.0

data/examples/gruff/{gruff_run.erl → gruff_run.sh}

@@ -1,5 +1,7 @@
 #!/usr/bin/env escript
+
 -export([main/1]).
+
 main(_Any) ->
   Data = [
     {apples, [10, 2, 3, 4, 4, 3]},
@@ -9,9 +11,9 @@ main(_Any) ->
   ],
   gruff:start(),
   Result = gruff:plot(
-    <<"My Charts">>, 
-    <<"/Users/scott/Library/Fonts/Arial">>, 
-    Data, 
+    <<"My Charts">>,
+    <<"/Users/scott/Library/Fonts/Arial">>,
+    Data,
     [{0, <<"2003">>}, {2, <<"2004">>}, {4, <<"2005">>}]
   ),
   file:write_file("out.png", Result).

data/examples/gruff/{stat_run.erl → stat_run.sh}

@@ -1,13 +1,15 @@
 #!/usr/bin/env escript
+
 -export([main/1]).
+
 main(_Any) ->
   gruff:start(),
   MemoryWriter = stat_writer:start(<<"Memory Info">>, fun() -> erlang:memory() end),
-  ProcessWriter = stat_writer:start(<<"Process Info">>, 
-    fun() -> 
+  ProcessWriter = stat_writer:start(<<"Process Info">>,
+    fun() ->
       {_, QueueLength} = erlang:process_info(erlang:whereis(gruff), message_queue_len),
       [{processes, erlang:system_info(process_count)},
-       {gruff_queue_length, QueueLength}] 
+       {gruff_queue_length, QueueLength}]
     end
   ),
   receive

data/examples/gruff/stat_writer.erl

@@ -3,8 +3,8 @@
 
 start(Title, Fun) ->
   spawn(?MODULE, loop, [Title, Fun, []]).
-  
-loop(Title, Fun, []) -> 
+
+loop(Title, Fun, []) ->
   Data = accumulate([], Fun()),
   loop(Title, Fun, Data, 0).
 
@@ -12,12 +12,12 @@ loop(Title, Fun, Data, Generation) ->
   receive
     {stop} -> ok
   after 3000 ->
-    NewGeneration = Generation + 1,    
+    NewGeneration = Generation + 1,
     NewData = accumulate(Data, Fun()),
     NewChart = gruff:plot(
-       list_to_binary([Title, << "- Generation" >>, integer_to_list(NewGeneration)]), 
-      <<"/Users/scott/Library/Fonts/Arial">>,   
-      NewData, 
+       list_to_binary([Title, << "- Generation" >>, integer_to_list(NewGeneration)]),
+      <<"/Users/scott/Library/Fonts/Arial">>,
+      NewData,
       []
     ),
     file:write_file(io_lib:format("~s - ~s.png", [Title, integer_to_list(NewGeneration)]),NewChart),

data/examples/simple/README.md

@@ -0,0 +1,5 @@
+This example demonstrates how Erlang and Ruby data types get converted when
+crossing from one to the other.
+
+    $ cd examples/simple
+    $ ./rerl.sh

data/examples/simple/rerl.rb

@@ -0,0 +1,111 @@
+#
+#  rerl.rb, for use with erlang's open_port
+#  spawn using rerl.sh escript:
+#
+#    $ ./rerl.sh
+#    ./rerl.sh:35: Warning: variable 'Port' is unused
+#    [erlang] ruby is alive
+#    [erlang]  sending: test
+#    [erlang]  sending: {atom,symbol}
+#    [erlang]  sending: {number,1}
+#    [erlang]  sending: {string,<<"reverse">>}
+#    [erlang]  sending: {array,[1,2,3]}
+#    [erlang]  sending: {array,[<<"abc">>,<<"cde">>]}
+#    [erlang]  sending: {hash,[{key,val}]}
+#    [erlang]  sending: {object,{1,{2},3,<<"four">>}}
+#    [ ruby ] received: test, nil
+#    [ ruby ]  sending: test, nil
+#    [erlang] received: test
+#    [ ruby ] received: atom, :symbol
+#    [ ruby ]  sending: atom, :lobmys
+#    [erlang] received: {atom,lobmys}
+#    [ ruby ] received: number, 1
+#    [ ruby ]  sending: number, 2
+#    [ ruby ] received: string, "reverse"
+#    [erlang] received: {number,2}
+#    [ ruby ]  sending: string, "esrever"
+#    [ ruby ] received: array, [1, 2, 3]
+#    [erlang] received: {string,<<"esrever">>}
+#    [ ruby ]  sending: array, [3, 2, 1]
+#    [ ruby ] received: array, ["abc", "cde"]
+#    [erlang] received: {array,{3,2,1}}
+#    [ ruby ]  sending: array, ["cde", "abc"]
+#    [ ruby ] received: hash, {:key=>:val}
+#    [erlang] received: {array,{<<"cde">>,<<"abc">>}}
+#    [ ruby ]  sending: hash, {:key=>:val, :ruby=>:true}
+#    [ ruby ] received: object, [1, [2], 3, "four"]
+#    [erlang] received: {hash,{{key,val},{ruby,true}}}
+#    [ ruby ]  sending: object, [1, [2], 3, "four"]
+#    [erlang] received: {object,{1,{2},3,<<"four">>}}
+#
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[../../lib])
+
+require 'rubygems'
+require 'erlectricity'
+
+def log arg
+  puts arg
+  # @f ||= File.open('/tmp/rerl.log', 'w')
+  # @f.puts arg
+  # @f.flush
+end
+
+def debug meth, got = nil, send = nil
+  log "[ ruby ] received: #{meth}, #{got.inspect}"
+  log "[ ruby ]  sending: #{meth}, #{send.inspect}"
+end
+
+receive do |f|
+  f.when(:test) do
+    debug(:test)
+    f.send!(:test)
+    f.receive_loop
+  end
+
+  f.when([:atom, Symbol]) do |sym|
+    debug(:atom, sym, sym.to_s.reverse.to_sym)
+    f.send!([:atom, sym.to_s.reverse.to_sym])
+    f.receive_loop
+  end
+
+  f.when([:bool, Erl.boolean]) do |bool|
+    debug(:bool, bool, !bool)
+    f.send!([:bool, !bool])
+    f.receive_loop
+  end
+
+  f.when([:number, Fixnum]) do |num|
+    debug(:number, num, num*2)
+    f.send!([:number, num*2])
+    f.receive_loop
+  end
+
+  f.when([:string, String]) do |str|
+    debug(:string, str, str.reverse)
+    f.send!([:string, str.reverse])
+    f.receive_loop
+  end
+
+  f.when([:array, Array]) do |arr|
+    debug(:array, arr, arr.reverse)
+    f.send!([:array, arr.reverse])
+    f.receive_loop
+  end
+
+  f.when([:hash, Erl.hash]) do |hash|
+    newhash = hash.dup
+    newhash[:ruby] = :true
+    debug(:hash, hash, newhash)
+    f.send!([:hash, newhash.to_a])
+    f.receive_loop
+  end
+
+  f.when([:object, Any]) do |obj|
+    debug(:object, obj, obj)
+    f.send!([:object, obj])
+    f.receive_loop
+  end
+  
+  f.send!(:i_am_alive)
+end

data/examples/simple/rerl.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env escript
+main(_) ->
+  Cmd = "ruby rerl.rb",
+  Port = open_port({spawn, Cmd}, [{packet, 4}, nouse_stdio, exit_status, binary]),
+  loop(Port).
+
+send(Port, Message) ->
+  io:format("[erlang]  sending: ~p~n", [Message]),
+  % can also use ! instead of port_command
+  % Port ! { self(), { command, term_to_binary(Message) } }.
+  port_command(Port, term_to_binary(Message)).
+
+loop(Port) ->
+  receive
+    {Port, {data, In}} ->
+      Data = binary_to_term(In),
+      process(Port, Data);
+    Any ->
+      io:format("[erlang]    other: ~p~n", [Any])
+  end,
+  loop(Port).
+
+process(Port, i_am_alive) ->
+  io:format("[erlang] ruby is alive~n"),
+
+  send(Port, test),
+  send(Port, {atom, symbol}),
+  send(Port, {bool, true}),
+  send(Port, {number, 1}),
+  send(Port, {string, <<"reverse">>}),
+  send(Port, {array, [1,2,3]}),
+  send(Port, {array, [<<"abc">>, <<"cde">>]}),
+  send(Port, {hash, [{key,val}]}),
+  send(Port, {object, {1,{2},3,<<"four">>}});
+
+process(Port, Data) ->
+  io:format("[erlang] received: ~p~n", [Data]).

data/examples/tinderl/README.md

@@ -0,0 +1,14 @@
+This is a more advanced example of Erlectricity that shows how you can
+integrate with Campfire via the Ruby "tinder" gem.
+
+    $ cd examples/tinderl
+    $ erl
+    Erlang (BEAM) emulator version 5.6.4 [source] [smp:2] [async-threads:0] [kernel-poll:false]
+
+    Eshell V5.6.4  (abort with ^G)
+    1> c(tinderl).
+    {ok,tinderl}
+    2> tinderl:start("example.campfireapp.com", "tom@example.com", "secret", "My Room").
+    <0.38.0>
+    5> tinderl:speak("Hello, World!").
+    {speak,<0.31.0>,<<"Hello, World!">>}

data/examples/tinderl/tinderl.erl

@@ -1,17 +1,16 @@
 -module(tinderl).
 -export([start/4, stop/0, speak/1, paste/1]).
 
-start(Domain, Email, Password, Room) -> 
-  spawn(fun() -> 
-    register(tinderl, self()), 
-    process_flag(trap_exit, true), 
+start(Domain, Email, Password, Room) ->
+  spawn(fun() ->
+    register(tinderl, self()),
+    process_flag(trap_exit, true),
     Cmd = lists:flatten(io_lib:format("ruby ./tinderl.rb ~s ~s ~s ~s", [Domain, Email, Password, Room])),
-    Port = open_port({spawn, Cmd}, [{packet, 4}, use_stdio, exit_status, binary]), 
-    port_loop(Port) 
-  end). 
-
-stop() -> tinderl ! stop. 
+    Port = open_port({spawn, Cmd}, [{packet, 4}, nouse_stdio, exit_status, binary]),
+    port_loop(Port)
+  end).
 
+stop() -> tinderl ! stop.
 
 speak(String) when is_list(String) -> speak(list_to_binary(String));
 speak(String) when is_binary(String) -> tinderl ! {speak, self(), String}.
@@ -23,23 +22,22 @@ port_loop(Port) ->
   receive
     {speak, _Caller, String} ->
       Data = term_to_binary({speak, String}),
-      Port ! {self(), {command, Data}}, 
+      Port ! {self(), {command, Data}},
 
       port_loop(Port);
-    
+
     {paste, _Caller, String} ->
         Data = term_to_binary({paste, String}),
-        Port ! {self(), {command, Data}}, 
+        Port ! {self(), {command, Data}},
 
         port_loop(Port);
-        
-    stop -> 
-      Port ! {self(), close}, 
-      receive 
-        {Port, closed} -> exit(normal) 
-      end; 
-    
+
+    stop ->
+      Port ! {self(), close},
+      receive
+        {Port, closed} -> exit(normal)
+      end;
+
     {'EXIT', Port, Reason} ->
       exit({port_terminated,Reason})
-  end.
-
+  end.

data/examples/tinderl/tinderl.rb

@@ -1,6 +1,7 @@
-$:.unshift(File.dirname(__FILE__) + "/../../lib/")
-require 'erlectricity'
+$:.unshift File.join(File.dirname(__FILE__), *%w[../../lib])
+
 require 'rubygems'
+require 'erlectricity'
 require 'tinder'
 
 domain, email, password, room_name = *ARGV
@@ -9,18 +10,18 @@ campfire.login email, password
 room = campfire.find_room_by_name room_name
 
 receive do |f|
-  f.when(:speak, Any) do |comment|
-    room.speak comment
+  f.when([:speak, Any]) do |comment|
+    room.speak(comment)
     f.receive_loop
-  end 
-  
-  f.when(:paste, Any) do |comment|
-    room.paste comment
+  end
+
+  f.when([:paste, Any]) do |comment|
+    room.paste(comment)
     f.receive_loop
   end
-  
+
   f.when(Any) do |obj|
-    STDERR.write obj.inspect
+    p obj
   end
 end
 

data/ext/decoder.c

@@ -25,7 +25,7 @@ static VALUE mErlectricity;
 static VALUE cDecoder;
 void Init_decoder();
 
-VALUE method_read_any_from(VALUE klass, VALUE rString);
+VALUE method_decode(VALUE klass, VALUE rString);
 
 VALUE read_any_raw(unsigned char **pData);
 
@@ -79,16 +79,16 @@ VALUE read_small_tuple(unsigned char **pData) {
   if(read_1(pData) != ERL_SMALL_TUPLE) {
     rb_raise(rb_eStandardError, "Invalid Type, not a small tuple");
   }
-  
+
   int arity = read_1(pData);
-  
+
   VALUE array = rb_ary_new2(arity);
-  
+
   int i;
   for(i = 0; i < arity; ++i) {
     rb_ary_store(array, i, read_any_raw(pData));
   }
-  
+
   return array;
 }
 
@@ -96,16 +96,16 @@ VALUE read_large_tuple(unsigned char **pData) {
   if(read_1(pData) != ERL_LARGE_TUPLE) {
     rb_raise(rb_eStandardError, "Invalid Type, not a large tuple");
   }
-  
+
   int arity = read_4(pData);
-  
+
   VALUE array = rb_ary_new2(arity);
-  
+
   int i;
   for(i = 0; i < arity; ++i) {
     rb_ary_store(array, i, read_any_raw(pData));
   }
-  
+
   return array;
 }
 
@@ -113,18 +113,18 @@ VALUE read_list(unsigned char **pData) {
   if(read_1(pData) != ERL_LIST) {
     rb_raise(rb_eStandardError, "Invalid Type, not an erlang list");
   }
-  
+
   int size = read_4(pData);
-  
+
   VALUE array = rb_ary_new2(size);
-  
+
   int i;
   for(i = 0; i < size; ++i) {
     rb_ary_store(array, i, read_any_raw(pData));
   }
-  
+
   read_1(pData);
-  
+
   return array;
 }
 
@@ -140,12 +140,12 @@ VALUE read_bin(unsigned char **pData) {
   if(read_1(pData) != ERL_BIN) {
     rb_raise(rb_eStandardError, "Invalid Type, not an erlang binary");
   }
-  
+
   int length = read_4(pData);
-  
+
   unsigned char buf[length + 1];
   read_string_raw(buf, pData, length);
-  
+
   return rb_str_new2((char *) buf);
 }
 
@@ -153,19 +153,19 @@ VALUE read_string(unsigned char **pData) {
   if(read_1(pData) != ERL_STRING) {
     rb_raise(rb_eStandardError, "Invalid Type, not an erlang string");
   }
-  
+
   int length = read_2(pData);
-  
+
   unsigned char buf[length + 1];
   read_string_raw(buf, pData, length);
-  
+
   VALUE array = rb_ary_new2(length);
-  
+
   int i = 0;
   for(i; i < length; ++i) {
     rb_ary_store(array, i, INT2NUM(*(buf + i)));
   }
-  
+
   return array;
 }
 
@@ -173,22 +173,29 @@ VALUE read_atom(unsigned char **pData) {
   if(read_1(pData) != ERL_ATOM) {
     rb_raise(rb_eStandardError, "Invalid Type, not an atom");
   }
-  
+
   int length = read_2(pData);
-  
+
   unsigned char buf[length + 1];
   read_string_raw(buf, pData, length);
-  
-  return ID2SYM(rb_intern((char *) buf));
+
+  // Erlang true and false are actually atoms
+  if(strncmp((char *) buf, "true", length) == 0) {
+    return Qtrue;
+  } else if(strncmp((char *) buf, "false", length) == 0) {
+    return Qfalse;
+  } else {
+    return ID2SYM(rb_intern((char *) buf));
+  }
 }
 
 VALUE read_small_int(unsigned char **pData) {
   if(read_1(pData) != ERL_SMALL_INT) {
     rb_raise(rb_eStandardError, "Invalid Type, not a small int");
   }
-  
+
   int value = read_1(pData);
-  
+
   return INT2FIX(value);
 }
 
@@ -196,15 +203,15 @@ VALUE read_int(unsigned char **pData) {
   if(read_1(pData) != ERL_INT) {
     rb_raise(rb_eStandardError, "Invalid Type, not an int");
   }
-  
+
   long long value = read_4(pData);
-  
+
   long long negative = ((value >> 31) & 0x1 == 1);
-  
+
   if(negative) {
     value = (value - ((long long) 1 << 32));
   }
-  
+
   return INT2FIX(value);
 }
 
@@ -212,27 +219,27 @@ VALUE read_small_bignum(unsigned char **pData) {
   if(read_1(pData) != ERL_SMALL_BIGNUM) {
     rb_raise(rb_eStandardError, "Invalid Type, not a small bignum");
   }
-  
+
   unsigned int size = read_1(pData);
   unsigned int sign = read_1(pData);
-  
+
   VALUE num = INT2NUM(0);
   VALUE tmp;
-  
+
   unsigned char buf[size + 1];
   read_string_raw(buf, pData, size);
-  
+
   int i;
   for(i = 0; i < size; ++i) {
     tmp = INT2FIX(*(buf + i));
     tmp = rb_funcall(tmp, rb_intern("<<"), 1, INT2NUM(i * 8));
     num = rb_funcall(num, rb_intern("+"), 1, tmp);
   }
-  
+
   if(sign) {
     num = rb_funcall(num, rb_intern("*"), 1, INT2NUM(-1));
   }
-  
+
   return num;
 }
 
@@ -240,28 +247,28 @@ VALUE read_large_bignum(unsigned char **pData) {
   if(read_1(pData) != ERL_LARGE_BIGNUM) {
     rb_raise(rb_eStandardError, "Invalid Type, not a small bignum");
   }
-  
+
   unsigned int size = read_4(pData);
   unsigned int sign = read_1(pData);
-  
+
   VALUE num = INT2NUM(0);
   VALUE tmp;
-  
+
   unsigned char buf[size + 1];
   read_string_raw(buf, pData, size);
-  
+
   int i;
   for(i = 0; i < size; ++i) {
     tmp = INT2FIX(*(buf + i));
     tmp = rb_funcall(tmp, rb_intern("<<"), 1, INT2NUM(i * 8));
-    
+
     num = rb_funcall(num, rb_intern("+"), 1, tmp);
   }
-  
+
   if(sign) {
     num = rb_funcall(num, rb_intern("*"), 1, INT2NUM(-1));
   }
-  
+
   return num;
 }
 
@@ -269,12 +276,12 @@ VALUE read_float(unsigned char **pData) {
   if(read_1(pData) != ERL_FLOAT) {
     rb_raise(rb_eStandardError, "Invalid Type, not a float");
   }
-  
+
   unsigned char buf[32];
   read_string_raw(buf, pData, 31);
-  
+
   VALUE rString = rb_str_new2((char *) buf);
-  
+
   return rb_funcall(rString, rb_intern("to_f"), 0);
 }
 
@@ -282,7 +289,7 @@ VALUE read_nil(unsigned char **pData) {
   if(read_1(pData) != ERL_NIL) {
     rb_raise(rb_eStandardError, "Invalid Type, not a nil list");
   }
-  
+
   return rb_ary_new2(0);
 }
 
@@ -292,12 +299,12 @@ VALUE read_pid(unsigned char **pData) {
   if(read_1(pData) != ERL_PID) {
     rb_raise(rb_eStandardError, "Invalid Type, not a pid");
   }
-  
+
   VALUE node = read_atom(pData);
   VALUE id = INT2NUM(read_4(pData));
   VALUE serial = INT2NUM(read_4(pData));
   VALUE creation = INT2FIX(read_1(pData));
-  
+
   VALUE pid_class = rb_const_get(mErlectricity, rb_intern("Pid"));
   return rb_funcall(pid_class, rb_intern("new"), 4, node, id, serial, creation);
 }
@@ -306,17 +313,17 @@ VALUE read_new_reference(unsigned char **pData) {
   if(read_1(pData) != ERL_NEW_REF) {
     rb_raise(rb_eStandardError, "Invalid Type, not a new-style reference");
   }
-  
+
   int size = read_2(pData);
   VALUE node = read_atom(pData);
   VALUE creation = INT2FIX(read_1(pData));
-  
+
   VALUE id = rb_ary_new2(size);
   int i;
   for(i = 0; i < size; ++i) {
     rb_ary_store(id, i, INT2NUM(read_4(pData)));
   }
-  
+
   VALUE newref_class = rb_const_get(mErlectricity, rb_intern("NewReference"));
   return rb_funcall(newref_class, rb_intern("new"), 3, node, creation, id);
 }
@@ -371,21 +378,21 @@ VALUE read_any_raw(unsigned char **pData) {
   return Qnil;
 }
 
-VALUE method_read_any_from(VALUE klass, VALUE rString) {
+VALUE method_decode(VALUE klass, VALUE rString) {
   unsigned char *data = (unsigned char *) StringValuePtr(rString);
-  
+
   unsigned char **pData = &data;
-  
+
   // check protocol version
   if(read_1(pData) != ERL_VERSION) {
     rb_raise(rb_eStandardError, "Bad Magic");
   }
-  
+
   return read_any_raw(pData);
 }
 
 void Init_decoder() {
   mErlectricity = rb_const_get(rb_cObject, rb_intern("Erlectricity"));
   cDecoder = rb_define_class_under(mErlectricity, "Decoder", rb_cObject);
-  rb_define_singleton_method(cDecoder, "read_any_from", method_read_any_from, 1);
-}
+  rb_define_singleton_method(cDecoder, "decode", method_decode, 1);
+}