herb 0.11.1 → 0.11.2

data/vendor/prism/templates/lib/prism/compiler.rb.erb

@@ -1,3 +1,6 @@
+#--
+# rbs_inline: enabled
+
 module Prism
   # A compiler is a visitor that returns the value of each node as it visits.
   # This is as opposed to a visitor which will only walk the tree. This can be
@@ -18,24 +21,30 @@ module Prism
   #
   class Compiler < Visitor
     # Visit an individual node.
-    def visit(node)
+    #
+    #: (node?) -> untyped
+    def visit(node) # :nodoc:
       node&.accept(self)
     end
 
     # Visit a list of nodes.
-    def visit_all(nodes)
+    #
+    #: (Array[node?]) -> untyped
+    def visit_all(nodes) # :nodoc:
       nodes.map { |node| node&.accept(self) }
     end
 
     # Visit the child nodes of the given node.
-    def visit_child_nodes(node)
+    #
+    #: (node) -> Array[untyped]
+    def visit_child_nodes(node) # :nodoc:
       node.each_child_node.map { |node| node.accept(self) }
     end
 
     <%- nodes.each_with_index do |node, index| -%>
 <%= "\n" if index != 0 -%>
-    # Compile a <%= node.name %> node
-    def visit_<%= node.human %>(node)
+    #: (<%= node.name %>) -> Array[untyped]
+    def visit_<%= node.human %>(node) # :nodoc:
       node.each_child_node.map { |node| node.accept(self) }
     end
     <%- end -%>

data/vendor/prism/templates/lib/prism/dispatcher.rb.erb

@@ -1,3 +1,6 @@
+#--
+# rbs_inline: enabled
+
 module Prism
   # The dispatcher class fires events for nodes that are found while walking an
   # AST to all registered listeners. It's useful for performing different types
@@ -32,17 +35,20 @@ module Prism
   #     dispatcher.dispatch_once(integer)
   #
   class Dispatcher < Visitor
-    # attr_reader listeners: Hash[Symbol, Array[Listener]]
-    attr_reader :listeners
+    # A hash mapping event names to arrays of listeners that should be notified
+    # when that event is fired.
+    attr_reader :listeners #: Hash[Symbol, Array[untyped]]
 
     # Initialize a new dispatcher.
+    #
+    #: () -> void
     def initialize
       @listeners = {}
     end
 
     # Register a listener for one or more events.
     #
-    # def register: (Listener, *Symbol) -> void
+    #: (untyped, *Symbol) -> void
     def register(listener, *events)
       register_events(listener, events)
     end
@@ -50,32 +56,31 @@ module Prism
     # Register all public methods of a listener that match the pattern
     # `on_<node_name>_(enter|leave)`.
     #
-    # def register_public_methods: (Listener) -> void
+    #: (untyped) -> void
     def register_public_methods(listener)
       register_events(listener, listener.public_methods(false).grep(/\Aon_.+_(?:enter|leave)\z/))
     end
 
     # Register a listener for the given events.
-    private def register_events(listener, events)
+    #
+    #: (untyped, Array[Symbol]) -> void
+    private def register_events(listener, events) # :nodoc:
       events.each { |event| (listeners[event] ||= []) << listener }
     end
 
     # Walks `root` dispatching events to all registered listeners.
-    #
-    # def dispatch: (Node) -> void
     alias dispatch visit
 
     # Dispatches a single event for `node` to all registered listeners.
     #
-    # def dispatch_once: (Node) -> void
+    #: (node node) -> void
     def dispatch_once(node)
       node.accept(DispatchOnce.new(listeners))
     end
     <%- nodes.each do |node| -%>
 
-    # Dispatch enter and leave events for <%= node.name %> nodes and continue
-    # walking the tree.
-    def visit_<%= node.human %>(node)
+    #: (<%= node.name %> node) -> void
+    def visit_<%= node.human %>(node) # :nodoc:
       listeners[:on_<%= node.human %>_enter]&.each { |listener| listener.on_<%= node.human %>_enter(node) }
       super
       listeners[:on_<%= node.human %>_leave]&.each { |listener| listener.on_<%= node.human %>_leave(node) }
