loxxy 0.2.01 → 0.2.02

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3137f0d16bb2c3dbbc4e2036abbf45888ba06b863fef69a8682898ffdb2a146b
-  data.tar.gz: 344ff5f99e7d64dd45074aaacde5622ecb676d8d3112773555b0fbcffbd5aa89
+  metadata.gz: afc822710c5023cdffd8eeb9e9316736f2b2d9ddb2d05e4c4e835dee9b9b4d8b
+  data.tar.gz: 5debd7264833555cc34c64586de96d4e811eef4ebebe25f6c42a0832dee8e433
 SHA512:
-  metadata.gz: f3cd447081d53619afeb040d9eade7fab0c0d5db79b8407fba412df727fb72849e5671679d7fd13fded703b9009399febfac6506ef91ac0bdd3220ef26472408
-  data.tar.gz: 4a83b84a9853787369d51f48d7c2eacfe8a7e58b4ab8cb5d5322b02e0a5de68c4481effa61587db70f066902d21c7b2a310509de74d13f2cf1476a490e2728a7
+  metadata.gz: d988772978387faa28692101e6b2dab580a93b6f5738ad9094faf22d8aed78aca68123982ff0a25d9b9029d4d27ef4f82788009b10942a14ce5dd9bd9f1e37a7
+  data.tar.gz: 711b3188b0dd14a9821eee5227ee0d574c60144b7be88a3f722d10b4506556fa864685659c7493acfd6d63c2cf82f8c0c6c36cc0431a57a2d476efe3b4bf7efd

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.2.02] - 2021-04-21
+- Improvements in the scanner class (escape sequence for quotes and newlines), error messages closer to jlox.
+
+### Changed
+- File `loxxy` executable doesn't show a stack trace for scanner errors
+- Class `ScannerError` is now a subclass of `Loxxy::Error`
+- Class `Scanner` now returns a specific error message for unterminated strings
+- Class `Scanner` error messages are closer to the ones from jlox
+- Class `Scanner` supports now escape sequences \" for double quotes, \n for newlines
+- File `README.md` Reshuffled some text
+
 ## [0.2.01] - 2021-04-18
 - Minor improvements in CLI, starting re-documenting `README.md`.
 

data/README.md

