rubasteme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7318849fdcbcfd2daa359998f303bba5c27429bce2a36f06e9beddf05d26ba8a
+  data.tar.gz: 0037b93486d56d45c125ec47aa5417de6f61dbb6519679154974ac039206a738
+SHA512:
+  metadata.gz: 10e44958db29f64d4b17e0db107756e8952393941b7305f9b32adf79b5f71ca18faa234d99cf24ceb5d6da6023e4855260998d16c50d105d002645d80231aa15
+  data.tar.gz: 7abdcb827afb2cbbe428e1ac59167d98f21c07ab83046e212cd48af734cc4245f32de39f7b36741f46a740f8787e1b08c981f91dce62154070704140ff0f463c

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Build
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,57 @@
+Gemfile.lock
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+- (nothing to record here)
+
+## [0.1.0] - 2021-05-20
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubasteme.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 mnbi
+
+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,136 @@
+# Rubasteme
+
+[![Build Status](https://github.com/mnbi/rubasteme/workflows/Build/badge.svg)](https://github.com/mnbi/rubasteme/actions?query=workflow%3A"Build")
+
+Simple Abstract Syntax Tree and a parser for Scheme written in Ruby.
+
+It is intended to be used as a part of a Scheme implementation written
+in Ruby.
+
+- Rubasteme is a set of classes to represent an AST for Scheme language.
+  - Currently (in 0.1.0), it does support partially the language
+    specification of Scheme.
+- Rubasteme does not provide any features for lexical analysis.
+  - Instead, it uses `rbscmlex` to execute lexical analysis of Scheme
+    program.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubasteme'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubasteme
+
+## Usage
+
+See the directory, `examples`.  There are 2 small implementations of
+subset for Scheme language.  Though both have very limited
+capabilities as Scheme interpreter, they can execute the following
+code:
+
+``` scheme
+(define (fact n)
+  (define (fact-iter n r c)
+    (if (< n c)
+	r
+	(fact-iter n (* r c) (+ c 1))))
+  (fact-iter n 1 1))
+
+(display (fact 10))
+(display (fact 100))
+(display (fact 1000))
+```
+
+``` scheme
+(define (iota-iter result count start step)
+  (if (zero? count)
+      result
+      (iota-iter (append result (list start))
+		 (- count 1)
+		 (+ start step)
+		 step)))
+
+(define (iota count start step)
+  (iota-iter () count start step))
+
+(display (iota 10 1 1))
+(display (iota 10 1/9 11/99))
+```
+
+### How to execute
+
+1. Save the above code in a file.
+2. Run `examples/mini_rus3` or `examples/mini_sicp_scheme`
+3. Input `(load "some_file.scm")` after the prompt, then hit return key.
+
+Or, input any arbitrary expressions after the prompt.  Note that the
+current REPL does not support to input expression in multi-lines.
+Each expression must be input entirely in a single line.
+
+### mini Rus3 (`mini_rus3`)
+
+It is intended to show how to use Ruby classes of AST nodes.
+
+### SICP Scheme (`mini_sicp_scheme`)
+
+It is intended to show how to use AST nodes those are represented as
+"tagged Array."
+
+## Abstract Syntax Tree
+
+### Supported Types
+
+- empty list
+- boolean
+- identifier
+- character
+- string
+- number
+- program
+- list
+- quotation
+- procedure call
+- lambda expression
+- conditional
+- assignment
+- identifier definition
+- cond
+- and
+- or
+- when
+- unless
+- let
+- let*
+- letrec
+- letrec*
+- do
+
+## TODO
+
+- Add more documentation.
+- Implement more types.
+- Re-factor code.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/mnbi/rubasteme](https://github.com/mnbi/rubasteme).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+require "rdoc/task"
+
+RDoc::Task.new do |rdoc|
+  rdoc.generator = "ri"
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rubasteme"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/mini_rus3

@@ -0,0 +1,193 @@
+#!/usr/bin/env ruby
+
+require "rubasteme"
+
+def usage
+  puts <<HELP
+usage:
+    mini_rus3 [option]
+option:
+    -v, --version : print version
+    -h, --help    : show this message
+HELP
+end
+
+opts = {}
+while ARGV.size > 0
+  arg = ARGV.shift
+  case arg
+  when "-v", "--version"
+    puts "mini_rus3 (Rubasteme :version #{Rubasteme::VERSION} :release #{Rubasteme::RELEASE})"
+    exit 0
+  when "-h", "--help"
+    usage
+    exit 0
+  end
+end
+
+class Evaluator
+  def version
+    "(sample-evaluator :version 0.1.0 :release 2021-05-20)"
+  end
+
+  def initialize
+    @env = Kernel.binding
+    {
+      "+"  => "add",
+      "-"  => "subtract",
+      "*"  => "mul",
+      "/"  => "div",
+      "%"  => "mod",
+      "<"  => "lt?",
+      "<=" => "le?",
+      ">"  => "gt?",
+      ">=" => "ge?",
+      "==" => "eqv?",
+    }.each { |op, proc_name|
+      @env.receiver.instance_eval("def #{proc_name}(op1, op2); op1 #{op} op2; end")
+    }
+    @env.receiver.instance_eval {
+      def display(obj)
+        pp obj
+      end
+    }
+  end
+
+  def eval(ast_node)
+    rb_src =
+      case ast_node.type
+      when :ast_program
+        ast_node.map{|node| translate(node)}.join("; ")
+      else
+        translate(ast_node)
+      end
+
+    rb_eval(rb_src)
+  end
+
+  private
+
+  def rb_eval(rb_src)
+    @env.receiver.instance_eval(rb_src)
+  end
+
+  def translate(ast_node)
+    case ast_node.type
+    when :ast_empty_list
+      ast_node.literal
+    when :ast_boolean
+      (ast_node.literal[1] == "f") ? "false" : "true"
+    when :ast_identifier
+      translate_identifier(ast_node)
+    when :ast_string
+      ast_node.literal
+    when :ast_number
+      ast_node.literal
+    when :ast_procedure_call
+      translate_procedure_call(ast_node)
+    when :ast_lambda_expression
+      translate_lambda_expression(ast_node)
+    when :ast_conditional
+      translate_conditional(ast_node)
+    when :ast_identifier_definition
+      translate_identifier_definition(ast_node)
+    else
+      puts "not implemented yet to evaluate AST node type(%s)" % ast_node.type
+    end
+  end
+
+  CHAR_MAP = {
+    "-" => "_",
+    ">" => "to_",
+  }
+
+  OPERATOR_MAP = {
+    "+"  => "add",
+    "-"  => "subtract",
+    "*"  => "mul",
+    "/"  => "div",
+    "%"  => "mod",
+    "=" => "eqv?",
+    "<" => "lt?",
+    ">" => "gt?",
+    "<=" => "le?",
+    ">=" => "ge?",
+  }
+
+  def translate_identifier(ast_node)
+    id = ast_node.literal
+    return OPERATOR_MAP[id] if OPERATOR_MAP.key?(id)
+    id.gsub!(/[\->]/, CHAR_MAP) if /[\->]/ === id
+    id
+  end
+
+  def translate_procedure_call(ast_node)
+    operands = ast_node.operands.map{|e| translate(e)}.join(", ")
+    operator = translate(ast_node.operator)
+    if ast_node.operator.type == :ast_lambda_expression
+      "#{operator}.call(#{operands})"
+    else
+      "#{operator}(#{operands})"
+    end
+  end
+
+  def translate_lambda_expression(ast_node)
+    formals = ast_node.formals.map{|e| translate(e)}.join(",")
+    body = ast_node.body.map{|e| translate(e)}.join("; ")
+    "lambda{|#{formals}|#{body}}"
+  end
+
+  def translate_conditional(ast_node)
+    test = translate(ast_node.test)
+    consequent = translate(ast_node.consequent)
+    alternate = translate(ast_node.alternate) if ast_node.alternate?
+    rb_src = "if #{test}; #{consequent}"
+    rb_src += "; else; #{alternate}" if alternate
+    rb_src += "; end"
+    rb_src
+  end
+
+  def translate_identifier_definition(ast_node)
+    name = translate(ast_node.identifier)
+    if ast_node.expression.type == :ast_lambda_expression
+      node = ast_node.expression
+      formals = node.formals.map{|e| translate(e)}.join(", ")
+      body = node.body.map{|e| translate(e)}.join("; ")
+      "def #{name}(#{formals}); #{body}; end"
+    else
+      value = translate(ast_node.expression)
+      "#{name} = #{value}"
+    end
+  end
+
+end
+
+evaluator = Evaluator.new
+
+require "readline"
+
+prompt = "mini_Rus3> "
+
+msg = loop {
+  source = Readline::readline(prompt, true)
+  break "Bye!" if source.nil?
+
+  case source
+  when /\(load-scm\s+"(.*)"\)/
+    file = Regexp.last_match[1]
+    source = File.readlines(file, chomp: true).join(" ")
+  when /\(version\)/
+    puts "(Rubasteme :version #{Rubasteme::VERSION} :release #{Rubasteme::RELEASE})"
+    puts "(Rbscmlex :version #{Rbscmlex::VERSION} :release #{Rbscmlex::RELEASE})"
+    next
+  end
+
+  lexer = Rbscmlex::Lexer.new(source, form: :token)
+  parser = Rubasteme.parser(lexer)
+  ast_program = parser.parse
+
+  result = evaluator.eval(ast_program)
+
+  pp result
+}
+puts msg unless msg.nil?