rus3 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a733b3f40b0fb9223d58d5293f08f68cbc404dbea10df196e92d15e47453a9b6
+  data.tar.gz: 20749c1d7410e925577b76fdca4ecf92ffc0c1ff4aef5d894079548c324f84ed
+SHA512:
+  metadata.gz: 5350b2341a176d7844910acb888faeae61c499659471148c9370deaad7ba2192e346a5d7e8a03cc3799540c2fe372feabc925cb8f8bdfd94e34dcaad01a36247
+  data.tar.gz: 2aab5a0555331938bc986d418dcb18e0d116be078088846bdad73aebc520ae8bda7b1b334f5ec26dc78bfb5ffe814ff380d1fc9eb9072ad027f4b8539f4fb3ed

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.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,56 @@
+*.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,14 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+- Add `CHANGELOG.md`. (2021-04-04)
+- Modify some files to pass tests. (2021-04-04)
+- Add files those are generated by `bundler`. (2021-04-04)
+
+## [0.1.0] - 2021-04-21
+- Initial release:
+  - Rus3 can translate fundamental syntax of Scheme into Ruby.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    rus3 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.4)
+    rake (13.0.3)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rus3!
+
+BUNDLED WITH
+   2.2.15

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,182 @@
+# Rus^3
+
+[![Build Status](https://github.com/mnbi/rus3/workflows/Build/badge.svg)](https://github.com/mnbi/rus3/actions?query=workflow%3A"Build")
+
+Ruby with Syntax Sugar of Scheme.
+Or a simple translator from Scheme program to Ruby.
+
+## Installation
+
+Execute as:
+
+    > gem install rus3
+
+## Usage
+
+You can start the Rus3 REPL with the command, `rus3`.
+
+``` scheme
+> rus3
+A simple REPL for Rus3:
+- Rus3 version: 0.1.0
+  - REPL version: 0.1.0
+    - Parser version 0.1.0 ((scheme-parser-version . 0.1.0) (scheme-lexer-version . 0.1.0))
+    - Evaluator version: 0.1.0
+    - using built-in PRINTER
+Rus3(scheme)>
+```
+
+`Rus3(scheme)>` is the prompt of the Rus3.
+
+In the REPL, you can enter Scheme expressions.  The REPL reads your
+Scheme expressions, translates it to Ruby expressions, and
+evaluated them.  Then, the REPL prints the result after `==> `.
+
+### Literal of Scheme values
+
+Boolean (`#f` and `#t`), an empty list (`()`), a string, and numbers
+(integer, real, rational and complex) can be translated.
+
+``` scheme
+Rus3(scheme)> #f
+==> false
+Rus3(scheme)> #t
+==> true
+Rus3(scheme)> ()
+==> []
+Rus3(scheme)> "foo"
+==> "foo"
+Rus3(scheme)> 123.456
+==> 123.456
+Rus3(scheme)> 1/9
+==> (1/9)
+Rus3(scheme)> 3+4i
+==> (3+4i)
+```
+
+### Procedure call
+
+You can apply a defined procedure.
+
+``` scheme
+Rus3(scheme)> (list 1 2 3)
+==> [1, 2, 3]
+Rus3(scheme)> (append (list 1 2 3) (list 4 5 6))
+==> [1, 2, 3, 4, 5, 6]
+```
+
+### Lambda expression
+
+You can apply lambda expression as a procedure.
+
+``` scheme
+Rus3(scheme)> ((lambda (x) (* x x)) 2)
+==> 4
+```
+
+### Conditional expression
+
+``` scheme
+Rus3(scheme)> (if (< 2 3) "true" "false")
+==> "true"
+```
+
+`cond` type is also available.
+
+### Assignment
+
+``` scheme
+Rus3(scheme)> (set! x 2)
+==> 2
+Rus3(scheme)> x
+==> 2
+```
+
+### Define a procedure
+
+``` scheme
+Rus3(scheme)> (define (fact n) (if (= n 0) 1 (* n (fact (- n 1)))))
+==> :fact
+Rus3(scheme)> (fact 5)
+==> 120
+```
+
+### Let expression
+
+``` scheme
+Rus3(scheme)> (let ((x 2) (y 3)) (* x y))
+==> 6
+```
+
+## Procedures in the Scheme specification (R5RS or R7RS-small)
+
+Following procedures described in the spec is available.
+
+- Predicates:
+  - null?, list?
+  - eqv?, eq?
+  - boolean?, pair?, symbol?, number?, string?
+    - char?, vector?, and port? are defined but it always returns `false`.
+  - complex?, real?, rational?, integer?
+  - zero?, positive?, negative?, odd?, even?
+  - string-eq?, string-ci-eq?, string-lt?, string-gt?, string-le?,
+    string-ge?, string-ci-lt?, string-ci-gt?, string-ci-le?, string-ci-ge?
+  - some predicates for `char` and `port` are defined but it always
+    returns `false`.
+
+- List operations
+  - cons, car, cdr, set-car!, set-cdr!, cxxr (caar and so on)
+  - list, length, append, reverse, list-tail, list-ref
+
+- Write values
+  - write
+  - display
+
+- Control features
+  - map
+  - zip
+
+## System interface
+
+### Load-scm procedure
+
+Reads a Scheme program file, then translates and evaluates.
+
+``` scheme
+Rus3(scheme)> (load-scm "examples/iota.scm")
+(1 2 3 4 5 6 7 8 9 10)
+(1/9 2/9 1/3 4/9 5/9 2/3 7/9 8/9 1/1 10/9)
+==> #<Rus3::Undef:0x00007f90f8945418>
+```
+
+## Restrictions
+
+In the current version, there are several restrictions, those are
+deviations from the Scheme specification (R5RS or R7RS-small).
+
+- `Equal?` does not defined.  Since `Object#equal?` must not re-define
+  in Ruby.
+- `Cdr` and `list-tail` do not return a reference of the part of the
+  target list.  They return a new list structure which contains the
+  same member of the target list.
+- Rus3 would replace some character which can not use as a part of
+  identifier in Ruby.  So, it is possible that some collision of
+  identifiers.
+- Nested definition of procedure can use outside.
+
+Some of these may be disappeared in the future version, or may not be.
+
+## 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/rus3](https://github.com/mnbi/rus3).
+
+
+## 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,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+require "rus3"
+
+# 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/fact.scm

@@ -0,0 +1,10 @@
+(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))

data/examples/fib.scm

@@ -0,0 +1,9 @@
+(define (fib-iter n f0 f1)
+  (cond ((= n 0) f0)
+ 	((= n 1) f1)
+ 	(else (fib-iter (- n 1) f1 (+ f0 f1)))))
+
+(define (fib n)
+  (fib-iter n 0 1))
+
+(fib 100)

data/examples/iota.scm

@@ -0,0 +1,13 @@
+(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))

