erlectricity-funbox 1.1.2

data/.gitignore

@@ -0,0 +1,24 @@
+pkg
+ext/Makefile
+ext/decoder.bundle
+ext/decoder.o
+*.beam
+*.dump
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/History.txt

@@ -0,0 +1,35 @@
+== 1.1.1 / 2009-10-28
+  * Bug Fixes
+    * Fix bignum encoding
+    * Prevent stack overflow for massive binaries in c decoder
+    * Optimize strings in c decoder
+
+== 1.1.0 / 2009-10-08
+  * Minor Improvements
+    * Implement Bignum encoding
+    * Fix tests on Erlang R13B
+
+== 1.0.2 / 2009-06-03
+  * Bug Fixes
+    * Fix decoding of atoms [github.com/bwbuchanan]
+    * Work around Ruby's reluctance to convert the empty string to
+      a symbol [github.com/bwbuchanan]
+
+== 1.0.1 / 2009-05-03
+  * Bug Fixes
+    * Fix premature null byte termination on binary decode
+
+== 1.0.0 / 2009-04-29
+  * Backward Incompatible Changes
+    * Implicit array call for f.when(:echo, String) must now be called as
+      f.when([:echo, String]) to eliminate ambiguity
+    * Implicit array call for f.send!(:ok, "foo") must now be called as
+      f.send!([:ok, "foo"]) to eliminate ambiguity
+    * The receive loop now defaults to using file descriptors 3 and 3
+      instead of STDIN and STDOUT. This prevents inadvertent output
+      statements from silently corrupting the transfer protocol.
+    * Erlang atoms 'true' and 'false' are now converted into Ruby booleans
+    * Erlectricity::Decoder.read_any_from -> Erlectricity::Decoder.decode
+  * Major Enhancements
+    * Calling `rake` now runs tests (with and without compiled C extensions)
+    * Package management is now done by Jeweler

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Scott Fleckenstein and Tom Preston-Werner
+
+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.

data/README.md

