yarp 0.7.0 → 0.9.0

data/config.yml

@@ -527,7 +527,7 @@ nodes:
       - name: parameters
         type: node?
         kind: BlockParametersNode
-      - name: statements
+      - name: body
         type: node?
       - name: opening_loc
         type: location
@@ -714,16 +714,18 @@ nodes:
         type: location?
       - name: superclass
         type: node?
-      - name: statements
+      - name: body
         type: node?
       - name: end_keyword_loc
         type: location
+      - name: name
+        type: string
     comment: |
       Represents a class declaration involving the `class` keyword.
 
           class Foo end
           ^^^^^^^^^^^^^
-  - name: ClassVariableOperatorAndWriteNode
+  - name: ClassVariableAndWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -736,7 +738,7 @@ nodes:
 
           @@target &&= value
           ^^^^^^^^^^^^^^^^
-  - name: ClassVariableOperatorOrWriteNode
+  - name: ClassVariableOperatorWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -744,12 +746,14 @@ nodes:
         type: location
       - name: value
         type: node
+      - name: operator
+        type: constant
     comment: |
-      Represents the use of the `||=` operator for assignment to a class variable.
+      Represents assigning to a class variable using an operator that isn't `=`.
 
-          @@target ||= value
-          ^^^^^^^^^^^^^^^^^^
-  - name: ClassVariableOperatorWriteNode
+          @@target += value
+          ^^^^^^^^^^^^^^^^^
+  - name: ClassVariableOrWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -757,19 +761,23 @@ nodes:
         type: location
       - name: value
         type: node
-      - name: operator
-        type: constant
     comment: |
-      Represents assigning to a class variable using an operator that isn't `=`.
+      Represents the use of the `||=` operator for assignment to a class variable.
 
-          @@target += value
-          ^^^^^^^^^^^^^^^^^
+          @@target ||= value
+          ^^^^^^^^^^^^^^^^^^
   - name: ClassVariableReadNode
     comment: |
       Represents referencing a class variable.
 
           @@foo
           ^^^^^
+  - name: ClassVariableTargetNode
+    comment: |
+      Represents writing to a class variable in a context that doesn't have an explicit value.
+
+          @@foo, @@bar = baz
+          ^^^^^  ^^^^^
   - name: ClassVariableWriteNode
     child_nodes:
       - name: name_loc
@@ -783,7 +791,7 @@ nodes:
 
           @@foo = 1
           ^^^^^^^^^
-  - name: ConstantOperatorAndWriteNode
+  - name: ConstantAndWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -796,7 +804,22 @@ nodes:
 
           Target &&= value
           ^^^^^^^^^^^^^^^^
-  - name: ConstantOperatorOrWriteNode
+  - name: ConstantOperatorWriteNode
+    child_nodes:
+      - name: name_loc
+        type: location
+      - name: operator_loc
+        type: location
+      - name: value
+        type: node
+      - name: operator
+        type: constant
+    comment: |
+      Represents assigning to a constant using an operator that isn't `=`.
+
+          Target += value
+          ^^^^^^^^^^^^^^^
+  - name: ConstantOrWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -809,21 +832,20 @@ nodes:
 
           Target ||= value
           ^^^^^^^^^^^^^^^^
-  - name: ConstantOperatorWriteNode
+  - name: ConstantPathAndWriteNode
     child_nodes:
-      - name: name_loc
-        type: location
+      - name: target
+        type: node
+        kind: ConstantPathNode
       - name: operator_loc
         type: location
       - name: value
         type: node
-      - name: operator
-        type: constant
     comment: |
-      Represents assigning to a constant using an operator that isn't `=`.
+      Represents the use of the `&&=` operator for assignment to a constant path.
 
-          Target += value
-          ^^^^^^^^^^^^^^^
+          Parent::Child &&= value
+          ^^^^^^^^^^^^^^^^^^^^^^^
   - name: ConstantPathNode
     child_nodes:
       - name: parent
@@ -837,7 +859,7 @@ nodes:
 
           Foo::Bar
           ^^^^^^^^
-  - name: ConstantPathOperatorAndWriteNode
+  - name: ConstantPathOperatorWriteNode
     child_nodes:
       - name: target
         type: node
@@ -846,12 +868,14 @@ nodes:
         type: location
       - name: value
         type: node
+      - name: operator
+        type: constant
     comment: |
-      Represents the use of the `&&=` operator for assignment to a constant path.
+      Represents assigning to a constant path using an operator that isn't `=`.
 
-          Parent::Child &&= value
-          ^^^^^^^^^^^^^^^^^^^^^^^
-  - name: ConstantPathOperatorOrWriteNode
+          Parent::Child += value
+          ^^^^^^^^^^^^^^^^^^^^^^
+  - name: ConstantPathOrWriteNode
     child_nodes:
       - name: target
         type: node