@@ -83,14 +88,17 @@ module Prism
     <%- end -%>
 
     class DispatchOnce < Visitor # :nodoc:
-      attr_reader :listeners
+      attr_reader :listeners #: Hash[Symbol, Array[untyped]]
 
+      #: (Hash[Symbol, Array[untyped]] listeners) -> void
       def initialize(listeners)
         @listeners = listeners
       end
       <%- nodes.each do |node| -%>
 
       # Dispatch enter and leave events for <%= node.name %> nodes.
+      #
+      #: (<%= node.name %> node) -> void
       def visit_<%= node.human %>(node)
         listeners[:on_<%= node.human %>_enter]&.each { |listener| listener.on_<%= node.human %>_enter(node) }
         listeners[:on_<%= node.human %>_leave]&.each { |listener| listener.on_<%= node.human %>_leave(node) }

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

@@ -1,3 +1,6 @@
+#--
+# rbs_inline: enabled
+
 require "cgi/escape"
 require "cgi/util" unless defined?(CGI::EscapeExt)
 
@@ -6,14 +9,18 @@ module Prism
   # subtree into a graphviz dot graph.
   class DotVisitor < Visitor
     class Field # :nodoc:
-      attr_reader :name, :value, :port
+      attr_reader :name #: String
+      attr_reader :value #: String?
+      attr_reader :port #: bool
 
+      #: (String name, String? value, bool port) -> void
       def initialize(name, value, port)
         @name = name
         @value = value
         @port = port
       end
 
+      #: () -> String
       def to_dot
         if port
           "<tr><td align=\"left\" colspan=\"2\" port=\"#{name}\">#{name}</td></tr>"
@@ -24,17 +31,21 @@ module Prism
     end
 
     class Table # :nodoc:
-      attr_reader :name, :fields
+      attr_reader :name #: String
+      attr_reader :fields #: Array[Field]
 
+      #: (String name) -> void
       def initialize(name)
         @name = name
         @fields = []
       end
 
+      #: (String name, ?String? value, ?port: bool) -> void
       def field(name, value = nil, port: false)
         fields << Field.new(name, value, port)
       end
 
+      #: () -> String
       def to_dot
         dot = <<~DOT
           <table border="0" cellborder="1" cellspacing="0" cellpadding="4">
@@ -50,26 +61,31 @@ module Prism
     end
 
     class Digraph # :nodoc:
-      attr_reader :nodes, :waypoints, :edges
+      attr_reader :nodes, :waypoints, :edges #: Array[String]
 
+      #: () -> void
       def initialize
         @nodes = []
         @waypoints = []
         @edges = []
       end
 
+      #: (String value) -> void
       def node(value)
         nodes << value
       end
 
+      #: (String value) -> void
       def waypoint(value)
         waypoints << value
       end
 
+      #: (String value) -> void
       def edge(value)
         edges << value
       end
 
+      #: () -> String
       def to_dot
         <<~DOT
           digraph "Prism" {
@@ -93,21 +109,25 @@ module Prism
     private_constant :Field, :Table, :Digraph
 
     # The digraph that is being built.
-    attr_reader :digraph
+    attr_reader :digraph #: Digraph
 
     # Initialize a new dot visitor.
+    #
+    #: () -> void
     def initialize
       @digraph = Digraph.new
     end
 
     # Convert this visitor into a graphviz dot graph string.
+    #
+    #: () -> String
     def to_dot
       digraph.to_dot
     end
     <%- nodes.each do |node| -%>
 
-    # Visit a <%= node.name %> node.
-    def visit_<%= node.human %>(node)
+    #: (<%= node.name %>) -> void
+    def visit_<%= node.human %>(node) # :nodoc:
       table = Table.new("<%= node.name %>")
       id = node_id(node)
       <%- if (node_flags = node.flags) -%>
@@ -152,7 +172,7 @@ module Prism
       <%- end -%>
       <%- end -%>
 
-      digraph.nodes << <<~DOT
+      digraph.node(<<~DOT)
         #{id} [
           label=<#{table.to_dot.gsub(/\n/, "\n  ")}>
         ];
