[ruby/prism] Generate RBI from RBS

ruby/prism@2c88ed893f

Author: kddnewton

lib/prism.rb

@@ -43,12 +43,12 @@ class CurrentVersionError < ArgumentError
     #: (String version) -> void
     def initialize(version)
       message = +"invalid version: Requested to parse as `version: 'current'`; "
-      segments =
+      major, minor, =
         if version.match?(/\A\d+\.\d+.\d+\z/)
           version.split(".").map(&:to_i)
         end
 
-      if segments && ((segments[0] < 3) || (segments[0] == 3 && segments[1] < 3))
+      if major && minor && ((major < 3) || (major == 3 && minor < 3))
         message << " #{version} is below the minimum supported syntax."
       else
         message << " #{version} is unknown. Please update the `prism` gem."

lib/prism/lex_compat.rb

@@ -7,7 +7,16 @@ module Prism
   # @rbs!
   #    module Translation
   #      class Ripper
+  #        EXPR_NONE: Integer
   #        EXPR_BEG: Integer
+  #        EXPR_MID: Integer
+  #        EXPR_END: Integer
+  #        EXPR_CLASS: Integer
+  #        EXPR_VALUE: Integer
+  #        EXPR_ARG: Integer
+  #        EXPR_CMDARG: Integer
+  #        EXPR_ENDARG: Integer
+  #        EXPR_ENDFN: Integer
   #
   #        class Lexer < Ripper
   #          class State

lib/prism/node_ext.rb

@@ -11,8 +11,7 @@ module Prism
   class Node
     #: (*String replacements) -> void
     def deprecated(*replacements) # :nodoc:
-      location = caller_locations(1, 1)
-      location = location[0].label if location
+      location = caller_locations(1, 1)&.[](0)&.label
       suggest = replacements.map { |replacement| "#{self.class}##{replacement}" }
 
       warn(<<~MSG, uplevel: 1, category: :deprecated)

lib/prism/parse_result/newlines.rb

@@ -114,88 +114,88 @@ def newline_flag!(lines) # :nodoc:
   end
 
   class BeginNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       # Never mark BeginNode with a newline flag, mark children instead.
     end
   end
 
   class ParenthesesNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       # Never mark ParenthesesNode with a newline flag, mark children instead.
     end
   end
 
   class IfNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       predicate.newline_flag!(lines)
     end
   end
 
   class UnlessNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       predicate.newline_flag!(lines)
     end
   end
 
   class UntilNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       predicate.newline_flag!(lines)
     end
   end
 
   class WhileNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       predicate.newline_flag!(lines)
     end
   end
 
   class RescueModifierNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       expression.newline_flag!(lines)
     end
   end
 
   class InterpolatedMatchLastLineNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       first = parts.first
       first.newline_flag!(lines) if first
     end
   end
 
   class InterpolatedRegularExpressionNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       first = parts.first
       first.newline_flag!(lines) if first
     end
   end
 
   class InterpolatedStringNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       first = parts.first
       first.newline_flag!(lines) if first
     end
   end
 
   class InterpolatedSymbolNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       first = parts.first
       first.newline_flag!(lines) if first
     end
   end
 
   class InterpolatedXStringNode < Node
-    # @rbs override
+    #: (Array[bool] lines) -> void
     def newline_flag!(lines) # :nodoc:
       first = parts.first
       first.newline_flag!(lines) if first

lib/prism/pattern.rb

@@ -94,9 +94,9 @@ def compile
     # matches the pattern. If no block is given, an enumerator will be returned
     # that will yield each node that matches the pattern.
     #--
-    #: (node root) { (node) -> void } -> void
     #: (node root) -> Enumerator[node, void]
-    def scan(root)
+    #: (node root) { (node) -> void } -> void
+    def scan(root, &blk)
       return to_enum(:scan, root) unless block_given?
 
       @compiled ||= compile

lib/prism/prism.gemspec

@@ -110,19 +110,31 @@ Gem::Specification.new do |spec|
     "lib/prism/translation/ruby_parser.rb",
     "lib/prism/visitor.rb",
     "prism.gemspec",
