skeem 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e25bd8499926a963c98886effec8d51eb78bb441
-  data.tar.gz: fd5e2e65ceffbe1ce202ab1d620645d74a2e03f7
+  metadata.gz: bfe901703f31ea172032969d5a52e73a99467917
+  data.tar.gz: e9ea6993d7f4f4a107e4c43dc8e342affe103439
 SHA512:
-  metadata.gz: 181ac16e0465292fc39a1ac157e313348afcb36d83243922b7539969a3e506dbbc0e2f97d78cf41f7bcb4a728dd43d1f78477ec8ca3a468841298f61ca51c2ca
-  data.tar.gz: 8c6a36fd38ebcc92a4f208bba5be6ac9f11423a1cfb405970f40bbf141f4c70dc1fa74279365d9d6277ef68b15bf6ff40bd2903eab6c865a246b25ab1e121dbc
+  metadata.gz: 8b034f52223d95e8d40e3de77596b126484116f900a5890d7da6c9f9de56a0ed1cd08d0ac0e80d1e6b92acc17da6663f3da55eb7b01a2041512e109d3a423285
+  data.tar.gz: f315e8f48f9c97391df7a665fd01c2fc6ea4ed292bc9c075bec7332e2706a01cfe00c0aad0ea6d54fccc50e3fb84bc8afc10596a8cedc3726413d3824343baac

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.0.6] - 2018-09-01
+Initial (minimalistic) interpreter implementation.
+### Added
+- Class `Interpreter`.
+- Spec file `interpreter_spec.rb` initial test suite for the interpreter.
+
+### Changed
+- File `README.md` Udpates, sample code snippet added, link to other similar project `heist`.
+- Method `SExprTerminalNode#interpret` returns self instead of the `value` attribute.
+
+
 ## [0.0.5] - 2018-08-30
 Parser now generates correct parse trees for expressions consisting of a single literal.
 

data/README.md

@@ -25,32 +25,41 @@ Or install it yourself as:
 ## Usage
 
 The __Skeem__ project has just started.  
-At this stage, the gem consists of a tokenizer.  
-At least these steps must be done in order to have a first interpreter:
-- TODO: define subset of Scheme grammar
-- TODO: buuild parser of Scheme subset
-- TODO: Implement Skeem interpreter (and REPL)
+At this stage, the gem consists of a bare-bones interpreter.
+
+```ruby
+  require 'skeem'
+
+  schemer = Skeem::Interpreter.new
+  scheme_code = '"Hello, world"'
+  result = schemer.run(scheme_code)
+  puts result.value # => "Hello, world"
+```
 
 Roadmap:
+- Extend language support
+- Implement REPL
 - 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.
 
