prism 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 967c414d9d2354dd828368920733b1c81240d1f0c267fdc422d075965f1cec94
-  data.tar.gz: a258399d77a8f4c6ca297fcea435c8b2c167bced045b32d2884f270a9483c33b
+  metadata.gz: 498f20248401af377faf45d30b7154d819b8bea560be2747c030d5ae536851c9
+  data.tar.gz: 8d3bb4fc0afb899869d8d6a55a526a40769fb46a582cf465035de750824d72d7
 SHA512:
-  metadata.gz: 104746123657e06d12be6da5ebc6778afda2f94646d3544ff88acd42c5ef2d01f46855f96548360166ee0b4ce6d5164107f7a857c1b52984237421287da4e85c
-  data.tar.gz: d4237da63459ab266d5ee824d680eadef6ee893da5b7fd47960b55f4496630e18b0804b455e51576dd52ab4f085a3eb013d1e08fc7c4577c1ed07441abf6b53e
+  metadata.gz: 2d71744c4342a671b578ed7ebf3dede7b0146404a61e40ed8b082c544f5d8e9d83dc4e1f0780555cab4c70bd052156e26f9d8b46a2f2012bcedf89bf5b21d54b
+  data.tar.gz: 2a2178b5615fe4c55d7c16156901423fe38dee075e4f60cc893c367630e7c136cc7d6bc19f3fcf037a6958d158b2663f61389656754fe679570271503a5b35a2

data/CHANGELOG.md

@@ -6,6 +6,24 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.16.0] - 2023-10-30
+
+### Added
+
+- `InterpolatedMatchLastLineNode#options` and `MatchLastLineNode#options` are added, which are the same methods as are exposed on `InterpolatedRegularExpressionNode` and `RegularExpressionNode`.
+- The project can now be compiled with `wasi-sdk` to expose a WebAssembly interface.
+- `ArgumentsNode#keyword_splat?` is added to indicate if the arguments node has a keyword splat.
+- The C API `pm_prettyprint` has a much improved output which lines up closely with `Node#inspect`.
+- Prism now ships with `RBS` and `RBI` type signatures (in the `/sig` and `/rbi` directories, respectively).
+- `Prism::parse_comments` and `Prism::parse_file_comments` APIs are added to extract only the comments from the source code.
+
+### Changed
+
+- **BREAKING**: `Multi{Target,Write}Node#targets` is split up now into `lefts`, `rest`, and `rights`. This is to avoid having to scan the list in the case that there are splat nodes.
+- Some bugs are fixed on `Multi{Target,Write}Node` accidentally creating additional nesting when not necessary.
+- **BREAKING**: `RequiredDestructuredParameterNode` has been removed in favor of using `MultiTargetNode` in those places.
+- **BREAKING**: `HashPatternNode#assocs` has been renamed to `HashPatternNode#elements`. `HashPatternNode#kwrest` has been renamed to `HashPatternNode#rest`.
+
 ## [0.15.1] - 2023-10-18
 
 ### Changed
@@ -201,7 +219,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby/prism/compare/v0.15.1...HEAD
+[unreleased]: https://github.com/ruby/prism/compare/v0.16.0...HEAD
+[0.16.0]: https://github.com/ruby/prism/compare/v0.15.1...v0.16.0
 [0.15.1]: https://github.com/ruby/prism/compare/v0.15.0...v0.15.1
 [0.15.0]: https://github.com/ruby/prism/compare/v0.14.0...v0.15.0
 [0.14.0]: https://github.com/ruby/prism/compare/v0.13.0...v0.14.0

data/Makefile

@@ -13,6 +13,7 @@ SOEXT := $(shell ruby -e 'puts RbConfig::CONFIG["SOEXT"]')
 CPPFLAGS := -Iinclude
 CFLAGS := -g -O2 -std=c99 -Wall -Werror -Wextra -Wpedantic -Wundef -Wconversion -fPIC -fvisibility=hidden
 CC := cc
+WASI_SDK_PATH := /opt/wasi-sdk
 
 HEADERS := $(shell find include -name '*.h')
 SOURCES := $(shell find src -name '*.c')
