herb 0.10.4 → 0.11.0

data/sig/herb/analysis/partial_declaration.rbs

@@ -0,0 +1,80 @@
+# Generated from lib/herb/analysis/partial_declaration.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    class StrictLocal < Data
+      attr_reader name(): untyped
+
+      attr_reader required(): untyped
+
+      attr_reader default_source(): untyped
+
+      def self.new: (untyped name, untyped required, untyped default_source) -> instance
+                  | (name: untyped, required: untyped, default_source: untyped) -> instance
+
+      def self.members: () -> [ :name, :required, :default_source ]
+
+      def members: () -> [ :name, :required, :default_source ]
+    end
+
+    class StrictLocal
+      # : (name: String, required: bool, ?default_source: String?) -> void
+      def initialize: (name: String, required: bool, ?default_source: String?) -> void
+
+      # : () -> Hash[String, untyped]
+      def to_h: () -> Hash[String, untyped]
+
+      # : (Hash[String, untyped]) -> StrictLocal
+      def self.from: (Hash[String, untyped]) -> StrictLocal
+    end
+
+    class PartialDeclaration
+      KEYWORD_KIND: String
+
+      KEYWORD_REST_KIND: String
+
+      attr_reader file: String
+
+      attr_reader locals: Array[StrictLocal]
+
+      attr_reader location: Hash[String, Integer]?
+
+      attr_accessor has_declaration: bool
+
+      attr_accessor has_keyword_rest: bool
+
+      # : (String) -> PartialDeclaration
+      def self.without_strict_locals: (String) -> PartialDeclaration
+
+      # : (Herb::AST::DocumentNode, String) -> PartialDeclaration
+      def self.from_document: (Herb::AST::DocumentNode, String) -> PartialDeclaration
+
+      # : (Herb::AST::Node) -> Hash[String, Integer]?
+      def self.location_of: (Herb::AST::Node) -> Hash[String, Integer]?
+
+      # : (Hash[String, untyped]) -> PartialDeclaration
+      def self.from: (Hash[String, untyped]) -> PartialDeclaration
+
+      # : (String) -> void
+      def initialize: (String) -> void
+
+      # : (Hash[String, Integer]?) -> void
+      attr_writer location: untyped
+
+      # : (String, bool, ?default_source: String?) -> void
+      def add_local: (String, bool, ?default_source: String?) -> void
+
+      # : () -> Array[String]
+      def required_locals: () -> Array[String]
+
+      # : () -> Array[String]
+      def optional_locals: () -> Array[String]
+
+      # : (String) -> bool
+      def accepts?: (String) -> bool
+
+      # : () -> Hash[String, untyped]
+      def to_h: () -> Hash[String, untyped]
+    end
+  end
+end

data/sig/herb/analysis/partial_index.rbs

@@ -0,0 +1,66 @@
+# Generated from lib/herb/analysis/partial_index.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    class PartialIndex
+      APPLICATION_DIRECTORY: String
+
+      attr_reader view_root: Pathname
+
+      attr_reader templates: Array[String]
+
+      # : (String | Pathname, ?templates: Array[String]?) -> PartialIndex
+      def self.build: (String | Pathname, ?templates: Array[String]?) -> PartialIndex
+
+      # : (String | Pathname) -> Pathname
+      def self.resolve_view_root: (String | Pathname) -> Pathname
+
+      # : (String | Pathname, Array[String]) -> void
+      def initialize: (String | Pathname, Array[String]) -> void
+
+      # : (String?) -> Array[String]
+      def files_for: (String?) -> Array[String]
+
+      # : (String?, String?) -> Array[String]
+      def resolve: (String?, String?) -> Array[String]
+
+      # : (String, String | Pathname) -> String?
+      def self.partial_name_for: (String, String | Pathname) -> String?
+
+      # : (String) -> String?
+      def partial_name_for: (String) -> String?
+
+      # : () -> Array[String]
+      def names: () -> Array[String]
+
+      # : (String?, String?) -> PartialDeclaration?
+      def lookup: (String?, String?) -> PartialDeclaration?
+
+      # : (String) -> PartialDeclaration?
+      def declaration_for_file: (String) -> PartialDeclaration?
+
+      # : (String) -> String?
+      def update: (String) -> String?
+
+      # : (String) -> String?
+      def remove: (String) -> String?
+
+      # : () -> Integer
+      def size: () -> Integer
+
+      # : () -> Hash[String, untyped]
+      def to_h: () -> Hash[String, untyped]
+
+      private
+
+      # : (String) -> String?
+      def source_directory_for: (String) -> String?
+
+      # : (String) -> PartialDeclaration?
+      def build_declaration: (String) -> PartialDeclaration?
+
+      # : (Array[String]) -> Hash[String, Array[String]]
+      def build_index: (Array[String]) -> Hash[String, Array[String]]
+    end
+  end
+end