data/exe/rus3

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "rus3"
+
+Rus3::Repl.start(verbose: ARGV.size > 0)

data/lib/rus3.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rus3
+
+  # An empty list is a special object in Scheme language.  The role
+  # roughly corresponds to the one of 'nil' in Ruby.
+
+  module EmptyList
+
+    # Represents an empty list.
+    EMPTY_LIST = []
+
+    # Returns true if the argument is an empty list.  RuS^3 treats nil
+    # (an instance of NilClass) as an empty list.
+
+    def null?(obj)
+      obj.instance_of?(Array) and obj.empty?
+    end
+
+  end
+
+  # Indicates the values is not specified in the Scheme specification.
+  # This value is intended using to be returned from procedures those
+  # does not have any specified value as its return value.
+
+  require "singleton"
+  class Undef
+    include Singleton
+
+    def to_s
+      "\#<undef>"
+    end
+  end
+  UNDEF = Undef.instance
+
+  require_relative "rus3/version"
+  require_relative "rus3/error"
+
+  require_relative "rus3/pair"
+  require_relative "rus3/char"
+  require_relative "rus3/port"
+
+  require_relative "rus3/procedure/predicate"
+  require_relative "rus3/procedure/list"
+  require_relative "rus3/procedure/control"
+  require_relative "rus3/procedure/write"
+
+  require_relative "rus3/parser"
+  require_relative "rus3/evaluator"
+  require_relative "rus3/printer"
+  require_relative "rus3/repl"
+end