@@ -0,0 +1,130 @@
+Erlectricity
+============
+
+http://github.com/mojombo/erlectricity
+
+By Scott Fleckenstein, Tom Preston-Werner
+
+Development Status: Production/Stable
+
+
+Description
+-----------
+
+Erlectricity allows a Ruby program to receive and respond to Erlang messages
+sent over the Erlang binary protocol.
+
+
+Install
+-------
+
+$ gem install erlectricity
+
+-or-
+
+$ gem install mojombo-erlectricity -s http://gems.github.com
+
+
+The Simplest Example
+--------------------
+
+### Ruby side (echo.rb)
+
+    require 'rubygems'
+    require 'erlectricity'
+
+    receive do |f|
+      f.when([:echo, String]) do |text|
+        f.send!([:result, "You said: #{text}"])
+        f.receive_loop
+      end
+    end
+
+### Erlang side (echo.erl)
+
+    -module(echo).
+    -export([test/0]).
+
+    test() ->
+      Cmd = "ruby echo.rb",
+      Port = open_port({spawn, Cmd}, [{packet, 4}, nouse_stdio, exit_status, binary]),
+      Payload = term_to_binary({echo, <<"hello world!">>}),
+      port_command(Port, Payload),
+      receive
+        {Port, {data, Data}} ->
+          {result, Text} = binary_to_term(Data),
+          io:format("~p~n", [Text])
+      end.
+
+
+Data Type Conversions and Matching
+----------------------------------
+
+    % Port is the port opened via open_port({spawn, Cmd}, [{packet, 4}, ...])
+    % Message is the Erlang term to encode and send to the port
+    send(Port, Message) ->
+      port_command(Port, term_to_binary(Message)).
+
+    # Each triplet below represents:
+    # (line 1) the Erlang call
+    # (line 2) the Ruby matcher
+    # (line 3) the Ruby output
+
+    send(Port, test).
+    f.when(:test) { p :ok }
+    # :ok
+
+    send(Port, {atom, symbol}).
+    f.when([:atom, Symbol]) { |sym| p sym }
+    # :symbol
+
+    send(Port, {number, 1}).
+    f.when([:number, Fixnum]) { |num| p num }
+    # 1
+
+    send(Port, {string, <<"foo">>}).
+    f.when([:string, String]) { |str| p str }
+    # "foo"
+
+    send(Port, {array, [1,2,3]}).
+    f.when([:array, Array]) { |arr| p arr }
+    # [1, 2, 3]
+
+    send(Port, {array, [<<"abc">>, <<"def">>]}).
+    f.when([:array, Array]) { |arr| p arr }
+    # ["abc", "def"]
+
+    send(Port, {hash, [{key,val}]}).
+    f.when([:hash, Erl.hash]) { |hash| p hash }
+    # {:key=>:val}
+
+    send(Port, {object, {1,{2},3,<<"four">>}}).
+    f.when([:object, Any]) { |any| p any }
+    # [1, [2], 3, "four"]
+
+
+Contribute
+----------
+
+If you'd like to hack on Erlectricity, start by forking my repo on GitHub:
+
+http://github.com/mojombo/erlectricity
+
+To get all of the dependencies, install the gem first. The best way to get
+your changes merged back into core is as follows:
+
+1. Clone down your fork
+1. Create a topic branch to contain your change
+1. Hack away
+1. Add tests and make sure everything still passes by running `rake`
+1. If you are adding new functionality, document it in the README.md
+1. Do not change the version number, I will do that on my end
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send me (mojombo) a pull request for your branch
+
+
+Copyright
+---------
+
+Copyright (c) 2009 Scott Fleckenstein and Tom Preston-Werner. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "erlectricity"
+    gem.rubyforge_project = "erlectricity"
+    gem.summary = "A library to interface erlang and ruby through the erlang port system"
+    gem.email = "tom@mojombo.com"
+    gem.homepage = "http://github.com/mojombo/erlectricity"
+    gem.authors = ["Scott Fleckenstein", "Tom Preston-Werner"]
+    gem.require_paths = ["lib", "ext"]
+    gem.files.include("ext")
+    gem.extensions << 'ext/extconf.rb'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+task :test do
+  require 'open3'
+  require 'fileutils'
+
+  puts "\nCleaning extension build files and running all specs in native ruby mode..."
+  `rm -f ext/*.bundle` && puts("rm -f ext/*.bundle")
+  `rm -f ext/*.o` && puts("rm -f ext/*.o")
+  Open3.popen3("ruby test/spec_suite.rb") do |stdin, stdout, stderr|
+    while !stdout.eof?
+      print stdout.read(1)
+    end
+  end
+
+  puts "\nRunning `make` to build extensions and rerunning decoder specs..."
+  Dir.chdir('ext') { `make` }
+  Open3.popen3("ruby test/decode_spec.rb") do |stdin, stdout, stderr|
+    while !stdout.eof?
+      print stdout.read(1)
+    end
+  end
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "erlectricity #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 1
+:major: 1

data/benchmarks/bench.rb

@@ -0,0 +1,21 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'erlectricity'
+require 'benchmark'
+
+data = [:ok, [:foo, :bar, [99, "bottles", "of", "beer", 3.14], [true, false]]]
+bert = Erlectricity::Encoder.encode(data)
+
+p bert
+
+Benchmark.bm do|b|
+  b.report("Decoder") do
+    100_000.times { Erl::Decoder.decode(bert) }
+  end
+end
+
+#               user        system     total    real
+# C Decoder      0.400000   0.000000   0.400000 (  0.425373)
+# Ruby Decoder  30.250000   0.220000  30.470000 ( 32.140890)
+#
+# C decoder is 75.56x faster than Ruby decoder on this data

data/erlectricity.gemspec

