skeem 0.2.14 → 0.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e35fb6742873b7c49a13e95be6143ae1a5cad7826f20aec0a02ba8dd98fa723
-  data.tar.gz: 7427071d91fa6578d37122bd953822e263f6eeba314d3d52bc5afd279052f08f
+  metadata.gz: 182cf920c536bb07dd813c34eae74af24181813a9d96fdd39c786cc28043f135
+  data.tar.gz: ba4cf5ce2df8d1708f3504e57a14b62734146f3c8a47043cf2d5ffdf591e35d6
 SHA512:
-  metadata.gz: 6f7229bba2d1cdffd83830124711b024452f82e4f3ba57219c476a4a6b07a67f3c84c13b7de2a22442f65ad82e7b414fcb429d3997047135f6e2105b2c42dece
-  data.tar.gz: 712805a13cff2128f340a0f75288ee81528e80114cac2815630e839c2e3c87c78efd5298a40bd47345edced3c597979a6be69b033db19478787da9f34a48af28
+  metadata.gz: bd03dfab05470ee167464113844c3a8b0b3174f58cd4607034f417218b91ec024e26aff941ac78e750be30ff216d18be97171b030c3f3055803443f421ad6c19
+  data.tar.gz: 2cd279dca2e9202e6a924373a01c1a49e493ea2379131284639b07977714c72df751574a8252231d15182dc6b23d55206aaa11be062502b4840a5d9a27143199

data/CHANGELOG.md

@@ -1,5 +1,22 @@
+## [0.2.15] - 2019-07-02
+- Added a basic command-line and console interface for Skeem interpreter.
+- Added procedures: `display!`, `newline`, `make-list`
+
+### Added
+- `bin/skeem` The CLI and REPL console implementation for Skeem 
+- `bin/cubic.skm`: A sample defining a procedure that computes the cube of a number.
+- `bin/hello-world.skm`: The initiatic programming example
+
+### Changed
+- File `primitive_builder.rb` Implementation of primitive procedures `newline`, `make-list`
+- File `base.skm` Added implementation of `newline` procedure.
+- File `README.md` vastly reorganized and introducing the new command line.
+
+### Removed
+- Bundler-generated files `bin/console`, `bin/setup`
+
 ## [0.2.14] - 2019-06-29
-- Added derived expression ´do´ as an imperative iteration form. 
+- Added derived expression `do` as an imperative iteration form. 
 - Added procedures: `vector-set!`
 
 ### Added

data/README.md

@@ -26,23 +26,73 @@ Or install it yourself as:
     $ gem install skeem
 
 
-The __Skeem__ project has started recently and at this stage, the gem supports  a small Scheme subset.
+The __Skeem__ project is WIP and currently the gem supports a subset of the __Scheme__ language.  
+If you're not familiar to Scheme, the section [About Scheme](#about-scheme) contains a number of interesting pointers.
 
-## About Scheme
 
-The Scheme programming language is a Lisp dialect that supports multiple paradigms, including functional programming and imperative programming.
+## Usage
+Once the gem is installed, the `skeem` executable can be used.
+It allows to run the interpreter from the command line.
 