-TODO: Write usage instructions here
 
 Good to know:
 Online book: [The Scheme Programming Language (4th Ed.)](https://www.scheme.com/tspl4/). Remark: covers an older version of Scheme.
-  
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies.
-Then, run `rake spec` 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).
+
+## Implemented Scheme R7RS features:
+
+### Literals
+* Boolean literals: `#t`, `#true`, `#f` and `#false`
+* Numeric literals for integers and reals.
+* `string` and `identifier` literals
+
+## Other similar Ruby projects
+__Skeem__ isn't the sole implementation of the Scheme language in Ruby.  
+Here are a few other ones:  
+- [Heist gem](https://rubygems.org/gems/heist) -- Probably one of best Scheme implementation in Ruby. Really worth a try. Alas, the [project](https://github.com/jcoglan/heist) seems to be dormant for several years.
 
 ## Contributing
 

data/lib/skeem/interpreter.rb

@@ -0,0 +1,16 @@
+require_relative 'parser'
+
+module Skeem
+  class Interpreter
+    attr_reader(:parser)
+    
+    def initialize()
+    end
+    
+    def run(source)
+      @parser ||= Parser.new
+      @ptree = parser.parse(source)
+      return @ptree.root.interpret
+    end
+  end # class
+end # module

data/lib/skeem/s_expr_nodes.rb

@@ -21,7 +21,7 @@ module Skeem
     end
 
     def interpret()
-      return value
+      return self
     end
     
     def done!()

data/lib/skeem/version.rb

@@ -1,3 +1,3 @@
 module Skeem
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

data/lib/skeem.rb

@@ -3,6 +3,6 @@
 # for a Skeem client.
 
 require_relative './skeem/version'
-require_relative './skeem/parser'
+require_relative './skeem/interpreter'
 
 # End of file

data/spec/skeem/interpreter_spec.rb

@@ -0,0 +1,84 @@
+require_relative '../spec_helper' # Use the RSpec framework
+require_relative '../../lib/skeem/interpreter' # Load the class under test
+
+module Skeem
+  describe Interpreter do
+    context 'Initialization:' do
+      it 'should be initialized without argument' do
+        expect { Interpreter.new() }.not_to raise_error
+      end
+
+      it 'should not have its parser initialized' do
+        expect(subject.parser).to be_nil
+      end
+    end # context
+    
+    context 'Interpreting self-evaluating expressions' do
+      it 'should evaluate isolated booleans' do
+        samples = [
+        ['#f', false],
+        ['#false', false],
+        ['#t', true],
+        ['#true', true]
+      ]
+        samples.each do |source, predicted|
+          result = subject.run(source)
+          expect(result).to be_kind_of(SExprBooleanNode)
+          expect(result.value).to eq(predicted)
+        end
+      end      
+    end
+    
+    it 'should evaluate isolated integers' do
+        samples = [
+        ['0', 0],
+        ['3', 3],
+        ['-3', -3],
+        ['+12345', 12345],
+        ['-12345', -12345]
+      ]
+        samples.each do |source, predicted|
+          result = subject.run(source)
+          expect(result).to be_kind_of(SExprIntegerNode)
+          expect(result.value).to eq(predicted)
+        end
+      end
+      
+      it 'should evaluate isolated real numbers' do
+        samples = [
+        ['0.0', 0.0],
+        ['3.14', 3.14],
+        ['-3.14', -3.14],
+        ['+123e+45', 123e+45],
+        ['-123e-45', -123e-45]
+      ]
+        samples.each do |source, predicted|
+          result = subject.run(source)
+          expect(result).to be_kind_of(SExprRealNode)
+          expect(result.value).to eq(predicted)
+        end
+      end
+
+      it 'should evaluate isolated strings' do
+        samples = [
+        ['"Hello, world"', 'Hello, world']
+      ]
+        samples.each do |source, predicted|
+          result = subject.run(source)
+          expect(result).to be_kind_of(SExprStringNode)
+          expect(result.value).to eq(predicted)
+        end
+      end
+
+      it 'should evaluate isolated identifiers' do
+        samples = [
+        ['the-word-recursion-has-many-meanings', 'the-word-recursion-has-many-meanings']
+      ]
+        samples.each do |source, predicted|
+          result = subject.run(source)
+          expect(result).to be_kind_of(SExprIdentifierNode)
+          expect(result.value).to eq(predicted)
+        end
+      end
+  end # describe
+end # module

data/spec/skeem/parser_spec.rb

@@ -3,17 +3,16 @@ require_relative '../../lib/skeem/tokenizer' # Load the class under test
 
 module Skeem
   describe Parser do
-  
     context 'Initialization:' do
       it 'should be initialized without argument' do
         expect { Parser.new() }.not_to raise_error
       end
 
-      it 'should have its enginer initialized' do
+      it 'should have its parse engine initialized' do
         expect(subject.engine).to be_kind_of(Rley::Engine)
-      end        
+      end
     end # context
-    
+
     context 'Parsing literals:' do
       it 'should parse isolated booleans' do
         samples = [
@@ -26,9 +25,9 @@ module Skeem
           ptree = subject.parse(source)
           expect(ptree.root).to be_kind_of(SExprBooleanNode)
           expect(ptree.root.value).to eq(predicted)
-        end 
+        end
       end
-      
+
       it 'should parse isolated integers' do
         samples = [
         ['0', 0],
@@ -41,9 +40,9 @@ module Skeem
           ptree = subject.parse(source)
           expect(ptree.root).to be_kind_of(SExprIntegerNode)
           expect(ptree.root.value).to eq(predicted)
-        end 
+        end
       end
-      
+
       it 'should parse isolated real numbers' do
         samples = [
         ['0.0', 0.0],
@@ -56,7 +55,7 @@ module Skeem
           ptree = subject.parse(source)
           expect(ptree.root).to be_kind_of(SExprRealNode)
           expect(ptree.root.value).to eq(predicted)
-        end 
+        end
       end
 
       it 'should parse isolated strings' do
@@ -67,7 +66,7 @@ module Skeem
           ptree = subject.parse(source)
           expect(ptree.root).to be_kind_of(SExprStringNode)
           expect(ptree.root.value).to eq(predicted)
-        end 
+        end
       end
 
       it 'should parse isolated identifiers' do
@@ -78,11 +77,11 @@ module Skeem
           ptree = subject.parse(source)
           expect(ptree.root).to be_kind_of(SExprIdentifierNode)
           expect(ptree.root.value).to eq(predicted)
-        end 
-      end      
+        end
+      end
     end # context
 
-    context 'Parsing forms:' do    
+    context 'Parsing forms:' do
       # it 'should parse definitions' do
         # source = '(define r 10)'
         # expect { subject.parse(source) }.not_to raise_error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skeem
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -86,6 +86,7 @@ files:
 - appveyor.yml
 - lib/skeem.rb
 - lib/skeem/grammar.rb
+- lib/skeem/interpreter.rb
 - lib/skeem/parser.rb
 - lib/skeem/s_expr_builder.rb
 - lib/skeem/s_expr_nodes.rb
@@ -93,6 +94,7 @@ files:
 - lib/skeem/tokenizer.rb
 - lib/skeem/version.rb
 - skeem.gemspec
+- spec/skeem/interpreter_spec.rb
 - spec/skeem/parser_spec.rb
 - spec/skeem/tokenizer_spec.rb
 - spec/skeem_spec.rb
@@ -124,6 +126,7 @@ specification_version: 4
 summary: Skeem is an interpreter of a subset of the Scheme programming language. Scheme
   is a descendent of the Lisp language.
 test_files:
+- spec/skeem/interpreter_spec.rb
 - spec/skeem/parser_spec.rb
 - spec/skeem/tokenizer_spec.rb
 - spec/skeem_spec.rb