Ruby: Re-enable Sorbet check (#465)

Now that Sorbet supports RBS aliases, this PR updates the Gemfile and
modifies the files under `/lib` to fix any type errors raised by Sorbet

Resolves #114

---------

Co-authored-by: Marco Roth <marco.roth@intergga.ch>

Author: mickeytgl

.github/workflows/build.yml

@@ -56,12 +56,12 @@ jobs:
       - name: Steep
         run: bundle exec steep check
 
+      - name: Sorbet
+        run: bundle exec srb tc
+
       - name: RBS Inline
         run: bundle exec rake rbs_inline
 
-      # - name: Sorbet
-      #   run: bundle exec srb tc
-
       - name: clang-tidy version
         run: clang-tidy-21 --version
 

lib/herb/ast/helpers.rb

@@ -4,12 +4,12 @@
 module Herb
   module AST
     module Helpers
-      #: (Herb::AST::Node) -> bool
+      #: (Herb::AST::Node?) -> bool
       def erb_outputs?(node)
         return false unless node.is_a?(Herb::AST::ERBContentNode)
 
-        opening = node.tag_opening&.value
-        opening&.include?("=") && !opening&.start_with?("<%#")
+        opening = node.tag_opening&.value || ""
+        opening.include?("=") && !opening.start_with?("<%#")
       end
 
       #: (String) -> bool

lib/herb/ast/node.rb

@@ -2,13 +2,18 @@
 # typed: true
 
 module Herb
+  #: type serialized_node = {
+  #|  type: String,
+  #|  location: serialized_location?,
+  #|  errors: Array[serialized_error]
+  #| }
   module AST
     class Node
       attr_reader :type #: String
       attr_reader :location #: Location
       attr_reader :errors #: Array[Herb::Errors::Error]
 
-      #: (String, Location, Array[Herb::Errors::Error]) -> void
+      #: (String, Location, ?Array[Herb::Errors::Error]) -> void
       def initialize(type, location, errors = [])
         @type = type
         @location = location
@@ -19,7 +24,7 @@ def initialize(type, location, errors = [])
       def to_hash
         {
           type: type,
-          location: location&.to_hash,
+          location: location.to_hash,
           errors: errors.map(&:to_hash),
         }
       end

lib/herb/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: false
 
 require "json"
 require "time"

lib/herb/engine/debug_visitor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: false
 
 module Herb
   class Engine
@@ -31,6 +32,7 @@ def initialize(file_path: nil, project_path: nil)
         @in_html_comment = false
         @in_html_doctype = false
         @erb_nodes_to_wrap = [] #: Array[Herb::AST::ERBContentNode]
+        @top_level_elements = [] #: Array[Herb::AST::HTMLElementNode]
       end
 
       def visit_document_node(node)
@@ -149,8 +151,6 @@ def replace_erb_nodes_recursive(node)
       end
 
       def find_top_level_elements(document_node)
-        @top_level_elements = [] #: Array[Herb::AST::HTMLElementNode]
-
         document_node.children.each do |child|
           @top_level_elements << child if child.is_a?(Herb::AST::HTMLElementNode)
         end

lib/herb/lex_result.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 module Herb
   class LexResult < Result

lib/herb/location.rb

@@ -2,6 +2,10 @@
 # typed: true
 
 module Herb
+  #: type serialized_location = {
+  #| start: serialized_position,
+  #| end: serialized_position
+  #| }
   class Location
     attr_reader :start #: Position
     attr_reader :end #: Position
@@ -28,9 +32,9 @@ def self.[](start_line, start_column, end_line, end_column)
     #: () -> serialized_location
     def to_hash
       {
-        start: start,
-        end: self.end,
-      } #: Herb::serialized_location
+        start: start.to_hash,
+        end: self.end.to_hash,
+      }
     end
 
     #: (?untyped) -> String

lib/herb/parse_result.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 require "json"
 

lib/herb/position.rb

@@ -2,6 +2,7 @@
 # typed: true
 
 module Herb
+  #: type serialized_position = { line: Integer, column: Integer }
   class Position
     attr_reader :line #: Integer
     attr_reader :column #: Integer

lib/herb/range.rb

@@ -2,6 +2,7 @@
 # typed: true
 
 module Herb
+  #: type serialized_range = [Integer, Integer]
   class Range
     attr_reader :from #: Integer
     attr_reader :to #: Integer