herb 0.10.1 → 0.11.1

data/sig/herb/errors.rbs

@@ -17,6 +17,12 @@ module Herb
       # : (String, Location?, String) -> void
       def initialize: (String, Location?, String) -> void
 
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : (template: String, ?origin: String) -> Herb::Diagnostic
+      def to_diagnostic: (template: String, ?origin: String) -> Herb::Diagnostic
+
       # : () -> serialized_error
       def to_hash: () -> serialized_error
 
@@ -83,6 +89,9 @@ module Herb
       # : (String, Location?, String, Herb::Token) -> void
       def initialize: (String, Location?, String, Herb::Token) -> void
 
+      # : () -> String?
+      def suggestion: () -> String?
+
       # : () -> String
       def inspect: () -> String
 
@@ -101,6 +110,9 @@ module Herb
       # : (String, Location?, String, Herb::Token) -> void
       def initialize: (String, Location?, String, Herb::Token) -> void
 
+      # : () -> String?
+      def suggestion: () -> String?
+
       # : () -> String
       def inspect: () -> String
 
@@ -121,6 +133,9 @@ module Herb
       # : (String, Location?, String, Herb::Token, Herb::Token) -> void
       def initialize: (String, Location?, String, Herb::Token, Herb::Token) -> void
 
+      # : () -> String?
+      def suggestion: () -> String?
+
       # : () -> String
       def inspect: () -> String
 
@@ -143,6 +158,9 @@ module Herb
       # : (String, Location?, String, Herb::Token, String, String) -> void
       def initialize: (String, Location?, String, Herb::Token, String, String) -> void
 
+      # : () -> String?
+      def suggestion: () -> String?
+
       # : () -> String
       def inspect: () -> String
 
@@ -161,6 +179,9 @@ module Herb
       # : (String, Location?, String, Herb::Token) -> void
       def initialize: (String, Location?, String, Herb::Token) -> void
 
+      # : () -> String?
+      def suggestion: () -> String?
+
       # : () -> String
       def inspect: () -> String
 
@@ -183,6 +204,9 @@ module Herb
       # : (String, Location?, String, String, String, String) -> void
       def initialize: (String, Location?, String, String, String, String) -> void
 
+      # : () -> String?
+      def suggestion: () -> String?
+
       # : () -> String
       def inspect: () -> String
 
@@ -249,6 +273,16 @@ module Herb
       def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
     end
 
+    class ERBCaseInlinePatternMatchError < Error
+      include Colors
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
     class ConditionalElementMultipleTagsError < Error
       include Colors
 
@@ -299,6 +333,50 @@ module Herb
       def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
     end
 
+    class UnclosedCommentError < Error
+      include Colors
+
+      attr_reader comment_start: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token) -> void
+
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_unclosed_comment_error
+      def to_hash: () -> serialized_unclosed_comment_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
+    class NestedCommentError < Error
+      include Colors
+
+      attr_reader comment_start: Herb::Token?
+
+      attr_reader nested_start: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token, Herb::Token) -> void
+
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_nested_comment_error
+      def to_hash: () -> serialized_nested_comment_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
     class InvalidCommentClosingTagError < Error
       include Colors
 
@@ -373,6 +451,27 @@ module Herb
       def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
     end
 
+    class EndTagWithTrailingSolidusError < Error
+      include Colors
+
+      attr_reader tag_name: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token) -> void
+
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_end_tag_with_trailing_solidus_error
+      def to_hash: () -> serialized_end_tag_with_trailing_solidus_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
     class UnclosedQuoteError < Error
       include Colors
 
@@ -399,6 +498,9 @@ module Herb
       # : (String, Location?, String, String) -> void
       def initialize: (String, Location?, String, String) -> void
 
+      # : () -> String?
+      def suggestion: () -> String?
+
       # : () -> String
       def inspect: () -> String
 
@@ -409,6 +511,111 @@ module Herb
       def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
     end
 
+    class MissingWhitespaceBetweenAttributesError < Error
+      include Colors
+
+      attr_reader found: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token) -> void
+
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_missing_whitespace_between_attributes_error
+      def to_hash: () -> serialized_missing_whitespace_between_attributes_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
+    class UnexpectedCharacterInAttributeNameError < Error
+      include Colors
+
+      attr_reader character: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token) -> void
+
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_unexpected_character_in_attribute_name_error
+      def to_hash: () -> serialized_unexpected_character_in_attribute_name_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
+    class UnexpectedCharacterInUnquotedAttributeValueError < Error
+      include Colors
+
+      attr_reader character: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token) -> void
+
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_unexpected_character_in_unquoted_attribute_value_error
+      def to_hash: () -> serialized_unexpected_character_in_unquoted_attribute_value_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
+    class UnexpectedEqualsSignBeforeAttributeNameError < Error
+      include Colors
+
+      attr_reader equals: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token) -> void
+
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_unexpected_equals_sign_before_attribute_name_error
+      def to_hash: () -> serialized_unexpected_equals_sign_before_attribute_name_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
+    class UnexpectedSolidusInTagError < Error
+      include Colors
+
+      attr_reader solidus: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token) -> void
+
+      # : () -> String?
+      def suggestion: () -> String?
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_unexpected_solidus_in_tag_error
+      def to_hash: () -> serialized_unexpected_solidus_in_tag_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
     class UnclosedERBTagError < Error
       include Colors
 
@@ -427,6 +634,26 @@ module Herb
       def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
     end
 
+    class MalformedERBClosingTagError < Error
+      include Colors
+
+      attr_reader opening_tag: Herb::Token?
+
+      attr_reader closing_tag: Herb::Token?
+
+      # : (String, Location?, String, Herb::Token, Herb::Token) -> void
+      def initialize: (String, Location?, String, Herb::Token, Herb::Token) -> void
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_malformed_erb_closing_tag_error
+      def to_hash: () -> serialized_malformed_erb_closing_tag_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
     class StrayERBClosingTagError < Error
       include Colors
 
@@ -655,6 +882,72 @@ module Herb
       def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
     end
 
+    class HerbStateMissingParenthesisError < Error
+      include Colors
+
+      attr_reader rest: String?
+
+      # : (String, Location?, String, String) -> void
+      def initialize: (String, Location?, String, String) -> void
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_herb_state_missing_parenthesis_error
+      def to_hash: () -> serialized_herb_state_missing_parenthesis_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
+    class HerbStateNonCanonicalDirectiveError < Error
+      include Colors
+
+      attr_reader found: String?
+
+      attr_reader expected: String?
+
+      # : (String, Location?, String, String, String) -> void
+      def initialize: (String, Location?, String, String, String) -> void
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_herb_state_non_canonical_directive_error
+      def to_hash: () -> serialized_herb_state_non_canonical_directive_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
+    class HerbStateInvalidParameterError < Error
+      include Colors
+
+      attr_reader parameter: String?
+
+      # : (String, Location?, String, String) -> void
+      def initialize: (String, Location?, String, String) -> void
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_herb_state_invalid_parameter_error
+      def to_hash: () -> serialized_herb_state_invalid_parameter_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
+    class HerbStateDuplicateDeclarationError < Error
+      include Colors
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
+
     class VoidElementContentError < Error
       include Colors
 
@@ -694,5 +987,23 @@ module Herb
       # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
       def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
     end
+
+    class TimeoutError < Error
+      include Colors
+
+      attr_reader timeout_ms: Integer?
+
+      # : (String, Location?, String, Integer) -> void
+      def initialize: (String, Location?, String, Integer) -> void
+
+      # : () -> String
+      def inspect: () -> String
+
+      # : () -> serialized_timeout_error
+      def to_hash: () -> serialized_timeout_error
+
+      # : (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+      def tree_inspect: (?indent: Integer, ?depth: Integer, ?depth_limit: Integer) -> String
+    end
   end
 end

data/sig/herb/fingerprint.rbs

@@ -0,0 +1,37 @@
+# Generated from lib/herb/fingerprint.rb with RBS::Inline
+
+module Herb
+  # Identifies content by what it is instead of by where it lives or when it was touched.
+  #
+  #     Herb::Fingerprint.file(asset)      #=> "9f2a1c4e…"
+  #     Herb::Fingerprint.template(source) #=> "d242d277…"
+  module Fingerprint
+    BOM: String
+
+    SHORT_LENGTH: Integer
+
+    # : (String?) -> String?
+    def self.of: (String?) -> String?
+
+    # : ((String | Pathname)?) -> String?
+    def self.file: ((String | Pathname)?) -> String?
+
+    # : (String?) -> String?
+    def self.template: (String?) -> String?
+
+    # : ((String | Pathname)?) -> String?
+    def self.template_file: ((String | Pathname)?) -> String?
+
+    # : (String?) -> String?
+    def self.short: (String?) -> String?
+
+    # : () -> void
+    def self.clear_cache: () -> void
+
+    # : () -> Hash[Array[untyped], String]
+    def self.cache: () -> Hash[Array[untyped], String]
+
+    # : (String) -> String
+    def self.strip_bom: (String) -> String
+  end
+end