@@ -3,7 +3,7 @@
 [![Build status](https://ci.appveyor.com/api/projects/status/8e5p7dgjanm0qjkp?svg=true)](https://ci.appveyor.com/project/famished-tiger/loxxy)
 [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/famished-tiger/loxxy/blob/main/LICENSE.txt)
 
-### What is loxxy?
+## What is loxxy?
 A Ruby implementation of the [Lox programming language](https://craftinginterpreters.com/the-lox-language.html ),
 a simple language defined in Bob Nystrom's excellent online book [Crafting Interpreters](https://craftinginterpreters.com/ ).
 
@@ -16,6 +16,14 @@ Although __Lox__ is fairly simple, it is far from being a toy language:
 - Functions and closures
 - Object-orientation (classes, methods, inheritance).
 
+### Loxxy gem features
+- Complete tree-walking interpreter including lexer, parser and resolver
+- 100% pure Ruby with clean design (not a port from some other language)
+- Minimal runtime dependency (Rley gem). Won't drag a bunch of gems...  
+- Ruby API for integrating a Lox interpreter with your code.
+- A command-line interpreter `loxxy`
+- Open for your language extensions
+
 ## How to start in 1, 2, 3...?
 ... in less than 3 minutes...
 
@@ -42,10 +50,11 @@ Lo and behold! The output device displays the famous greeting:
     Hello, world.
  
 
-Congrats! You ran your first `Lox` program with __Loxxy__.
+Congrats! You ran your first `Lox` program thanks __Loxxy__ gem. 
+For a less superficial encounter with the language jump to the next section.
 
-### Something beefier?...
-Let's admit it, the hello world example was unimpressive. 
+## So you want something beefier?...
+Let's admit it, the hello world example was unimpressive.   
 To a get a taste of `Lox` object-oriented capabilities, let's try another `Hello world` variant:
 
 ```javascript
@@ -172,12 +181,6 @@ Indeed, an open-source language that misses some features is an invitation for t
 There are already a number of programming languages derived from `Lox`...
 
 ## Why `Loxxy`? What's in it for me?...
-Features:
-- Complete tree-walking interpreter including lexer, parser and resolver
-- 100% pure Ruby with clean design (not a port from some other language)
-- Ruby API for integrating a Lox interpreter with your code.
-- Minimal runtime dependency (Rley gem). Won't drag a bunch of gems...
-
 
 ### Purpose of this project:
 - To deliver an open source example of a programming language fully implemented in Ruby  

data/bin/loxxy

@@ -17,11 +17,15 @@ class LoxxyRunner
     return if file_names.nil? || file_names.empty?
 
     lox = Loxxy::Interpreter.new
-    file_names.each do |lox_file|
-      fname = validate_filename(lox_file)
-      next unless file_exist?(fname)
-
-      File.open(fname, 'r') { |f| lox.evaluate(f.read) }
+    begin
+      file_names.each do |lox_file|
+        fname = validate_filename(lox_file)
+        next unless file_exist?(fname)
+
+        File.open(fname, 'r') { |f| lox.evaluate(f.read) }
+      end
+    rescue Loxxy::ScanError => e
+      $stderr.puts e.message
     end
   end
 

data/lib/loxxy/error.rb

@@ -7,6 +7,9 @@ module Loxxy
   # Error occurring while Loxxy executes some invalid Lox code.
   class RuntimeError < Error; end
 
+  # Error occurring while Loxxy scans invalid input.
+  class ScanError < Error; end
+
   # Error occurring while Loxxy parses some invalid Lox code.
   class SyntaxError < Error; end
 end

data/lib/loxxy/front_end/scanner.rb

@@ -2,6 +2,7 @@
 
 require 'strscan'
 require 'rley'
+require_relative '../error'
 require_relative '../datatype/all_datatypes'
 require_relative 'literal'
 
@@ -60,8 +61,6 @@ module Loxxy
         PRINT RETURN SUPER THIS TRUE VAR WHILE
       ].map { |x| [x, x] }.to_h
 
-      class ScanError < StandardError; end
-
       # Constructor. Initialize a tokenizer for Lox input.
       # @param source [String] Lox text to tokenize.
       def initialize(source = nil)
@@ -117,11 +116,14 @@ module Loxxy
           keyw = @@keywords[lexeme.upcase]
           tok_type = keyw || 'IDENTIFIER'
           token = build_token(tok_type, lexeme)
+        elsif scanner.scan(/"(?:\\"|[^"])*\z/)
+          # Error: unterminated string...
+          col = scanner.pos - @line_start + 1
+          raise ScanError, "Error: [line #{lineno}:#{col}]: Unterminated string."
         else # Unknown token
-          erroneous = curr_ch.nil? ? '' : scanner.scan(/./)
-          sequel = scanner.scan(/.{1,20}/)
-          erroneous += sequel unless sequel.nil?
-          raise ScanError, "Unknown token #{erroneous} on line #{lineno}"
+          col = scanner.pos - @line_start + 1
+          _erroneous = curr_ch.nil? ? '' : scanner.scan(/./)
+          raise ScanError, "Error: [line #{lineno}:#{col}]: Unexpected character."
         end
 
         return token
@@ -156,7 +158,7 @@ module Loxxy
           when 'NUMBER'
             value = Datatype::Number.new(aLexeme)
           when 'STRING'
-            value = Datatype::LXString.new(aLexeme)
+            value = Datatype::LXString.new(unescape_string(aLexeme))
           when 'TRUE'
             value = Datatype::True.instance
           else
@@ -166,6 +168,29 @@ module Loxxy
         return [value, symb]
       end
 
+      # Replace any sequence sequence by their "real" value.
+      def unescape_string(aText)
+        result = +''
+        previous = nil
+
+        aText.each_char do |ch|
+          if previous
+            if ch == ?n
+              result << "\n"
+            else
+              result << ch
+            end
+            previous = nil
+          elsif ch == '\\'
+            previous = ?\
+          else
+            result << ch
+          end
+        end
+
+        result
+      end
+
       # Skip non-significant whitespaces and comments.
       # Advance the scanner until something significant is found.
       def skip_intertoken_spaces

data/lib/loxxy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loxxy
-  VERSION = '0.2.01'
+  VERSION = '0.2.02'
 end

data/spec/front_end/scanner_spec.rb

@@ -189,6 +189,26 @@ LOX_END
           end
         end
 
+        it 'should recognize escaped quotes' do
+          embedded_quotes = %q{she said: \"Hello\"}
+          result = subject.send(:unescape_string, embedded_quotes)
+          expect(result).to eq('she said: "Hello"')
+        end
+
+        it 'should recognize escaped backslash' do
+          embedded_backslash = 'backslash>\\\\'
+          result = subject.send(:unescape_string, embedded_backslash)
+          expect(result).to eq('backslash>\\')
+        end
+
+        # rubocop: disable Style/StringConcatenation
+        it 'should recognize newline escape sequence' do
+          embedded_newline = 'line1\\nline2'
+          result = subject.send(:unescape_string, embedded_newline)
+          expect(result).to eq('line1' + "\n" + 'line2')
+        end
+        # rubocop: enable Style/StringConcatenation
+
         it 'should recognize a nil token' do
           subject.start_with('nil')
           token_nil = subject.tokens[0]
@@ -237,6 +257,20 @@ LOX_END
           ]
           match_expectations(subject, expectations)
         end
+
+        it 'should complain if it finds an unterminated string' do
+          subject.start_with('var a = "Unfinished;')
+          err = Loxxy::ScanError
+          err_msg = 'Error: [line 1:21]: Unterminated string.'
+          expect { subject.tokens }.to raise_error(err, err_msg)
+        end
+
+        it 'should complain if it finds an unexpected character' do
+          subject.start_with('var a = ?1?;')
+          err = Loxxy::ScanError
+          err_msg = 'Error: [line 1:9]: Unexpected character.'
+          expect { subject.tokens }.to raise_error(err, err_msg)
+        end
       end # context
     end # describe
   end # module

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loxxy
 version: !ruby/object:Gem::Version
-  version: 0.2.01
+  version: 0.2.02
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley