yet-another-ruby-tcl 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d953a7ef2388ec0c122d75ee8f0aa1d1e8015c4d45f186bae997d7349cbccf98
+  data.tar.gz: 6b43f241ffb82c7a465e41f5b5ef69377d90b7a3ce3fb075c6c48715640424ae
+SHA512:
+  metadata.gz: 5dbfc97d96dd4c8441a1f66b3e75f51b8fbac3d7848bbc8f5fd43443254c89d84bec7eca3bf05c37aa0e08ebd74608a335c66f35e085b1c9351fb51a6873ea1e
+  data.tar.gz: 919d94922034ab630f531cc6d89817b8e31c314a12734e10fe640e71c2a05a6963a7f8d167ee43696f6a1d8e9367707470cd54691fa033b4ad0bb8c6dae071cd

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,18 @@
+*.gem
+.bundle
+Gemfile.lock
+# rcov generated
+coverage
+lib/tcl_ext.so
+ext/tcl_ext/mkmf.log
+ext/tcl_ext/Makefile
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+tmp
+pkg

data/.rubocop.yml

@@ -0,0 +1,12 @@
+plugins:
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# to be removed if/when done
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,14 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in tcl.gemspec
+gemspec
+
+group :development do
+  gem 'bundler'
+  gem 'irb'
+  gem 'rake'
+  gem 'rake-compiler'
+  gem 'rubocop'
+  gem 'rubocop-rake'
+  gem 'test-unit'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2008-2011 Sam Stephenson and Mark J. Titorenko
+Copyright (c) 2026 Pedro Miranda
+
+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,13 @@
+# 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
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+begin
+  require 'bundler'
+rescue LoadError
+  warn 'You must install bundler - run `gem install bundler`'
+end
+
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.main = 'README.md'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yet-another-yet-another-ruby-tcl #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+RUBY_TCL_SPEC = Bundler.load_gemspec('tcl.gemspec')
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = false
+end
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('tcl_ext', RUBY_TCL_SPEC)
+CLEAN.include %w[**/*.{o,bundle,jar,so,obj,pdb,lib,def,exp,log} pkg/ tmp/ rdoc/ doc/]
+
+task default: %i[clean compile test rubocop rdoc build install]

data/ext/tcl_ext/extconf.rb

@@ -0,0 +1,40 @@
+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')
+
+unless pkg_config('tcl')
+
+  # 3. Fallback: OS-Specific manual search
+  # Determine if we are compiling on Windows
+  is_windows = RUBY_PLATFORM.match?(/mingw|mswin/)
+
+  # Define the library names based on the OS convention
+  lib_names = if is_windows
+                %w[tcl86 tcl85 tcl] # MSYS2 usually drops the dot
+              else
+                %w[tcl8.6 tcl8.5 tcl] # Unix usually keeps the dot
+              end
+
+  # Check for the header file
+  unless have_header('tcl.h') || find_header('tcl.h',
+                                             '/usr/include/tcl8.6',
+                                             '/usr/include/tcl8.5',
+                                             '/usr/local/include/tcl8.6',
+                                             '/usr/local/include/tcl8.5',
+                                             '/opt/homebrew/include',
+                                             '/opt/homebrew/opt/tcl-tk/include')
+    abort "\n*** ERROR: Cannot find tcl.h. Please install Tcl development headers or use --with-tcl-include ***\n"
+  end
+
+  # Try to link against the libraries, one by one.
+  # We test for 'Tcl_Init' because it's a core Tcl C function.
+  found_lib = lib_names.any? do |lib|
+    have_library(lib, 'Tcl_Init')
+  end
+
+  abort "\n*** ERROR: Cannot find the Tcl library. Please install Tcl or use --with-tcl-lib ***\n" unless found_lib
+end
+create_makefile('tcl_ext')

data/ext/tcl_ext/tcl.c

@@ -0,0 +1,237 @@
+#include <ruby.h>
+#include <tcl.h>
+
+typedef struct {
+  Tcl_Interp *interp;
+  VALUE exit_exception;
+} tcl_interp_struct;
+
+static void rb_tcl_interp_destroy(void *ptr) {
+  tcl_interp_struct *tcl_interp = (tcl_interp_struct *)ptr;
+  Tcl_DeleteInterp(tcl_interp->interp);
+  Tcl_Release(tcl_interp->interp);
+  free(tcl_interp);
+}
+
+static const rb_data_type_t tcl_interp_type = {
+    "tcl_interp_struct", // Name of the type
+    {
+        0,                     // dmark function (or 0 if none)
+        rb_tcl_interp_destroy, // dfree function (replace with your actual free func)
+        0,                     // dsize function (or 0 if none)
+    },
+    0, 0, RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+
+static VALUE rb_value_to_s(VALUE value) {
+  return rb_funcall(value, rb_intern("to_s"), 0, 0);
+}
+
+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;
+  TypedData_Get_Struct(obj, tcl_interp_struct, &tcl_interp_type, 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;
+  TypedData_Get_Struct(obj, tcl_interp_struct, &tcl_interp_type, 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_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 = TypedData_Make_Struct(klass, tcl_interp_struct, &tcl_interp_type, 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;
+  TypedData_Get_Struct(obj, tcl_interp_struct, &tcl_interp_type, 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;
+  TypedData_Get_Struct(self, tcl_interp_struct, &tcl_interp_type, 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_str_new2(Tcl_GetStringResult(tcl_interp->interp));
+    case TCL_ERROR:
+      if (NIL_P(tcl_interp->exit_exception)) {
+        rb_raise(error_class, "%s", Tcl_GetStringResult(tcl_interp->interp));
+      } 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;
+  TypedData_Get_Struct(self, tcl_interp_struct, &tcl_interp_type, 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_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;
+  TypedData_Get_Struct(self, tcl_interp_struct, &tcl_interp_type, 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_str_new2(Tcl_GetStringFromObj(list, NULL));
+
+  Tcl_DecrRefCount(list);
+
+  return result;
+}
+
+void Init_tcl_ext(void) {
+  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
+  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/tcl/delegator.rb

@@ -0,0 +1,17 @@
+module Tcl
+  module Delegator
+    def self.included(klass)
+      klass.class_eval do
+        attr_reader :interp
+      end
+    end
+
+    def method_missing(name, ...)
+      interp.respond_to?(name) ? interp.send(name, ...) : super
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      interp.respond_to?(name, include_private) || super
+    end
+  end
+end

data/lib/tcl/interp.rb

@@ -0,0 +1,48 @@
+module Tcl
+  class Interp
+    include Utils
+
+    class << self
+      def load_from_file(filename)
+        new.tap { _1.eval(File.read(filename)) }
+      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].each_with_object([]) do |type, lines|
+        send("#{type}s").sort.each do |name|
+          object = send(type, name)
+          lines << object.to_tcl unless object.builtin?
+        end
+      end.join("\n")
+    end
+  end
+end

data/lib/tcl/proc.rb

@@ -0,0 +1,48 @@
+module Tcl
+  class Proc
+    BUILTINS = %w[
+      auto_execok auto_import auto_load auto_load_index
+      auto_qualify tclLog unknown
+    ].freeze
+    include Utils
+    include Delegator
+
+    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|
+        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
+
+    def body
+      _!(:info, :body, name)
+    end
+
+    def call(*args)
+      _!(name, *args.map(&: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/utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Tcl
+  module Utils
+    def _(*args)
+      interp.array_to_list(args)
+    end
+
+    def _!(*args)
+      interp.eval(_(*args))
+    end
+  end
+end

data/lib/tcl/var.rb

@@ -0,0 +1,63 @@
+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
+    ].freeze
+
+    include Utils
+    include Delegator
+
+    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
+
+    def to_a
+      value.split.each_slice(2).to_a
+    end
+
+    def to_h
+      to_a.to_h
+    end
+  end
+end

data/lib/tcl/version.rb

@@ -0,0 +1,3 @@
+module Tcl
+  VERSION = '0.1.2'.freeze
+end

data/lib/tcl.rb

@@ -0,0 +1,7 @@
+require 'tcl_ext'
+
+require_relative 'tcl/utils'
+require_relative 'tcl/delegator'
+require_relative 'tcl/interp'
+require_relative 'tcl/proc'
+require_relative 'tcl/var'

data/tcl.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/tcl/version'
+
+Gem::Specification.new do |s|
+  s.name = 'yet-another-ruby-tcl'
+  s.version = Tcl::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Sam Stephenson', 'Mark J. Titorenko', 'Pedro Miranda']
+  s.email = 'pedro.at.miranda@gmail.com'
+  s.homepage = 'http://github.com/p3t3ru5/yet-another-ruby-tcl'
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = s.homepage
+  s.metadata['rubygems_mfa_required'] = 'true'
+  s.summary = 'A minimal Ruby interface to libtcl.'
+  s.description = 'Bindings to the Tcl interpreter for use from within ruby.'
+  s.required_ruby_version = '>= 3.0.0'
+  s.extra_rdoc_files = %w[LICENSE README.md]
+  s.extensions = ['ext/tcl_ext/extconf.rb']
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+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,107 @@
+# frozen_string_literal: true
+
+require_relative '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_by5(num)
+    num.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_by5 0')
+    assert_equal '25', @interp.eval('interp_send multiply_by5 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,123 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+warn 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 = @interp.vars
+    procs = @interp.procs
+    @interp = Tcl::Interp.load_from_file(path_to_fixture('test.tcl'))
+    @interp.eval('rename clock ""') if @interp.procs.include?('clock')
+
+    assert_equal %w[a b], (@interp.vars - vars).sort
+    assert_equal %w[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
+    return unless defined?(Tcl::Timeout)
+
+    assert_raises(Tcl::Timeout) { @interp.eval('while 1 {}', 100) }
+  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(%w[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_empty
+    assert_equal [], @interp.list_to_array('')
+    assert_equal [''], @interp.list_to_array('{}')
+  end
+
+  def test_list_to_array_simple_strings
+    assert_equal ['one'], @interp.list_to_array('one')
+    assert_equal %w[one two], @interp.list_to_array('one two')
+  end
+
+  def test_list_to_array_escaped_spaces
+    assert_equal ['a', ' b', 'c'], @interp.list_to_array('a { b} c')
+    assert_equal ['a', ' b', 'c'], @interp.list_to_array('a \\ b c')
+  end
+
+  def test_list_to_array_escaped_characters
+    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 %w[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 %w[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 File.read(path_to_fixture('test.tcl'))
+    assert_equal <<~TCL.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 {} {}
+    TCL
+  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_relative '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,21 @@
+require 'test/unit'
+require_relative '../lib/tcl'
+
+module Tcl
+  class Interp
+    def clear!
+      procs.each { |p| _! :rename, p, '' }
+      vars.each  { |v| _! :unset, v }
+    end
+  end
+end
+
+module Test
+  module Unit
+    class TestCase
+      def path_to_fixture(*path_pieces)
+        File.join(File.dirname(__FILE__), 'fixtures', *path_pieces)
+      end
+    end
+  end
+end

data/test/var_test.rb

@@ -0,0 +1,59 @@
+require_relative '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_error_info
+    assert_errorinfo ''
+    Tcl::Var.find(@interp, 'b')
+    assert_errorinfo ''
+  end
+
+  def test_attempting_to_find_nonexistent_variable_does_not_modify_error_info
+    assert_errorinfo ''
+    assert_raises(Tcl::Error) { Tcl::Var.find(@interp, 'nonexistent') }
+    assert_errorinfo ''
+  end
+
+  protected
+
+  def assert_errorinfo(value)
+    return unless @interp.vars.include?('errorInfo')
+
+    assert_equal value, @interp.var('errorInfo').value
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: yet-another-ruby-tcl
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Sam Stephenson
+- Mark J. Titorenko
+- Pedro Miranda
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Bindings to the Tcl interpreter for use from within ruby.
+email: pedro.at.miranda@gmail.com
+executables: []
+extensions:
+- ext/tcl_ext/extconf.rb
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".document"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ext/tcl_ext/extconf.rb
+- ext/tcl_ext/tcl.c
+- lib/tcl.rb
+- lib/tcl/delegator.rb
+- lib/tcl/interp.rb
+- lib/tcl/proc.rb
+- lib/tcl/utils.rb
+- lib/tcl/var.rb
+- lib/tcl/version.rb
+- 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/p3t3ru5/yet-another-ruby-tcl
+licenses: []
+metadata:
+  homepage_uri: http://github.com/p3t3ru5/yet-another-ruby-tcl
+  source_code_uri: http://github.com/p3t3ru5/yet-another-ruby-tcl
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.15
+specification_version: 4
+summary: A minimal Ruby interface to libtcl.
+test_files: []