@@ -23,6 +24,7 @@ all: shared static
 
 shared: build/librubyparser.$(SOEXT)
 static: build/librubyparser.a
+wasm: javascript/src/prism.wasm
 
 build/librubyparser.$(SOEXT): $(SHARED_OBJECTS)
 	$(ECHO) "linking $@"
@@ -32,6 +34,10 @@ build/librubyparser.a: $(STATIC_OBJECTS)
 	$(ECHO) "building $@"
 	$(Q) $(AR) $(ARFLAGS) $@ $(STATIC_OBJECTS) $(Q1:0=>/dev/null)
 
+javascript/src/prism.wasm: Makefile $(SOURCES) $(HEADERS)
+	$(ECHO) "building $@"
+	$(Q) $(WASI_SDK_PATH)/bin/clang --sysroot=$(WASI_SDK_PATH)/share/wasi-sysroot/ $(DEBUG_FLAGS) -DPRISM_EXPORT_SYMBOLS -D_WASI_EMULATED_MMAN -lwasi-emulated-mman $(CPPFLAGS) $(CFLAGS) -Wl,--export-all -Wl,--no-entry -mexec-model=reactor -o $@ $(SOURCES)
+
 build/shared/%.o: src/%.c Makefile $(HEADERS)
 	$(ECHO) "compiling $@"
 	$(Q) mkdir -p $(@D)

data/README.md

@@ -85,7 +85,9 @@ See the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information. We additio
 * [Encoding](docs/encoding.md)
 * [Fuzzing](docs/fuzzing.md)
 * [Heredocs](docs/heredocs.md)
+* [JavaScript](docs/javascript.md)
 * [Mapping](docs/mapping.md)
+* [Releasing](docs/releasing.md)
 * [Ripper](docs/ripper.md)
 * [Ruby API](docs/ruby_api.md)
 * [Serialization](docs/serialization.md)

data/config.yml

@@ -329,6 +329,10 @@ tokens:
   - name: __END__
     comment: "marker for the point in the file at which the parser should stop"
 flags:
+  - name: ArgumentsNodeFlags
+    values:
+      - name: KEYWORD_SPLAT
+        comment: "if arguments contain keyword splat"
   - name: CallNodeFlags
     values:
       - name: SAFE_NAVIGATION
@@ -432,6 +436,9 @@ nodes:
     fields:
       - name: arguments
         type: node[]
+      - name: flags
+        type: flags
+        kind: ArgumentsNodeFlags
     comment: |
       Represents a set of arguments to a method or a keyword.
 
@@ -1349,9 +1356,9 @@ nodes:
     fields:
       - name: constant
         type: node?
-      - name: assocs
+      - name: elements
         type: node[]
-      - name: kwrest
+      - name: rest
         type: node?
       - name: opening_loc
         type: location?
@@ -1915,7 +1922,11 @@ nodes:
           ^^^^^^^^^^^^^^
   - name: MultiTargetNode
     fields:
-      - name: targets
+      - name: lefts
+        type: node[]
+      - name: rest
+        type: node?
+      - name: rights
         type: node[]
       - name: lparen_loc
         type: location?
@@ -1924,11 +1935,15 @@ nodes:
     comment: |
       Represents a multi-target expression.
 
-          a, b, c = 1, 2, 3
-          ^^^^^^^
+          a, (b, c) = 1, 2, 3
+             ^^^^^^
   - name: MultiWriteNode
     fields:
-      - name: targets
+      - name: lefts
+        type: node[]
+      - name: rest
+        type: node?
+      - name: rights
         type: node[]
       - name: lparen_loc
         type: location?
@@ -2169,20 +2184,6 @@ nodes:
 
           /foo/i
           ^^^^^^
-  - name: RequiredDestructuredParameterNode
-    fields:
-      - name: parameters
-        type: node[]
-      - name: opening_loc
-        type: location
-      - name: closing_loc
-        type: location
-    comment: |
-      Represents a destructured required parameter node.
-
-          def foo((bar, baz))
-                  ^^^^^^^^^^
-          end
   - name: RequiredParameterNode
     fields:
       - name: name

