loxxy 0.2.02 → 0.2.03

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc822710c5023cdffd8eeb9e9316736f2b2d9ddb2d05e4c4e835dee9b9b4d8b
-  data.tar.gz: 5debd7264833555cc34c64586de96d4e811eef4ebebe25f6c42a0832dee8e433
+  metadata.gz: eb84858746525e4b5f6821e8168066f4af75b639e8320710cd36213ac72a65ed
+  data.tar.gz: 6ef7b9c8edcfdd1cda3aadfedeff6fef99c1194e92782c3dfe1b1abcc8052e96
 SHA512:
-  metadata.gz: d988772978387faa28692101e6b2dab580a93b6f5738ad9094faf22d8aed78aca68123982ff0a25d9b9029d4d27ef4f82788009b10942a14ce5dd9bd9f1e37a7
-  data.tar.gz: 711b3188b0dd14a9821eee5227ee0d574c60144b7be88a3f722d10b4506556fa864685659c7493acfd6d63c2cf82f8c0c6c36cc0431a57a2d476efe3b4bf7efd
+  metadata.gz: 901731bc9670cab315c53e864430636c14c70b9c15d2218d81ae5657b40e5261b79d7ae7ff7937a638931a0c89af8d75f99a65973dd4cbd9a3418588f6388e87
+  data.tar.gz: fdedef4073b56af0e5bd2f348b15149dd80ab96d8814b5f0f114529372594ae661203509306603b6be8773976f577aaf73466d6a778a4596f11fd0d383c88dd6

data/README.md

@@ -22,17 +22,28 @@ Although __Lox__ is fairly simple, it is far from being a toy 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
+- Open for your language extensions...
 
 ## How to start in 1, 2, 3...?
 ... in less than 3 minutes...
 
 ### 1. Installing
-Install __Loxxy__ as a gem:
+__Loxxy__'s  installation is pretty standard:
 
 
     $ gem install loxxy
 