@@ -165,19 +185,25 @@ module Prism
     private
 
     # Generate a unique node ID for a node throughout the digraph.
-    def node_id(node)
+    #
+    #: (node) -> String
+    def node_id(node) # :nodoc:
       "Node_#{node.object_id}"
     end
 
-    # Inspect a location to display the start and end line and column numbers.
-    def location_inspect(location)
+    # Inspect a location to display the start and end line and columns in bytes.
+    #
+    #: (Location) -> String
+    def location_inspect(location) # :nodoc:
       "(#{location.start_line},#{location.start_column})-(#{location.end_line},#{location.end_column})"
     end
     <%- flags.each do |flag| -%>
 
     # Inspect a node that has <%= flag.human %> flags to display the flags as a
     # comma-separated list.
-    def <%= flag.human %>_inspect(node)
+    #
+    #: (<%= nodes.filter_map { |node| node.name if node.flags == flag }.join(" | ") %> node) -> String
+    def <%= flag.human %>_inspect(node) # :nodoc:
       flags = [] #: Array[String]
       <%- flag.values.each do |value| -%>
       flags << "<%= value.name.downcase %>" if node.<%= value.name.downcase %>?

data/vendor/prism/templates/lib/prism/dsl.rb.erb

@@ -1,8 +1,11 @@
+#--
+# rbs_inline: enabled
+
 module Prism
   # The DSL module provides a set of methods that can be used to create prism
   # nodes in a more concise manner. For example, instead of writing:
   #
-  #     source = Prism::Source.for("[1]")
+  #     source = Prism::Source.for("[1]", 1, [0])
   #
   #     Prism::ArrayNode.new(
   #       source,
@@ -56,17 +59,31 @@ module Prism
     extend self
 
     # Create a new Source object.
+    #
+    #: (String string) -> Source
     def source(string)
-      Source.for(string)
+      Source.for(string, 1, build_offsets(string))
     end
 
     # Create a new Location object.
+    #
+    #: (?source: Source, ?start_offset: Integer, ?length: Integer) -> Location
     def location(source: default_source, start_offset: 0, length: 0)
       Location.new(source, start_offset, length)
     end
     <%- nodes.each do |node| -%>
+    <%-
+    params = [
+      ["source", "Source"],
+      ["node_id", "Integer"],
+      ["location", "Location"],
+      ["flags", "Integer"]
+    ].concat(node.fields.map { |field| [field.name, field.rbs_class] })
+    -%>
 
     # Create a new <%= node.name %> node.