data/docs/configuration.md

@@ -4,6 +4,8 @@ A lot of code in prism's repository is templated from a single configuration fil
 
 * `ext/prism/api_node.c` - for defining how to build Ruby objects for the nodes out of C structs
 * `include/prism/ast.h` - for defining the C structs that represent the nodes
+* `javascript/src/deserialize.js` - for defining how to deserialize the nodes in JavaScript
+* `javascript/src/nodes.js` - for defining the nodes in JavaScript
 * `java/org/prism/AbstractNodeVisitor.java` - for defining the visitor interface for the nodes in Java
 * `java/org/prism/Loader.java` - for defining how to deserialize the nodes in Java
 * `java/org/prism/Nodes.java` - for defining the nodes in Java

data/docs/javascript.md

@@ -0,0 +1,90 @@
+# JavaScript
+
+Prism provides bindings to JavaScript out of the box.
+
+## Node
+
+To use the package from node, install the `@ruby/prism` dependency:
+
+```sh
+npm install @ruby/prism
+```
+
+Then import the package:
+
+```js
+import { loadPrism } from "@ruby/prism";
+```
+
+Then call the load function to get a parse function:
+
+```js
+const parse = await loadPrism();
+```
+
+## Browser
+
+To use the package from the browser, you will need to do some additional work. The [javascript/example.html](javascript/example.html) file shows an example of running Prism in the browser. You will need to instantiate the WebAssembly module yourself and then pass it to the `parsePrism` function.
+
+First, get a shim for WASI since not all browsers support it yet.
+
+```js
+import { WASI } from "https://unpkg.com/@bjorn3/browser_wasi_shim@latest/dist/index.js";
+```
+
+Next, import the `parsePrism` function from `@ruby/prism`, either through a CDN or by bundling it with your application.
+
+```js
+import { parsePrism } from "https://unpkg.com/@ruby/prism@latest/src/parsePrism.js";
+```
+
+Next, fetch and instantiate the WebAssembly module. You can access it through a CDN or by bundling it with your application.
+
+```js
+const wasm = await WebAssembly.compileStreaming(fetch("https://unpkg.com/@ruby/prism@latest/src/prism.wasm"));
+```
+
+Next, instantiate the module and initialize WASI.
+
+```js
+const wasi = new WASI([], [], []);
+const instance = await WebAssembly.instantiate(wasm, { wasi_snapshot_preview1: wasi.wasiImport });
+wasi.initialize(instance);
+```
+
+Finally, you can create a function that will parse a string of Ruby code.
+
+```js
+function parse(source) {
+  return parsePrism(instance.exports, source);
+}
+```
+
+## API
+
+Now that we have access to a `parse` function, we can use it to parse Ruby code:
+
+```js
+const parseResult = parse("1 + 2");
+```
+
+A ParseResult object is very similar to the Prism::ParseResult object from Ruby. It has the same properties: `value`, `comments`, `magicComments`, `errors`, and `warnings`. Here we can serialize the AST to JSON.
+
+```js
+console.log(JSON.stringify(parseResult.value, null, 2));
+```
+
+## Building
+
+To build the WASM package yourself, first obtain a copy of `wasi-sdk`. You can retrieve this here: <https://github.com/WebAssembly/wasi-sdk>. Next, run:
+
+```sh
+make wasm WASI_SDK_PATH=path/to/wasi-sdk
+```
+
+This will generate `javascript/src/prism.wasm`. From there, you can run the tests to verify everything was generated correctly.
+
+```sh
+cd javascript
+node test
+```

data/docs/releasing.md

