prism 0.27.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c27362d3d2d174aeaeab0db8eaf69b47d618f4c2948c9c8a55e96cb927c1ddd6
-  data.tar.gz: f66f7d1e74c9e35c5ce45e8e34240f90cfc659bc5641048f81f3835ae52fd584
+  metadata.gz: 4ac8167684c0f975fdba449e77206d97756f6c39f22ce871f79a79a61260503f
+  data.tar.gz: 6a2dd5c0a47df7c8c575ad2e5b344c789d548e93cfe82e5fa29974d46a52bb3c
 SHA512:
-  metadata.gz: dc64bd0ead37af96b5632498babd6860c9f257c98b0f9dc7aae2c78d6a853b9b95ef6a2f625f61ee1348ef41645e5d4c3f256c30357abca33d7d9387b2a76e2e
-  data.tar.gz: 34f22069e23dc9adf8c7968e7dcf929b479ef3650c909c4c3ad142e858d89c529bc53b6bd38c40fa7f00340dbafabb86fdf59ab6ba3367b71f64c43201b4e99a
+  metadata.gz: dfa7fe63285b85cb45aa0be681916d6891ee5e5adf2162ab5c18423417f7938afc99f00eca8fd6187fbd0b7168af088d932fbda3c1361d1c73953f39329bed70
+  data.tar.gz: 79bc51db60600d74a6bfbeae5eba3a8ec505e9809d0f7ff0b05563f1f7a8cd284cc293233397323a443217a4a5271f90b4c40516168ae3a8be0ddc2d7376cef9

data/CHANGELOG.md

@@ -6,6 +6,48 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.29.0] - 2024-05-10
+
+### Added
+
+- Added `Prism::CallNode#full_message_loc`, which gives the location including the `=` if there is one.
+- A warning for when `# shareable_constant_value` is not used on its own line.
+- An error for invalid implicit local variable writes.
+- Implicit hash patterns in array patterns are disallowed.
+- We now validate that Unicode escape sequences are not surrogates.
+
+### Changed
+
+- All fields named `operator` have been renamed to `binary_operator` for `*OperatorWriteNode` nodes. This is to make it easier to provide C++ support. In the Ruby API, the old fields are aliased to the new fields with a deprecation warning.
+- Many updated error messages to more closely match CRuby.
+- We ensure keyword parameters do not end in `!` or `?`.
+- Fixed some escaping in string literals with control sequences and hex escapes.
+- Fix a bug with RBS types when used outside the `ruby/prism` codebase.
+
+## [0.28.0] - 2024-05-03
+
+### Added
+
+- Nested hashes will now warn for duplicated keys, as in: `{ foo: 1, **{ foo: 2 } }`.
+- `Prism::ReturnNode` now has a flag on it to indicate if it is redundant.
+- `Prism::Location#slice_lines` and `Prism::Node#slice_lines` are now provided to slice the source code of a node including the content before the node on the same line that it starts on and the content after the node on the same line that it ends on.
+- Symbols with invalid byte sequences now give errors.
+- You can now pass `"3.3.1"` to the `version:` parameter on all `Prism.*` APIs.
+- `Prism::Source#lines`, `Prism::Location#source_lines`, `Prism::Node#source_lines`, and `Prism::Node#script_lines` are now provided, which will all return the source code of the source as an array of strings.
+- `Prism::ASCIISource` is now provided, which is a subclass of `Prism::Source` but specialized to increase performance when the source is entirely ASCII.
+- Prism now provides errors when parsing Ruby 3.4+ syntax for index expressions with keywords or blocks.
+- Prism now provides an error when `**nil` is used after other keyword parameters.
+- Prism now provides errors when safe navigation is used in call target expressions, e.g., `foo&.bar, = 1`.
+- `Prism::Node#tunnel` is now provided, which returns an array of nodes starting at the current node that contain a given line and column.
+
+### Changed
+
+- All translation layers now assume an eval context, which means they will not return errors for invalid jumps like `yield`.
+- `Prism::Node#inspect` now uses a queue instead of recursion to avoid stack overflows.
+- Prism now more closely mirrors CRuby interpolation semantics, which means you could potentially have a static literal string that directly interpolates another static literal string.
+- The shipped RBI sorbet types no longer use generics.
+- `Prism::ConstantPathNode#child` and `Prism::ConstantTargetNode#child` are now deprecated, replaced by two new fields on these nodes: `name` and `name_loc`.
+
 ## [0.27.0] - 2024-04-23
 
 ### Added
@@ -476,7 +518,9 @@ 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.27.0...HEAD
+[unreleased]: https://github.com/ruby/prism/compare/v0.29.0...HEAD
+[0.29.0]: https://github.com/ruby/prism/compare/v0.28.0...v0.29.0
+[0.28.0]: https://github.com/ruby/prism/compare/v0.27.0...v0.28.0
 [0.27.0]: https://github.com/ruby/prism/compare/v0.26.0...v0.27.0
 [0.26.0]: https://github.com/ruby/prism/compare/v0.25.0...v0.26.0
 [0.25.0]: https://github.com/ruby/prism/compare/v0.24.0...v0.25.0

data/config.yml

@@ -7,13 +7,16 @@ errors:
   - ARGUMENT_BARE_HASH
   - ARGUMENT_BLOCK_FORWARDING
   - ARGUMENT_BLOCK_MULTI
+  - ARGUMENT_CONFLICT_AMPERSAND
+  - ARGUMENT_CONFLICT_STAR
+  - ARGUMENT_CONFLICT_STAR_STAR
   - ARGUMENT_FORMAL_CLASS
   - ARGUMENT_FORMAL_CONSTANT
   - ARGUMENT_FORMAL_GLOBAL
   - ARGUMENT_FORMAL_IVAR
   - ARGUMENT_FORWARDING_UNBOUND
   - ARGUMENT_IN
-  - ARGUMENT_NO_FORWARDING_AMP
+  - ARGUMENT_NO_FORWARDING_AMPERSAND
   - ARGUMENT_NO_FORWARDING_ELLIPSES
   - ARGUMENT_NO_FORWARDING_STAR
   - ARGUMENT_NO_FORWARDING_STAR_STAR
@@ -95,6 +98,7 @@ errors:
   - EXPECT_EXPRESSION_AFTER_SPLAT_HASH
   - EXPECT_EXPRESSION_AFTER_STAR
   - EXPECT_IDENT_REQ_PARAMETER
+  - EXPECT_IN_DELIMITER
   - EXPECT_LPAREN_REQ_PARAMETER
   - EXPECT_MESSAGE
   - EXPECT_RBRACKET
@@ -123,16 +127,18 @@ errors:
   - HASH_ROCKET
   - HASH_TERM
   - HASH_VALUE
+  - HEREDOC_IDENTIFIER
   - HEREDOC_TERM
   - INCOMPLETE_QUESTION_MARK
   - INCOMPLETE_VARIABLE_CLASS
-  - INCOMPLETE_VARIABLE_CLASS_3_3_0
+  - INCOMPLETE_VARIABLE_CLASS_3_3
   - INCOMPLETE_VARIABLE_INSTANCE
-  - INCOMPLETE_VARIABLE_INSTANCE_3_3_0
+  - INCOMPLETE_VARIABLE_INSTANCE_3_3
   - INSTANCE_VARIABLE_BARE
   - INVALID_BLOCK_EXIT
   - INVALID_CHARACTER
   - INVALID_ENCODING_MAGIC_COMMENT
+  - INVALID_ESCAPE_CHARACTER
   - INVALID_FLOAT_EXPONENT
   - INVALID_LOCAL_VARIABLE_READ
   - INVALID_LOCAL_VARIABLE_WRITE
@@ -141,16 +147,19 @@ errors:
   - INVALID_MULTIBYTE_ESCAPE
   - INVALID_NUMBER_BINARY
   - INVALID_NUMBER_DECIMAL
+  - INVALID_NUMBER_FRACTION
   - INVALID_NUMBER_HEXADECIMAL
   - INVALID_NUMBER_OCTAL
-  - INVALID_NUMBER_UNDERSCORE
+  - INVALID_NUMBER_UNDERSCORE_INNER
+  - INVALID_NUMBER_UNDERSCORE_TRAILING
   - INVALID_PERCENT
   - INVALID_PRINTABLE_CHARACTER
   - INVALID_RETRY_AFTER_ELSE
   - INVALID_RETRY_AFTER_ENSURE
   - INVALID_RETRY_WITHOUT_RESCUE
+  - INVALID_SYMBOL
   - INVALID_VARIABLE_GLOBAL
-  - INVALID_VARIABLE_GLOBAL_3_3_0
+  - INVALID_VARIABLE_GLOBAL_3_3
   - INVALID_YIELD
   - IT_NOT_ALLOWED_NUMBERED
   - IT_NOT_ALLOWED_ORDINARY
@@ -184,6 +193,7 @@ errors:
   - PARAMETER_ASSOC_SPLAT_MULTI
   - PARAMETER_BLOCK_MULTI
   - PARAMETER_CIRCULAR