+Alternatively, you can install `loxxy` with Bundler.  
+Add this line to your application's Gemfile:
+
+    gem 'loxxy'
+
+And then execute:
+
+    $ bundle
+
+
+
 ### 2. Your first `Lox`  program
 Create a text file and enter the following lines:
 ```javascript

data/lib/loxxy/ast/ast_visitee.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Loxxy
+  module Ast
+    # Mix-in module that relies on meta-programming to add a method
+    # called `accept` to the host class (an AST node).
+    # That method fulfills the expected behavior of the `visitee` in
+    # the Visitor design pattern.
+    module ASTVisitee
+      # Convert the input string into a snake case string.
+      # Example: ClassExpr => class_expr
+      # @param aName [String] input name to convert
+      # @return [String] the name converted into snake case
+      def snake_case(aName)
+        converted = +''
+        down = false
+        aName.each_char do |ch|
+          lower = ch.downcase
+          if lower == ch
+            converted << ch
+            down = true
+          else
+            converted << '_' if down && converted[-1] != '_'
+            converted << lower
+            down = false
+          end
+        end
+
+        converted
+      end
+
+      # This method adds a method named `accept` that takes a visitor
+      # The visitor is expected to implement a method named:
+      # visit + class name (without the Lox prefix) in snake case
+      # Example: class name = LoxClassStmt => visit method = visit_class_stmt
+      def define_accept
+        return if instance_methods(false).include?(:accept)
+
+        base_name = name.split('::').last
+        name_suffix = snake_case(base_name).sub(/^lox/, '')
+        accept_body = <<-MTH_END
+          # Part of the 'visitee' role in Visitor design pattern.
+          # @param visitor [Ast::ASTVisitor] the visitor
+          def accept(aVisitor)
+            aVisitor.visit#{name_suffix}(self)
+          end
+        MTH_END
+
+        class_eval(accept_body)
+      end
+    end # module
+  end # module
+end # module

data/lib/loxxy/ast/ast_visitor.rb

@@ -133,7 +133,7 @@ module Loxxy
 
       # @param aSetExpr [AST::LOXGetExpr] the get expression node to visit
       def visit_set_expr(aSetExpr)
-        broadcast(:before_set_expr, aSetExpr)
+        broadcast(:before_set_expr, aSetExpr, self)
         traverse_subnodes(aSetExpr)
         broadcast(:after_set_expr, aSetExpr, self)
       end

data/lib/loxxy/ast/lox_assign_expr.rb

@@ -17,11 +17,7 @@ module Loxxy
         @name = aName
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_assign_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_binary_expr.rb

@@ -16,12 +16,7 @@ module Loxxy
         @operator = anOperator
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_binary_expr(self)
-      end
-
+      define_accept # Add `accept` method as found in Visitor design pattern
       alias operands subnodes
     end # class
   end # module

data/lib/loxxy/ast/lox_block_stmt.rb

@@ -15,11 +15,7 @@ module Loxxy
         subnodes.size == 1 && subnodes[0].nil?
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_block_stmt(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_call_expr.rb

@@ -15,11 +15,7 @@ module Loxxy
         @arguments = argList
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_call_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_class_stmt.rb

@@ -24,11 +24,7 @@ module Loxxy
         @body = theMethods
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_class_stmt(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_for_stmt.rb

@@ -25,17 +25,13 @@ module Loxxy
         @update_expr = updateExpr
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_for_stmt(self)
-      end
-
       # Accessor to the condition expression
       # @return [LoxNode]
       def condition
         subnodes[0]
       end
+
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_fun_stmt.rb

@@ -23,11 +23,7 @@ module Loxxy
         @is_method = false
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_fun_stmt(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
     # rubocop: enable Style/AccessorGrouping
   end # module

data/lib/loxxy/ast/lox_get_expr.rb

@@ -18,12 +18,7 @@ module Loxxy
         @property = aPropertyName
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_get_expr(self)
-      end
-
+      define_accept # Add `accept` method as found in Visitor design pattern
       alias callee= object=
     end # class
   end # module

data/lib/loxxy/ast/lox_grouping_expr.rb

@@ -11,11 +11,7 @@ module Loxxy
         super(aPosition, [subExpr])
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_grouping_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_if_stmt.rb

@@ -21,17 +21,13 @@ module Loxxy
         @else_stmt = elseStmt
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_if_stmt(self)
-      end
-
       # Accessor to the condition expression
       # @return [LoxNode]
       def condition
         subnodes[0]
       end
+
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_literal_expr.rb

@@ -15,11 +15,7 @@ module Loxxy
         @literal = aLiteral
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_literal_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_logical_expr.rb

@@ -16,12 +16,7 @@ module Loxxy
         @operator = anOperator
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_logical_expr(self)
-      end
-
+      define_accept # Add `accept` method as found in Visitor design pattern
       alias operands subnodes
     end # class
   end # module

data/lib/loxxy/ast/lox_node.rb

@@ -1,8 +1,16 @@
 # frozen_string_literal: true
 
+require_relative 'ast_visitee'
+
 module Loxxy
   module Ast
+    # Abstract class.
+    # Instances of its subclasses represent nodes of an abstract syntax tree
+    # that is the product of the parse of an input text.
     class LoxNode
+      # Let nodes take `visitee` role as defined in the Visitor design pattern
+      extend ASTVisitee
+
       # return [Rley::Lexical::Position] Position of the entry in the input stream.
       attr_reader :position
 
@@ -16,7 +24,7 @@ module Loxxy
         # Default: do nothing ...
       end
 
-      # Abstract method.
+      # Abstract method (must be overriden in subclasses).
       # Part of the 'visitee' role in Visitor design pattern.
       # @param _visitor [LoxxyTreeVisitor] the visitor
       def accept(_visitor)

data/lib/loxxy/ast/lox_print_stmt.rb

@@ -11,11 +11,7 @@ module Loxxy
         super(aPosition, [anExpression])
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_print_stmt(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_return_stmt.rb

@@ -12,11 +12,7 @@ module Loxxy
         super(aPosition, [expr])
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_return_stmt(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_seq_decl.rb

@@ -5,11 +5,7 @@ require_relative 'lox_compound_expr'
 module Loxxy
   module Ast
     class LoxSeqDecl < LoxCompoundExpr
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_seq_decl(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_set_expr.rb

@@ -18,11 +18,7 @@ module Loxxy
         @object = anObject
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_set_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_super_expr.rb

@@ -18,17 +18,13 @@ module Loxxy
         @property = aMethodName
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_super_expr(self)
-      end
-
       # Quack like a LoxVariableExpr
       # @return [String] the `super` keyword
       def name
         'super'
       end
+
+      define_accept # Add `accept` method as found in Visitor design pattern
       alias callee= object=
     end # class
   end # module

data/lib/loxxy/ast/lox_this_expr.rb

@@ -12,11 +12,7 @@ module Loxxy
         'this'
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param _visitor [LoxxyTreeVisitor] the visitor
-      def accept(aVisitor)
-        aVisitor.visit_this_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_unary_expr.rb

@@ -15,12 +15,7 @@ module Loxxy
         @operator = anOperator
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_unary_expr(self)
-      end
-
+      define_accept # Add `accept` method as found in Visitor design pattern
       alias operands subnodes
     end # class
   end # module

data/lib/loxxy/ast/lox_var_stmt.rb

@@ -18,11 +18,7 @@ module Loxxy
         @name = aName
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_var_stmt(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_variable_expr.rb

@@ -16,11 +16,7 @@ module Loxxy
         @name = aName
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_variable_expr(self)
-      end
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/ast/lox_while_stmt.rb

@@ -16,17 +16,13 @@ module Loxxy
         @body = theBody
       end
 
-      # Part of the 'visitee' role in Visitor design pattern.
-      # @param visitor [Ast::ASTVisitor] the visitor
-      def accept(visitor)
-        visitor.visit_while_stmt(self)
-      end
-
       # Accessor to the condition expression
       # @return [LoxNode]
       def condition
         subnodes[0]
       end
+
+      define_accept # Add `accept` method as found in Visitor design pattern
     end # class
   end # module
 end # module

data/lib/loxxy/back_end/engine.rb

@@ -176,16 +176,20 @@ module Loxxy
         variable.assign(value)
       end
 
-      def after_set_expr(aSetExpr, aVisitor)
-        value = stack.pop
-        # Evaluate object part
+      def before_set_expr(aSetExpr, aVisitor)
+        # Evaluate receiver object part
         aSetExpr.object.accept(aVisitor)
+      end
+
+      def after_set_expr(aSetExpr, _visitor)
+        value = stack.pop
         assignee = stack.pop
         unless assignee.kind_of?(LoxInstance)
-          raise StandardError, 'Only instances have fields.'
+          raise Loxxy::RuntimeError, 'Only instances have fields.'
         end
 
         assignee.set(aSetExpr.property, value)
+        stack.push value
       end
 
       def after_logical_expr(aLogicalExpr, visitor)
@@ -272,7 +276,7 @@ module Loxxy
         aGetExpr.object.accept(aVisitor)
         instance = stack.pop
         unless instance.kind_of?(LoxInstance)
-          raise StandardError, 'Only instances have properties.'
+          raise Loxxy::RuntimeError, 'Only instances have properties.'
         end
 
         stack.push instance.get(aGetExpr.property)
@@ -285,7 +289,7 @@ module Loxxy
       def after_variable_expr(aVarExpr, aVisitor)
         var_name = aVarExpr.name
         var = variable_lookup(aVarExpr)
-        raise StandardError, "Undefined variable '#{var_name}'." unless var
+        raise Loxxy::RuntimeError, "Undefined variable '#{var_name}'." unless var
 
         var.value.accept(aVisitor) # Evaluate variable value then push on stack
       end

data/lib/loxxy/back_end/lox_instance.rb

@@ -38,7 +38,7 @@ module Loxxy
 
         method = klass.find_method(aName)
         unless method
-          raise StandardError, "Undefined property '#{aName}'."
+          raise Loxxy::RuntimeError, "Undefined property '#{aName}'."
         end
 
         method.bind(self)

data/lib/loxxy/version.rb

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

data/spec/interpreter_spec.rb

@@ -480,6 +480,18 @@ LOX_END
         snippet
       end
 
+      it 'should support field assignment expression' do
+        program = <<-LOX_END
+          class Foo {}
+
+          var foo = Foo();
+
+          print foo.bar = "bar value"; // expect: bar value
+        LOX_END
+        expect { subject.evaluate(program) }.not_to raise_error
+        expect(sample_cfg[:ostream].string).to eq('bar value')
+      end
+
       it 'should support class declaration' do
         program = <<-LOX_END
           #{duck_class}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loxxy
 version: !ruby/object:Gem::Version
-  version: 0.2.02
+  version: 0.2.03
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -91,6 +91,7 @@ files:
 - lib/loxxy.rb
 - lib/loxxy/ast/all_lox_nodes.rb
 - lib/loxxy/ast/ast_builder.rb
+- lib/loxxy/ast/ast_visitee.rb
 - lib/loxxy/ast/ast_visitor.rb
 - lib/loxxy/ast/lox_assign_expr.rb
 - lib/loxxy/ast/lox_binary_expr.rb