data/sig/herb/html/elements.rbs

@@ -0,0 +1,19 @@
+# Generated from lib/herb/html/elements.rb with RBS::Inline
+
+module Herb
+  module HTML
+    module Elements
+      RAW_TEXT_ELEMENTS: Array[String]
+
+      RCDATA_ELEMENTS: Array[String]
+
+      VOID_ELEMENTS: Array[String]
+
+      BOOLEAN_ATTRIBUTES: Array[String]
+
+      WHITESPACE_PRESERVING_ELEMENTS: Array[String]
+
+      INLINE_ELEMENTS: Array[String]
+    end
+  end
+end

data/sig/herb/html/util.rbs

@@ -3,11 +3,25 @@
 module Herb
   module HTML
     module Util
-      # TODO: extract to shared utility for all languages in .yml
       VOID_ELEMENTS: Array[String]
 
+      RCDATA_ELEMENTS: Array[String]
+
+      RAW_TEXT_ELEMENTS: Array[String]
+
+      BOOLEAN_ATTRIBUTES: Array[String]
+
       # : (String) -> bool
       def self.void_element?: (String) -> bool
+
+      # : (String) -> bool
+      def self.rcdata_element?: (String) -> bool
+
+      # : (String) -> bool
+      def self.raw_text_element?: (String) -> bool
+
+      # : (String) -> bool
+      def self.boolean_attribute?: (String) -> bool
     end
   end
 end

data/sig/herb/lex_result.rbs

@@ -6,11 +6,5 @@ module Herb
 
     # : (Array[Herb::Token], String, Array[Herb::Warnings::Warning], Array[Herb::Errors::Error]) -> void
     def initialize: (Array[Herb::Token], String, Array[Herb::Warnings::Warning], Array[Herb::Errors::Error]) -> void
-
-    # : () -> bool
-    def success?: () -> bool
-
-    # : () -> bool
-    def failed?: () -> bool
   end
 end

data/sig/herb/locate.rbs

