loxxy 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5383d6eb1725f5c53bb343e46d763f18d9d69f6b010241dbc4a93c18f949a6f
-  data.tar.gz: 286f213ab01ebec8061a9f25c86c6f28be064891880e06942a0d6d86b4210fcb
+  metadata.gz: 5db00fee0e8e7ef89a48cacc4e9ad0baf7ae5ee2cb419ba76964199bd7552199
+  data.tar.gz: ddb8e9c7ac267f32bed3f77ada05a6af38a872b5f892452a496b17522b608977
 SHA512:
-  metadata.gz: 32d447c7dbe6593ad0002ad383a917561c82da22cbf70b4102d0eaa389cf92196e03ee14ab1cc160f530b1c96a1e259db8e7923e2de81322fc854898fa306d49
-  data.tar.gz: 245d4c9e255b7bb9d8602ab103367d7f83baf516db61f5a9192945ffa689027eb9f5f7a282e7052bca6b9e904cd6f6ed956d61ea949e02b7916f100033ebd9ec
+  metadata.gz: 44e0049b0bc01e5d35bed7b91c32a7a3b977e6ba4e806439958bad2dc8aae7ead017a310c8523bd4cb628c14951946981bee42f4001d68b701159fcdaff53419
+  data.tar.gz: c90236a82f0a4872b209b8462d5f13377815fd4fc41babf256ff4894ea6900e343c6f192194e1b713cb9f8a8d2bffc326e7ea4f00726193e0a792dc9e1457e41

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - 'exp/**/*'
+    - 'demo/**/*'
 
 Layout/ArgumentAlignment:
   Enabled: false
@@ -55,6 +56,9 @@ Layout/MultilineMethodCallBraceLayout:
 
 Layout/SpaceAroundOperators:
   Enabled: true
+  
+Layout/SpaceBeforeBrackets:
+  Enabled: true
 
 Layout/SpaceInsideParens:
   Enabled: true
@@ -70,6 +74,9 @@ Layout/TrailingEmptyLines:
 
 Layout/TrailingWhitespace:
   Enabled: true
+  
+Lint/AmbiguousAssignment:
+  Enabled: true
 
 Lint/DuplicateBranch:
   Enabled: true
@@ -226,6 +233,9 @@ Style/GuardClause:
 
 Style/HashEachMethods:
   Enabled: true
+  
+Style/HashExcept:
+  Enabled: true
 
 Style/HashTransformKeys:
   Enabled: true

data/.yardopts

@@ -0,0 +1,6 @@
+--exclude examples --exclude features --exclude spec
+--no-private
+--markup markdown
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.0.5] - 2021-01-02
+- Improved example in `README.md`, code re-styling to please `Rubocop` 1.7
+
+## Changed
+- Code re-styling to please `Rubocop` 1.7
+- File `README.md` Improved example with better parse tree visualization.
+
 ## [0.0.4] - 2021-01-01
 - A first parser implementation able to parse Lox source code.
 

data/README.md

@@ -13,6 +13,8 @@ a simple language used in Bob Nystrom's online book [Crafting Interpreters](http
 - [DONE] Scanner (tokenizer)
 - [DONE] Raw parser. It parses Lox programs and generates a parse tree.
 - [TODO] Tailored parser for generating AST (Abstract Syntax Tree)
+- [TODO] Custom AST builder class  
+- [TODO] Hierarchy classes for representing Lox expressions in AST  
 - [TODO] Interpreter or transpiler
 
 
@@ -34,11 +36,45 @@ base_parser = Loxxy::FrontEnd::RawParser.new
 # Now parse the input into a concrete parse tree...
 ptree = base_parser.parse(lox_input)
 
