ruby-tcl 0.1.0

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby-tcl.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2011 Sam Stephenson and Mark J. Titorenko
+
+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.rdoc

@@ -0,0 +1,30 @@
+= ruby-tcl
+
+A minimal Ruby interface to libtcl. The library was originally written
+by Sam Stephenson.  This edition was created by Mark J. Titorenko.
+
+This fork uses the original C bindings written by Sam Stephenson in
+order to integrate with libtcl.  For a FFI implementation, see
+https://github.com/factorypreset/ruby-tcl (which also contains some
+other additions/improvements to the library).
+
+The original codebase is located at
+https://github.com/sstephenson/ruby-tcl - this is not a direct fork of
+that codebase as it has been created from the ground up as a
+Bueller-based gem.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version
+  in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2008-2001 Sam Stephenson and Mark J. Titorenko. See
+LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError
+  $stderr.puts "You must install bundler - run `gem install bundler`"
+end
+
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'bueller'
+Bueller::Tasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-tcl #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('tcl')
+CLEAN.include ['**/*.{o,bundle,jar,so,obj,pdb,lib,def,exp,log}']
+
+task :test => :compile
+task :default => :test
+

data/ext/tcl/extconf.rb

@@ -0,0 +1,8 @@
+require "mkmf"
+
+# To build against Tcl 8.5 on OS X Intel:
+# RC_ARCHS=i386 ruby extconf.rb --with-tcl-dir=/path/to/tcl8.5
+
+dir_config("tcl")
+have_library("tcl") unless have_library("tcl8.5")
+create_makefile("tcl")

data/ext/tcl/tcl.c

@@ -0,0 +1,225 @@
+#include <ruby.h>
+#include <tcl.h>
+
+typedef struct {
+  Tcl_Interp *interp;
+  VALUE exit_exception;
+} tcl_interp_struct;
+
+static VALUE rb_value_to_s(VALUE value) {
+  return rb_funcall(value, rb_intern("to_s"), 0, 0);
+}
+
+static void rb_tcl_interp_destroy(tcl_interp_struct *tcl_interp) {
+  Tcl_DeleteInterp(tcl_interp->interp);
+  Tcl_Release(tcl_interp->interp);
+  free(tcl_interp);
+}
+
+static VALUE rb_tcl_interp_send_begin(VALUE args) {
+  VALUE obj = rb_ary_entry(args, 0);
+  VALUE interp_receive_args = rb_ary_entry(args, 1);
+  
+  VALUE result = rb_funcall2(obj, rb_intern("interp_receive"), RARRAY_LEN(interp_receive_args), RARRAY_PTR(interp_receive_args));
+  
+  tcl_interp_struct *tcl_interp;
+  Data_Get_Struct(obj, tcl_interp_struct, tcl_interp);
+
+  char *tcl_result = strdup(RSTRING_PTR(rb_value_to_s(result)));
+  Tcl_SetResult(tcl_interp->interp, tcl_result, (Tcl_FreeProc *)free);
+  
+  return Qtrue;
+}
+
+static VALUE rb_tcl_interp_send_rescue(VALUE args, VALUE error_info) {
+  VALUE obj = rb_ary_entry(args, 0);
+  tcl_interp_struct *tcl_interp;
+  Data_Get_Struct(obj, tcl_interp_struct, tcl_interp);
+  
+  char *tcl_result = strdup(RSTRING_PTR(rb_value_to_s(error_info)));
+  Tcl_SetResult(tcl_interp->interp, tcl_result, (Tcl_FreeProc *)free);
+
+  if (rb_obj_is_kind_of(error_info, rb_eSystemExit)) {
+    tcl_interp->exit_exception = error_info;
+  }
+
+  return Qfalse;
+}
+
+static int rb_tcl_interp_send(ClientData clientData, Tcl_Interp *interp, int objc, Tcl_Obj *CONST objv[]) {
+  VALUE interp_receive_args = rb_ary_new2(objc - 1);
+  int i;
+  
+  for (i = 1; i < objc; i++) {
+    int element_length;
+    const char *element;
+    
+    element = Tcl_GetStringFromObj(objv[i], &element_length);
+    rb_ary_push(interp_receive_args, rb_tainted_str_new2(element));
+  }
+  
+  VALUE args = rb_ary_new3(2, (VALUE) clientData, interp_receive_args);
+  
+  if (rb_rescue2(rb_tcl_interp_send_begin, args, rb_tcl_interp_send_rescue, args, rb_eException) == Qtrue) {
+    return TCL_OK;
+  } else {
+    return TCL_ERROR;
+  }
+}
+
+static VALUE rb_tcl_interp_allocate(VALUE klass) {
+  tcl_interp_struct *tcl_interp;
+  VALUE obj = Data_Make_Struct(klass, tcl_interp_struct, NULL, rb_tcl_interp_destroy, tcl_interp);
+  
+  tcl_interp->interp = Tcl_CreateInterp();
+  tcl_interp->exit_exception = Qnil;
+  Tcl_Init(tcl_interp->interp);
+  Tcl_Preserve(tcl_interp->interp);
+  
+  Tcl_CreateObjCommand(tcl_interp->interp, "interp_send", (Tcl_ObjCmdProc *)rb_tcl_interp_send, (ClientData) obj, (Tcl_CmdDeleteProc *)NULL);
+  
+  return obj;
+}
+
+static VALUE rb_tcl_safe_interp_allocate(VALUE klass) {
+  VALUE obj = rb_tcl_interp_allocate(klass);
+
+  tcl_interp_struct *tcl_interp;
+  Data_Get_Struct(obj, tcl_interp_struct, tcl_interp);
+  
+  Tcl_MakeSafe(tcl_interp->interp);
+
+  return obj;
+}
+
+#ifdef TCL_LIMIT_TIME
+static VALUE rb_tcl_interp_eval(VALUE self, VALUE args) {
+  VALUE script = rb_ary_entry(args, 0);
+
+  int timeout = 0;
+  if (RARRAY_LEN(args) == 2) {
+    timeout = NUM2INT(rb_ary_entry(args, 1));
+  }
+#else
+static VALUE rb_tcl_interp_eval(VALUE self, VALUE script) {
+#endif
+
+  tcl_interp_struct *tcl_interp;
+  Data_Get_Struct(self, tcl_interp_struct, tcl_interp);
+
+#ifdef TCL_LIMIT_TIME
+  if (timeout > 0) {
+    Tcl_Time timeout_time;
+    Tcl_GetTime(&timeout_time);
+    timeout_time.sec += (long) timeout / 1000;
+    timeout_time.usec += (long) (timeout % 1000) * 1000;
+
+    Tcl_LimitSetTime(tcl_interp->interp, &timeout_time);
+    Tcl_LimitTypeSet(tcl_interp->interp, TCL_LIMIT_TIME);
+  }
+#endif
+
+  int result = Tcl_Eval(tcl_interp->interp, RSTRING_PTR(rb_value_to_s(script)));
+  
+  VALUE error_class = rb_const_get(rb_const_get(rb_cObject, rb_intern("Tcl")), rb_intern("Error"));
+
+#ifdef TCL_LIMIT_TIME
+  if (timeout > 0) {
+    if (Tcl_LimitTypeExceeded(tcl_interp->interp, TCL_LIMIT_TIME))
+      error_class = rb_const_get(rb_const_get(rb_cObject, rb_intern("Tcl")), rb_intern("Timeout"));
+      
+    Tcl_LimitTypeReset(tcl_interp->interp, TCL_LIMIT_TIME);
+  }
+#endif
+  
+  switch (result) {
+    case TCL_OK:
+      return rb_tainted_str_new2(tcl_interp->interp->result);
+    case TCL_ERROR:
+      if (NIL_P(tcl_interp->exit_exception)) {
+        rb_raise(error_class, "%s", tcl_interp->interp->result);
+      } else {
+        rb_exit(NUM2INT(rb_iv_get(tcl_interp->exit_exception, "status")));
+      }
+    default:
+      return Qnil;
+  }
+}
+
+static VALUE rb_tcl_interp_list_to_array(VALUE self, VALUE list) {
+  tcl_interp_struct *tcl_interp;
+  Data_Get_Struct(self, tcl_interp_struct, tcl_interp);
+  
+  Tcl_Obj *string = Tcl_NewStringObj(RSTRING_PTR(rb_value_to_s(list)), -1);
+  Tcl_IncrRefCount(string);
+
+  int list_length, i;
+  Tcl_Obj **elements;
+  
+  if (Tcl_ListObjGetElements(tcl_interp->interp, string, &list_length, &elements) != TCL_OK) {
+    Tcl_DecrRefCount(string);
+    return Qnil;
+  }
+  
+  for (i = 0; i < list_length; i++)
+    Tcl_IncrRefCount(elements[i]);
+  
+  VALUE result = rb_ary_new2(list_length);
+  
+  for (i = 0; i < list_length; i++) {
+    int element_length;
+    const char *element;
+    
+    element = Tcl_GetStringFromObj(elements[i], &element_length);
+    rb_ary_push(result, element ? rb_tainted_str_new(element, element_length) : rb_str_new2(""));
+    Tcl_DecrRefCount(elements[i]);
+  }
+  
+  Tcl_DecrRefCount(string);
+
+  return result;
+}
+
+static VALUE rb_tcl_interp_array_to_list(VALUE self, VALUE array) {
+  tcl_interp_struct *tcl_interp;
+  Data_Get_Struct(self, tcl_interp_struct, tcl_interp);
+
+  int array_length = RARRAY_LEN(array), i;
+  
+  Tcl_Obj *list = Tcl_NewObj();
+  Tcl_IncrRefCount(list);
+  
+  for (i = 0; i < array_length; i++) {
+    VALUE element = rb_ary_entry(array, i);
+    Tcl_Obj *string = Tcl_NewStringObj(RSTRING_PTR(rb_value_to_s(element)), -1);
+
+    Tcl_IncrRefCount(string);
+    Tcl_ListObjAppendElement(tcl_interp->interp, list, string);
+    Tcl_DecrRefCount(string);
+  }
+
+  VALUE result = rb_tainted_str_new2(Tcl_GetStringFromObj(list, NULL));
+  
+  Tcl_DecrRefCount(list);
+  
+  return result;
+}
+
+void Init_tcl() {
+  VALUE tcl_module = rb_define_module("Tcl");
+  VALUE interp_class = rb_define_class_under(tcl_module, "Interp", rb_cObject);
+  VALUE safe_interp_class = rb_define_class_under(tcl_module, "SafeInterp", interp_class);
+  VALUE error_class = rb_define_class_under(tcl_module, "Error", rb_eStandardError);
+
+  rb_define_alloc_func(interp_class, rb_tcl_interp_allocate);
+  rb_define_alloc_func(safe_interp_class, rb_tcl_safe_interp_allocate);
+  rb_define_method(interp_class, "list_to_array", rb_tcl_interp_list_to_array, 1);
+  rb_define_method(interp_class, "array_to_list", rb_tcl_interp_array_to_list, 1);
+
+#ifdef TCL_LIMIT_TIME
+  VALUE timeout_class = rb_define_class_under(tcl_module, "Timeout", error_class);
+  rb_define_method(interp_class, "eval", rb_tcl_interp_eval, -2);
+#else
+  rb_define_method(interp_class, "eval", rb_tcl_interp_eval, 1);
+#endif
+}

data/lib/ruby-tcl.rb

@@ -0,0 +1,7 @@
+require 'tcl'
+require "tcl/version"
+require "tcl/interp_helper"
+require "tcl/interp"
+require "tcl/proc"
+require "tcl/var"
+

data/lib/ruby-tcl/version.rb

@@ -0,0 +1,3 @@
+module Tcl
+  VERSION = "0.1.0"
+end

data/lib/tcl/interp.rb

@@ -0,0 +1,51 @@
+module Tcl
+  class Interp
+    include InterpHelper
+    
+    class << self
+      def load_from_file(filename)
+        interp = new
+        interp.eval(IO.read(filename))
+        interp
+      end
+    end
+    
+    def interp
+      self
+    end
+    
+    def interp_receive(method, *args)
+      send("tcl_#{method}", *args)
+    end
+  
+    def expose(name)
+      _!(:interp, :alias, nil, name, nil, :interp_send, name)
+    end
+
+    def proc(name)
+      Tcl::Proc.new(self, name)
+    end
+    
+    def var(name)
+      Tcl::Var.find(self, name)
+    end
+
+    def procs
+      list_to_array _!(:info, :procs)
+    end
+    
+    def vars
+      list_to_array _!(:info, :vars)
+    end
+    
+    def to_tcl
+      %w( var proc ).inject([]) do |lines, type|
+        send("#{type}s").sort.each do |name|
+          object = send(type, name)
+          lines << object.to_tcl unless object.builtin?
+        end
+        lines
+      end.join("\n")
+    end
+  end
+end

data/lib/tcl/interp_helper.rb

@@ -0,0 +1,25 @@
+module Tcl
+  module InterpHelper
+    def self.included(klass)
+      klass.class_eval do
+        attr_reader :interp
+      end
+    end
+    
+    def _(*args)
+      interp.array_to_list(args)
+    end
+    
+    def _!(*args)
+      interp.eval(_(*args))
+    end
+    
+    def method_missing(name, *args, &block)
+      if interp.respond_to?(name)
+        interp.send(name, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/tcl/proc.rb

@@ -0,0 +1,50 @@
+module Tcl
+  class Proc
+    BUILTINS = %w(
+      auto_execok auto_import auto_load auto_load_index 
+      auto_qualify tclLog unknown
+    )
+
+    include InterpHelper
+
+    attr_reader :name
+    
+    def initialize(interp, name)
+      @interp = interp
+      @name = name.to_s
+      to_tcl
+    end
+    
+    def arguments
+      list_to_array(_!(:info, :args, name)).map do |argument_name|
+        begin
+          variable_name = "__Tcl_Proc_arguments_#{name}_#{argument_name}"
+          if _!(:info, :default, name, argument_name, variable_name) == "0"
+            argument_name
+          else
+            _(argument_name, var(variable_name).value)
+          end
+        ensure
+          _!(:unset, variable_name)
+        end
+      end
+    end
+    
+    def body
+      _!(:info, :body, name)
+    end
+    
+    def call(*args)
+      _!(name, *args.map { |arg| arg.to_s })
+    end
+    
+    def to_tcl
+      _(:proc, name, _(*arguments), body)
+    end
+    
+    def builtin?
+      # TODO should also check to see if the definition has changed
+      BUILTINS.include?(name) 
+    end
+  end
+end

data/lib/tcl/var.rb

@@ -0,0 +1,54 @@
+module Tcl
+  class Var
+    BUILTINS = %w(
+      auto_index auto_oldpath auto_path env errorCode errorInfo
+      tcl_libPath tcl_library tcl_patchLevel tcl_pkgPath tcl_platform tcl_version
+    )
+    
+    include InterpHelper
+    
+    class << self
+      def find(interp, name)
+        if interp._!(:array, :exists, name) == "1"
+          ArrayVar.new(interp, name)
+        elsif interp._!(:info, :exists, name) == "1"
+          StringVar.new(interp, name)
+        else
+          raise Tcl::Error, "can't read \"#{name}\": no such variable"
+        end
+      end
+    end
+    
+    attr_reader :name
+    
+    def initialize(interp, name)
+      @interp = interp
+      @name = name.to_s
+      to_tcl
+    end
+    
+    def builtin?
+      BUILTINS.include?(name)
+    end
+  end
+  
+  class StringVar < Var
+    def value
+      _!(:set, name)
+    end
+    
+    def to_tcl
+      _(:set, name, value)
+    end
+  end
+  
+  class ArrayVar < Var
+    def value
+      _!(:array, :get, name)
+    end
+    
+    def to_tcl
+      _(:array, :set, name, value)
+    end
+  end
+end

data/ruby-tcl.gemspec

@@ -0,0 +1,35 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'ruby-tcl/version'
+
+Gem::Specification.new do |s|
+  s.name = 'ruby-tcl'
+  s.version = Tcl::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.date = "2011-09-23"
+  s.authors = ['Sam Stephenson', 'Mark J. Titorenko']
+  s.email = 'mark.titorenko@alces-software.com'
+  s.homepage = 'http://github.com/mjtko/ruby-tcl'
+  s.summary = %Q{A minimal Ruby interface to libtcl.}
+  s.description = %Q{Bindings to the Tcl interpreter for use from within ruby.}
+  s.extra_rdoc_files = [
+    'LICENSE',
+    'README.rdoc',
+  ]
+  s.extensions = ["ext/tcl/extconf.rb"]
+
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.7')
+  s.rubygems_version = '1.3.7'
+  s.specification_version = 3
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'bueller'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake-compiler'
+end
+

data/test/fixtures/test.tcl

@@ -0,0 +1,6 @@
+set a 0
+set b(a) 1
+set b(b) 2
+proc c args return
+proc d {a {b 0}} {return $b}
+proc e {} {}

data/test/interp_receive_test.rb

@@ -0,0 +1,106 @@
+require "test_helper"
+
+class InterpWithNoReceiveMethod < Tcl::Interp
+  undef_method :interp_receive
+end
+
+class InterpWithDefaultReceiveMethod < Tcl::Interp
+  def tcl_no_arguments
+    "hello"
+  end
+  
+  def tcl_one_argument(arg)
+    arg
+  end
+  
+  def tcl_variable_arguments(*args)
+    _(*args)
+  end
+  
+  def tcl_multiply_by_5(n)
+    n.to_i * 5
+  end
+end
+
+class InterpWithCustomReceiveMethod < Tcl::Interp
+  def interp_receive(method, *args)
+    _(method, *args)
+  end
+end
+
+class InterpWithExposedMethods < Tcl::Interp
+  def initialize
+    super
+    expose :hello
+  end
+  
+  def tcl_hello(who)
+    "hello, #{who}"
+  end
+end
+
+class InterpWithExitMethod < Tcl::Interp  
+  def tcl_exit
+    exit
+  end
+end
+
+class InterpReceiveTest < Test::Unit::TestCase
+  def setup
+    @interp = InterpWithDefaultReceiveMethod.new
+  end
+  
+  def test_interp_send_on_interp_with_no_interp_receive_method_should_raise
+    @interp = InterpWithDefaultReceiveMethod.new
+    assert_raises(Tcl::Error) { @interp.eval("interp_send") }
+  end
+  
+  def test_interp_send_with_no_arguments_should_raise
+    assert_raises(Tcl::Error) { @interp.eval("interp_send") }
+  end
+  
+  def test_interp_send_returns_tcl_ok
+    assert_equal "0",           @interp.eval("catch {interp_send no_arguments}")
+  end
+  
+  def test_interp_send_to_method_with_no_arguments
+    assert_equal "hello",       @interp.eval("interp_send no_arguments")
+    assert_raises(Tcl::Error) { @interp.eval("interp_send no_arguments foo") }
+  end
+  
+  def test_interp_send_to_method_with_one_argument
+    assert_raises(Tcl::Error) { @interp.eval("interp_send one_argument") }
+    assert_equal "foo",         @interp.eval("interp_send one_argument foo")
+    assert_raises(Tcl::Error) { @interp.eval("interp_send one_argument foo bar") }
+  end
+
+  def test_interp_send_to_method_with_variable_arguments
+    assert_equal "",            @interp.eval("interp_send variable_arguments")
+    assert_equal "foo",         @interp.eval("interp_send variable_arguments foo")
+    assert_equal "foo bar",     @interp.eval("interp_send variable_arguments foo bar")
+  end
+  
+  def test_interp_send_converts_non_string_results_to_string
+    assert_equal "0",           @interp.eval("interp_send multiply_by_5 0")
+    assert_equal "25",          @interp.eval("interp_send multiply_by_5 5")
+  end
+  
+  def test_interp_send_with_custom_interp_receive_method
+    @interp = InterpWithCustomReceiveMethod.new
+    assert_raises(Tcl::Error) { @interp.eval("interp_send") }
+    assert_equal "foo",         @interp.eval("interp_send foo")
+    assert_equal "foo bar",     @interp.eval("interp_send foo bar")
+  end
+  
+  def test_interp_expose
+    @interp = InterpWithExposedMethods.new
+    assert_equal "hello, Sam",  @interp.eval("interp_send hello Sam")
+    assert_equal "hello, Sam",  @interp.eval("hello Sam")
+  end
+  
+  def test_interp_send_does_not_convert_system_exit_into_tcl_error
+    @interp = InterpWithExitMethod.new
+    assert_raises(SystemExit) { @interp.eval("interp_send exit") }
+  end
+end
+

data/test/interp_test.rb

@@ -0,0 +1,109 @@
+STDERR.puts Tcl::Interp.inspect
+
+class InterpTest < Test::Unit::TestCase
+  def setup
+    @interp = Tcl::Interp.new
+    @interp.eval('rename clock ""') if @interp.procs.include?('clock')
+  end
+  
+  def test_load_from_file
+    vars, procs = @interp.vars, @interp.procs
+    @interp = Tcl::Interp.load_from_file(path_to_fixture("test.tcl"))
+    @interp.eval('rename clock ""') if @interp.procs.include?('clock')
+
+    assert_equal ["a", "b"],       (@interp.vars - vars).sort
+    assert_equal ["c", "d", "e"],  (@interp.procs - procs).sort
+  end
+  
+  def test_eval
+    assert_equal "",                @interp.eval("")
+    assert_equal "0",               @interp.eval("return 0")
+    assert_equal "",                @interp.eval("return \"\"")
+    assert_equal "",                @interp.eval("return {}")
+    assert_equal " ",               @interp.eval("return \" \"")
+  end
+  
+  def test_eval_raises_on_tcl_exception
+    assert_raises(Tcl::Error)     { @interp.eval("nonexistent") }
+    assert_raises(Tcl::Error)     { @interp.eval("{") }
+    assert_raises(Tcl::Error)     { @interp.eval("error") }
+  end
+  
+  def test_eval_with_timeout_argument
+    if defined?(Tcl::Timeout)
+      assert_raises(Tcl::Timeout) { @interp.eval("while 1 {}", 100) }
+    end
+  end
+  
+  def test_array_to_list
+    assert_equal "",                @interp.array_to_list([])
+    assert_equal "{}",              @interp.array_to_list([nil])
+    assert_equal "{}",              @interp.array_to_list([""])
+    assert_equal "one",             @interp.array_to_list(["one"])
+    assert_equal "one two",         @interp.array_to_list(["one", "two"])
+    assert_equal "a { b} c",        @interp.array_to_list(["a", " b", "c"])
+    assert_equal "\\{",             @interp.array_to_list(["{"])
+    assert_equal "{\"}",            @interp.array_to_list(["\""])
+  end
+  
+  def test_list_to_array
+    assert_equal [],                @interp.list_to_array("")
+    assert_equal [""],              @interp.list_to_array("{}")
+    assert_equal ["one"],           @interp.list_to_array("one")
+    assert_equal ["one", "two"],    @interp.list_to_array("one two")
+    assert_equal ["a", " b", "c"],  @interp.list_to_array("a { b} c")
+    assert_equal ["a", " b", "c"],  @interp.list_to_array("a \\ b c")
+    assert_equal ["{"],             @interp.list_to_array("\\{")
+    assert_equal ["["],             @interp.list_to_array("\\[")
+    assert_equal ["\""],            @interp.list_to_array("\\\"")
+  end
+  
+  def test_procs
+    @interp.clear!
+    assert_equal [], @interp.procs
+    @interp.eval "proc foo {} {}"
+    assert_equal ["foo"], @interp.procs
+    @interp.eval "proc bar {} {}"
+    assert_equal ["bar", "foo"], @interp.procs.sort
+  end
+  
+  def test_vars
+    @interp.clear!
+    assert_equal [], @interp.vars
+    @interp.eval "set a 0"
+    assert_equal ["a"], @interp.vars
+    @interp.eval "set b(a) 0"
+    assert_equal ["a", "b"], @interp.vars.sort
+  end
+  
+  def test_proc
+    assert_raises(Tcl::Error) { @interp.proc("foo") }
+    @interp.eval "proc foo {} {}"
+    proc = @interp.proc("foo")
+    assert proc.is_a?(Tcl::Proc)
+    assert_equal "foo", proc.name
+  end
+  
+  def test_var
+    assert_raises(Tcl::Error) { @interp.var("foo") }
+    @interp.eval "set foo bar"
+    var = @interp.var("foo")
+    assert var.is_a?(Tcl::Var)
+    assert_equal "foo", var.name
+  end
+  
+  def test_to_tcl
+    @interp.eval IO.read(path_to_fixture("test.tcl"))
+    assert_equal <<-EOF.chomp, @interp.to_tcl
+set a 0
+array set b {a 1 b 2}
+proc c args return
+proc d {a {b 0}} {return $b}
+proc e {} {}
+    EOF
+  end
+  
+  def test_interp_helper_method_missing_super_passthrough
+    assert_raises(NoMethodError) { @interp.nonexistent }
+  end
+end

data/test/proc_test.rb

@@ -0,0 +1,42 @@
+require "test_helper"
+
+class ProcTest < Test::Unit::TestCase
+  def setup
+    @interp = Tcl::Interp.load_from_file(path_to_fixture("test.tcl"))
+  end
+  
+  def test_proc_arguments_for_proc_with_no_arguments
+    assert_equal [], @interp.proc("e").arguments
+  end
+  
+  def test_proc_arguments_for_proc_with_one_argument
+    assert_equal ["args"], @interp.proc("c").arguments
+  end
+
+  def test_proc_arguments_for_proc_with_default_argument
+    assert_equal ["a", "b 0"], @interp.proc("d").arguments
+  end
+  
+  def test_proc_body
+    assert_equal "return",    @interp.proc("c").body
+    assert_equal "return $b", @interp.proc("d").body
+    assert_equal "",          @interp.proc("e").body
+  end
+
+  def test_proc_call
+    assert_equal "",  @interp.proc("c").call
+    assert_equal "0", @interp.proc("d").call("a")
+    assert_equal "b", @interp.proc("d").call("a", "b")
+    assert_equal "",  @interp.proc("e").call
+  end
+  
+  def test_proc_call_raises_on_missing_argument
+    assert_raises(Tcl::Error) { @interp.proc("d").call }
+  end
+  
+  def test_proc_to_tcl
+    assert_equal "proc c args return", @interp.proc("c").to_tcl
+    assert_equal "proc d {a {b 0}} {return $b}", @interp.proc("d").to_tcl
+    assert_equal "proc e {} {}", @interp.proc("e").to_tcl
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require "test/unit"
+require File.join(File.dirname(__FILE__), *%w".. lib ruby-tcl")
+
+class Tcl::Interp
+  def clear!
+    procs.each { |p| _! :rename, p, "" }
+    vars.each  { |v| _! :unset, v }
+  end
+end
+
+class Test::Unit::TestCase
+  def path_to_fixture(*path_pieces)
+    File.join(File.dirname(__FILE__), "fixtures", *path_pieces)
+  end
+end

data/test/var_test.rb

@@ -0,0 +1,58 @@
+require "test_helper"
+
+class VarTest < Test::Unit::TestCase
+  def setup
+    @interp = Tcl::Interp.load_from_file(path_to_fixture("test.tcl"))
+  end
+  
+  def test_var_find_raises_when_var_does_not_exist
+    assert_raises(Tcl::Error) { Tcl::Var.find(@interp, "nonexistent") }
+  end
+  
+  def test_var_find_returns_string_var
+    var = Tcl::Var.find(@interp, "a")
+    assert_equal "a", var.name
+    assert var.is_a?(Tcl::StringVar)
+  end
+  
+  def test_var_find_returns_array_var
+    var = Tcl::Var.find(@interp, "b")
+    assert_equal "b", var.name
+    assert var.is_a?(Tcl::ArrayVar)
+  end
+  
+  def test_string_var_value
+    assert_equal "0", @interp.var("a").value
+  end
+  
+  def test_array_var_value
+    assert_equal "a 1 b 2", @interp.var("b").value
+  end
+  
+  def test_string_var_to_tcl
+    assert_equal "set a 0", @interp.var("a").to_tcl
+  end
+  
+  def test_array_var_to_tcl
+    assert_equal "array set b {a 1 b 2}", @interp.var("b").to_tcl
+  end
+  
+  def test_array_var_to_tcl_does_not_modify_errorInfo
+    assert_errorinfo ""
+    Tcl::Var.find(@interp, "b")
+    assert_errorinfo ""
+  end
+  
+  def test_attempting_to_find_nonexistent_variable_does_not_modify_errorInfo
+    assert_errorinfo ""
+    assert_raises(Tcl::Error) { Tcl::Var.find(@interp, "nonexistent") }
+    assert_errorinfo ""
+  end
+  
+  protected
+    def assert_errorinfo(value)
+      if @interp.vars.include?("errorInfo")
+        assert_equal value, @interp.var("errorInfo").value
+      end
+    end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: ruby-tcl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sam Stephenson
+- Mark J. Titorenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &70242944619420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242944619420
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70242944606500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242944606500
+- !ruby/object:Gem::Dependency
+  name: bueller
+  requirement: &70242944605720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242944605720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70242944605000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242944605000
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: &70242944604280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242944604280
+description: Bindings to the Tcl interpreter for use from within ruby.
+email: mark.titorenko@alces-software.com
+executables: []
+extensions:
+- ext/tcl/extconf.rb
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- ext/tcl/extconf.rb
+- ext/tcl/tcl.c
+- lib/ruby-tcl.rb
+- lib/ruby-tcl/version.rb
+- lib/tcl/interp.rb
+- lib/tcl/interp_helper.rb
+- lib/tcl/proc.rb
+- lib/tcl/var.rb
+- ruby-tcl.gemspec
+- test/fixtures/test.tcl
+- test/interp_receive_test.rb
+- test/interp_test.rb
+- test/proc_test.rb
+- test/test_helper.rb
+- test/var_test.rb
+homepage: http://github.com/mjtko/ruby-tcl
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3606260369119369042
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.7
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A minimal Ruby interface to libtcl.
+test_files:
+- test/fixtures/test.tcl
+- test/interp_receive_test.rb
+- test/interp_test.rb
+- test/proc_test.rb
+- test/test_helper.rb
+- test/var_test.rb