data/sig/herb/analysis/partial_resolution.rbs

@@ -0,0 +1,57 @@
+# Generated from lib/herb/analysis/partial_resolution.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    module PartialResolution
+      PARTIAL_PREFIX: String
+
+      EXTENSIONS: Array[String]
+
+      EXTENSION_ALTERNATIVES: String
+
+      TEMPLATE_GLOB_PATTERN: String
+
+      PARTIAL_GLOB_PATTERN: String
+
+      VIEW_ROOT: String
+
+      LAYOUTS_DIRECTORY: String
+
+      APPLICATION_LAYOUT: String
+
+      MAILER_LAYOUT: String
+
+      MAILER_SUFFIX: String
+
+      # : (String | Pathname) -> Pathname
+      def self.view_root_for: (String | Pathname) -> Pathname
+
+      # : (String) -> bool
+      def self.template_path?: (String) -> bool
+
+      # : (String) -> bool
+      def self.partial_path?: (String) -> bool
+
+      # : (String) -> Integer
+      def self.template_rank: (String) -> Integer
+
+      # : (String, String) -> bool
+      def self.outranks_template?: (String, String) -> bool
+
+      # : (Array[String]) -> Array[String]
+      def self.by_precedence: (Array[String]) -> Array[String]
+
+      # : (String, String | Pathname) -> String?
+      def self.template_name_for: (String, String | Pathname) -> String?
+
+      # : (String, String | Pathname) -> Array[String]
+      def self.layout_candidates_for: (String, String | Pathname) -> Array[String]
+
+      # : (String, String | Pathname) -> String?
+      def self.partial_name_for: (String, String | Pathname) -> String?
+
+      # : (String, String | Pathname) -> String?
+      private def self.relative_to_view_root: (String, String | Pathname) -> String?
+    end
+  end
+end

data/sig/herb/analysis/partial_resolver.rbs

