tree_haver 5.0.5 → 7.1.0

data/RUBOCOP.md

@@ -1,71 +0,0 @@
-# RuboCop Usage Guide
-
-## Overview
-
-A tale of two RuboCop plugin gems.
-
-### RuboCop Gradual
-
-This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
-
-### RuboCop LTS
-
-This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
-RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
-
-## Checking RuboCop Violations
-
-To check for RuboCop violations in this project, always use:
-
-```bash
-bundle exec rake rubocop_gradual:check
-```
-
-**Do not use** the standard RuboCop commands like:
-- `bundle exec rubocop`
-- `rubocop`
-
-## Understanding the Lock File
-
-The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
-
-1. Prevent new violations while gradually fixing existing ones
-2. Track progress on code style improvements
-3. Ensure CI builds don't fail due to pre-existing violations
-
-## Common Commands
-
-- **Check violations**
-    - `bundle exec rake rubocop_gradual`
-    - `bundle exec rake rubocop_gradual:check`
-- **(Safe) Autocorrect violations, and update lockfile if no new violations**
-  - `bundle exec rake rubocop_gradual:autocorrect`
-- **Force update the lock file (w/o autocorrect) to match violations present in code**
-  - `bundle exec rake rubocop_gradual:force_update`
-
-## Workflow
-
-1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
-   a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
-2. If there are new violations, either:
-   - Fix them in your code
-   - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
-3. Commit the updated `.rubocop_gradual.lock` file along with your changes
-
-## Never add inline RuboCop disables
-
-Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
-
-- Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
-- Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
-  - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
-  - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
-
-In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
-
-## Benefits of rubocop_gradual
-
-- Allows incremental adoption of code style rules
-- Prevents CI failures due to pre-existing violations
-- Provides a clear record of code style debt
-- Enables focused efforts on improving code quality over time

data/SECURITY.md