-### Resources on Scheme  
-Here are a few pointers for the Scheme programming language:  
-- Wikipedia article on [Scheme](https://en.m.wikipedia.org/wiki/Scheme_\(programming_language\))
-- Latest official Scheme standard: [R7RS](https://bitbucket.org/cowan/r7rs-wg1-infra/src/default/R7RSHomePage.md)
-#### Online tutorials and books:
-- [The Scheme Programming Language, 4th Edition](https://www.scheme.com/tspl4/) by Kent Dybvig. A complete, introductory textbook on Scheme based on the older R5RS standard.
-- [Teach Yourself Scheme in Fixnum Days](http://ds26gte.github.io/tyscheme/index.html) by Dorai Sitaram
-- [Yet Another Scheme Tutorial](http://www.shido.info/lisp/idx_scm_e.html) by Shido Takafumi
-- [An Introduction to Scheme and its Implementation](http://www.cs.utexas.edu/ftp/garbage/cs345/schintro-v14/schintro_toc.html) by Paul R. Wilson
+### Launching a REPL session
+To start a REPL (Read-Eval-Print-Loop) session, just type:
+```
+  skeem
+```
 
-## Usage
+Skeem displays a greeting, a prompt and then waits for your input:
+```
+Welcome to Skeem 0.2.15.
+>
+```
+
+Now that we know that `Skeem` is well alive, let's kick it...
+We begin with the ritual 'Hello world' example, by typing after the __>__ prompt:
+```
+(display "Hello, world")
+```
+
+Skeem then replies:
+```
+Hello, world
+Skeem::SkmUndefined
+```
+
+This works as expected except, maybe, for the last line. It can be easily explained if one knows
+that the return value of the `display` procedure is undefined in standard Scheme.  
+Internally Skeem, implements such undefined result as a `Skeem::Undefined`instance.
+
+To give some taste of things, here is an excerpt from a REPL session:
+```
+> (+ 4 (* 5 6))
+34
+> (define x 6)
+6
+> (+ (* 5 x x) (* 4 x) 3)
+207
+> (/ 21 5)
+21/5
+> (/ 21.0 5)
+21/5
+```
+
+#### Terminating a REPL session
+To exit a REPL session, call the `exit` procedure as follows:
+```
+(exit)
+```
+
+### Running a Skeem file
+To run a Scheme file:
+
+```
+  skeem path/to/some-file.skm
+```
+
+By the way, the `/bin` folder of the `skeem` gem contains a couple of Skeem sample files.
+
+## Embed Skeem in your Ruby app
+This is the third way for Rubyists to interact with Skeem by integrating it directly in their Ruby code.
 
 ### Example 1 (Variable definition)
 
@@ -195,6 +245,51 @@ Here are a few pointers for the Scheme programming language:
 - Iteration (`do`)
 - Control procedures
 
+### Standard library
+This section lists the procedures following closely the official [Revised7 Report on the Algorithmic Language](https://bitbucket.org/cowan/r7rs/src/draft-10/rnrs/r7rs.pdf) standard.
+
+#### Equivalence predicates
+* `eqv?`, `equal?`
+
+#### Boolean procedures
+* `boolean?`, `boolean=?`, `and`, `or`,  `not`
+
+#### Character procedures
+* `char?` `char->integer`, `char=?`, `char<?`, `char>?`,`char<=?`, `char>=?`
+
+#### Numerical operations
+* Number-level: `number?`, `complex?`, `real?`, `rational?`, `integer?`, `zero?`,  
+`exact?`, `inexact?`, `exact-integer?` , `+`, `-`, `*`, `/`, `=`, `square`, `number->string`
+* Real-level: `positive?`, `negative?`, `<`, `>`, `<=`, `>=`, `abs`, `max`, `min`,  
+ `floor/`, `floor-quotient`, `floor-remainder`, `truncate/`, `truncate-quotient`,  
+`truncate-remainder`, `quotient`, `remainder`, `modulo`, `gcd`, `lcm`, `numerator`,  
+`denominator`, `floor`, `ceiling`, `truncate`, `round`
+* Integer-level: `even?`, `odd?`, `integer->char`
+
+#### List procedures
+* `list?`, `null?`, `pair?`, `append`, `car`, `cdr`, `caar`, `cadr`, `cdar`, `cddr`,  
+`cons`,  `make-list`, `length`, `list`, `list-copy`, `list->vector`, `reverse`,  
+`set-car!`, `set-cdr!`, `assq`, `assv`
+
+#### String procedures
+* `string?`, `string=?`, `string`, `make-string`, `string-append`, `string-length`, `string->symbol`
+
+#### Symbol procedures
+* `symbol?`, `symbol=?`, `symbol->string`
+
+#### Vector procedures
+* `vector?`, `make-vector`, `vector`, `vector-length`, `vector-set!`, `vector->list`
+
+#### Control procedures
+* `procedure?`, `apply`, `map`
+
+#### Input/output procedures
+* `display`, `newline`
+
+#### Non-standard procedures
+* `assert`
+
+
 ### Standard syntactic forms
 #### define  
 __Purpose:__ Create a new variable and bind an expression/value to it.  
@@ -254,56 +349,29 @@ __Purpose:__ Define one or more variable local to the block.
 __Syntax:__   
 * (let* (<binding_spec\*\>) <body\>)
 
-### Standard library
-This section lists the implemented standard procedures
-
-#### Equivalence predicates
-* `eqv?`, `equal?`
-
-#### Boolean procedures
-* `boolean?`, `boolean=?`, `and`, `or`,  `not`
-
-#### Character procedures
-* `char?` `char->integer`, `char=?`, `char<?`, `char>?`,`char<=?`, `char>=?`
-
-#### Numerical operations
-* Number-level: `number?`, `complex?`, `real?`, `rational?`, `integer?`, `zero?`, `exact?`, `inexact?`, `exact-integer?` , `+`, `-`, `*`, `/`,
-`=`, `square`, `number->string`
-* Real-level: `positive?`, `negative?`, `<`, `>`, `<=`, `>=`, `abs`, `max`, `min`,  `floor/`, `floor-quotient`, `floor-remainder`, `truncate/`, `truncate-quotient`,
-  `truncate-remainder`, `quotient`, `remainder`, `modulo`, `gcd`, `lcm`, `numerator`, `denominator`, `floor`, `ceiling`, `truncate`, `round`
-* Integer-level: `even?`, `odd?`, `integer->char`
-
-#### List procedures
-* `list?`, `null?`, `pair?`, `append`, `car`, `cdr`, `caar`, `cadr`, `cdar`, `cddr`,  `cons`,  `length`, `list`, `list-copy`, `list->vector`, `reverse`,  `set-car!`, `set-cdr!`
- , `assq`, `assv`
-
-#### String procedures
-* `string?`, `string=?`, `string`, `make-string`, `string-append`, `string-length`, `string->symbol`
 
-#### Symbol procedures
-* `symbol?`, `symbol=?`, `symbol->string`
-
-#### Vector procedures
-* `vector?`, `make-vector`, `vector`, `vector-length`, `vector-set!`, `vector->list`
-
-#### Control procedures
-* `procedure?`, `apply`, `map`
-
-#### Input/output procedures
-* `newline`
-
-#### Special procedures
-* `assert`
-
-Roadmap:
-- Extend language support
-- Implement REPL
+## Roadmap
 - Implement an equivalent of [lis.py](http://www.norvig.com/lispy.html)
 - Implement an equivalent of [lispy](http://norvig.com/lispy2.html)
 - Make it pass the test suite
 - Extend the language in order to support [Minikanren](https://github.com/TheReasonedSchemer2ndEd/CodeFromTheReasonedSchemer2ndEd)
 - Make it pass all examples from the [Reasoned Schemer](https://mitpress.mit.edu/books/reasoned-schemer-second-edition) book.
 
+## About Scheme
+
+The Scheme programming language is a Lisp dialect that supports multiple paradigms, including functional programming and imperative programming.
+
+### Resources on Scheme  
+Here are a few pointers for the Scheme programming language:  
+- Wikipedia article on [Scheme](https://en.m.wikipedia.org/wiki/Scheme_\(programming_language\))
+- Latest official Scheme standard: [R7RS](https://bitbucket.org/cowan/r7rs-wg1-infra/src/default/R7RSHomePage.md)
+#### Online tutorials and books:
+- [The Scheme Programming Language, 4th Edition](https://www.scheme.com/tspl4/) by Kent Dybvig. A complete, introductory textbook on Scheme based on the older R5RS standard.
+- [Teach Yourself Scheme in Fixnum Days](http://ds26gte.github.io/tyscheme/index.html) by Dorai Sitaram
+- [Yet Another Scheme Tutorial](http://www.shido.info/lisp/idx_scm_e.html) by Shido Takafumi
+- [An Introduction to Scheme and its Implementation](http://www.cs.utexas.edu/ftp/garbage/cs345/schintro-v14/schintro_toc.html) by Paul R. Wilson
+
+
 ## Other Scheme implementations in Ruby
 __Skeem__ isn't the sole implementation of the Scheme language in Ruby.  
 Here are a few other ones:  

data/bin/cubic.skm

@@ -0,0 +1,4 @@
+(define cubic 
+  (lambda (x)
+    (* x x x)))
+(cubic 3) ; => 27

data/bin/hello-world.skm

@@ -0,0 +1 @@
+(display "Hello, world")

data/bin/skeem

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+require 'skeem'
+
+class SkeemREPL
+  attr_reader :interpreter
+
+  def initialize()
+    @interpreter = Skeem::Interpreter.new
+  end
+
+  def run_session
+    puts "Welcome to Skeem #{Skeem::VERSION}."  
+    loop do
+      print '> '
+      input = gets.chomp.strip
+      break if input == '(quit)' || input == '(exit)'
+      process_input(input)
+    end
+  end
+
+  def run_file(aFilename)
+    if File.exist?(aFilename)
+      valid_fname = aFilename
+    else # Retry by adding extension...
+      if File.extname(aFilename).empty?
+        if File.exist?(aFilename + '.skm')
+          valid_fname = aFilename + '.skm'
+        elsif File.exist?(aFilename + '.scm')
+          valid_fname = aFilename + '.scm'
+        else
+          valid_fname = nil
+        end
+      end
+    end
+
+    raise ScriptError, "No such file -- #{aFilename}" unless valid_fname
+
+    source_code = File.read(valid_fname)
+    process_input(source_code)
+  end
+
+  def process_input(input)
+    begin
+      ptree = interpreter.parse(input)
+    rescue StandardError => exc
+      $stderr.puts exc.message
+      return
+    end
+
+    raw_result = ptree.root.evaluate(interpreter.runtime)
+    result = raw_result.kind_of?(Skeem::SkmPair) ? raw_result.last : raw_result
+    if result.kind_of?(Skeem::SkmUndefined)
+      puts "\n#{result.class}"
+    elsif result.respond_to?(:value)
+      puts result.value
+    else
+      puts result.inspect
+    end
+  end
+end # class
+
+########################################
+# Entry point
+########################################
+djinn = SkeemREPL.new
+
+if ARGV.empty?
+  djinn.run_session
+else
+  djinn.run_file(ARGV[0])
+end

data/lib/skeem/primitive/primitive_builder.rb

@@ -130,6 +130,7 @@ module Skeem
         create_cons(aRuntime)
         create_car(aRuntime)
         create_cdr(aRuntime)
+        create_make_list(aRuntime)
         create_length(aRuntime)
         create_list2vector(aRuntime)
         create_append(aRuntime)
@@ -158,7 +159,7 @@ module Skeem
       end
 
       def add_io_procedures(aRuntime)(aRuntime)
-        create_newline(aRuntime)
+        create_display(aRuntime)
       end
 
       def add_special_procedures(aRuntime)
@@ -670,12 +671,12 @@ module Skeem
       def create_make_string(aRuntime)
         primitive = ->(runtime, count_arg, arglist) do
           count = count_arg
-          check_argtype(count, SkmInteger, 'integer', 'make_string')
+          check_argtype(count, SkmInteger, 'integer', 'make-string')
           if arglist.empty?
             filler = SkmChar.create(rand(0xff).chr)
           else
             filler = arglist.first
-            check_argtype(filler, SkmChar, 'char', 'make_string')
+            check_argtype(filler, SkmChar, 'char', 'make-string')
           end
           string(filler.value.to_s * count.value)
         end
@@ -774,6 +775,22 @@ module Skeem
 
         define_primitive_proc(aRuntime, 'cons', binary, primitive)
       end
+      
+      def create_make_list(aRuntime)
+        primitive = ->(runtime, count_arg, arglist) do
+          count = count_arg
+          check_argtype(count, SkmInteger, 'integer', 'make-list')
+          if arglist.empty?
+            filler = SkmUndefined.instance
+          else
+            filler = arglist.first
+          end
+          arr = Array.new(count.value, filler)
+          SkmPair.create_from_a(arr)
+        end
+
+        define_primitive_proc(aRuntime, 'make-list', one_or_two, primitive)      
+      end
 
       def create_length(aRuntime)
         primitive = ->(_runtime, arg_evaluated) do
@@ -1093,14 +1110,15 @@ module Skeem
 
         define_primitive_proc(aRuntime, 'map', one_or_more, primitive)
       end
-
-      def create_newline(aRuntime)
-        primitive = ->(runtime) do
+      
+      def create_display(aRuntime)
+        primitive = ->(runtime, arg_evaluated) do
           # @TODO: make output stream configurable
-          print "\n"
+          print arg_evaluated.value.to_s
+          SkmUndefined.instance
         end
-
-        define_primitive_proc(aRuntime, 'newline', nullary, primitive)
+        
+        define_primitive_proc(aRuntime, 'display', unary, primitive)      
       end
 
       def create_test_assert(aRuntime)

data/lib/skeem/standard/base.skm

@@ -140,6 +140,10 @@
 
 (define symbol=? string=?)
 
+(define newline 
+  (lambda ()
+    (display #\newline)))
+
 ;; Test the equivalence (with eqv? predicate) between an expected value and
 ;; an expression
 ;; (test-eqv expected test-expr)

data/lib/skeem/version.rb

@@ -1,3 +1,3 @@
 module Skeem
-  VERSION = '0.2.14'.freeze
+  VERSION = '0.2.15'.freeze
 end

data/skeem.gemspec

@@ -16,7 +16,7 @@ module PkgExtending
       'LICENSE.txt',
       'README.md',
       'skeem.gemspec',
-      'bin/*.rb',
+      'bin/*.*',
       'lib/*.*',
       'lib/**/*.rb',
       'lib/**/*.skm',
@@ -51,6 +51,7 @@ SUMMARY
   spec.license       = 'MIT'
 
   spec.bindir = 'bin'
+  spec.executables << 'skeem'
   spec.require_paths = ['lib']
   PkgExtending.pkg_files(spec)
   PkgExtending.pkg_documentation(spec)

data/spec/skeem/interpreter_spec.rb

@@ -836,6 +836,16 @@ SKEEM
         compare_to_predicted(checks)
       end
     end # context
+    
+    context 'Input/output:' do
+      it 'should implement the newline procedure' do
+        default_stdout = $stdout
+        $stdout = StringIO.new()
+        subject.run('(newline) (newline) (newline)')
+        expect($stdout.string).to match(/\n\n\n$/)
+        $stdout = default_stdout
+      end
+    end # context
 
     context 'Second-order functions' do
       it 'should implement lambda that calls second-order function' do

data/spec/skeem/primitive/primitive_builder_spec.rb

@@ -623,6 +623,14 @@ SKEEM
           example = "(cdr '())" # => error
           expect { subject.run(example) }.to raise_error(StandardError)
         end
+        
+        it 'should implement the length procedure' do
+          example = '(make-list 2 3)'
+          result = subject.run(example)
+          expect(result).to be_list
+          expect(result.length).to eq(2)
+          expect(result.to_a).to eq([3, 3])
+        end        
 
         it 'should implement the length procedure' do
           checks = [
@@ -908,7 +916,7 @@ SKEEM
 #(0 ("Sue" "Sue") "Anna")
           result = subject.run(source)
           expect(result).to be_kind_of(SkmVector)
-          expectation = [SkmInteger.create(0), 
+          expectation = [SkmInteger.create(0),
             SkmPair.new(SkmString.create("Sue"), SkmPair.new(SkmString.create("Sue"), SkmEmptyList.instance)),
             SkmString.create("Anna") ]
           expect(result).to eq(expectation)
@@ -965,11 +973,11 @@ SKEEM
       end # context
 
       context 'IO procedures:' do
-        it 'should implement the newline procedure' do
+        it 'should implement the display procedure' do
           default_stdout = $stdout
           $stdout = StringIO.new()
-          subject.run('(newline) (newline) (newline)')
-          expect($stdout.string).to match(/\n\n\n$/)
+          subject.run('(display "Hello")')
+          expect($stdout.string).to eq('Hello')
           $stdout = default_stdout
         end
       end # context

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skeem
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.2.15
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-29 00:00:00.000000000 Z
+date: 2019-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -69,7 +69,8 @@ dependencies:
 description: "  Skeem is a Scheme language interpreter implemented in Ruby.\n"
 email:
 - famished.tiger@yahoo.com
-executables: []
+executables:
+- skeem
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -83,6 +84,9 @@ files:
 - README.md
 - Rakefile
 - appveyor.yml
+- bin/cubic.skm
+- bin/hello-world.skm
+- bin/skeem
 - lib/skeem.rb
 - lib/skeem/datum_dsl.rb
 - lib/skeem/element_visitor.rb