prism 0.15.1 → 0.17.0

data/lib/prism/visitor.rb

@@ -11,14 +11,18 @@ module Prism
   # implement each one that they need. For a default implementation that
   # continues walking the tree, see the Visitor class.
   class BasicVisitor
+    # Calls `accept` on the given node if it is not `nil`, which in turn should
+    # call back into this visitor by calling the appropriate `visit_*` method.
     def visit(node)
       node&.accept(self)
     end
 
+    # Visits each node in `nodes` by calling `accept` on each one.
     def visit_all(nodes)
       nodes.each { |node| node&.accept(self) }
     end
 
+    # Visits the child nodes of `node` by calling `accept` on each one.
     def visit_child_nodes(node)
       node.compact_child_nodes.each { |node| node.accept(self) }
     end
@@ -296,9 +300,6 @@ module Prism
     # Visit a KeywordHashNode node
     alias visit_keyword_hash_node visit_child_nodes
 
-    # Visit a KeywordParameterNode node
-    alias visit_keyword_parameter_node visit_child_nodes
-
     # Visit a KeywordRestParameterNode node
     alias visit_keyword_rest_parameter_node visit_child_nodes
 
@@ -359,6 +360,9 @@ module Prism
     # Visit a NumberedReferenceReadNode node
     alias visit_numbered_reference_read_node visit_child_nodes
 
+    # Visit a OptionalKeywordParameterNode node
+    alias visit_optional_keyword_parameter_node visit_child_nodes
+
     # Visit a OptionalParameterNode node
     alias visit_optional_parameter_node visit_child_nodes
 
@@ -398,8 +402,8 @@ module Prism
     # Visit a RegularExpressionNode node
     alias visit_regular_expression_node visit_child_nodes
 
-    # Visit a RequiredDestructuredParameterNode node
-    alias visit_required_destructured_parameter_node visit_child_nodes
+    # Visit a RequiredKeywordParameterNode node
+    alias visit_required_keyword_parameter_node visit_child_nodes
 
     # Visit a RequiredParameterNode node
     alias visit_required_parameter_node visit_child_nodes

data/lib/prism.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
+# The Prism Ruby parser.
+#
+# "Parsing Ruby is suddenly manageable!"
+#   - You, hopefully
+#
 module Prism
   # There are many files in prism that are templated to handle every node type,
   # which means the files can end up being quite large. We autoload them to make
   # our require speed faster since consuming libraries are unlikely to use all
   # of these features.
+
   autoload :BasicVisitor, "prism/visitor"
   autoload :Compiler, "prism/compiler"
   autoload :Debug, "prism/debug"
@@ -23,17 +29,26 @@ module Prism
 
   # Some of these constants are not meant to be exposed, so marking them as
   # private here.
+
   private_constant :Debug
   private_constant :LexCompat
   private_constant :LexRipper
 
+  # :call-seq:
+  #   Prism::lex_compat(source, **options) -> Array
+  #
   # Returns an array of tokens that closely resembles that of the Ripper lexer.
   # The only difference is that since we don't keep track of lexer state in the
   # same way, it's going to always return the NONE state.
-  def self.lex_compat(source, filepath = "")
-    LexCompat.new(source, filepath).result
+  #
+  # For supported options, see Prism::parse.
+  def self.lex_compat(source, **options)
+    LexCompat.new(source, **options).result
   end
 
+  # :call-seq:
+  #   Prism::lex_ripper(source) -> Array
+  #
   # This lexes with the Ripper lex. It drops any space events but otherwise
   # returns the same tokens. Raises SyntaxError if the syntax in source is
   # invalid.
@@ -41,6 +56,9 @@ module Prism
     LexRipper.new(source).result
   end
 
+  # :call-seq:
+  #   Prism::load(source, serialized) -> ParseResult
+  #
   # Load the serialized AST using the source as a reference into a tree.
   def self.load(source, serialized)
     Serialize.load(source, serialized)

data/prism.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "prism"
-  spec.version = "0.15.1"
+  spec.version = "0.17.0"
   spec.authors = ["Shopify"]
   spec.email = ["ruby@shopify.com"]
 
@@ -28,8 +28,9 @@ Gem::Specification.new do |spec|
     "docs/encoding.md",
     "docs/fuzzing.md",
     "docs/heredocs.md",
+    "docs/javascript.md",
     "docs/mapping.md",
-    "docs/prism.png",
+    "docs/releasing.md",
     "docs/ripper.md",
     "docs/ruby_api.md",
     "docs/serialization.md",
@@ -44,8 +45,10 @@ Gem::Specification.new do |spec|
     "include/prism/diagnostic.h",
     "include/prism/enc/pm_encoding.h",
     "include/prism/node.h",
+    "include/prism/options.h",
     "include/prism/pack.h",
     "include/prism/parser.h",
+    "include/prism/prettyprint.h",
     "include/prism/regexp.h",
     "include/prism/util/pm_buffer.h",
     "include/prism/util/pm_char.h",
@@ -54,6 +57,7 @@ Gem::Specification.new do |spec|
     "include/prism/util/pm_memchr.h",
     "include/prism/util/pm_newline_list.h",
     "include/prism/util/pm_state_stack.h",
+    "include/prism/util/pm_strncasecmp.h",
     "include/prism/util/pm_string.h",
     "include/prism/util/pm_string_list.h",
     "include/prism/util/pm_strpbrk.h",
@@ -103,8 +107,13 @@ Gem::Specification.new do |spec|
     "src/util/pm_string_list.c",
     "src/util/pm_strncasecmp.c",
     "src/util/pm_strpbrk.c",
+    "src/options.c",
     "src/prism.c",
     "prism.gemspec",
+    "sig/prism.rbs",
+    "sig/prism_static.rbs",
+    "rbi/prism.rbi",
+    "rbi/prism_static.rbi"
   ]
 
   spec.extensions = ["ext/prism/extconf.rb"]