@@ -0,0 +1,27 @@
+# Releasing
+
+To release a new version of Prism, perform the following steps:
+
+## Preparation
+
+* Update the CHANGELOG.md file.
+  * Add a new section for the new version at the top of the file.
+  * Fill in the relevant changes — it may be easiest to click the link for the `Unreleased` heading to find the commits.
+  * Update the links at the bottom of the file.
+* Update the version in the following files:
+  * `prism.gemspec` in the `Gem::Specification#version=` method call
+  * `ext/prism/extension.h` in the `EXPECTED_PRISM_VERSION` macro
+  * `include/prism/version.h` in the version macros
+  * `javascript/package.json` in the `version` field
+  * `rust/prism-sys/tests/utils_tests.rs` in the `version_test` function
+  * `templates/java/org/prism/Loader.java.erb` in the `load` function
+  * `templates/javascript/src/deserialize.js.erb` in the version constants
+  * `templates/lib/prism/serialize.rb.erb` in the version constants
+* Run `bundle install` to update the `Gemfile.lock` file.
+* Update `rust/prism-sys/Cargo.toml` to match the new version and run `cargo build`
+* Update `rust/prism/Cargo.toml` to match the new version and run `cargo build`
+* Commit all of the updated files.
+
+## Publishing
+
+* Run `bundle exec rake release` to publish the gem to [rubygems.org](rubygems.org). Note that you must have access to the `prism` gem to do this.

data/docs/ruby_api.md