@@ -0,0 +1,76 @@
+# Generated from lib/herb/analysis/partial_resolver.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    # Finds the file a render call names, and what the compile of that file calls itself.
+    #
+    # The engine resolves partials at compile time in more than one place, the render
+    # validator and the inliner among them, and each used to walk the filesystem on its own
+    # from the project's view root. This is the one object they ask instead, and the one an
+    # application can replace through `Herb::Engine.new(source, resolver: ...)` with a lookup
+    # that knows its real view paths, an engine's or a gem's, and how it names its templates.
+    #
+    # The default answers from the filesystem the way the engine always has. A name with a
+    # directory is looked up under the view root, a bare name next to the calling template
+    # and then under the view root, and the identifier is the path relative to the project,
+    # which is what the compile of that template reports as its own relative file path.
+    class PartialResolver
+      class Resolved < Data
+        attr_reader path(): Pathname
+
+        attr_reader identifier(): String
+
+        def self.new: (Pathname path, String identifier) -> instance
+                    | (path: Pathname, identifier: String) -> instance
+
+        def self.members: () -> [ :path, :identifier ]
+
+        def members: () -> [ :path, :identifier ]
+      end
+
+      TEMPLATE_HINT: String
+
+      attr_reader project_path: Pathname
+
+      attr_reader view_root: Pathname?
+
+      # : (?(String | Pathname)?, ?view_root: (String | Pathname | false)?) -> void
+      def initialize: (?(String | Pathname)?, ?view_root: (String | Pathname | false)?) -> void
+
+      # : (String, ?from: (String | Pathname)?, ?format: String?) -> Resolved?
+      def resolve: (String, ?from: (String | Pathname)?, ?format: String?) -> Resolved?
+
+      # : (String, ?from: (String | Pathname)?) -> Array[Pathname]
+      def candidates: (String, ?from: (String | Pathname)?) -> Array[Pathname]
+
+      # : (String, ?from: (String | Pathname)?, ?limit: Integer) -> Array[String]
+      def similar: (String, ?from: (String | Pathname)?, ?limit: Integer) -> Array[String]
+
+      # : (Pathname) -> String
+      def identifier_for: (Pathname) -> String
+
+      # : (String, Pathname?) -> Array[Pathname]
+      def candidate_paths: (String, Pathname?) -> Array[Pathname]
+
+      # : (String, Pathname?, ?limit: Integer) -> Array[String]
+      def similar_partials: (String, Pathname?, ?limit: Integer) -> Array[String]
+
+      # : (String, Pathname?) -> Array[String]
+      def non_partial_matches: (String, Pathname?) -> Array[String]
+
+      private
+
+      # : (String, Pathname?) -> Array[Pathname]
+      def lookup_directories: (String, Pathname?) -> Array[Pathname]
+
+      # : (Pathname?) -> Array[String]
+      def partial_names: (Pathname?) -> Array[String]
+
+      # : ((String | Pathname)?) -> Pathname?
+      def source_directory: ((String | Pathname)?) -> Pathname?
+
+      # : (Array[Pathname], String) -> Array[Pathname]
+      def prefer_format: (Array[Pathname], String) -> Array[Pathname]
+    end
+  end
+end

data/sig/herb/analysis/project_index.rbs

@@ -0,0 +1,57 @@
+# Generated from lib/herb/analysis/project_index.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    class ProjectIndex
+      attr_reader project_path: Pathname
+
+      attr_reader partials: PartialIndex?
+
+      attr_reader graph: RenderGraph?
+
+      # : (String | Pathname) -> void
+      def initialize: (String | Pathname) -> void
+
+      # : () -> void
+      def index_all: () -> void
+
+      # : () -> void
+      def index_partials: () -> void
+
+      # : () -> void
+      def index_call_sites: () -> void
+
+      # : () -> Pathname?
+      def view_root: () -> Pathname?
+
+      # : (String, ?String?) -> bool
+      def handle_change: (String, ?String?) -> bool
+
+      # : (String) -> bool
+      def remove: (String) -> bool
+
+      private
+
+      # : () -> RenderGraph::Builder?
+      def builder: () -> RenderGraph::Builder?
+
+      # : (String) -> String?
+      def template_file_for: (String) -> String?
+
+      # : (String) -> bool
+      def update_partial: (String) -> bool
+
+      # : (String) -> bool
+      def remove_partial: (String) -> bool
+
+      # : (String, String?) -> bool
+      def update_call_sites: (String, String?) -> bool
+
+      # : (String) -> bool
+      def remove_call_sites: (String) -> bool
+
+      # : (String) -> String?
+      def read: (String) -> String?
+    end
+  end
+end

data/sig/herb/{action_view → analysis}/render_analyzer.rbs

@@ -1,7 +1,7 @@
-# Generated from lib/herb/action_view/render_analyzer.rb with RBS::Inline
+# Generated from lib/herb/analysis/render_analyzer.rb with RBS::Inline
 
 module Herb
-  module ActionView
+  module Analysis
     class RenderAnalyzer
       include Colors
 
@@ -54,6 +54,12 @@ module Herb
 
       def print_summary_line: (untyped result) -> untyped
 
+      # : (String) -> bool
+      def component_template?: (String) -> bool
+
+      # : (Array[Hash[Symbol, untyped]]) -> void
+      def print_warning_summary_line: (Array[Hash[Symbol, untyped]]) -> void
+
       private
 
       def print_partial_tree: (untyped partial_names, untyped render_graph, untyped partial_files, untyped view_root, untyped reachable, ?indent: untyped, ?visited: untyped) -> untyped
@@ -64,7 +70,20 @@ module Herb
 
       def trace_to_entry_points: (untyped partial_name, untyped reverse_graph, untyped _partial_files, untyped view_root) -> untyped
 
-      def print_results: (untyped result, untyped duration) -> untyped
+      def print_results: (untyped result, untyped duration, ?untyped warnings) -> untyped
+
+      def check_dependencies: (untyped erb_files, untyped view_root) -> untyped
+
+      # : (Array[String], untyped, Pathname) -> Hash[String, Set[String]]
+      def collect_passed_locals: (Array[String], untyped, Pathname) -> Hash[String, Set[String]]
+
+      # : (Hash[Symbol, untyped]) -> String
+      def dynamic_call_display: (Hash[Symbol, untyped]) -> String
+
+      def print_dependency_warnings: (untyped warnings) -> untyped
+
+      # : (Array[Hash[Symbol, untyped]]) -> void
+      def print_unknown_call_tally: (Array[Hash[Symbol, untyped]]) -> void
 
       def find_erb_files: () -> untyped
 
@@ -72,6 +91,8 @@ module Herb
 
       def find_partial_files: (untyped view_root) -> untyped
 
+      def partial_index: (untyped view_root) -> untyped
+
       def partial_name_for_file: (untyped file_path, untyped view_root) -> untyped
 
       def collect_render_calls_by_file: (untyped files) -> untyped
@@ -94,7 +115,7 @@ module Herb
 
       def find_unresolved: (untyped render_calls, untyped partial_files, untyped view_root) -> untyped
 
-      def resolve_partial: (untyped partial_name, untyped source_file, untyped partial_files, untyped view_root) -> untyped
+      def resolve_partial: (untyped partial_name, untyped source_file, untyped _partial_files, untyped view_root) -> untyped
 
       def expected_file_path: (untyped partial_name, untyped view_root) -> untyped
 

data/sig/herb/analysis/render_graph/ancestor_chain.rbs

@@ -0,0 +1,22 @@
+# Generated from lib/herb/analysis/render_graph/ancestor_chain.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    class RenderGraph
+      class AncestorChain
+        attr_reader tags: Array[String]
+
+        attr_reader attributes: Array[Hash[String, String]]?
+
+        attr_reader frames: Array[CallFrame]
+
+        attr_accessor occurrences: Integer
+
+        # : (Array[String], Array[Hash[String, String]]?, Array[CallFrame], Integer) -> void
+        def initialize: (Array[String], Array[Hash[String, String]]?, Array[CallFrame], Integer) -> void
+
+        EMPTY: AncestorChain
+      end
+    end
+  end
+end

data/sig/herb/analysis/render_graph/builder.rbs

@@ -0,0 +1,180 @@
+# Generated from lib/herb/analysis/render_graph/builder.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    class RenderGraph
+      class Builder
+        RENDER_MARKER: String
+
+        YIELD_MARKER: String
+
+        DOCUMENT_ROOT_TAG: String
+
+        ANCESTOR_CONTEXT_ATTRIBUTES: Array[String]
+
+        PARSER_OPTIONS: Hash[Symbol, bool]
+
+        class ScannedTemplate < Data
+          attr_reader sites(): untyped
+
+          attr_reader yields(): untyped
+
+          attr_reader document_root(): untyped
+
+          attr_reader roots(): untyped
+
+          def self.new: (untyped sites, untyped yields, untyped document_root, untyped roots) -> instance
+                      | (sites: untyped, yields: untyped, document_root: untyped, roots: untyped) -> instance
+
+          def self.members: () -> [ :sites, :yields, :document_root, :roots ]
+
+          def members: () -> [ :sites, :yields, :document_root, :roots ]
+        end
+
+        class YieldSite < Data
+          attr_reader ancestors(): untyped
+
+          attr_reader ancestor_attributes(): untyped
+
+          attr_reader location(): untyped
+
+          def self.new: (untyped ancestors, untyped ancestor_attributes, untyped location) -> instance
+                      | (ancestors: untyped, ancestor_attributes: untyped, location: untyped) -> instance
+
+          def self.members: () -> [ :ancestors, :ancestor_attributes, :location ]
+
+          def members: () -> [ :ancestors, :ancestor_attributes, :location ]
+        end
+
+        class RenderSite < Data
+          attr_reader node(): untyped
+
+          attr_reader ancestors(): untyped
+
+          attr_reader ancestor_attributes(): untyped
+
+          def self.new: (untyped node, untyped ancestors, untyped ancestor_attributes) -> instance
+                      | (node: untyped, ancestors: untyped, ancestor_attributes: untyped) -> instance
+
+          def self.members: () -> [ :node, :ancestors, :ancestor_attributes ]
+
+          def members: () -> [ :node, :ancestors, :ancestor_attributes ]
+        end
+
+        class CollectedCallSites < Data
+          attr_reader unresolved(): untyped
+
+          attr_reader yields(): untyped
+
+          attr_reader document_root(): untyped
+
+          attr_reader roots(): untyped
+
+          def self.new: (untyped unresolved, untyped yields, untyped document_root, untyped roots) -> instance
+                      | (unresolved: untyped, yields: untyped, document_root: untyped, roots: untyped) -> instance
+
+          def self.members: () -> [ :unresolved, :yields, :document_root, :roots ]
+
+          def members: () -> [ :unresolved, :yields, :document_root, :roots ]
+        end
+
+        class StackEntry < Data
+          attr_reader tag_name(): untyped
+
+          attr_reader attributes(): untyped
+
+          def self.new: (untyped tag_name, untyped attributes) -> instance
+                      | (tag_name: untyped, attributes: untyped) -> instance
+
+          def self.members: () -> [ :tag_name, :attributes ]
+
+          def members: () -> [ :tag_name, :attributes ]
+        end
+
+        class ScanState
+          attr_reader sites: Array[RenderSite]
+
+          attr_reader yields: Array[YieldSite]
+
+          attr_reader stack: Array[StackEntry]
+
+          attr_reader tags: Array[String]
+
+          attr_reader conditional_tags: Array[String]
+
+          attr_reader renders: Array[String]
+
+          attr_accessor document_root: bool
+
+          attr_accessor conditional_depth: Integer
+
+          attr_accessor roots_resolved: bool
+
+          # : () -> void
+          def initialize: () -> void
+        end
+
+        NOTHING_COLLECTED: CollectedCallSites
+
+        # : (PartialIndex, ?resolve_layouts: bool) -> void
+        def initialize: (PartialIndex, ?resolve_layouts: bool) -> void
+
+        # : (String, String, Hash[String, Array[PartialCallSite]]) -> CollectedCallSites
+        def collect_call_sites: (String, String, Hash[String, Array[PartialCallSite]]) -> CollectedCallSites
+
+        # : (Array[String]) -> RenderGraph
+        def build: (Array[String]) -> RenderGraph
+
+        private
+
+        # : (Array[String], Hash[String, Array[YieldSite]], Hash[String, Array[PartialCallSite]]) -> void
+        def add_layout_call_sites: (Array[String], Hash[String, Array[YieldSite]], Hash[String, Array[PartialCallSite]]) -> void
+
+        # : (String) -> Herb::AST::DocumentNode
+        def parse: (String) -> Herb::AST::DocumentNode
+
+        # : (String) -> String?
+        def read: (String) -> String?
+
+        # : (Herb::AST::Node) -> ScannedTemplate
+        def scan_template: (Herb::AST::Node) -> ScannedTemplate
+
+        # : (Herb::AST::Node, ScanState) -> void
+        def walk: (Herb::AST::Node, ScanState) -> void
+
+        # : (Herb::AST::Node, String?, ScanState) -> void
+        def collect_root: (Herb::AST::Node, String?, ScanState) -> void
+
+        # : (ScanState) -> Array[Hash[String, String]]?
+        def ancestor_attributes_for: (ScanState) -> Array[Hash[String, String]]?
+
+        # : (Herb::AST::Node) -> bool
+        def bare_yield?: (Herb::AST::Node) -> bool
+
+        # : (Herb::AST::Node) -> bool
+        def conditional_node?: (Herb::AST::Node) -> bool
+
+        # : (Herb::AST::HTMLElementNode?) -> Hash[String, String]
+        def static_ancestor_attributes: (Herb::AST::HTMLElementNode?) -> Hash[String, String]
+
+        # : (Herb::AST::HTMLAttributeNode) -> String?
+        def attribute_name: (Herb::AST::HTMLAttributeNode) -> String?
+
+        # : (Herb::AST::HTMLAttributeNode) -> String
+        def static_attribute_value: (Herb::AST::HTMLAttributeNode) -> String
+
+        # : (Array[Herb::AST::Node]) -> String?
+        def literal_content: (Array[Herb::AST::Node]) -> String?
+
+        # : (Herb::AST::ERBRenderNode) -> String?
+        def partial_name_rendered_by: (Herb::AST::ERBRenderNode) -> String?
+
+        # : (Herb::AST::ERBRenderNode) -> Array[String]
+        def locals_passed_by: (Herb::AST::ERBRenderNode) -> Array[String]
+
+        # : (Herb::AST::Node) -> CallSiteLocation?
+        def call_site_location: (Herb::AST::Node) -> CallSiteLocation?
+      end
+    end
+  end
+end

