shen-ruby 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4388a5a344cbc54d04a341a42a341cf05aae8ebc
-  data.tar.gz: 2777d3e71e1f2f90a953487007f4c6b4fdcaf97a
+  metadata.gz: c457075dab1a292cac646bf9148aaafb79de2457
+  data.tar.gz: b8909a0fef1f820b121110a06394366a7c01c3a4
 SHA512:
-  metadata.gz: 1655075e45839d973a8a5bc310cc7a8399ac155960261e968785932a1cb733082a15d084dd3ea669cfe28fbc64ec19b6af54c59e46542fef0b99489290a8491f
-  data.tar.gz: be259a2837137dd278a3d8c6a9912df4051ed953a82805b5b138b72e1c7e7cd1e4dea991f0655ca63793ae68532025371a65ee67cdca8e276e8a551729b078b3
+  metadata.gz: 686bb28d207078c9e7e0a9ad38c058fe9ed7da9695a84adf4f51a85e58ca3870b90235ada593ae3c7ebdedfc641ac0649591dfa59ae9dc43b84b1f5607747de9
+  data.tar.gz: d767482519d1199ad6206f122fd0c1bd8211c155df994cdabbf5e9c7f2f5f6a616e7019e1d7d9886a775ffd1e72625d605c837286b6d4cd6dda6012884169092

data/.rspec

@@ -0,0 +1 @@
+-I ./lib -I ./shen/lib

data/.travis.yml

@@ -1,5 +1,11 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - jruby-19mode
+  - 2.0
+  - 2.1
+  - 2.2
+env: "RUBY_THREAD_VM_STACK_SIZE=2097152"
+script: "ruby bin/shen_test_suite.rb && rake"
+matrix:
+  include:
+    - rvm: jruby-1.7.17
+      script: "ruby -J-Xss32m bin/shen_test_suite.rb && rake"

data/Gemfile

@@ -1,6 +1,3 @@
 source 'https://rubygems.org'
 
-group :development do
-  gem 'rake', '~> 0.9'
-  gem 'rspec', '~> 2.12.0'
-end
+gemspec

data/HISTORY.md

@@ -1,5 +1,21 @@
 # ShenRuby Release History
 
+## 0.11.0 - January 15, 2014
+### Features
+- KLambda implementation switched to [Klam](https://github.com/gregspurrier/klam). This has many implications, including:
+  - Significant performance increase. E.g., the Shen Test Suite now runs 2.5 times faster than with ShenRuby 0.10.0.
+  - Tail call optimization applies only to self tail calls
+  - The environment extends BasicObject rather than Object
+  - Shen functions are directly installed as methods on the ShenRuby::Shen instance.
+  - Many primitives are inlined.
+  - Primitives are less strict with respect to type errors, relying on the Shen type checker to do this work when type checking is enabled.
+    - E.g., `(+ "a" "b") no longer throws a type error
+
+### Breaking Changes
+- Ruby->Shen interop has changed as a result of the switch to Klam and in preparation for more substantial Ruby<->Shen interop to come. Notably:
+  - Underscores in method names are no longer coerced to hyphens before invoking Shen functions. Use `__send__` to invoke Shen functions having names that are not valid Ruby method names.
+  - Ruby arrays are no longer automatically coerced to Shen lists and vice versa.
+
 ## 0.10.0 - September 19, 2014
 ### Features
 - Upgrade to Shen 16

data/MIT_LICENSE.txt

@@ -3,7 +3,7 @@ the 'shen' directory, which is subject to its own license.
 
 -----
 
-Copyright (c) 2012-2013 Greg Spurrier
+Copyright (c) 2012-2015 Greg Spurrier
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -7,14 +7,14 @@ The ShenRuby project has two primary goals. The first is to be a low barrier-to-
 
 Second, ShenRuby aims to enable hybrid applications implemented using a combination of Ruby and Shen. Ruby methods should be able to invoke functions written in Shen and vice versa. Performance is a secondary part of this goal. It should be good enough that, for most tasks, the choice between Ruby and Shen is based primarily on which language is best suited for solving the problem at hand.
 
-ShenRuby 0.1.0 began to satisfy the first goal by providing a Shen REPL accessible from the command line. The second goal is more ambitious and is the subject of ongoing work beginning with the 0.2.0 release and leading up to the eventual 1.0.0 release.
+ShenRuby 0.1.0 began to satisfy the first goal by providing a Shen REPL accessible from the command line. The second goal is more ambitious and is the subject of ongoing work leading up to the eventual 1.0.0 release.
 
 [![Build Status](https://travis-ci.org/gregspurrier/shen-ruby.png)](https://travis-ci.org/gregspurrier/shen-ruby)
 
 ## Installation
-NOTE: ShenRuby requires Ruby 1.9 language features. It has been tested with Ruby 1.9.3 and Ruby 2.0.0. It has been lightly tested with JRuby 1.7.8.
+NOTE: ShenRuby requires Ruby 1.9 language features. It is tested with Ruby 2.0.0, 2.1.5, and 2.2.0. It has been lightly tested with JRuby 1.7.17. It is functional with Ruby 1.9.3, however its fixed stack size prevents it from passing the Shen Test Suite (see [Setting Stack Size](setting-stack-size) below).
 
-ShenRuby 0.10.0 is the current release. To install it as a gem, use the following command:
+ShenRuby 0.11.0 is the current release. To install it as a gem, use the following command:
 
     gem install shen-ruby
 
@@ -23,19 +23,17 @@ ShenRuby 0.10.0 is the current release. To install it as a gem, use the followin
 Once the gem has been installed, the Shen REPL can be launched via the `srrepl` (short for ShenRuby REPL) command. For example:
 
     % srrepl
-    Loading.... Completed in 7.04 seconds.
+    Loading.... Completed in 2.18 seconds.
 
     Shen 2010, copyright (C) 2010 Mark Tarver
     released under the Shen license
     www.shenlanguage.org, version 16
-    running under Ruby, implementation: ruby 2.0.0
-    port 0.10.0 ported by Greg Spurrier
+    running under Ruby, implementation: ruby 2.2.0
+    port 0.11.0 ported by Greg Spurrier
 
 
     (0-)
 
-Please be patient: the Shen REPL takes a while to load (about 7 seconds on a 2.66 GHz MacBook Pro). This will be addressed in future releases.
-
 The `(0-)` seen above is the Shen REPL prompt. The number in the prompt increases after each expression that is entered.
 
 Here is an example of defining a recursive factorial function via the REPL and trying it out:
@@ -106,31 +104,34 @@ More commonly, though, `eval_string` is used with Shen `define` expressions to e
 
 ### Invoking Shen Functions from Ruby
 
-A better way to invoke most Shen functions from Ruby is to simply invoke the corresponding method on the Shen object. If the Shen function's name includes a hyphen, use an underscore instead.
-
-For example, to use the `fizz-buzz` function defined in the previous section to compute the first 20 Fizz Buzz values:
+Shen functions are instance methods of the ShenRuby::Shen environment object. Functions having names that are valid Ruby method names may be invoked directly:
 
-    (1..20).map { |x| shen.fizz_buzz(x) }
-    # => ["1", "2", "Fizz", "4", "Buzz", "Fizz", "7", "8", "Fizz", "Buzz", "11", "Fizz", "13", "14", "Fizz Buzz", "16", "17", "Fizz", "19", "Buzz"]
+    shen.cn("Hello, ", "Shen!")
+    # => "Hello, Shen!"
 
-The above example uses Ruby's `map` function, but could also have used Shen's version, relying on ShenRuby's interop features to coerce Ruby arrays to and from Shen lists:
+If the Shen function's name is not a valid Ruby method name--e.g. it includes a hyphen--it can be invoked via `__send__`:
 
-    shen.map(:fizz_buzz, (1..20).to_a)
-    # => ["1", "2", "Fizz", "4", "Buzz", "Fizz", "7", "8", "Fizz", "Buzz", "11", "Fizz", "13", "14", "Fizz Buzz", "16", "17", "Fizz", "19", "Buzz"]
+    shen.__send__('fizz-buzz', 15)
+    # => "Fizz Buzz"
 
-Note that the Ruby symbol `:fizz_buzz` is automatically coerced to the Shen symbol `fizz-buzz` so that refer to the function defined above.
+Ruby arrays must be converted to Shen lists or vectors before passing to Shen. Here is an example of converting an array to a list, invoking Shen's `map` function, and converting the resulting list back to a Ruby array:
 
-As a final example, Ruby functions may be passed as arguments to higher-order Shen functions:
+    ShenRuby.list_to_array(shen.map(:'fizz-buzz', ShenRuby.array_to_list((1..20).to_a)))
+    => ["1", "2", "Fizz", "4", "Buzz", "Fizz", "7", "8", "Fizz", "Buzz", "11", "Fizz", "13", "14", "Fizz Buzz", "16", "17", "Fizz", "19", "Buzz"]
 
-    shen.map(lambda {|x| x * x}, [1, 2, 3, 4, 5])
-    # => [1, 4, 9, 16, 25]
+The equivalent conversion functions for vectors are `ShenRuby.vector_to_list` and `ShenRuby.list_to_vector`.
 
 #### Caveats
-Shen function invocation via methods on the Shen object only works for normal functions. It will not work for special forms like `define`.
+Shen function invocation via methods on the Shen object only works for normal functions. It will not work for special forms like `define` or macros.
+
+## Setting Stack Size
+Some operations in Shen, notably type checking of complicated types, require more stack space than is available by default in Ruby. If your program encounters a stack overflow, you can increase Ruby's stack size through the following methods.
 
-The array<->list and underscore<->hyphen automatic coercions do not take effect for Ruby functions that are added to the Shen environment or for the K Lambda [primitives](http://www.shenlanguage.org/documentation/shendoc.htm#The%20Primitive%20Functions%20of%20K%20Lambda) that form the basis of Shen. In practice, this should not be much of a limitation, but it is hoped that this restriction will be lifted in the future.
+### Ruby
+Beginning in Ruby 2.0.0, the MRI stack size can be overridden via the `RUBY_THREAD_VM_STACK_SIZE` environment variable. A value of 2097152 is sufficient for the Shen Test Suite to pass under both OS X and Linux.
 
-Shen functions cannot be passed as arguments to functions defined in Ruby. This restriction will be removed in the future.
+### JRuby
+JRuby uses the JVM's stack. It can be increased via the `-J-Xss` command line argument. A value of 32m (i.e., `-J-Xss32m`) is sufficient for the Shen Test Suite to pass under both OS X and Linux.
 
 ## Shen Resources
 
@@ -151,10 +152,8 @@ The following features and improvements are among those planned for ShenRuby as
 - Support for command-line Shen scripts that under ShenRuby
 - Support for Rubinius
 - Thread-safe `ShenRuby::Shen` instances
-- Improved performance
 
 ## Known Limitations
-- The "Qi interpreter - chapter 13" test case in the Shen Test Suite and some of the benchmarks are currently failing with stack overflow errors.
 - ShenRuby fails with a stack overflow when run under cygwin on Windows ([Issue #3](https://github.com/gregspurrier/shen-ruby/issues/3)). The Ruby environment installed by [RubyInstaller](http://rubyinstaller.org/), however, is capable of running ShenRuby. It is the recommended environment for running ShenRuby on Windows until the stack overflow issues seen on cygwin can be addressed.
 - ShenRuby fails to load under Rubinius ([Issue #7])(https://github.com/gregspurrier/shen-ruby/issues/7)].
 
@@ -169,4 +168,4 @@ Shen and ShenRuby are released under the Shen License. A copy of the Shen Licens
 
 The implementation of Shen, which is found in the [shen/release](https://github.com/gregspurrier/shen-ruby/tree/master/shen) directory, is Copyright (c) 2010-2014 Mark Tarver and may only be used in accordance with the Shen License.
 
-The remainder of the code for ShenRuby is Copyright(c) 2012-2014 Greg Spurrier. It may be used outside of the context of ShenRuby under the terms of the MIT License. A copy of the MIT License may be found in [MIT_LICENSE.txt](https://github.com/gregspurrier/shen-ruby/blob/master/MIT_LICENSE.txt).
+The remainder of the code for ShenRuby is Copyright(c) 2012-2015 Greg Spurrier. It may be used outside of the context of ShenRuby under the terms of the MIT License. A copy of the MIT License may be found in [MIT_LICENSE.txt](https://github.com/gregspurrier/shen-ruby/blob/master/MIT_LICENSE.txt).

data/Rakefile

@@ -3,14 +3,8 @@ require 'rspec/core/rake_task'
 
 SHENRUBY_ROOT = File.expand_path(File.dirname(__FILE__))
 
-# Run implementation specs
 RSpec::Core::RakeTask.new(:spec)
-
-# Run K Lambda specs
-RSpec::Core::RakeTask.new(:k_lambda_spec) do |t|
-  t.rspec_opts = '-I k_lambda_spec'
-  t.pattern = 'k_lambda_spec/**/*_spec.rb'
-end
+task :default => :spec
 
 # Import Shen Release
 RELEASE_DIR = File.join(SHENRUBY_ROOT, 'shen/release')
@@ -53,7 +47,7 @@ namespace :shen do
 
       src_paths = Dir.glob(File.join(src_root, '**/*'))
       src_dirs, src_files = src_paths.partition { |p| File.directory?(p) }
-      
+
       mkdir_p dst_root
       src_dirs.each { |dir| mkdir_p dst_path(src_root, dir, dst_root) }
       src_files.each { |file| cp file, dst_path(src_root, file, dst_root) }
@@ -72,7 +66,7 @@ namespace :shen do
         end
       end
     end
-    
+
     task :k_lambda => [:unzip, RELEASE_DIR] do
       import_dir('K Lambda')
     end
@@ -88,5 +82,3 @@ namespace :shen do
     end
   end
 end
-
-task :default => [:spec, :k_lambda_spec]

data/bin/shen_test_suite.rb

@@ -4,6 +4,18 @@ $LOAD_PATH << File.expand_path('../../shen/lib', __FILE__)
 require 'shen_ruby'
 
 shen = ShenRuby::Shen.new
-shen.__eval(Kl::Cons.list([:cd, "shen/release/test_programs"]))
-shen.__eval(Kl::Cons.list([:load, "README.shen"]))
-shen.__eval(Kl::Cons.list([:load, "tests.shen"]))
+shen.cd('shen/release/test_programs')
+shen.load('README.shen')
+
+# Override y-on-n? so that the script continues on error.
+# We must use KLambda's defun to circumvent Shen's protection
+# against redefining system functions.
+shen.eval_string('(defun y-or-n? (Ignored) true)')
+
+# Reset the pass/fail counters now and then make reset a no-op
+# so that we can query it at the end of the test run.
+shen.reset
+shen.eval_string('(define reset -> true)')
+
+shen.load('tests.shen')
+exit(1) unless shen.value(:"test-harness.*failed*") == 0

data/bin/srrepl

@@ -18,22 +18,20 @@ now = Time.now.to_f
 puts ". Completed in %0.2f seconds.\n" % (now - start)
 
 # Now that the Shen environment is loaded, repurpose the SIGINT
-# handler to interrupt the current execution.
-class ReplInterrupt < StandardError; end
+# handler to interrupt the current execution. Subclass Interrupt
+# so that the exception is not caught by trap-error.
+class ReplInterrupt < Interrupt; end
 Signal.trap("INT") { raise ReplInterrupt }
 
 # Launch the REPL
 command = :"shen.shen"
 begin
-  shen.__eval(Kl::Cons.list([command]))
-rescue StandardError => e
-  # K Lambda simple errors are already handled by the Shen REPL. Therefore
-  # this must be another type of exception. Print it as such and reenter
-  # the REPL without re-display the initial credits.
+  shen.__send__ command
+rescue ReplInterrupt, SystemStackError => e
   if e.kind_of? ReplInterrupt
     puts "Execution interrupted. If you are trying to exit the REPL, use (quit)."
   else
-    puts "Ruby exception: #{e.message}"
+    puts "Stack overflow"
   end
   command = :"shen.loop"
   retry

data/lib/shen_ruby.rb

@@ -1,5 +1,10 @@
-require 'kl'
+require 'klam'
 require 'shen_ruby/version'
+require 'shen_ruby/converters'
+
+module ShenRuby
+  extend ShenRuby::Converters
+end
 
 # The following file is a derivative of the Shen release packages with ShenRuby
 # and it located under the shen directory hierarchy to make the license

data/lib/shen_ruby/converters.rb

@@ -0,0 +1,23 @@
+module ShenRuby
+  module Converters
+    include Klam::Converters::List
+
+    def array_to_list(a)
+      arrayToList(a)
+    end
+
+    def list_to_array(l)
+      listToArray(l)
+    end
+
+    def array_to_vector(a)
+      v = Klam::Absvector.new(a)
+      v.unshift(a.size)
+      v
+    end
+
+    def vector_to_array(v)
+      Array.new(v.slice(1,v[0]))
+    end
+  end
+end

data/lib/shen_ruby/version.rb

@@ -1,3 +1,3 @@
 module ShenRuby
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/shen-ruby.gemspec

@@ -16,7 +16,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version     = ">= 1.9.3"
 
-  s.add_development_dependency "rspec", "~> 2.12"
+  s.add_runtime_dependency 'klam', '0.0.2', '0.0.2'
+
+  s.add_development_dependency 'rake', '~> 10.4.2', '>= 10.4.2'
+  s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
 
   git_files            = `git ls-files`.split("\n") rescue ''
   s.files              = git_files

data/shen/lib/shen_ruby/shen.rb

@@ -5,7 +5,7 @@
 # software, to distribute these applications in source or binary form,
 # and to charge monies for them as he sees fit and in concordance with
 # the laws of the land subject to the following license.
-# 
+#
 # 1. The license applies to all the software and all derived software
 # and must appear on such.
 #
@@ -63,58 +63,63 @@
 
 module ShenRuby
   # Instances of the ShenRuby::Shen class provide a Shen environment
-  # running within ShenRuby's K Lambda implementation.
-  class Shen < Kl::Environment
+  # running within a Klam environment
+  class Shen < Klam::Environment
     def initialize
       super
 
       # Set the global variables
       set("*language*".to_sym, "Ruby")
-      set("*implementation*".to_sym, "#{RUBY_ENGINE} #{RUBY_VERSION}")
-      set("*release*".to_sym, RUBY_VERSION)
-      set("*port*".to_sym, ShenRuby::VERSION)
+      set("*implementation*".to_sym, "#{::RUBY_ENGINE} #{::RUBY_VERSION}")
+      set("*release*".to_sym, ::RUBY_VERSION)
+      set("*port*".to_sym, ::ShenRuby::VERSION)
       set("*porters*".to_sym, "Greg Spurrier")
-      set("*home-directory*".to_sym, Dir.pwd)
-      set("*stinput*".to_sym, STDIN)
-      set("*stoutput*".to_sym, STDOUT)
-
+      set("*home-directory*".to_sym, ::Dir.pwd)
+      set("*stinput*".to_sym, ::STDIN)
+      set("*stoutput*".to_sym, ::STDOUT)
 
       # Load the K Lambda files
-      kl_root = File.expand_path('../../../release/k_lambda', __FILE__)
+      kl_root = ::File.expand_path('../../../release/k_lambda', __FILE__)
       %w(toplevel core sys).each do |kl_filename|
-        Kl::Environment.load_file(self, File.join(kl_root, kl_filename + ".kl"))
+        ::ShenRuby::Shen.load_file(self, ::File.join(kl_root, kl_filename + ".kl"))
       end
 
       # Overrides
       class << self
-        # Kl::Absvector.new already initializes every element, so we can
-        # use a simpler version of vector
-        def vector(n)
-          v = ::Kl::Absvector.new(n + 1) #, fail)
-          v[0] = n
-          v
-        end
-
         # Give a way to bail out
-        define_method 'quit' do
+        def quit
           ::Kernel.exit(0)
         end
 
-        # For debugging the compiler
-        define_method 'set-dump-code' do |val|
-          @dump_code = val
-        end
-
         # Add a way to evaluate strings, intended for use with Ruby interop.
         # Returns the result of the last expression evaluated.
-        # Based on the implementation of read-file in reader.shen
         def eval_string(s)
-          forms = __apply(:"read-from-string", [s])
+          forms = __send__(:"read-from-string", s)
           result = nil
-          forms.each { |f| result = __apply(:eval, [f]) }
+          while forms
+            result = eval(head(forms))
+            forms = tail(forms)
+          end
           result
         end
         alias_method :"eval-string", :eval_string
+
+        # The performance of `element?` is critical
+        def element?(x, l)
+          while l
+            return true if l.hd == x
+            l = l.tl
+          end
+          return false
+        rescue => e
+          __send(:"shen.sys-error", :element?)
+        end
+
+        def vector(n)
+          v = ::Klam::Absvector.new(n + 1, :"shen.fail!")
+          v[0] = n
+          v
+        end
       end
 
       # Load the rest of the K Lambda files
@@ -122,13 +127,24 @@ module ShenRuby
          reader prolog track load writer
          macros declarations t-star types
         ).each do |kl_filename|
-        Kl::Environment.load_file(self, File.join(kl_root, kl_filename + ".kl"))
+        ::ShenRuby::Shen.load_file(self, ::File.join(kl_root, kl_filename + ".kl"))
       end
 
       # Give type signatures to the new functions added above
-      declare :quit, [:'-->', :unit]
-      declare :eval_string, [:string, :'-->', :unit]
-      declare :'eval-string', [:string, :'-->', :unit]
+      declare :quit, cons(:"-->", cons(:unit, nil))
+      declare :eval_string, cons(:string, cons(:"-->", cons(:unit, nil)))
+      declare :"eval-string", cons(:string, cons(:"-->", cons(:unit, nil)))
+    end
+
+    class << self
+      def load_file(env, path)
+        ::File.open(path, 'r') do |file|
+          reader = ::Klam::Reader.new(file)
+          while form = reader.next
+            env.__send__(:"eval-kl", form)
+          end
+        end
+      end
     end
   end
 end