-    "rbi/prism.rbi",
-    "rbi/prism/compiler.rbi",
-    "rbi/prism/dsl.rbi",
-    "rbi/prism/inspect_visitor.rbi",
-    "rbi/prism/node_ext.rbi",
-    "rbi/prism/node.rbi",
-    "rbi/prism/parse_result.rbi",
-    "rbi/prism/reflection.rbi",
-    "rbi/prism/string_query.rbi",
+    "rbi/generated/prism.rbi",
+    "rbi/generated/prism/compiler.rbi",
+    "rbi/generated/prism/desugar_compiler.rbi",
+    "rbi/generated/prism/dispatcher.rbi",
+    "rbi/generated/prism/dot_visitor.rbi",
+    "rbi/generated/prism/dsl.rbi",
+    "rbi/generated/prism/inspect_visitor.rbi",
+    "rbi/generated/prism/lex_compat.rbi",
+    "rbi/generated/prism/mutation_compiler.rbi",
+    "rbi/generated/prism/node.rbi",
+    "rbi/generated/prism/node_ext.rbi",
+    "rbi/generated/prism/parse_result.rbi",
+    "rbi/generated/prism/pattern.rbi",
+    "rbi/generated/prism/reflection.rbi",
+    "rbi/generated/prism/relocation.rbi",
+    "rbi/generated/prism/serialize.rbi",
+    "rbi/generated/prism/string_query.rbi",
+    "rbi/generated/prism/translation.rbi",
+    "rbi/generated/prism/visitor.rbi",
+    "rbi/generated/prism/parse_result/comments.rbi",
+    "rbi/generated/prism/parse_result/errors.rbi",
+    "rbi/generated/prism/parse_result/newlines.rbi",
     "rbi/prism/translation/parser.rbi",
     "rbi/prism/translation/parser_versions.rbi",
     "rbi/prism/translation/ripper.rbi",
-    "rbi/prism/visitor.rbi",
     "sig/generated/prism.rbs",
     "sig/generated/prism/compiler.rbs",
     "sig/generated/prism/desugar_compiler.rbs",

prism/templates/lib/prism/dot_visitor.rb.erb

@@ -126,7 +126,7 @@ module Prism
     end
     <%- nodes.each do |node| -%>
 
-    # (<%= node.name %>) -> void
+    #: (<%= node.name %>) -> void
     def visit_<%= node.human %>(node) # :nodoc:
       table = Table.new("<%= node.name %>")
       id = node_id(node)

prism/templates/lib/prism/node.rb.erb

@@ -294,7 +294,7 @@ module Prism
     #     node.breadth_first_search { |node| node.node_id == node_id }
     #--
     #: () { (node) -> bool } -> node?
-    def breadth_first_search(&block)
+    def breadth_first_search(&blk)
       queue = [self] #: Array[node]
 
       while (node = queue.shift)
@@ -313,7 +313,7 @@ module Prism
     #     node.breadth_first_search_all { |node| node.is_a?(Prism::CallNode) }
     #--
     #: () { (node) -> bool } -> Array[node]
-    def breadth_first_search_all(&block)
+    def breadth_first_search_all(&blk)
       queue = [self] #: Array[Prism::node]
       results = [] #: Array[Prism::node]
 
@@ -366,9 +366,9 @@ module Prism
     # an enumerator that contains each child node. Excludes any `nil`s in
     # the place of optional nodes that were not present.
     #--
-    #: () { (node) -> void } -> void
     #: () -> Enumerator[node, void]
-    def each_child_node
+    #: () { (node) -> void } -> void
+    def each_child_node(&blk)
       raise NoMethodError, "undefined method `each_child_node' for #{inspect}"
     end
 
@@ -481,9 +481,9 @@ module Prism
 
     # See Node.each_child_node.
     #--
-    #: () { (node) -> void } -> void
     #: () -> Enumerator[node, void]
-    def each_child_node
+    #: () { (node) -> void } -> void
+    def each_child_node(&blk)
       return to_enum(:each_child_node) unless block_given?
 
       <%- node.fields.each do |field| -%>
@@ -705,7 +705,7 @@ module Prism
     <%- end -%>
     # :section:
 
-    #: (untyped other) -> bool
+    #: (untyped other) -> boolish
     def ===(other) # :nodoc:
       other.is_a?(<%= node.name %>)<%= " &&" if (fields = [*node.flags, *node.fields]).any? %>
         <%- fields.each_with_index do |field, index| -%>