+  - PARAMETER_FORWARDING_AFTER_REST
   - PARAMETER_METHOD_NAME
   - PARAMETER_NAME_DUPLICATED
   - PARAMETER_NO_DEFAULT
@@ -194,6 +204,7 @@ errors:
   - PARAMETER_STAR
   - PARAMETER_UNEXPECTED_FWD
   - PARAMETER_WILD_LOOSE_COMMA
+  - PARAMETER_UNEXPECTED_NO_KW
   - PATTERN_CAPTURE_DUPLICATE
   - PATTERN_EXPRESSION_AFTER_BRACKET
   - PATTERN_EXPRESSION_AFTER_COMMA
@@ -205,8 +216,10 @@ errors:
   - PATTERN_EXPRESSION_AFTER_PIPE
   - PATTERN_EXPRESSION_AFTER_RANGE
   - PATTERN_EXPRESSION_AFTER_REST
+  - PATTERN_HASH_IMPLICIT
   - PATTERN_HASH_KEY
   - PATTERN_HASH_KEY_DUPLICATE
+  - PATTERN_HASH_KEY_INTERPOLATED
   - PATTERN_HASH_KEY_LABEL
   - PATTERN_HASH_KEY_LOCALS
   - PATTERN_IDENT_AFTER_HROCKET
@@ -247,6 +260,9 @@ errors:
   - UNARY_RECEIVER
   - UNDEF_ARGUMENT
   - UNEXPECTED_BLOCK_ARGUMENT
+  - UNEXPECTED_INDEX_BLOCK
+  - UNEXPECTED_INDEX_KEYWORDS
+  - UNEXPECTED_SAFE_NAVIGATION
   - UNEXPECTED_TOKEN_CLOSE_CONTEXT
   - UNEXPECTED_TOKEN_IGNORE
   - UNTIL_TERM
@@ -266,7 +282,7 @@ warnings:
   - COMPARISON_AFTER_COMPARISON
   - DOT_DOT_DOT_EOL
   - EQUAL_IN_CONDITIONAL
-  - EQUAL_IN_CONDITIONAL_3_3_0
+  - EQUAL_IN_CONDITIONAL_3_3
   - END_IN_METHOD
   - DUPLICATED_HASH_KEY
   - DUPLICATED_WHEN_CLAUSE
@@ -279,6 +295,7 @@ warnings:
   - KEYWORD_EOL
   - LITERAL_IN_CONDITION_DEFAULT
   - LITERAL_IN_CONDITION_VERBOSE
+  - SHAREABLE_CONSTANT_VALUE_LINE
   - SHEBANG_CARRIAGE_RETURN
   - UNEXPECTED_CARRIAGE_RETURN
   - UNREACHABLE_STATEMENT
@@ -617,6 +634,8 @@ tokens:
 flags:
   - name: ArgumentsNodeFlags
     values:
+      - name: CONTAINS_KEYWORDS
+        comment: "if arguments contain keywords"
       - name: CONTAINS_KEYWORD_SPLAT
         comment: "if arguments contain keyword splat"
     comment: Flags for arguments nodes.
@@ -706,6 +725,11 @@ flags:
       - name: FORCED_US_ASCII_ENCODING
         comment: "internal bytes forced the encoding to US-ASCII"
     comment: Flags for regular expression and match last line nodes.
+  - name: ReturnNodeFlags
+    values:
+      - name: REDUNDANT
+        comment: "a return statement that is redundant because it is the last statement in a method"
+    comment: Flags for return nodes.
   - name: ShareableConstantNodeFlags
     values:
       - name: LITERAL
@@ -1189,9 +1213,9 @@ nodes:
         type: constant
       - name: write_name
         type: constant
-      - name: operator
+      - name: binary_operator
         type: constant
-      - name: operator_loc
+      - name: binary_operator_loc
         type: location
       - name: value
         type: node
@@ -1347,11 +1371,11 @@ nodes:
         type: constant
       - name: name_loc
         type: location
-      - name: operator_loc
+      - name: binary_operator_loc
         type: location
       - name: value
         type: node
-      - name: operator
+      - name: binary_operator
         type: constant
     comment: |
       Represents assigning to a class variable using an operator that isn't `=`.
@@ -1457,11 +1481,11 @@ nodes:
         type: constant
       - name: name_loc
         type: location
-      - name: operator_loc
+      - name: binary_operator_loc
         type: location
       - name: value
         type: node
-      - name: operator
+      - name: binary_operator
         type: constant
     comment: |
       Represents assigning to a constant using an operator that isn't `=`.