-# Dump the parse tree contents...
-p ptree # Lengthy (unwieldy) output
+# Display the parse tree thanks to Rley formatters...
+visitor = Rley::ParseTreeVisitor.new(ptree)
+tree_formatter = Rley::Formatter::Asciitree.new($stdout)
+tree_formatter.render(visitor)
 ```
 
-Soon, the `loxxy`will host another, tailored parser, that will generate
+This is the output produced by the above example:
+```
+program
++-- declaration_star
+|   +-- declaration_star
+|   +-- declaration
+|       +-- statement
+|           +-- printStmt
+|               +-- PRINT: 'print'
+|               +-- expression
+|               |   +-- assignment
+|               |       +-- logic_or
+|               |           +-- logic_and
+|               |           |   +-- equality
+|               |           |   |   +-- comparison
+|               |           |   |   |   +-- term
+|               |           |   |   |   |   +-- factor
+|               |           |   |   |   |   |   +-- unary
+|               |           |   |   |   |   |   |   +-- call
+|               |           |   |   |   |   |   |       +-- primary
+|               |           |   |   |   |   |   |       |   +-- STRING: '"Hello, world!"'
+|               |           |   |   |   |   |   |       +-- refinement_star
+|               |           |   |   |   |   |   +-- multiplicative_star
+|               |           |   |   |   |   +-- additive_star
+|               |           |   |   |   +-- comparisonTest_star
+|               |           |   |   +-- equalityTest_star
+|               |           |   +-- conjunct_star
+|               |           +-- disjunct_star
+|               +-- SEMICOLON: ';'
++-- EOF: ''
+```
+
+Soon, the `loxxy` will host another, tailored parser, that will generate
 abstract syntax tree which much more convenient for further processing 
 (like implementing an interpreter).
 

data/lib/loxxy/datatype/builtin_datatype.rb

@@ -8,15 +8,14 @@ module Loxxy
     class BuiltinDatatype
       # @return [Object] The Ruby representation
       attr_reader :value
-      
+
       # Constructor. Initialize a Lox value from one of its built-in data type.
       def initialize(aValue)
         @value = validated_value(aValue)
       end
-      
-      
+
       protected
-      
+
       def validated_value(aValue)
         aValue
       end

data/lib/loxxy/datatype/false.rb

@@ -8,13 +8,13 @@ module Loxxy
     # Class for representing a Lox false value.
     class False < Boolean
       include Singleton # Make a singleton class
-      
+
       # Build the sole instance
       def initialize
         super(false)
       end
     end # class
-    
-    False.instance.freeze  # Make the sole instance immutable
+
+    False.instance.freeze # Make the sole instance immutable
   end # module
 end # module

data/lib/loxxy/datatype/lx_string.rb

@@ -6,12 +6,6 @@ module Loxxy
   module Datatype
     # Class for representing a Lox string of characters value.
     class LXString < BuiltinDatatype
-
-      # Build the sole instance
-      def initialize(aValue)
-        super(aValue)
-      end
-
       # Compare a Lox String with another Lox (or genuine Ruby) String
       # @param other [Datatype::LxString, String]
       # @return [Boolean]
@@ -22,7 +16,8 @@ module Loxxy
           when String
             value == other
         else
-          raise StandardError, 'Cannot compare a #{self.class} with #{other.class}'
+          err_msg = "Cannot compare a #{self.class} with #{other.class}"
+          raise StandardError, err_msg
         end
       end
 
@@ -34,8 +29,8 @@ module Loxxy
         end
 
         # Remove double quotes delimiter
-        aValue.gsub(/(^")|("$)/, '')  
+        aValue.gsub(/(^")|("$)/, '')
       end
     end # class
   end # module
-end # module
+end # module

data/lib/loxxy/datatype/nil.rb

@@ -8,13 +8,13 @@ module Loxxy
     # Class for representing a Lox nil "value".
     class Nil < BuiltinDatatype
       include Singleton # Make a singleton class
-      
+
       # Build the sole instance
       def initialize
         super(nil)
       end
     end # class
-    
-    Nil.instance.freeze  # Make the sole instance immutable
+
+    Nil.instance.freeze # Make the sole instance immutable
   end # module
 end # module

data/lib/loxxy/datatype/number.rb

@@ -6,19 +6,11 @@ module Loxxy
   module Datatype
     # Class for representing a Lox numeric value.
     class Number < BuiltinDatatype
-
-      # Build the sole instance
-      def initialize(aValue)
-        super(aValue)
-      end
-
       protected
 
       def validated_value(aValue)
         case aValue
-          when Integer
-            result = aValue
-          when Numeric
+          when Integer, Numeric
             result = aValue
           when /^-?\d+$/
             result = aValue.to_i
@@ -32,4 +24,4 @@ module Loxxy
       end
     end # class
   end # module
-end # module
+end # module

data/lib/loxxy/datatype/true.rb

@@ -8,13 +8,13 @@ module Loxxy
     # Class for representing a Lox true value.
     class True < Boolean
       include Singleton # Make a singleton class
-      
+
       # Build the sole instance
       def initialize
         super(true)
-      end      
+      end
     end # class
-    
-    True.instance.freeze  # Make the sole instance immutable
+
+    True.instance.freeze # Make the sole instance immutable
   end # module
 end # module

data/lib/loxxy/front_end/grammar.rb

@@ -131,7 +131,7 @@ module Loxxy
       rule('primary' => 'IDENTIFIER')
       rule('primary' => 'LEFT_PAREN expression RIGHT_PAREN')
       rule('primary' => 'SUPER DOT IDENTIFIER')
-      
+
       # Utility rules
       rule('function' => 'IDENTIFIER LEFT_PAREN params_opt RIGHT_PAREN block')
       rule('params_opt' => 'parameters')
@@ -142,11 +142,10 @@ module Loxxy
       rule('arguments_opt' => [])
       rule('arguments' => 'arguments COMMA expression')
       rule('arguments' => 'expression')
-      
     end
 
-  # And now build the grammar and make it accessible via a constant
-  # @return [Rley::Syntax::Grammar]
-  Grammar = builder.grammar
+    # And now build the grammar and make it accessible via a constant
+    # @return [Rley::Syntax::Grammar]
+    Grammar = builder.grammar
   end # module
 end # module

data/lib/loxxy/front_end/literal.rb

@@ -14,7 +14,7 @@ module Loxxy
       # @param theLexeme [String] the lexeme (= piece of text from input)
       # @param aTerminal [Rley::Syntax::Terminal, String]
       #   The terminal symbol corresponding to the lexeme.
-      # @param aPosition [Rley::Lexical::Position] The position of lexeme 
+      # @param aPosition [Rley::Lexical::Position] The position of lexeme
       #   in input text.
       def initialize(aValue, aLexeme, aTerminal, aPosition)
         super(aLexeme, aTerminal, aPosition)

data/lib/loxxy/front_end/raw_parser.rb

@@ -15,7 +15,7 @@ module Loxxy
     # A TerminalNode is leaf node, that is, it has no child node.
     # While concrete parse tree nodes can be generated out of the box,
     # they have the following drawbacks:
-    # - Generic node classes that aren't always suited for the needs of 
+    # - Generic node classes that aren't always suited for the needs of
     #     the language being processing.
     # - Concrete parse tree tend to be deeply nested, which may complicate
     #   further processing.
@@ -27,7 +27,6 @@ module Loxxy
         # Create a Rley facade object
         @engine = Rley::Engine.new do |cfg|
           cfg.diagnose = true
-          # cfg.repr_builder = SkmBuilder
         end
 
         # Step 1. Load Lox grammar
@@ -52,4 +51,4 @@ module Loxxy
       end
     end # class
   end # module
-end # module
+end # module

data/lib/loxxy/front_end/scanner.rb

@@ -50,7 +50,7 @@ module Loxxy
         '>' => 'GREATER',
         '>=' => 'GREATER_EQUAL',
         '<' => 'LESS',
-        '<=' => 'LESS_EQUAL',
+        '<=' => 'LESS_EQUAL'
       }.freeze
 
       # Here are all the implemented Lox keywords (in uppercase)
@@ -99,7 +99,7 @@ module Loxxy
 
         token = nil
 
-        if "(){},.;/*".include? curr_ch
+        if '(){},.;/*'.include? curr_ch
           # Single delimiter or separator character
           token = build_token(@@lexeme2name[curr_ch], scanner.getch)
         elsif (lexeme = scanner.scan(/[+\-](?!\d)/))
@@ -150,7 +150,7 @@ module Loxxy
           when 'FALSE'
             value = Datatype::False.instance
           when 'NIL'
-            value = Datatype::Nil.instance            
+            value = Datatype::Nil.instance
           when 'NUMBER'
             value = Datatype::Number.new(aLexeme)
           when 'STRING'
@@ -167,8 +167,6 @@ module Loxxy
       # Skip non-significant whitespaces and comments.
       # Advance the scanner until something significant is found.
       def skip_intertoken_spaces
-        pre_pos = scanner.pos
-
         loop do
           ws_found = scanner.skip(/[ \t\f]+/) ? true : false
           nl_found = scanner.skip(/(?:\r\n)|\r|\n/)
@@ -191,7 +189,7 @@ module Loxxy
           break unless ws_found || cmt_found
         end
 
-        curr_pos = scanner.pos
+        scanner.pos
       end
 
       def skip_block_comment

data/lib/loxxy/version.rb

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

data/loxxy.gemspec

@@ -40,8 +40,8 @@ Gem::Specification.new do |spec|
   spec.version       = Loxxy::VERSION
   spec.authors       = ['Dimitri Geshef']
   spec.email         = ['famished.tiger@yahoo.com']
-  spec.summary       = %q{An implementation of the Lox programming language. WIP}
-  spec.description   = %q{An implementation of the Lox programming language. WIP}
+  spec.summary       = 'An implementation of the Lox programming language. WIP'
+  spec.description   = 'An implementation of the Lox programming language. WIP'
   spec.homepage      = 'https://github.com/famished-tiger/loxxy'
   spec.license       = 'MIT'
   spec.required_ruby_version = '~> 2.4'

data/spec/datatype/lx_string_spec.rb

@@ -1,35 +1,35 @@
-# frozen_string_literal: true
-
-require_relative '../spec_helper' # Use the RSpec framework
-
-# Load the class under test
-require_relative '../../lib/loxxy/datatype/lx_string'
-
-module Loxxy
-  module Datatype
-    describe LXString do
-      let(:sample_text) { 'some_text' }
-      subject { LXString.new(sample_text) }
-      
-      context 'Initialization:' do
-        it 'should accept a String value at initialization' do
-          expect { LXString.new(sample_text) }.not_to raise_error
-        end
-        
-        it 'should know its value' do
-          expect(subject.value).to eq(sample_text)
-        end
-      end
-
-      context 'Provided services:' do
-        it 'compares with another string' do
-          expect(subject).to eq(sample_text)
-          expect(subject).to eq(LXString.new(sample_text.dup))
-
-          expect(subject).not_to eq('')
-          expect(subject).not_to eq('other-text')
-        end
-      end
-    end # describe
-  end # module
-end # module
+# frozen_string_literal: true
+
+require_relative '../spec_helper' # Use the RSpec framework
+
+# Load the class under test
+require_relative '../../lib/loxxy/datatype/lx_string'
+
+module Loxxy
+  module Datatype
+    describe LXString do
+      let(:sample_text) { 'some_text' }
+      subject { LXString.new(sample_text) }
+
+      context 'Initialization:' do
+        it 'should accept a String value at initialization' do
+          expect { LXString.new(sample_text) }.not_to raise_error
+        end
+
+        it 'should know its value' do
+          expect(subject.value).to eq(sample_text)
+        end
+      end
+
+      context 'Provided services:' do
+        it 'compares with another string' do
+          expect(subject).to eq(sample_text)
+          expect(subject).to eq(LXString.new(sample_text.dup))
+
+          expect(subject).not_to eq('')
+          expect(subject).not_to eq('other-text')
+        end
+      end
+    end # describe
+  end # module
+end # module

data/spec/front_end/raw_parser_spec.rb

@@ -92,8 +92,10 @@ LOX_END
           expect(leaf_node.token.value).to eq('Hello, world!')
           expect(prnt_stmt.subnodes[2]).to be_kind_of(Rley::PTree::TerminalNode)
           expect(prnt_stmt.subnodes[2].symbol.name).to eq('SEMICOLON')
+          expect(eof).to be_kind_of(Rley::PTree::TerminalNode)
+          expect(eof.symbol.name).to eq('EOF')
         end
       end
     end # describe
   end # module
-end # module
+end # module

data/spec/front_end/scanner_spec.rb

@@ -78,7 +78,7 @@ module Loxxy
         end
 
         it 'should recognize non-datatype keywords' do
-          keywords =<<-LOX_END
+          keywords = <<-LOX_END
             and class else fun for if or
             print return super this var while
 LOX_END
@@ -167,7 +167,7 @@ LOX_END
         end
 
         it 'should recognize string values' do
-          input =<<-LOX_END
+          input = <<-LOX_END
           ""
           "string"
           "123"

data/spec/loxxy_spec.rb

@@ -3,7 +3,7 @@
 require_relative '../lib/loxxy/version/'
 
 RSpec.describe Loxxy do
-  it "has a version number" do
+  it 'has a version number' do
     expect(Loxxy::VERSION).not_to be nil
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
-require "bundler/setup"
-require "loxxy"
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'loxxy'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
+  config.example_status_persistence_file_path = '.rspec_status'
 
   config.expect_with :rspec do |c|
     # Disable the `should` syntax

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loxxy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-01 00:00:00.000000000 Z
+date: 2021-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -77,6 +77,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt