herb 0.1.1-x86_64-linux-gnu → 0.2.0-x86_64-linux-gnu

data/lib/herb/ast.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 module Herb
   module AST

data/lib/herb/cli.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 require "optparse"
 
@@ -41,7 +44,7 @@ class Herb::CLI
     end
 
     unless File.exist?(@file)
-      puts "Not a directory: '#{@file}'."
+      puts "Not a file: '#{@file}'."
       puts
     end
 

data/lib/herb/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# typed: true
 
 # NOTE: This file is generated by the templates/template.rb script and should not be
 # modified manually. See /Users/marcoroth/Development/herb-release/templates/lib/herb/errors.rb.erb
@@ -6,16 +7,18 @@
 module Herb
   module Errors
     class Error
-      attr_reader :type
-      attr_reader :location
-      attr_reader :message
+      attr_reader :type #: String
+      attr_reader :location #: Location
+      attr_reader :message #: String
 
+      #: (String, Location, String) -> void
       def initialize(type, location, message)
         @type = type
         @location = location
         @message = message
       end
 
+      #: () -> serialized_error
       def to_hash
         {
           type: type,
@@ -24,20 +27,33 @@ module Herb
         }
       end
 
+      #: () -> String
+      def class_name
+        self.class.name || "Error"
+      end
+
+      #: () -> String
       def error_name
-        self.class.name.split("::").last
+        class_name.split("::").last || "Error"
+      end
+
+      #: (?untyped) -> String
+      def to_json(state = nil)
+        to_hash.to_json(state)
       end
 
-      def to_json(*args)
-        to_hash.to_json(*args)
+      #: (?Integer) -> String
+      def tree_inspect(_indent = 0)
+        raise NotImplementedError
       end
     end
 
     class UnexpectedError < Error
-      attr_reader :description
-      attr_reader :expected
-      attr_reader :found
+      attr_reader :description #: String
+      attr_reader :expected #: String
+      attr_reader :found #: String
 
+      #: (String, Location, String, String, String, String) -> void
       def initialize(type, location, message, description, expected, found)
         super(type, location, message)
 
@@ -46,18 +62,21 @@ module Herb
         @found = found
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_unexpected_error
       def to_hash
         super.merge({
           description: description,
           expected: expected,
           found: found,
-        })
+        }) #: Herb::serialized_unexpected_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 
@@ -73,9 +92,10 @@ module Herb
     end
 
     class UnexpectedTokenError < Error
-      attr_reader :expected_type
-      attr_reader :found
+      attr_reader :expected_type #: String
+      attr_reader :found #: Herb::Token
 
+      #: (String, Location, String, String, Herb::Token) -> void
       def initialize(type, location, message, expected_type, found)
         super(type, location, message)
 
@@ -83,17 +103,20 @@ module Herb
         @found = found
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_unexpected_token_error
       def to_hash
         super.merge({
           expected_type: expected_type,
           found: found,
-        })
+        }) #: Herb::serialized_unexpected_token_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 
@@ -108,24 +131,28 @@ module Herb
     end
 
     class MissingOpeningTagError < Error
-      attr_reader :closing_tag
+      attr_reader :closing_tag #: Herb::Token
 
+      #: (String, Location, String, Herb::Token) -> void
       def initialize(type, location, message, closing_tag)
         super(type, location, message)
 
         @closing_tag = closing_tag
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_missing_opening_tag_error
       def to_hash
         super.merge({
           closing_tag: closing_tag,
-        })
+        }) #: Herb::serialized_missing_opening_tag_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 
@@ -139,24 +166,28 @@ module Herb
     end
 
     class MissingClosingTagError < Error
-      attr_reader :opening_tag
+      attr_reader :opening_tag #: Herb::Token
 
+      #: (String, Location, String, Herb::Token) -> void
       def initialize(type, location, message, opening_tag)
         super(type, location, message)
 
         @opening_tag = opening_tag
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_missing_closing_tag_error
       def to_hash
         super.merge({
           opening_tag: opening_tag,
-        })
+        }) #: Herb::serialized_missing_closing_tag_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 
@@ -170,9 +201,10 @@ module Herb
     end
 
     class TagNamesMismatchError < Error
-      attr_reader :opening_tag
-      attr_reader :closing_tag
+      attr_reader :opening_tag #: Herb::Token
+      attr_reader :closing_tag #: Herb::Token
 
+      #: (String, Location, String, Herb::Token, Herb::Token) -> void
       def initialize(type, location, message, opening_tag, closing_tag)
         super(type, location, message)
 
@@ -180,17 +212,20 @@ module Herb
         @closing_tag = closing_tag
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_tag_names_mismatch_error
       def to_hash
         super.merge({
           opening_tag: opening_tag,
           closing_tag: closing_tag,
-        })
+        }) #: Herb::serialized_tag_names_mismatch_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 
@@ -205,9 +240,10 @@ module Herb
     end
 
     class QuotesMismatchError < Error
-      attr_reader :opening_quote
-      attr_reader :closing_quote
+      attr_reader :opening_quote #: Herb::Token
+      attr_reader :closing_quote #: Herb::Token
 
+      #: (String, Location, String, Herb::Token, Herb::Token) -> void
       def initialize(type, location, message, opening_quote, closing_quote)
         super(type, location, message)
 
@@ -215,17 +251,20 @@ module Herb
         @closing_quote = closing_quote
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_quotes_mismatch_error
       def to_hash
         super.merge({
           opening_quote: opening_quote,
           closing_quote: closing_quote,
-        })
+        }) #: Herb::serialized_quotes_mismatch_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 
@@ -240,10 +279,11 @@ module Herb
     end
 
     class VoidElementClosingTagError < Error
-      attr_reader :tag_name
-      attr_reader :expected
-      attr_reader :found
+      attr_reader :tag_name #: Herb::Token
+      attr_reader :expected #: String
+      attr_reader :found #: String
 
+      #: (String, Location, String, Herb::Token, String, String) -> void
       def initialize(type, location, message, tag_name, expected, found)
         super(type, location, message)
 
@@ -252,18 +292,21 @@ module Herb
         @found = found
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_void_element_closing_tag_error
       def to_hash
         super.merge({
           tag_name: tag_name,
           expected: expected,
           found: found,
-        })
+        }) #: Herb::serialized_void_element_closing_tag_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 
@@ -279,24 +322,28 @@ module Herb
     end
 
     class UnclosedElementError < Error
-      attr_reader :opening_tag
+      attr_reader :opening_tag #: Herb::Token
 
+      #: (String, Location, String, Herb::Token) -> void
       def initialize(type, location, message, opening_tag)
         super(type, location, message)
 
         @opening_tag = opening_tag
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_unclosed_element_error
       def to_hash
         super.merge({
           opening_tag: opening_tag,
-        })
+        }) #: Herb::serialized_unclosed_element_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 
@@ -310,10 +357,11 @@ module Herb
     end
 
     class RubyParseError < Error
-      attr_reader :error_message
-      attr_reader :diagnostic_id
-      attr_reader :level
+      attr_reader :error_message #: String
+      attr_reader :diagnostic_id #: String
+      attr_reader :level #: String
 
+      #: (String, Location, String, String, String, String) -> void
       def initialize(type, location, message, error_message, diagnostic_id, level)
         super(type, location, message)
 
@@ -322,18 +370,21 @@ module Herb
         @level = level
       end
 
+      #: () -> String
       def inspect
         tree_inspect.rstrip.gsub(/\s+$/, "")
       end
 
+      #: () -> serialized_ruby_parse_error
       def to_hash
         super.merge({
           error_message: error_message,
           diagnostic_id: diagnostic_id,
           level: level,
-        })
+        }) #: Herb::serialized_ruby_parse_error
       end
 
+      #: (?Integer) -> String
       def tree_inspect(indent = 0)
         output = +""
 

data/lib/herb/lex_result.rb

@@ -2,17 +2,20 @@
 
 module Herb
   class LexResult < Result
-    attr_reader :value
+    attr_reader :value #: TokenList
 
+    #: (Array[Herb::Token], String, Array[Herb::Warnings::Warning], Array[Herb::Errors::Error]) -> void
     def initialize(value, source, warnings, errors)
       @value = TokenList.new(value)
       super(source, warnings, errors)
     end
 
+    #: () -> bool
     def success?
       errors.empty?
     end
 
+    #: () -> bool
     def failed?
       errors.any?
     end

data/lib/herb/libherb/array.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 require "forwardable"
 

data/lib/herb/libherb/ast_node.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 module Herb
   module LibHerb

data/lib/herb/libherb/buffer.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 module Herb
   module LibHerb

data/lib/herb/libherb/extract_result.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 require "forwardable"
 

data/lib/herb/libherb/lex_result.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 require "forwardable"
 

data/lib/herb/libherb/libherb.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 require "herb/libherb/ast_node"
 require "herb/libherb/buffer"

data/lib/herb/libherb/parse_result.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 require "forwardable"
 

data/lib/herb/libherb/token.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 module Herb
   module LibHerb

data/lib/herb/libherb.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 require "ffi"
 require "rbconfig"

data/lib/herb/location.rb

@@ -1,14 +1,18 @@
 # frozen_string_literal: true
+# typed: true
 
 module Herb
   class Location
-    attr_reader :start, :end
+    attr_reader :start #: Position
+    attr_reader :end #: Position
 
+    #: (Position, Position) -> void
     def initialize(start_position, end_position)
       @start = start_position
       @end = end_position
     end
 
+    #: (Integer, Integer, Integer, Integer) -> Location
     def self.from(start_line, start_column, end_line, end_column)
       new(
         Position.new(start_line, start_column),
@@ -16,25 +20,30 @@ module Herb
       )
     end
 
-    def self.[](...)
-      from(...)
+    #: (Integer, Integer, Integer, Integer) -> Location
+    def self.[](start_line, start_column, end_line, end_column)
+      from(start_line, start_column, end_line, end_column)
     end
 
+    #: () -> serialized_location
     def to_hash
       {
         start: start,
         end: self.end,
-      }
+      } #: Herb::serialized_location
     end
 
-    def to_json(*args)
-      to_hash.to_json(*args)
+    #: (?untyped) -> String
+    def to_json(state = nil)
+      to_hash.to_json(state)
     end
 
+    #: () -> String
     def tree_inspect
       %((location: #{start.tree_inspect}-#{self.end.tree_inspect}))
     end
 
+    #: () -> String
     def inspect
       %(#<Herb::Location #{tree_inspect}>)
     end

data/lib/herb/parse_result.rb

@@ -4,23 +4,32 @@ require "json"
 
 module Herb
   class ParseResult < Result
-    attr_reader :value
+    attr_reader :value #: Herb::AST::DocumentNode
 
+    #: (Herb::AST::DocumentNode, String, Array[Herb::Warnings::Warning], Array[Herb::Errors::Error]) -> void
     def initialize(value, source, warnings, errors)
       @value = value
       super(source, warnings, errors)
     end
 
+    #: () -> bool
     def failed?
       errors.any? || value.errors.any? # TODO: this should probably be recursive
     end
 
+    #: () -> bool
     def success?
       !failed?
     end
 
+    #: () -> String
     def pretty_errors
       JSON.pretty_generate(errors + value.errors)
     end
+
+    #: (Visitor) -> void
+    def visit(visitor)
+      value.accept(visitor)
+    end
   end
 end

data/lib/herb/position.rb

@@ -1,34 +1,43 @@
 # frozen_string_literal: true
+# typed: true
 
 module Herb
   class Position
-    attr_reader :line, :column
+    attr_reader :line #: Integer
+    attr_reader :column #: Integer
 
+    #: (Integer, Integer) -> void
     def initialize(line, column)
       @line = line
       @column = column
     end
 
-    def self.[](...)
-      new(...)
+    #: (Integer, Integer) -> Position
+    def self.[](line, column)
+      new(line, column)
     end
 
-    def self.from(...)
-      new(...)
+    #: (Integer, Integer) -> Position
+    def self.from(line, column)
+      new(line, column)
     end
 
+    #: () -> serialized_position
     def to_hash
-      { line: line, column: column }
+      { line: line, column: column } #: Herb::serialized_position
     end
 
-    def to_json(*args)
-      to_hash.to_json(*args)
+    #: (?untyped) -> String
+    def to_json(state = nil)
+      to_hash.to_json(state)
     end
 
+    #: () -> String
     def tree_inspect
       "(#{line}:#{column})"
     end
 
+    #: () -> String
     def inspect
       %(#<Herb::Position #{tree_inspect}>)
     end

data/lib/herb/project.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+# typed: ignore
+
+# rbs_inline: disabled
 
 require "io/console"
 require "timeout"
@@ -221,10 +224,10 @@ module Herb
         summary = [
           heading("Summary"),
           "Total files: #{files.count}",
-          "✅ Successful: #{successful_files.count}",
-          "❌ Failed: #{failed_files.count}",
-          "⚠️ Parse errors: #{error_files.count}",
-          "⏱️ Timed out: #{timeout_files.count}"
+          "✅ Successful: #{successful_files.count} (#{percentage(successful_files.count, files.count)}%)",
+          "❌ Failed: #{failed_files.count} (#{percentage(failed_files.count, files.count)}%)",
+          "⚠️ Parse errors: #{error_files.count} (#{percentage(error_files.count, files.count)}%)",
+          "⏱️ Timed out: #{timeout_files.count} (#{percentage(timeout_files.count, files.count)}%)"
         ]
 
         summary.each do |line|
@@ -352,6 +355,12 @@ module Herb
       "[#{completed}#{partial}#{remaining}] #{percentage}% (#{current}/#{total})"
     end
 
+    def percentage(part, total)
+      return 0.0 if total.zero?
+
+      ((part.to_f / total) * 100).round(1)
+    end
+
     def heading(text)
       prefix = "--- #{text.upcase} "