@@ -0,0 +1,89 @@
+# Generated from lib/herb/locate.rb with RBS::Inline
+
+module Herb
+  # Finds the most specific node at a position, and the nodes it sits inside.
+  #
+  #     result = document.locate(Herb::Position.from(2, 7))
+  #
+  #     result.node      #=> the innermost node whose location contains the position
+  #     result.ancestors #=> every node it sits inside, nearest first
+  #
+  # A node and a parse result both answer, so a walk starts from whichever one a caller already
+  # holds. `Herb::AST::Node#locate` and `Herb::ParseResult#locate` are the same walk from different
+  # starting points.
+  #
+  # Everything that reads a position back from a rendered page, an editor, or a diagnostic needs
+  # this, and every caller was writing its own descent. A finding at `2:7` is a node before it is
+  # anything a person can act on.
+  #
+  # `ancestors` reads nearest first, the way `caller` does, so the enclosing element a caller wants
+  # is the first one that answers:
+  #
+  #     result.ancestors.find { |node| node.is_a?(Herb::AST::HTMLElementNode) }
+  #
+  # A node's location contains its start and stops short of its end, so two nodes sitting next to
+  # each other never both answer for the character between them. A position past the end of the
+  # source belongs to no node, and the answer is `nil`.
+  #
+  # Columns are 0-based character offsets into their line, which is what the parser reports.
+  # `Herb::Position#to_one_based` is what turns one into what an editor shows.
+  #
+  # `Herb::Locate::Result` holds what was found, and what it was found inside.
+  #
+  #     result.node      #=> #<Herb::AST::LiteralNode>
+  #     result.ancestors #=> [#<...HTMLAttributeNameNode>, #<...HTMLAttributeNode>, ...]
+  class Locate
+    class Result
+      attr_reader node: Herb::AST::Node
+
+      attr_reader ancestors: Array[Herb::AST::Node]
+
+      # : (Herb::AST::Node, Array[Herb::AST::Node]) -> void
+      def initialize: (Herb::AST::Node, Array[Herb::AST::Node]) -> void
+
+      # : (untyped) -> Herb::AST::Node?
+      def innermost: (untyped) -> Herb::AST::Node?
+
+      # : () -> Array[Herb::AST::Node]
+      def path: () -> Array[Herb::AST::Node]
+
+      # : () -> String
+      def inspect: () -> String
+    end
+
+    # : ((Herb::AST::Node | Herb::ParseResult), Herb::Position) -> Result?
+    def self.call: (Herb::AST::Node | Herb::ParseResult, Herb::Position) -> Result?
+
+    # : ((Herb::AST::Node | Herb::ParseResult), Herb::Position) -> bool
+    def self.locatable?: (Herb::AST::Node | Herb::ParseResult, Herb::Position) -> bool
+
+    # : ((Herb::AST::Node | Herb::ParseResult)) -> Herb::AST::Node
+    def self.root: (Herb::AST::Node | Herb::ParseResult) -> Herb::AST::Node
+
+    # : (Herb::Position) -> void
+    def initialize: (Herb::Position) -> void
+
+    # : ((Herb::AST::Node | Herb::ParseResult)) -> Result?
+    def call: (Herb::AST::Node | Herb::ParseResult) -> Result?
+
+    # : ((Herb::AST::Node | Herb::ParseResult)) -> bool
+    def locatable?: (Herb::AST::Node | Herb::ParseResult) -> bool
+
+    private
+
+    # : (Herb::AST::Node, Array[Herb::AST::Node]) -> Result?
+    def descend: (Herb::AST::Node, Array[Herb::AST::Node]) -> Result?
+
+    # : (Herb::AST::Node) -> bool
+    def contains?: (Herb::AST::Node) -> bool
+
+    # : (Herb::AST::Node) -> bool
+    def within_extent?: (Herb::AST::Node) -> bool
+
+    # : (Herb::AST::Node) -> Herb::Location?
+    def extent: (Herb::AST::Node) -> Herb::Location?
+
+    # : (Herb::Location?, Herb::Location) -> Herb::Location
+    def union: (Herb::Location?, Herb::Location) -> Herb::Location
+  end
+end

data/sig/herb/location.rbs

@@ -19,6 +19,18 @@ module Herb
     # : (Integer, Integer, Integer, Integer) -> Location
     def self.[]: (Integer, Integer, Integer, Integer) -> Location
 
+    # : () -> Location
+    def self.zero: () -> Location
+
+    # : (Position) -> bool
+    def contains?: (Position) -> bool
+
+    # : (Location) -> bool
+    def covers?: (Location) -> bool
+
+    # : () -> bool
+    def empty?: () -> bool
+
     # : () -> serialized_location
     def to_hash: () -> serialized_location
 

data/sig/herb/parse_result.rbs

@@ -6,21 +6,23 @@ module Herb
 
     attr_reader options: Herb::ParserOptions
 
-    # : (Herb::AST::DocumentNode, String, Array[Herb::Warnings::Warning], Array[Herb::Errors::Error], Herb::ParserOptions) -> void
-    def initialize: (Herb::AST::DocumentNode, String, Array[Herb::Warnings::Warning], Array[Herb::Errors::Error], Herb::ParserOptions) -> void
+    attr_reader error_count: Integer?
+
+    # : (Herb::AST::DocumentNode, String, Array[Herb::Warnings::Warning], Array[Herb::Errors::Error], Herb::ParserOptions, ?Integer?) -> void
+    def initialize: (Herb::AST::DocumentNode, String, Array[Herb::Warnings::Warning], Array[Herb::Errors::Error], Herb::ParserOptions, ?Integer?) -> void
 
     # : () -> Array[Herb::Errors::Error]
     def errors: () -> Array[Herb::Errors::Error]
 
-    # : () -> bool
-    def failed?: () -> bool
-
-    # : () -> bool
-    def success?: () -> bool
-
     # : () -> String
     def pretty_errors: () -> String
 
+    # : (Herb::Position) -> Herb::Locate::Result?
+    def locate: (Herb::Position) -> Herb::Locate::Result?
+
+    # : (Herb::Position) -> bool
+    def locatable?: (Herb::Position) -> bool
+
     # : (Visitor) -> void
     def visit: (Visitor) -> void
   end