@@ -23,3 +23,5 @@ The full API is documented below.
 * `Prism.parse_lex(source)` - parse the syntax tree corresponding to the given source string and return it within a parse result, along with the tokens
 * `Prism.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
 * `Prism.load(source, serialized)` - load the serialized syntax tree using the source as a reference into a syntax tree
+* `Prism.parse_comments(source)` - parse the comments corresponding to the given source string and return them
+* `Prism.parse_file_comments(source)` - parse the comments corresponding to the given source file and return them

data/ext/prism/api_node.c

@@ -132,7 +132,6 @@ static VALUE rb_cPrismRangeNode;
 static VALUE rb_cPrismRationalNode;
 static VALUE rb_cPrismRedoNode;
 static VALUE rb_cPrismRegularExpressionNode;
-static VALUE rb_cPrismRequiredDestructuredParameterNode;
 static VALUE rb_cPrismRequiredParameterNode;
 static VALUE rb_cPrismRescueModifierNode;
 static VALUE rb_cPrismRescueNode;
@@ -607,10 +606,10 @@ pm_ast_new(pm_parser_t *parser, pm_node_t *node, rb_encoding *encoding) {
                 case PM_HASH_PATTERN_NODE: {
                     pm_hash_pattern_node_t *cast = (pm_hash_pattern_node_t *) node;
                     pm_node_stack_push(&node_stack, (pm_node_t *) cast->constant);
-                    for (size_t index = 0; index < cast->assocs.size; index++) {
-                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->assocs.nodes[index]);
+                    for (size_t index = 0; index < cast->elements.size; index++) {
+                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->elements.nodes[index]);
                     }
-                    pm_node_stack_push(&node_stack, (pm_node_t *) cast->kwrest);
+                    pm_node_stack_push(&node_stack, (pm_node_t *) cast->rest);
                     break;
                 }
 #line 108 "api_node.c.erb"
@@ -806,16 +805,24 @@ pm_ast_new(pm_parser_t *parser, pm_node_t *node, rb_encoding *encoding) {
 #line 108 "api_node.c.erb"
                 case PM_MULTI_TARGET_NODE: {
                     pm_multi_target_node_t *cast = (pm_multi_target_node_t *) node;
-                    for (size_t index = 0; index < cast->targets.size; index++) {
-                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->targets.nodes[index]);
+                    for (size_t index = 0; index < cast->lefts.size; index++) {
+                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->lefts.nodes[index]);
+                    }
+                    pm_node_stack_push(&node_stack, (pm_node_t *) cast->rest);
+                    for (size_t index = 0; index < cast->rights.size; index++) {
+                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->rights.nodes[index]);
                     }
                     break;
                 }
 #line 108 "api_node.c.erb"
                 case PM_MULTI_WRITE_NODE: {
                     pm_multi_write_node_t *cast = (pm_multi_write_node_t *) node;
-                    for (size_t index = 0; index < cast->targets.size; index++) {
-                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->targets.nodes[index]);
+                    for (size_t index = 0; index < cast->lefts.size; index++) {
+                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->lefts.nodes[index]);
+                    }
+                    pm_node_stack_push(&node_stack, (pm_node_t *) cast->rest);
+                    for (size_t index = 0; index < cast->rights.size; index++) {
+                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->rights.nodes[index]);
                     }
                     pm_node_stack_push(&node_stack, (pm_node_t *) cast->value);
                     break;
@@ -908,14 +915,6 @@ pm_ast_new(pm_parser_t *parser, pm_node_t *node, rb_encoding *encoding) {
                     pm_node_stack_push(&node_stack, (pm_node_t *) cast->numeric);
                     break;
                 }
-#line 108 "api_node.c.erb"
-                case PM_REQUIRED_DESTRUCTURED_PARAMETER_NODE: {
-                    pm_required_destructured_parameter_node_t *cast = (pm_required_destructured_parameter_node_t *) node;
-                    for (size_t index = 0; index < cast->parameters.size; index++) {
-                        pm_node_stack_push(&node_stack, (pm_node_t *) cast->parameters.nodes[index]);
-                    }
-                    break;
-                }
 #line 108 "api_node.c.erb"
                 case PM_RESCUE_MODIFIER_NODE: {
                     pm_rescue_modifier_node_t *cast = (pm_rescue_modifier_node_t *) node;
@@ -1123,7 +1122,7 @@ pm_ast_new(pm_parser_t *parser, pm_node_t *node, rb_encoding *encoding) {
 #line 134 "api_node.c.erb"
                 case PM_ARGUMENTS_NODE: {
                     pm_arguments_node_t *cast = (pm_arguments_node_t *) node;
-                    VALUE argv[2];
+                    VALUE argv[3];
 
                     // arguments
 #line 148 "api_node.c.erb"
@@ -1132,10 +1131,14 @@ pm_ast_new(pm_parser_t *parser, pm_node_t *node, rb_encoding *encoding) {
                         rb_ary_push(argv[0], rb_ary_pop(value_stack));
                     }
 
+                    // flags
+#line 179 "api_node.c.erb"
+                    argv[1] = ULONG2NUM(node->flags & ~PM_NODE_FLAG_COMMON_MASK);
+
                     // location
-                    argv[1] = pm_location_new(parser, node->location.start, node->location.end, source);
+                    argv[2] = pm_location_new(parser, node->location.start, node->location.end, source);
 
-                    rb_ary_push(value_stack, rb_class_new_instance(2, argv, rb_cPrismArgumentsNode));
+                    rb_ary_push(value_stack, rb_class_new_instance(3, argv, rb_cPrismArgumentsNode));
                     break;
                 }
 #line 134 "api_node.c.erb"
@@ -2694,14 +2697,14 @@ pm_ast_new(pm_parser_t *parser, pm_node_t *node, rb_encoding *encoding) {
 #line 145 "api_node.c.erb"
                     argv[0] = rb_ary_pop(value_stack);
 
-                    // assocs
+                    // elements
 #line 148 "api_node.c.erb"
-                    argv[1] = rb_ary_new_capa(cast->assocs.size);
-                    for (size_t index = 0; index < cast->assocs.size; index++) {
+                    argv[1] = rb_ary_new_capa(cast->elements.size);
+                    for (size_t index = 0; index < cast->elements.size; index++) {
                         rb_ary_push(argv[1], rb_ary_pop(value_stack));
                     }
 
-                    // kwrest
+                    // rest
 #line 145 "api_node.c.erb"
                     argv[2] = rb_ary_pop(value_stack);
 
@@ -3681,61 +3684,83 @@ pm_ast_new(pm_parser_t *parser, pm_node_t *node, rb_encoding *encoding) {
 #line 134 "api_node.c.erb"
                 case PM_MULTI_TARGET_NODE: {
                     pm_multi_target_node_t *cast = (pm_multi_target_node_t *) node;
-                    VALUE argv[4];
+                    VALUE argv[6];
 
-                    // targets
+                    // lefts
 #line 148 "api_node.c.erb"
-                    argv[0] = rb_ary_new_capa(cast->targets.size);
-                    for (size_t index = 0; index < cast->targets.size; index++) {
+                    argv[0] = rb_ary_new_capa(cast->lefts.size);
+                    for (size_t index = 0; index < cast->lefts.size; index++) {
                         rb_ary_push(argv[0], rb_ary_pop(value_stack));
                     }
 
+                    // rest
+#line 145 "api_node.c.erb"
+                    argv[1] = rb_ary_pop(value_stack);
+
+                    // rights
+#line 148 "api_node.c.erb"
+                    argv[2] = rb_ary_new_capa(cast->rights.size);
+                    for (size_t index = 0; index < cast->rights.size; index++) {
+                        rb_ary_push(argv[2], rb_ary_pop(value_stack));
+                    }
+
                     // lparen_loc
 #line 173 "api_node.c.erb"
-                    argv[1] = cast->lparen_loc.start == NULL ? Qnil : pm_location_new(parser, cast->lparen_loc.start, cast->lparen_loc.end, source);
+                    argv[3] = cast->lparen_loc.start == NULL ? Qnil : pm_location_new(parser, cast->lparen_loc.start, cast->lparen_loc.end, source);
 
                     // rparen_loc
 #line 173 "api_node.c.erb"
-                    argv[2] = cast->rparen_loc.start == NULL ? Qnil : pm_location_new(parser, cast->rparen_loc.start, cast->rparen_loc.end, source);
+                    argv[4] = cast->rparen_loc.start == NULL ? Qnil : pm_location_new(parser, cast->rparen_loc.start, cast->rparen_loc.end, source);
 
                     // location
-                    argv[3] = pm_location_new(parser, node->location.start, node->location.end, source);
+                    argv[5] = pm_location_new(parser, node->location.start, node->location.end, source);
 
-                    rb_ary_push(value_stack, rb_class_new_instance(4, argv, rb_cPrismMultiTargetNode));
+                    rb_ary_push(value_stack, rb_class_new_instance(6, argv, rb_cPrismMultiTargetNode));
                     break;
                 }
 #line 134 "api_node.c.erb"
                 case PM_MULTI_WRITE_NODE: {
                     pm_multi_write_node_t *cast = (pm_multi_write_node_t *) node;
-                    VALUE argv[6];
+                    VALUE argv[8];
 
-                    // targets
+                    // lefts
 #line 148 "api_node.c.erb"
-                    argv[0] = rb_ary_new_capa(cast->targets.size);
-                    for (size_t index = 0; index < cast->targets.size; index++) {
+                    argv[0] = rb_ary_new_capa(cast->lefts.size);
+                    for (size_t index = 0; index < cast->lefts.size; index++) {
                         rb_ary_push(argv[0], rb_ary_pop(value_stack));
                     }
 
+                    // rest
+#line 145 "api_node.c.erb"
+                    argv[1] = rb_ary_pop(value_stack);
+
+                    // rights
+#line 148 "api_node.c.erb"
+                    argv[2] = rb_ary_new_capa(cast->rights.size);
+                    for (size_t index = 0; index < cast->rights.size; index++) {
+                        rb_ary_push(argv[2], rb_ary_pop(value_stack));
+                    }
+
                     // lparen_loc
 #line 173 "api_node.c.erb"
-                    argv[1] = cast->lparen_loc.start == NULL ? Qnil : pm_location_new(parser, cast->lparen_loc.start, cast->lparen_loc.end, source);
+                    argv[3] = cast->lparen_loc.start == NULL ? Qnil : pm_location_new(parser, cast->lparen_loc.start, cast->lparen_loc.end, source);
 
                     // rparen_loc
 #line 173 "api_node.c.erb"
-                    argv[2] = cast->rparen_loc.start == NULL ? Qnil : pm_location_new(parser, cast->rparen_loc.start, cast->rparen_loc.end, source);
+                    argv[4] = cast->rparen_loc.start == NULL ? Qnil : pm_location_new(parser, cast->rparen_loc.start, cast->rparen_loc.end, source);
 
                     // operator_loc
 #line 170 "api_node.c.erb"
-                    argv[3] = pm_location_new(parser, cast->operator_loc.start, cast->operator_loc.end, source);
+                    argv[5] = pm_location_new(parser, cast->operator_loc.start, cast->operator_loc.end, source);
 
                     // value
 #line 145 "api_node.c.erb"
-                    argv[4] = rb_ary_pop(value_stack);
+                    argv[6] = rb_ary_pop(value_stack);
 
                     // location
-                    argv[5] = pm_location_new(parser, node->location.start, node->location.end, source);
+                    argv[7] = pm_location_new(parser, node->location.start, node->location.end, source);
 
-                    rb_ary_push(value_stack, rb_class_new_instance(6, argv, rb_cPrismMultiWriteNode));
+                    rb_ary_push(value_stack, rb_class_new_instance(8, argv, rb_cPrismMultiWriteNode));
                     break;
                 }
 #line 134 "api_node.c.erb"
@@ -4131,32 +4156,6 @@ pm_ast_new(pm_parser_t *parser, pm_node_t *node, rb_encoding *encoding) {
                     rb_ary_push(value_stack, rb_class_new_instance(6, argv, rb_cPrismRegularExpressionNode));
                     break;
                 }
-#line 134 "api_node.c.erb"
-                case PM_REQUIRED_DESTRUCTURED_PARAMETER_NODE: {
-                    pm_required_destructured_parameter_node_t *cast = (pm_required_destructured_parameter_node_t *) node;
-                    VALUE argv[4];
-
-                    // parameters
-#line 148 "api_node.c.erb"
-                    argv[0] = rb_ary_new_capa(cast->parameters.size);
-                    for (size_t index = 0; index < cast->parameters.size; index++) {
-                        rb_ary_push(argv[0], rb_ary_pop(value_stack));
-                    }
-
-                    // opening_loc
-#line 170 "api_node.c.erb"
-                    argv[1] = pm_location_new(parser, cast->opening_loc.start, cast->opening_loc.end, source);
-
-                    // closing_loc
-#line 170 "api_node.c.erb"
-                    argv[2] = pm_location_new(parser, cast->closing_loc.start, cast->closing_loc.end, source);
-
-                    // location
-                    argv[3] = pm_location_new(parser, node->location.start, node->location.end, source);
-
-                    rb_ary_push(value_stack, rb_class_new_instance(4, argv, rb_cPrismRequiredDestructuredParameterNode));
-                    break;
-                }
 #line 134 "api_node.c.erb"
                 case PM_REQUIRED_PARAMETER_NODE: {
                     pm_required_parameter_node_t *cast = (pm_required_parameter_node_t *) node;
@@ -4849,7 +4848,6 @@ Init_prism_api_node(void) {
     rb_cPrismRationalNode = rb_define_class_under(rb_cPrism, "RationalNode", rb_cPrismNode);
     rb_cPrismRedoNode = rb_define_class_under(rb_cPrism, "RedoNode", rb_cPrismNode);
     rb_cPrismRegularExpressionNode = rb_define_class_under(rb_cPrism, "RegularExpressionNode", rb_cPrismNode);
-    rb_cPrismRequiredDestructuredParameterNode = rb_define_class_under(rb_cPrism, "RequiredDestructuredParameterNode", rb_cPrismNode);
     rb_cPrismRequiredParameterNode = rb_define_class_under(rb_cPrism, "RequiredParameterNode", rb_cPrismNode);
     rb_cPrismRescueModifierNode = rb_define_class_under(rb_cPrism, "RescueModifierNode", rb_cPrismNode);
     rb_cPrismRescueNode = rb_define_class_under(rb_cPrism, "RescueNode", rb_cPrismNode);

data/ext/prism/extension.c

@@ -396,6 +396,24 @@ parse_input(pm_string_t *input, const char *filepath) {
     return result;
 }
 
+// Parse the given input and return an array of Comment objects.
+static VALUE
+parse_input_comments(pm_string_t *input, const char *filepath) {
+    pm_parser_t parser;
+    pm_parser_init(&parser, pm_string_source(input), pm_string_length(input), filepath);
+
+    pm_node_t *node = pm_parse(&parser);
+    rb_encoding *encoding = rb_enc_find(parser.encoding.name);
+
+    VALUE source = pm_source_new(&parser, encoding);
+    VALUE comments = parser_comments(&parser, source);
+
+    pm_node_destroy(&parser, node);
+    pm_parser_free(&parser);
+
+    return comments;
+}
+
 // Parse the given string and return a ParseResult instance.
 static VALUE
 parse(int argc, VALUE *argv, VALUE self) {
@@ -436,6 +454,33 @@ parse_file(VALUE self, VALUE filepath) {
     return value;
 }
 
+// Parse the given string and return an array of Comment objects.
+static VALUE
+parse_comments(int argc, VALUE *argv, VALUE self) {
+    VALUE string;
+    VALUE filepath;
+    rb_scan_args(argc, argv, "11", &string, &filepath);
+
+    pm_string_t input;
+    input_load_string(&input, string);
+
+    return parse_input_comments(&input, check_string(filepath));
+}
+
+// Parse the given file and return an array of Comment objects.
+static VALUE
+parse_file_comments(VALUE self, VALUE filepath) {
+    pm_string_t input;
+
+    const char *checked = check_string(filepath);
+    if (!pm_string_mapped_init(&input, checked)) return Qnil;
+
+    VALUE value = parse_input_comments(&input, checked);
+    pm_string_free(&input);
+
+    return value;
+}
+
 // Parse the given string and return a ParseResult instance.
 static VALUE
 parse_lex(int argc, VALUE *argv, VALUE self) {
@@ -554,6 +599,31 @@ parse_serialize_file_metadata(VALUE self, VALUE filepath, VALUE metadata) {
     return result;
 }
 
+// Inspect the AST that represents the given source using the prism pretty print
+// as opposed to the Ruby implementation.
+static VALUE
+inspect_node(VALUE self, VALUE source) {
+    pm_string_t input;
+    input_load_string(&input, source);
+
+    pm_parser_t parser;
+    pm_parser_init(&parser, pm_string_source(&input), pm_string_length(&input), NULL);
+
+    pm_node_t *node = pm_parse(&parser);
+    pm_buffer_t buffer = { 0 };
+
+    pm_prettyprint(&buffer, &parser, node);
+
+    rb_encoding *encoding = rb_enc_find(parser.encoding.name);
+    VALUE string = rb_enc_str_new(pm_buffer_value(&buffer), pm_buffer_length(&buffer), encoding);
+
+    pm_buffer_free(&buffer);
+    pm_node_destroy(&parser, node);
+    pm_parser_free(&parser);
+
+    return string;
+}
+
 /******************************************************************************/
 /* Initialization of the extension                                            */
 /******************************************************************************/
@@ -596,6 +666,8 @@ Init_prism(void) {
     rb_define_singleton_method(rb_cPrism, "lex_file", lex_file, 1);
     rb_define_singleton_method(rb_cPrism, "parse", parse, -1);
     rb_define_singleton_method(rb_cPrism, "parse_file", parse_file, 1);
+    rb_define_singleton_method(rb_cPrism, "parse_comments", parse_comments, -1);
+    rb_define_singleton_method(rb_cPrism, "parse_file_comments", parse_file_comments, 1);
     rb_define_singleton_method(rb_cPrism, "parse_lex", parse_lex, -1);
     rb_define_singleton_method(rb_cPrism, "parse_lex_file", parse_lex_file, 1);
 
@@ -606,6 +678,7 @@ Init_prism(void) {
     rb_define_singleton_method(rb_cPrismDebug, "memsize", memsize, 1);
     rb_define_singleton_method(rb_cPrismDebug, "profile_file", profile_file, 1);
     rb_define_singleton_method(rb_cPrismDebug, "parse_serialize_file_metadata", parse_serialize_file_metadata, 2);
+    rb_define_singleton_method(rb_cPrismDebug, "inspect_node", inspect_node, 1);
 
     // Next, initialize the other APIs.
     Init_prism_api_node();