@@ -865,31 +889,28 @@ nodes:
 
           Parent::Child ||= value
           ^^^^^^^^^^^^^^^^^^^^^^^
-  - name: ConstantPathOperatorWriteNode
+  - name: ConstantPathTargetNode
     child_nodes:
-      - name: target
+      - name: parent
+        type: node?
+      - name: child
         type: node
-        kind: ConstantPathNode
-      - name: operator_loc
+      - name: delimiter_loc
         type: location
-      - name: value
-        type: node
-      - name: operator
-        type: constant
     comment: |
-      Represents assigning to a constant path using an operator that isn't `=`.
+      Represents writing to a constant path in a context that doesn't have an explicit value.
 
-          Parent::Child += value
-          ^^^^^^^^^^^^^^^^^^^^^^
+          Foo::Foo, Bar::Bar = baz
+          ^^^^^^^^  ^^^^^^^^
   - name: ConstantPathWriteNode
     child_nodes:
       - name: target
         type: node
         kind: ConstantPathNode
       - name: operator_loc
-        type: location?
+        type: location
       - name: value
-        type: node?
+        type: node
     comment: |
       Represents writing to a constant path.
 
@@ -907,14 +928,20 @@ nodes:
 
           Foo
           ^^^
+  - name: ConstantTargetNode
+    comment: |
+      Represents writing to a constant in a context that doesn't have an explicit value.
+
+          Foo, Bar = baz
+          ^^^  ^^^
   - name: ConstantWriteNode
     child_nodes:
       - name: name_loc
         type: location
       - name: value
-        type: node?
+        type: node
       - name: operator_loc
-        type: location?
+        type: location
     comment: |
       Represents writing to a constant.
 
@@ -929,7 +956,7 @@ nodes:
       - name: parameters
         type: node?
         kind: ParametersNode
-      - name: statements
+      - name: body
         type: node?
       - name: locals
         type: constant[]
@@ -1123,7 +1150,7 @@ nodes:
 
           super
           ^^^^^
-  - name: GlobalVariableOperatorAndWriteNode
+  - name: GlobalVariableAndWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1136,7 +1163,7 @@ nodes:
 
           $target &&= value
           ^^^^^^^^^^^^^^^^^
-  - name: GlobalVariableOperatorOrWriteNode
+  - name: GlobalVariableOperatorWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1144,12 +1171,14 @@ nodes:
         type: location
       - name: value
         type: node
+      - name: operator
+        type: constant
     comment: |
-      Represents the use of the `||=` operator for assignment to a global variable.
+      Represents assigning to a global variable using an operator that isn't `=`.
 
-          $target ||= value
-          ^^^^^^^^^^^^^^^^^
-  - name: GlobalVariableOperatorWriteNode
+          $target += value
+          ^^^^^^^^^^^^^^^^
+  - name: GlobalVariableOrWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1157,27 +1186,31 @@ nodes:
         type: location
       - name: value
         type: node
-      - name: operator
-        type: constant
     comment: |
-      Represents assigning to a global variable using an operator that isn't `=`.
+      Represents the use of the `||=` operator for assignment to a global variable.
 
-          $target += value
-          ^^^^^^^^^^^^^^^^
+          $target ||= value
+          ^^^^^^^^^^^^^^^^^
   - name: GlobalVariableReadNode
     comment: |
       Represents referencing a global variable.
 
           $foo
           ^^^^
+  - name: GlobalVariableTargetNode
+    comment: |
+      Represents writing to a global variable in a context that doesn't have an explicit value.
+
+          $foo, $bar = baz
+          ^^^^  ^^^^
   - name: GlobalVariableWriteNode
     child_nodes:
       - name: name_loc
         type: location
       - name: operator_loc
-        type: location?
+        type: location
       - name: value
-        type: node?
+        type: node
     comment: |
       Represents writing to a global variable.
 
@@ -1263,7 +1296,7 @@ nodes:
 
           case a; in b then c end
                   ^^^^^^^^^^^
-  - name: InstanceVariableOperatorAndWriteNode
+  - name: InstanceVariableAndWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1276,7 +1309,7 @@ nodes:
 
           @target &&= value
           ^^^^^^^^^^^^^^^^^
-  - name: InstanceVariableOperatorOrWriteNode
+  - name: InstanceVariableOperatorWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1284,12 +1317,14 @@ nodes:
         type: location
       - name: value
         type: node
+      - name: operator
+        type: constant
     comment: |
-      Represents the use of the `||=` operator for assignment to an instance variable.
+      Represents assigning to an instance variable using an operator that isn't `=`.
 