data/sig/herb/analysis/render_graph/call_frame.rbs

@@ -0,0 +1,26 @@
+# Generated from lib/herb/analysis/render_graph/call_frame.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    class RenderGraph
+      class CallFrame < Data
+        attr_reader file(): untyped
+
+        attr_reader ancestors(): untyped
+
+        attr_reader ancestor_attributes(): untyped
+
+        attr_reader via(): untyped
+
+        attr_reader location(): untyped
+
+        def self.new: (untyped file, untyped ancestors, untyped ancestor_attributes, untyped via, untyped location) -> instance
+                    | (file: untyped, ancestors: untyped, ancestor_attributes: untyped, via: untyped, location: untyped) -> instance
+
+        def self.members: () -> [ :file, :ancestors, :ancestor_attributes, :via, :location ]
+
+        def members: () -> [ :file, :ancestors, :ancestor_attributes, :via, :location ]
+      end
+    end
+  end
+end

data/sig/herb/analysis/render_graph/call_site_location.rbs

@@ -0,0 +1,28 @@
+# Generated from lib/herb/analysis/render_graph/call_site_location.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    class RenderGraph
+      class CallSiteLocation < Data
+        attr_reader line(): untyped
+
+        attr_reader column(): untyped
+
+        def self.new: (untyped line, untyped column) -> instance
+                    | (line: untyped, column: untyped) -> instance
+
+        def self.members: () -> [ :line, :column ]
+
+        def members: () -> [ :line, :column ]
+      end
+
+      class CallSiteLocation
+        # : (Hash[String, untyped]?) -> CallSiteLocation?
+        def self.from: (Hash[String, untyped]?) -> CallSiteLocation?
+
+        # : () -> Hash[String, Integer]
+        def to_h: () -> Hash[String, Integer]
+      end
+    end
+  end
+end

data/sig/herb/analysis/render_graph/inferred_signature.rbs

@@ -0,0 +1,27 @@
+# Generated from lib/herb/analysis/render_graph/inferred_signature.rb with RBS::Inline
+
+module Herb
+  module Analysis
+    class RenderGraph
+      class InferredSignature < Data
+        attr_reader locals(): untyped
+
+        attr_reader call_site_count(): untyped
+
+        attr_reader keyword_rest(): untyped
+
+        def self.new: (untyped locals, untyped call_site_count, untyped keyword_rest) -> instance
+                    | (locals: untyped, call_site_count: untyped, keyword_rest: untyped) -> instance
+
+        def self.members: () -> [ :locals, :call_site_count, :keyword_rest ]
+
+        def members: () -> [ :locals, :call_site_count, :keyword_rest ]
+      end
+
+      class InferredSignature
+        # : () -> String
+        def strict_locals_declaration: () -> String
+      end
+    end
+  end
+end