@@ -0,0 +1,105 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{erlectricity-funbox}
+  s.version = "1.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Fleckenstein", "Tom Preston-Werner"]
+  s.date = %q{2009-10-28}
+  s.email = %q{tom@mojombo.com}
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION.yml",
+     "benchmarks/bench.rb",
+     "erlectricity.gemspec",
+     "examples/echo/README.md",
+     "examples/echo/echo.erl",
+     "examples/echo/echo.rb",
+     "examples/gruff/gruff.erl",
+     "examples/gruff/gruff_provider.rb",
+     "examples/gruff/gruff_run.sh",
+     "examples/gruff/stat_run.sh",
+     "examples/gruff/stat_writer.erl",
+     "examples/simple/README.md",
+     "examples/simple/rerl.rb",
+     "examples/simple/rerl.sh",
+     "examples/tinderl/README.md",
+     "examples/tinderl/tinderl.erl",
+     "examples/tinderl/tinderl.rb",
+     "ext/decoder.c",
+     "ext/extconf.rb",
+     "lib/erlectricity.rb",
+     "lib/erlectricity/condition.rb",
+     "lib/erlectricity/conditions/boolean.rb",
+     "lib/erlectricity/conditions/hash.rb",
+     "lib/erlectricity/conditions/static.rb",
+     "lib/erlectricity/conditions/type.rb",
+     "lib/erlectricity/constants.rb",
+     "lib/erlectricity/decoder.rb",
+     "lib/erlectricity/encoder.rb",
+     "lib/erlectricity/errors/decode_error.rb",
+     "lib/erlectricity/errors/encode_error.rb",
+     "lib/erlectricity/errors/erlectricity_error.rb",
+     "lib/erlectricity/matcher.rb",
+     "lib/erlectricity/port.rb",
+     "lib/erlectricity/receiver.rb",
+     "lib/erlectricity/types/function.rb",
+     "lib/erlectricity/types/list.rb",
+     "lib/erlectricity/types/new_function.rb",
+     "lib/erlectricity/types/new_reference.rb",
+     "lib/erlectricity/types/pid.rb",
+     "lib/erlectricity/types/reference.rb",
+     "lib/erlectricity/version.rb",
+     "test/condition_spec.rb",
+     "test/decode_spec.rb",
+     "test/encode_spec.rb",
+     "test/matcher_spec.rb",
+     "test/port_spec.rb",
+     "test/receiver_spec.rb",
+     "test/spec_suite.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mojombo/erlectricity}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib", "ext"]
+  s.rubyforge_project = %q{erlectricity}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A library to interface erlang and ruby through the erlang port system}
+  s.test_files = [
+    "test/condition_spec.rb",
+     "test/decode_spec.rb",
+     "test/encode_spec.rb",
+     "test/matcher_spec.rb",
+     "test/port_spec.rb",
+     "test/receiver_spec.rb",
+     "test/spec_suite.rb",
+     "test/test_helper.rb",
+     "examples/echo/echo.rb",
+     "examples/gruff/gruff_provider.rb",
+     "examples/simple/rerl.rb",
+     "examples/tinderl/tinderl.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/examples/echo/README.md

@@ -0,0 +1,12 @@
+This is a simple echo server example showing off basic Erlectricity usage.
+
+    $ cd examples/echo
+    $ 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(echo).
+    {ok,echo}
+    2> echo:test().
+    <<"You said: hello world!">>
+    ok

data/examples/echo/echo.erl

@@ -0,0 +1,13 @@
+-module(echo).
+-export([test/0]).
+
+test() ->
+  Cmd = "ruby echo.rb",
+  Port = open_port({spawn, Cmd}, [{packet, 4}, nouse_stdio, exit_status, binary]), 
+  Payload = term_to_binary({echo, <<"hello world!">>}),
+  port_command(Port, Payload),
+  receive
+    {Port, {data, Data}} ->
+      {result, Text} = binary_to_term(Data),
+      io:format("~p~n", [Text])
+  end.