@@ -1,21 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version  | Supported |
-|----------|-----------|
-| 5.latest | ✅         |
-
-## Security contact information
-
-To report a security vulnerability, please use the
-[Tidelift security contact](https://tidelift.com/security).
-Tidelift will coordinate the fix and disclosure.
-
-## Additional Support
-
-If you are interested in support for versions older than the latest release,
-please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
-or find other sponsorship links in the [README].
-
-[README]: README.md

data/lib/tree_haver/base.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module TreeHaver
-  # Base classes for backend implementation
-  module Base
-    autoload :Node, File.join(__dir__, "base", "node")
-    autoload :Tree, File.join(__dir__, "base", "tree")
-    autoload :Parser, File.join(__dir__, "base", "parser")
-    autoload :Language, File.join(__dir__, "base", "language")
-    autoload :Point, File.join(__dir__, "base", "point")
-  end
-end

data/lib/tree_haver/compat.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-# Compatibility shim for code that expects TreeSitter constants
-#
-# When required, this file creates a TreeSitter module that maps to TreeHaver
-# equivalents, allowing code written for ruby_tree_sitter to work with TreeHaver
-# without modification.
-#
-# This shim is safe and idempotent:
-# - If TreeSitter is already defined (real ruby_tree_sitter is loaded), this does nothing
-# - If TreeSitter is not defined, it creates aliases to TreeHaver
-#
-# @example Using the compatibility shim
-#   require "tree_haver/compat"
-#
-#   # Now code expecting TreeSitter will work
-#   parser = TreeSitter::Parser.new  # Actually creates TreeHaver::Parser
-#   tree = parser.parse(source)
-#
-# @note This is an opt-in feature. Only require this file if you need compatibility
-# @see TreeHaver The main module this aliases to
-
-unless defined?(TreeSitter)
-  # Compatibility module aliasing TreeHaver classes to TreeSitter
-  #
-  # @note Only defined if TreeSitter doesn't already exist
-  module TreeSitter; end
-
-  # @!parse
-  #   module TreeSitter
-  #     Error = TreeHaver::Error
-  #     Parser = TreeHaver::Parser
-  #     Tree = TreeHaver::Tree
-  #     Node = TreeHaver::Node
-  #     Language = TreeHaver::Language
-  #   end
-
-  TreeSitter::Error = TreeHaver::Error
-  TreeSitter::Parser = TreeHaver::Parser
-  TreeSitter::Tree = TreeHaver::Tree
-  TreeSitter::Node = TreeHaver::Node
-  TreeSitter::Language = TreeHaver::Language
-end

data/lib/tree_haver/rspec/testable_node.rb

@@ -1,217 +0,0 @@
-# frozen_string_literal: true
-
-# Ensure TreeHaver::Node and TreeHaver::Point are loaded
-require "tree_haver"
-
-module TreeHaver
-  module RSpec
-    # A mock inner node that provides the minimal interface TreeHaver::Node expects.
-    #
-    # This is what TreeHaver::Node wraps - it simulates the backend-specific node
-    # (like tree-sitter's Node, Markly::Node, etc.)
-    #
-    # @api private
-    class MockInnerNode
-      attr_reader :type, :start_byte, :end_byte, :children_data
-
-      def initialize(
-        type:,
-        text: nil,
-        start_byte: 0,
-        end_byte: nil,
-        start_row: 0,
-        start_column: 0,
-        end_row: nil,
-        end_column: nil,
-        children: []
-      )
-        @type = type.to_s
-        @text_content = text
-        @start_byte = start_byte
-        @end_byte = end_byte || (text ? start_byte + text.length : start_byte)
-        @start_row = start_row
-        @start_column = start_column
-        @end_row = end_row || start_row
-        @end_column = end_column || (text ? start_column + text.length : start_column)
-        @children_data = children
-      end
-
-      def start_point
-        TreeHaver::Point.new(@start_row, @start_column)
-      end
-
-      def end_point
-        TreeHaver::Point.new(@end_row, @end_column)
-      end
-
-      def child_count
-        @children_data.length
-      end
-
-      def child(index)
-        return if index.nil? || index < 0 || index >= @children_data.length
-
-        @children_data[index]
-      end
-
-      # Return children array (for enumerable behavior)
-      def children
-        @children_data
-      end
-
-      def first_child
-        @children_data.first
-      end
-
-      def last_child
-        @children_data.last
-      end
-
-      # Iterate over children
-      def each(&block)
-        return enum_for(:each) unless block
-
-        @children_data.each(&block)
-      end
-
-      def named?
-        true
-      end
-
-      # Test nodes are always valid (no parse errors)
-      def has_error?
-        false
-      end
-
-      # Test nodes are never missing (not error recovery insertions)
-      def missing?
-        false
-      end
-
-      # Some backends provide text directly
-      def text
-        @text_content
-      end
-
-      # For backends that use string_content (like Markly/Commonmarker)
-      def string_content
-        @text_content
-      end
-    end
-
-    # A real TreeHaver::Node that wraps a MockInnerNode.
-    #
-    # This gives us full TreeHaver::Node behavior (#text, #type, #source_position, etc.)
-    # while allowing us to control the underlying data for testing.
-    #
-    # TestableNode is designed for testing code that works with TreeHaver nodes
-    # without requiring an actual parser backend. It creates real TreeHaver::Node
-    # instances with controlled, predictable data.
-    #
-    # @example Creating a testable node
-    #   node = TreeHaver::RSpec::TestableNode.create(
-    #     type: :heading,
-    #     text: "## My Heading",
-    #     start_line: 1
-    #   )
-    #   node.text       # => "## My Heading"
-    #   node.type       # => "heading"
-    #   node.start_line # => 1
-    #
-    # @example Creating with children
-    #   parent = TreeHaver::RSpec::TestableNode.create(
-    #     type: :document,
-    #     text: "# Title\n\nParagraph",
-    #     children: [
-    #       { type: :heading, text: "# Title", start_line: 1 },
-    #       { type: :paragraph, text: "Paragraph", start_line: 3 },
-    #     ]
-    #   )
-    #
-    # @example Using the convenience constant
-    #   # After requiring tree_haver/rspec/testable_node, you can use:
-    #   node = TestableNode.create(type: :paragraph, text: "Hello")
-    #
-    class TestableNode < TreeHaver::Node
-      class << self
-        # Create a TestableNode with the given attributes.
-        #
-        # @param type [Symbol, String] Node type (e.g., :heading, :paragraph)
-        # @param text [String] The text content of the node
-        # @param start_line [Integer] 1-based start line number (default: 1)
-        # @param end_line [Integer, nil] 1-based end line number (default: calculated from text)
-        # @param start_column [Integer] 0-based start column (default: 0)
-        # @param end_column [Integer, nil] 0-based end column (default: calculated from text)
-        # @param start_byte [Integer] Start byte offset (default: 0)
-        # @param end_byte [Integer, nil] End byte offset (default: calculated from text)
-        # @param children [Array<Hash>] Child node specifications
-        # @param source [String, nil] Full source text (default: uses text param)
-        # @return [TestableNode]
-        def create(
-          type:,
-          text: "",
-          start_line: 1,
-          end_line: nil,
-          start_column: 0,
-          end_column: nil,
-          start_byte: 0,
-          end_byte: nil,
-          children: [],
-          source: nil
-        )
-          # Convert 1-based line to 0-based row
-          start_row = start_line - 1
-          end_row = end_line ? end_line - 1 : start_row + text.count("\n")
-
-          # Calculate end_column if not provided
-          if end_column.nil?
-            lines = text.split("\n", -1)
-            end_column = lines.last&.length || 0
-          end
-
-          # Build children as MockInnerNodes
-          child_nodes = children.map do |child_spec|
-            MockInnerNode.new(**child_spec)
-          end
-
-          inner = MockInnerNode.new(
-            type: type,
-            text: text,
-            start_byte: start_byte,
-            end_byte: end_byte,
-            start_row: start_row,
-            start_column: start_column,
-            end_row: end_row,
-            end_column: end_column,
-            children: child_nodes,
-          )
-
-          # Create a real TreeHaver::Node wrapping our mock
-          # Pass source so TreeHaver::Node can extract text if needed
-          new(inner, source: source || text)
-        end
-
-        # Create multiple nodes from an array of specifications.
-        #
-        # @param specs [Array<Hash>] Array of node specifications
-        # @return [Array<TestableNode>]
-        def create_list(*specs)
-          specs.flatten.map { |spec| create(**spec) }
-        end
-      end
-
-      # Additional test helper methods
-
-      # Check if this is a testable node (for test assertions)
-      #
-      # @return [Boolean] true
-      def testable?
-        true
-      end
-    end
-  end
-end
-
-# Make TestableNode available at top level for convenience in specs.
-# This allows specs to use `TestableNode.create(...)` without the full namespace.
-TestableNode = TreeHaver::RSpec::TestableNode