@@ -1512,23 +1536,9 @@ nodes:
 
               a.b::C
               ^^^
-      - name: child
-        type: node
-        kind:
-          - ConstantReadNode
-          - MissingNode
-        comment: |
-          The right-hand node of the path. Always a `ConstantReadNode` in a
-          valid Ruby syntax tree.
-
-              ::Foo
-                ^^^
-
-              self::Test
-                    ^^^^
-
-              a.b::C
-                   ^
+      - name: name
+        type: constant?
+        comment: The name of the constant being accessed. This could be `nil` in the event of a syntax error.
       - name: delimiter_loc
         type: location
         comment: |
@@ -1539,6 +1549,16 @@ nodes:
 
               One::Two
                  ^^
+      - name: name_loc
+        type: location
+        comment: |
+          The location of the name of the constant.
+
+              ::Foo
+                ^^^
+
+              One::Two
+                   ^^^
     comment: |
       Represents accessing a constant through a path of `::` operators.
 
@@ -1549,11 +1569,11 @@ nodes:
       - name: target
         type: node
         kind: ConstantPathNode
-      - name: operator_loc
+      - name: binary_operator_loc
         type: location
       - name: value
         type: node
-      - name: operator
+      - name: binary_operator
         type: constant
     comment: |
       Represents assigning to a constant path using an operator that isn't `=`.
@@ -1578,13 +1598,12 @@ nodes:
     fields:
       - name: parent
         type: node?
-      - name: child
-        type: node
-        kind:
-          - ConstantReadNode
-          - MissingNode
+      - name: name
+        type: constant?
       - name: delimiter_loc
         type: location
+      - name: name_loc
+        type: location
     comment: |
       Represents writing to a constant path in a context that doesn't have an explicit value.
 
@@ -1921,11 +1940,11 @@ nodes:
         type: constant
       - name: name_loc
         type: location
-      - name: operator_loc
+      - name: binary_operator_loc
         type: location
       - name: value
         type: node
-      - name: operator
+      - name: binary_operator
         type: constant
     comment: |
       Represents assigning to a global variable using an operator that isn't `=`.
@@ -2257,9 +2276,9 @@ nodes:
         type: location
       - name: block
         type: node?
-      - name: operator
+      - name: binary_operator
         type: constant
-      - name: operator_loc
+      - name: binary_operator_loc
         type: location
       - name: value
         type: node
@@ -2345,11 +2364,11 @@ nodes:
         type: constant
       - name: name_loc
         type: location
-      - name: operator_loc
+      - name: binary_operator_loc
         type: location
       - name: value
         type: node
-      - name: operator
+      - name: binary_operator
         type: constant
     comment: |
       Represents assigning to an instance variable using an operator that isn't `=`.
@@ -2625,13 +2644,13 @@ nodes:
     fields:
       - name: name_loc
         type: location
-      - name: operator_loc
+      - name: binary_operator_loc
         type: location
       - name: value
         type: node
       - name: name
         type: constant
-      - name: operator
+      - name: binary_operator
         type: constant
       - name: depth
         type: uint32
@@ -3066,6 +3085,8 @@ nodes:
           # On parsing error of `f(**kwargs, ...)` or `f(**nil, ...)`, the keyword_rest value is moved here:
           - KeywordRestParameterNode
           - NoKeywordsParameterNode
+          # On parsing error of `f(..., ...)`, the first forwarding parameter is moved here:
+          - ForwardingParameterNode
       - name: keywords
         type: node[]
         kind:
@@ -3330,6 +3351,9 @@ nodes:
           ^^^^^
   - name: ReturnNode
     fields:
+      - name: flags
+        type: flags
+        kind: ReturnNodeFlags
       - name: keyword_loc
         type: location
       - name: arguments

data/docs/configuration.md

@@ -14,6 +14,7 @@ A lot of code in prism's repository is templated from a single configuration fil
 * `lib/prism/dispatcher.rb` - for defining the dispatch visitors for the nodes in Ruby
 * `lib/prism/dot_visitor.rb` - for defining the dot visitor for the nodes in Ruby
 * `lib/prism/dsl.rb` - for defining the DSL for the nodes in Ruby
+* `lib/prism/inspect_visitor.rb` - for defining the `#inspect` methods on nodes in Ruby
 * `lib/prism/mutation_compiler.rb` - for defining the mutation compiler for the nodes in Ruby
 * `lib/prism/node.rb` - for defining the nodes in Ruby
 * `lib/prism/reflection.rb` - for defining the reflection API in Ruby