-          @target ||= value
-          ^^^^^^^^^^^^^^^^^
-  - name: InstanceVariableOperatorWriteNode
+          @target += value
+          ^^^^^^^^^^^^^^^^
+  - name: InstanceVariableOrWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1297,27 +1332,31 @@ nodes:
         type: location
       - name: value
         type: node
-      - name: operator
-        type: constant
     comment: |
-      Represents assigning to an instance variable using an operator that isn't `=`.
+      Represents the use of the `||=` operator for assignment to an instance variable.
 
-          @target += value
-          ^^^^^^^^^^^^^^^^
+          @target ||= value
+          ^^^^^^^^^^^^^^^^^
   - name: InstanceVariableReadNode
     comment: |
       Represents referencing an instance variable.
 
           @foo
           ^^^^
+  - name: InstanceVariableTargetNode
+    comment: |
+      Represents writing to an instance variable in a context that doesn't have an explicit value.
+
+          @foo, @bar = baz
+          ^^^^  ^^^^
   - name: InstanceVariableWriteNode
     child_nodes:
       - name: name_loc
         type: location
       - name: value
-        type: node?
+        type: node
       - name: operator_loc
-        type: location?
+        type: location
     comment: |
       Represents writing to an instance variable.
 
@@ -1429,19 +1468,23 @@ nodes:
     child_nodes:
       - name: locals
         type: constant[]
+      - name: operator_loc
+        type: location
       - name: opening_loc
         type: location
+      - name: closing_loc
+        type: location
       - name: parameters
         type: node?
         kind: BlockParametersNode
-      - name: statements
+      - name: body
         type: node?
     comment: |
       Represents using a lambda literal (not the lambda method call).
 
           ->(value) { value * 2 }
           ^^^^^^^^^^^^^^^^^^^^^^^
-  - name: LocalVariableOperatorAndWriteNode
+  - name: LocalVariableAndWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1451,12 +1494,14 @@ nodes:
         type: node
       - name: constant_id
         type: constant
+      - name: depth
+        type: uint32
     comment: |
       Represents the use of the `&&=` operator for assignment to a local variable.
 
           target &&= value
           ^^^^^^^^^^^^^^^^
-  - name: LocalVariableOperatorOrWriteNode
+  - name: LocalVariableOperatorWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1466,12 +1511,16 @@ nodes:
         type: node
       - name: constant_id
         type: constant
+      - name: operator_id
+        type: constant
+      - name: depth
+        type: uint32
     comment: |
-      Represents the use of the `||=` operator for assignment to a local variable.
+      Represents assigning to a local variable using an operator that isn't `=`.
 
-          target ||= value
-          ^^^^^^^^^^^^^^^^
-  - name: LocalVariableOperatorWriteNode
+          target += value
+          ^^^^^^^^^^^^^^^
+  - name: LocalVariableOrWriteNode
     child_nodes:
       - name: name_loc
         type: location
@@ -1481,13 +1530,13 @@ nodes:
         type: node
       - name: constant_id
         type: constant
-      - name: operator_id
-        type: constant
+      - name: depth
+        type: uint32
     comment: |
-      Represents assigning to a local variable using an operator that isn't `=`.
+      Represents the use of the `||=` operator for assignment to a local variable.
 
-          target += value
-          ^^^^^^^^^^^^^^^
+          target ||= value
+          ^^^^^^^^^^^^^^^^
   - name: LocalVariableReadNode
     child_nodes:
       - name: constant_id
@@ -1501,6 +1550,17 @@ nodes:
 
           foo
           ^^^
+  - name: LocalVariableTargetNode
+    child_nodes:
+      - name: constant_id
+        type: constant
+      - name: depth
+        type: uint32
+    comment: |
+      Represents writing to a local variable in a context that doesn't have an explicit value.
+
+          foo, bar = baz
+          ^^^  ^^^
   - name: LocalVariableWriteNode
     child_nodes:
       - name: constant_id
@@ -1508,11 +1568,11 @@ nodes:
       - name: depth
         type: uint32
       - name: value
-        type: node?
+        type: node
       - name: name_loc
         type: location
       - name: operator_loc
-        type: location?
+        type: location
     comment: |
       Represents writing to a local variable.
 
@@ -1556,10 +1616,12 @@ nodes:
         type: location
       - name: constant_path
         type: node
-      - name: statements
+      - name: body
         type: node?
       - name: end_keyword_loc
         type: location
+      - name: name
+        type: string
     comment: |
       Represents a module declaration involving the `module` keyword.
 
@@ -1673,7 +1735,7 @@ nodes:
           end
   - name: ParenthesesNode
     child_nodes:
-      - name: statements
+      - name: body
         type: node?
       - name: opening_loc
         type: location
@@ -1916,7 +1978,7 @@ nodes:
         type: location
       - name: expression
         type: node
-      - name: statements
+      - name: body
         type: node?
       - name: end_keyword_loc
         type: location
@@ -1932,7 +1994,6 @@ nodes:
           __ENCODING__
           ^^^^^^^^^^^^
   - name: SourceFileNode
-    is_migrated: true
     child_nodes:
       - name: filepath
         type: string
@@ -2027,7 +2088,7 @@ nodes:
       - name: opening_loc
         type: location?
       - name: value_loc
-        type: location
+        type: location?
       - name: closing_loc
         type: location?
       - name: unescaped
@@ -2084,6 +2145,8 @@ nodes:
     child_nodes:
       - name: keyword_loc
         type: location
+      - name: closing_loc
+        type: location?
       - name: predicate
         type: node
       - name: statements
@@ -2111,14 +2174,18 @@ nodes:
         type: node?
         kind: StatementsNode
     comment: |
-      case true
-      when true
-      ^^^^^^^^^
-      end
+      Represents the use of the `when` keyword within a case statement.
+
+          case true
+          when true
+          ^^^^^^^^^
+          end
   - name: WhileNode
     child_nodes:
       - name: keyword_loc
         type: location
+      - name: closing_loc
+        type: location?
       - name: predicate
         type: node
       - name: statements

data/docs/configuration.md

@@ -7,6 +7,7 @@ A lot of code in YARP's repository is templated from a single configuration file
 * `java/org/yarp/AbstractNodeVisitor.java` - for defining the visitor interface for the nodes in Java
 * `java/org/yarp/Loader.java` - for defining how to deserialize the nodes in Java
 * `java/org/yarp/Nodes.java` - for defining the nodes in Java
+* `lib/yarp/mutation_visitor.rb` - for defining the mutation visitor for the nodes in Ruby
 * `lib/yarp/node.rb` - for defining the nodes in Ruby
 * `lib/yarp/serialize.rb` - for defining how to deserialize the nodes in Ruby
 * `src/node.c` - for defining how to free the nodes in C and calculate the size in memory in C

data/docs/ruby_api.md

@@ -20,4 +20,6 @@ The full API is documented below.
 * `YARP.lex_file(filepath)` - parse the tokens corresponding to the given source file and return them as an array within a parse result
 * `YARP.parse(source)` - parse the syntax tree corresponding to the given source string and return it within a parse result
 * `YARP.parse_file(filepath)` - parse the syntax tree corresponding to the given source file and return it within a parse result
+* `YARP.parse_lex(source)` - parse the syntax tree corresponding to the given source string and return it within a parse result, along with the tokens
+* `YARP.parse_lex_file(filepath)` - parse the syntax tree corresponding to the given source file and return it within a parse result, along with the tokens
 * `YARP.load(source, serialized)` - load the serialized syntax tree using the source as a reference into a syntax tree

data/docs/serialization.md

@@ -73,7 +73,7 @@ The header is structured like the following table:
 | varint | content pool size |
 
 After the header comes the body of the serialized string.
-The body consistents of a sequence of nodes that is built using a prefix traversal order of the syntax tree.
+The body consists of a sequence of nodes that is built using a prefix traversal order of the syntax tree.
 Each node is structured like the following table:
 
 | # bytes | field |

data/docs/testing.md

@@ -12,9 +12,9 @@ These test specific YARP implementation details like comments, errors, and regul
 
 ### Snapshot tests
 
-Snapshot tests ensure that parsed output is equivalent to previous parsed output. There are many categorized examples of valid syntax within the `test/fixtures/` directory. When the test suite runs, it will parse all of this syntax, and compare it against corresponding files in the `test/snapshots/` directory. For example, `test/fixtures/strings.txt` has a corresponding `test/snapshots/strings.txt`.
+Snapshot tests ensure that parsed output is equivalent to previous parsed output. There are many categorized examples of valid syntax within the `test/yarp/fixtures/` directory. When the test suite runs, it will parse all of this syntax, and compare it against corresponding files in the `test/yarp/snapshots/` directory. For example, `test/yarp/fixtures/strings.txt` has a corresponding `test/yarp/snapshots/strings.txt`.
 
-If the parsed files do not match, it will raise an error. If there is not a corresponding file in the `test/snapshots/` directory, one will be created so that it exists for the next test run.
+If the parsed files do not match, it will raise an error. If there is not a corresponding file in the `test/yarp/snapshots/` directory, one will be created so that it exists for the next test run.
 
 ### Testing against repositories