+    #
+    #: (<%= params.map { |(name, type)| "?#{name}: #{type}" }.join(", ") %>) -> <%= node.name %>
     def <%= node.human %>(<%= ["source: default_source", "node_id: 0", "location: default_location", "flags: 0", *node.fields.map { |field|
       case field
       when Prism::Template::NodeField
@@ -100,6 +117,8 @@ module Prism
     <%- flags.each do |flag| -%>
 
     # Retrieve the value of one of the <%= flag.name %> flags.
+    #
+    #: (Symbol name) -> Integer
     def <%= flag.human.chomp("s") %>(name)
       case name
       <%- flag.values.each do |value| -%>
@@ -114,20 +133,40 @@ module Prism
 
     # The default source object that gets attached to nodes and locations if no
     # source is specified.
+    #
+    #: () -> Source
     def default_source
-      Source.for("")
+      Source.for("", 1, [0])
     end
 
     # The default location object that gets attached to nodes if no location is
     # specified, which uses the given source.
+    #
+    #: () -> Location
     def default_location
       Location.new(default_source, 0, 0)
     end
 
     # The default node that gets attached to nodes if no node is specified for a
     # required node field.
+    #
+    #: (Source source, Location location) -> node
     def default_node(source, location)
-      MissingNode.new(source, -1, location, 0)
+      ErrorRecoveryNode.new(source, -1, location, 0, nil)
+    end
+
+    private
+
+    # Build the newline byte offset array for the given source string.
+    #
+    #: (String source) -> Array[Integer]
+    def build_offsets(source)
+      offsets = [0]
+      start = 0
+      while (index = source.byteindex("\n", start))
+        offsets << (start = index + 1)
+      end
+      offsets
     end
   end
 end

data/vendor/prism/templates/lib/prism/inspect_visitor.rb.erb

@@ -1,3 +1,6 @@
+#--
+# rbs_inline: enabled
+
 module Prism
   # This visitor is responsible for composing the strings that get returned by
   # the various #inspect methods defined on each of the nodes.
@@ -7,8 +10,9 @@ module Prism
     # when we hit an element in that list. In this case, we have a special
     # command that replaces the subsequent indent with the given value.
     class Replace # :nodoc:
-      attr_reader :value
+      attr_reader :value #: String
 
+      #: (String value) -> void
       def initialize(value)
         @value = value
       end
@@ -17,19 +21,25 @@ module Prism
     private_constant :Replace
 
     # The current prefix string.
-    attr_reader :indent
+    # :stopdoc:
+    attr_reader :indent #: String
+    # :startdoc:
 
     # The list of commands that we need to execute in order to compose the
     # final string.
-    attr_reader :commands
+    #: stopdoc:
+    attr_reader :commands #: Array[[String | node | Replace, String]]
+    # :startdoc:
 
-    # Initializes a new instance of the InspectVisitor.
-    def initialize(indent = +"")
+    #: (?String indent) -> void
+    def initialize(indent = +"") # :nodoc:
       @indent = indent
       @commands = []
     end
 
     # Compose an inspect string for the given node.
+    #
+    #: (node node) -> String
     def self.compose(node)
       visitor = new
       node.accept(visitor)
@@ -37,7 +47,9 @@ module Prism
     end
 
     # Compose the final string.
-    def compose
+    #
+    #: () -> String
+    def compose # :nodoc:
       buffer = +""
       replace = nil
 
@@ -66,8 +78,8 @@ module Prism
     end
     <%- nodes.each do |node| -%>
 
-    # Inspect a <%= node.name %> node.
-    def visit_<%= node.human %>(node)
+    #: (<%= node.name %> node) -> void
+    def visit_<%= node.human %>(node) # :nodoc:
       commands << [inspect_node(<%= node.name.inspect %>, node), indent]
       <%- (fields = [node.flags || Prism::Template::Flags.empty, *node.fields]).each_with_index do |field, index| -%>
       <%- pointer = index == fields.length - 1 ? "└── " : "├── " -%>
@@ -114,13 +126,17 @@ module Prism
     private
 
     # Compose a header for the given node.
-    def inspect_node(name, node)
+    #
+    #: (String name, node node) -> String
+    def inspect_node(name, node) # :nodoc:
       location = node.location
       "@ #{name} (location: (#{location.start_line},#{location.start_column})-(#{location.end_line},#{location.end_column}))\n"
     end
 
     # Compose a string representing the given inner location field.
-    def inspect_location(location)
+    #
+    #: (Location? location) -> String
+    def inspect_location(location) # :nodoc:
       if location
         "(#{location.start_line},#{location.start_column})-(#{location.end_line},#{location.end_column}) = #{location.slice.inspect}"
       else

data/vendor/prism/templates/lib/prism/mutation_compiler.rb.erb

@@ -1,3 +1,6 @@
+#--
+# rbs_inline: enabled
+
 module Prism
   # This visitor walks through the tree and copies each node as it is being
   # visited. This is useful for consumers that want to mutate the tree, as you
@@ -5,8 +8,8 @@ module Prism
   class MutationCompiler < Compiler
     <%- nodes.each_with_index do |node, index| -%>
 <%= "\n" if index != 0 -%>
-    # Copy a <%= node.name %> node
-    def visit_<%= node.human %>(node)
+    #: (<%= node.name %>) -> node?
+    def visit_<%= node.human %>(node) # :nodoc:
       <%- fields = node.fields.select { |field| [Prism::Template::NodeField, Prism::Template::OptionalNodeField, Prism::Template::NodeListField].include?(field.class) } -%>
       <%- if fields.any? -%>
       node.copy(<%= fields.map { |field| "#{field.name}: #{field.is_a?(Prism::Template::NodeListField) ? "visit_all" : "visit"}(node.#{field.name})" }.join(", ") %>)