ast-merge 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72301b52fa4f37e5f4224041c08fe9ace0117f84521e37b8b1c8b354bc5af500
-  data.tar.gz: 16c3d01ce0e56c17998fcf7e0e4629832fc52db44dc64d07b897004e9981f6ea
+  metadata.gz: e10cc78b855b0a28a19d476767d5cb49b880e0101b940a8846be8cb01c736882
+  data.tar.gz: 03dde93b3c46ceec1859268a538c917162f3737eb719a2138e9923fe4f3b05e6
 SHA512:
-  metadata.gz: e0ab85926e6944d30500a5ced0144c86fa966d6a18252cda9c6c8091e4827e62b8743119be97944c30145d9a1e64f8c2fad52c5e9fd6f50d09b3ff70417ce64d
-  data.tar.gz: f57d3ce4c7cdb62dbbe59493581bbe2fb721a62ea029bf327a527edd2e76d394be554b34ad97fe68a82f009abf56e39225994835f03315663b8c3b137e56a459
+  metadata.gz: 5e0715a8946d00becd61e3e8cf6418f6fcb57b89d735dacf60728e62db78e9ea95691fe55b96c30bb7e7bb14255de1919bb4962af4bef2e66460988db9242bd9
+  data.tar.gz: 04f7fde08c4419a7b5fa086d0575bf4cdbe5bcd748519eda89dcb7c161a8b6aa322521bbe5d9ca008dc1875186c0a2795b5976621449c8c864ca2b6640b6209b

data/CHANGELOG.md

@@ -30,6 +30,52 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [4.0.4] - 2026-01-20
+
+- TAG: [v4.0.4][4.0.4t]
+- COVERAGE: 96.37% -- 2552/2648 lines in 50 files
+- BRANCH COVERAGE: 87.22% -- 812/931 branches in 50 files
+- 98.81% documented
+
+### Added
+
+- **RSpec Split Loading Pattern**: New files for granular RSpec dependency tag loading
+  - `lib/ast/merge/rspec/setup.rb` - Loads only registry and helper classes (no RSpec configuration)
+  - `lib/ast/merge/rspec/dependency_tags_helpers.rb` - DependencyTags helper module
+  - `lib/ast/merge/rspec/dependency_tags_config.rb` - RSpec.configure block with exclusion filters
+  - Enables registering known gems before RSpec.configure runs (solving catch-22 problem)
+  - Required for ast-merge test suite to preserve SimpleCov coverage
+  - Required for merge gems that register other merge gems as dependencies
+- **`Ast::Merge::RSpec::MergeGemRegistry.force_check_availability!`**: Deferred availability checking for accurate test coverage
+  - Called automatically in `before(:suite)` hook AFTER SimpleCov is loaded
+  - Prevents premature gem loading that would bypass coverage instrumentation
+  - Ensures accurate coverage reporting in merge gem test suites
+
+### Changed
+
+- **RSpec Dependency Tags**: Fixed exclusion filter setup to properly skip tests when optional gems unavailable
+  - Exclusion filters now set during `RSpec.configure` (not in `before(:suite)` which runs too late)
+  - Fixed RSpec API usage: `config.filter_run_excluding tag => true` (not `[tag] = true`)
+  - `ast-merge` uses split loading pattern in `spec/spec_helper.rb` and `spec/config/tree_haver.rb`
+  - `markdown-merge` uses split pattern (registers `:commonmarker_merge`, `:markly_merge`)
+  - `markly-merge` uses split pattern (registers `:prism_merge`)
+  - `commonmarker-merge` uses simple pattern (no registrations needed)
+
+### Fixed
+
+- **Test coverage accuracy**: Fixed premature gem loading that bypassed SimpleCov instrumentation
+  - `MergeGemRegistry.registered_gems` now returns ONLY explicitly registered gems, not all KNOWN_GEMS
+  - RSpec exclusion filters are configured in `before(:suite)` hook after `force_check_availability!` runs
+  - This ensures gems are loaded AFTER SimpleCov sets up coverage instrumentation
+  - Previously, commonmarker-merge reported only 11 lines covered when it should have been far more
+- **RSpec Dependency Tags**: Tests with tags like `:markdown_merge`, `:markly_merge` now properly skip when those gems aren't available
+  - Fixed 141 test failures caused by tests running without required gems loaded
+  - Removed `require` statements from integration specs - dependency tags handle gem loading
+  - Fixed tag usage: Tests using `Markdown::Merge::PartialTemplateMerger` with `:markly` backend now correctly tagged with both `:markdown_merge` and `:markly_merge`
+- **Thread-Safety Spec**: Fixed JRuby concurrency test failure in `NodeTyping::Normalizer#canonical_type`
+  - Changed from unsynchronized `Array` to thread-safe `Queue` for collecting results from concurrent threads
+  - Eliminates `ConcurrencyError: Detected invalid array contents due to unsynchronized modifications`
+
 ## [4.0.3] - 2026-01-19
 
 - TAG: [v4.0.3][4.0.3t]
@@ -687,7 +733,11 @@ Please file a bug if you notice a violation of semantic versioning.
 
 - Initial release
 
-[Unreleased]: https://github.com/kettle-rb/ast-merge/compare/v4.0.3...HEAD
+[Unreleased]: https://github.com/kettle-rb/ast-merge/compare/v4.0.4...HEAD
+[4.0.5]: https://github.com/kettle-rb/ast-merge/compare/v4.0.4...v4.0.5
+[4.0.5t]: https://github.com/kettle-rb/ast-merge/releases/tag/v4.0.5
+[4.0.4]: https://github.com/kettle-rb/ast-merge/compare/v4.0.3...v4.0.4
+[4.0.4t]: https://github.com/kettle-rb/ast-merge/releases/tag/v4.0.4
 [4.0.3]: https://github.com/kettle-rb/ast-merge/compare/v4.0.2...v4.0.3
 [4.0.3t]: https://github.com/kettle-rb/ast-merge/releases/tag/v4.0.3
 [4.0.2]: https://github.com/kettle-rb/ast-merge/compare/v4.0.1...v4.0.2

data/README.md

@@ -1106,7 +1106,7 @@ Thanks for RTFM. ☺️
 [📌gitmoji]: https://gitmoji.dev
 [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-2.815-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-2.648-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
 [🔐security]: SECURITY.md
 [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
 [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

data/lib/ast/merge/rspec/dependency_tags.rb

@@ -1,140 +1,35 @@
 # frozen_string_literal: true
 
-require_relative "merge_gem_registry"
-
-# Ast::Merge RSpec Dependency Tags
+# Ast::Merge RSpec Dependency Tags - Combined Loader
+#
+# This file provides the standard entry point for RSpec dependency tags.
+# It loads both the helper module and the RSpec configuration.
+#
+# **When to use the split loading pattern:**
+# - ast-merge: MUST use split pattern (to preserve SimpleCov coverage of ast-merge itself)
+# - Merge gems that register other merge gems: MUST use split pattern (to avoid catch-22)
+# - Other gems: Can use simple `require "ast/merge/rspec"` (this file)
 #
-# This module provides dependency detection helpers for conditional test execution
-# in the ast-merge gem family. It uses MergeGemRegistry for dynamic merge gem detection.
+# @example Simple pattern (for gems that DON'T register other gems)
+#   # In spec/config/tree_haver.rb:
+#   require "ast-merge"
+#   require "ast/merge/rspec"  # Loads everything
 #
-# @example Loading in spec_helper.rb
-#   require "ast/merge/rspec/dependency_tags"
+# @example Split pattern (for ast-merge or gems that register other merge gems)
+#   # In spec/config/tree_haver.rb:
+#   require "ast-merge"
+#   require "ast/merge/rspec/setup"  # Load registry/helpers only
+#   Ast::Merge::RSpec::MergeGemRegistry.register_known_gems(:markly_merge)
+#   require "ast/merge/rspec/dependency_tags_config"  # Load RSpec config
+#   require "ast/merge/rspec/shared_examples"
 #
 # @example Usage in specs
 #   it "requires markly-merge", :markly_merge do
 #     # This test only runs when markly-merge is available
 #   end
-#
-#   it "requires prism-merge", :prism_merge do
-#     # This test only runs when prism-merge is available
-#   end
-#
-# == Dynamic Tag Registration
-#
-# Merge gems register themselves with MergeGemRegistry, which automatically:
-# - Defines `*_available?` methods on DependencyTags
-# - Configures RSpec exclusion filters for the tag
-# - Supports negated tags (`:not_*`)
-#
-# @example How merge gems register (in their lib file)
-#   Ast::Merge::RSpec::MergeGemRegistry.register(
-#     :markly_merge,
-#     require_path: "markly/merge",
-#     merger_class: "Markly::Merge::SmartMerger",
-#     test_source: "# Test\n\nParagraph",
-#     category: :markdown
-#   )
-#
-# == Built-in Composite Tags
-#
-# [:any_markdown_merge]
-#   At least one markdown merge gem is available (category: :markdown).
-
-module Ast
-  module Merge
-    module RSpec
-      # Dependency detection helpers for conditional test execution
-      module DependencyTags
-        class << self
-          # ============================================================
-          # Composite Availability Checks
-          # ============================================================
-
-          # Check if at least one markdown merge gem is available
-          #
-          # @return [Boolean] true if any markdown merge gem works
-          def any_markdown_merge_available?
-            MergeGemRegistry.gems_by_category(:markdown).any? do |tag|
-              MergeGemRegistry.available?(tag)
-            end
-          end
-
-          # ============================================================
-          # Summary and Reset
-          # ============================================================
-
-          # Get a summary of available dependencies (for debugging)
-          #
-          # @return [Hash{Symbol => Boolean}] map of dependency name to availability
-          def summary
-            result = MergeGemRegistry.summary
-            result[:any_markdown_merge] = any_markdown_merge_available?
-            result
-          end
-
-          # Reset all memoized availability checks
-          #
-          # @return [void]
-          def reset!
-            MergeGemRegistry.reset_availability!
-          end
-        end
-      end
-    end
-  end
-end
-
-# NOTE: Known merge gems (KNOWN_GEMS) are NOT automatically registered here.
-# Each test suite should explicitly register only the gems it needs in its
-# spec/config/tree_haver.rb file using:
-#
-#   Ast::Merge::RSpec::MergeGemRegistry.register_known_gems(:gem1, :gem2, ...)
-#
-# This avoids wasting time registering gems that aren't needed for a particular
-# test suite. Only the gems that are actually required for testing should be registered.
-#
-# Example for a gem that needs to test with optional markdown backends:
-#   Ast::Merge::RSpec::MergeGemRegistry.register_known_gems(
-#     :commonmarker_merge,
-#     :markly_merge
-#   )
-
-# Configure RSpec with dependency-based exclusion filters
-RSpec.configure do |config|
-  deps = Ast::Merge::RSpec::DependencyTags
-  registry = Ast::Merge::RSpec::MergeGemRegistry
-
-  config.before(:suite) do
-    # Print dependency summary if AST_MERGE_DEBUG is set
-    unless ENV.fetch("AST_MERGE_DEBUG", "false").casecmp?("false")
-      puts "\n=== Ast::Merge Test Dependencies ==="
-      deps.summary.each do |dep, available|
-        status = available ? "✓ available" : "✗ not available"
-        puts "  #{dep}: #{status}"
-      end
-      puts "=====================================\n"
-    end
-  end
-
-  # ============================================================
-  # Dynamic Merge Gem Tags
-  # ============================================================
-  # Tags are configured dynamically based on what's registered in MergeGemRegistry.
-  # Each merge gem registers itself, and exclusion filters are set up automatically.
-
-  registry.registered_gems.each do |tag|
-    # Positive tag: run when gem IS available
-    config.filter_run_excluding(tag => true) unless registry.available?(tag)
-
-    # Negated tag: run when gem is NOT available
-    negated_tag = :"not_#{tag}"
-    config.filter_run_excluding(negated_tag => true) if registry.available?(tag)
-  end
 
-  # ============================================================
-  # Composite Tags
-  # ============================================================
+# Load the helper module (DependencyTags methods)
+require_relative "dependency_tags_helpers"
 
-  config.filter_run_excluding(any_markdown_merge: true) unless deps.any_markdown_merge_available?
-  config.filter_run_excluding(not_any_markdown_merge: true) if deps.any_markdown_merge_available?
-end
+# Load the RSpec configuration (exclusion filters)
+require_relative "dependency_tags_config"

data/lib/ast/merge/rspec/dependency_tags_config.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "dependency_tags_helpers"
+
+# Ast::Merge RSpec Dependency Tags - RSpec Configuration
+#
+# This file configures RSpec with dependency-based exclusion filters.
+# It should be loaded AFTER gems have been registered with MergeGemRegistry.
+#
+# @example Loading in spec_helper.rb (for merge gem test suites)
+#   require "ast/merge/rspec"  # Loads this file automatically
+#
+# @example For ast-merge test suite (split loading)
+#   # In spec_helper.rb BEFORE requiring ast-merge:
+#   require "ast/merge/rspec/setup"
+#
+#   # Register known gems:
+#   Ast::Merge::RSpec::MergeGemRegistry.register_known_gems(:markly_merge)
+#
+#   # Then AFTER requiring ast-merge, load config:
+#   require "ast/merge/rspec/dependency_tags_config"
+
+# Configure RSpec with dependency-based exclusion filters
+RSpec.configure do |config|
+  deps = Ast::Merge::RSpec::DependencyTags
+  registry = Ast::Merge::RSpec::MergeGemRegistry
+
+  # CRITICAL: Exclusion filters MUST be set during RSpec.configure, not in before(:suite)
+  # because RSpec filters tests before before(:suite) runs!
+
+  # Force availability checking for all registered gems
+  # This loads the gems NOW during configuration, which is after SimpleCov has instrumented
+  # the code (since this file is required AFTER ast-merge loads in spec_helper.rb)
+  registry.force_check_availability!
+
+  # Now configure exclusion filters based on actual availability
+  registry.registered_gems.each do |tag|
+    if registry.available?(tag)
+      # Gem is available - exclude tests tagged with :not_tag
+      negated_tag = :"not_#{tag}"
+      config.filter_run_excluding(negated_tag => true)
+    else
+      # Gem is NOT available - exclude tests tagged with :tag
+      config.filter_run_excluding(tag => true)
+    end
+  end
+
+  # Configure composite tags (these also trigger gem loading, so must be here)
+  if deps.any_markdown_merge_available?
+    config.filter_run_excluding(not_any_markdown_merge: true)
+  else
+    config.filter_run_excluding(any_markdown_merge: true)
+  end
+
+  # Print dependency summary if AST_MERGE_DEBUG is set
+  config.before(:suite) do
+    unless ENV.fetch("AST_MERGE_DEBUG", "false").casecmp?("false")
+      puts "\n=== Ast::Merge Test Dependencies ==="
+      deps.summary.each do |dep, available|
+        status = available ? "✓ available" : "✗ not available"
+        puts "  #{dep}: #{status}"
+      end
+      puts "=====================================\n"
+    end
+  end
+
+  # ============================================================
+  # Dynamic Merge Gem Tags - Initial Setup
+  # ============================================================
+  # Note: We don't set exclusions here because that would require checking
+  # availability (loading gems) before SimpleCov. The actual exclusions are
+  # set in the before(:suite) hook above after force_check_availability! runs.
+  # This includes composite tags like :any_markdown_merge.
+end

data/lib/ast/merge/rspec/dependency_tags_helpers.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "merge_gem_registry"
+
+# Ast::Merge RSpec Dependency Tags - Helper Module Only
+#
+# This module provides dependency detection helpers for conditional test execution
+# in the ast-merge gem family. It uses MergeGemRegistry for dynamic merge gem detection.
+#
+# NOTE: This file contains ONLY the helper module, not the RSpec configuration.
+# The RSpec configuration is in dependency_tags_config.rb and is loaded by
+# ast/merge/rspec (the full entry point).
+
+module Ast
+  module Merge
+    module RSpec
+      # Dependency detection helpers for conditional test execution
+      module DependencyTags
+        class << self
+          # ============================================================
+          # Composite Availability Checks
+          # ============================================================
+
+          # Check if at least one markdown merge gem is available
+          #
+          # @return [Boolean] true if any markdown merge gem works
+          def any_markdown_merge_available?
+            MergeGemRegistry.gems_by_category(:markdown).any? do |tag|
+              MergeGemRegistry.available?(tag)
+            end
+          end
+
+          # ============================================================
+          # Summary and Reset
+          # ============================================================
+
+          # Get a summary of available dependencies (for debugging)
+          #
+          # @return [Hash{Symbol => Boolean}] map of dependency name to availability
+          def summary
+            result = MergeGemRegistry.summary
+            result[:any_markdown_merge] = any_markdown_merge_available?
+            result
+          end
+
+          # Reset all memoized availability checks
+          #
+          # @return [void]
+          def reset!
+            MergeGemRegistry.reset_availability!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ast/merge/rspec/merge_gem_registry.rb

@@ -295,12 +295,17 @@ module Ast
           end
         end
 
-        # Get all registered gem tag names (including pre-configured known gems)
+        # Get all explicitly registered gem tag names
+        #
+        # This returns ONLY gems that were explicitly registered via register() or
+        # register_known_gems(), NOT all gems in KNOWN_GEMS. This prevents premature
+        # loading of gems during RSpec tag setup, which would happen before SimpleCov
+        # and ruin coverage reporting.
         #
         # @return [Array<Symbol>] list of registered tag names
         def registered_gems
           @mutex.synchronize do
-            (KNOWN_GEMS.keys + @registry.keys).uniq
+            @registry.keys
           end
         end
 
@@ -316,6 +321,31 @@ module Ast
           end
         end
 
+        # Force availability checking for all registered gems
+        #
+        # This method should be called AFTER SimpleCov is loaded (typically at the end
+        # of spec_helper.rb) to trigger gem loading and availability checking. Calling
+        # this ensures RSpec exclusion filters are properly configured based on which
+        # gems are actually available.
+        #
+        # This is necessary because register_known_gems() only registers gems without
+        # checking availability. The actual availability check (which requires loading
+        # the gem) must happen AFTER coverage instrumentation is set up.
+        #
+        # @return [void]
+        #
+        # @example At the end of spec_helper.rb (after SimpleCov loads)
+        #   # Force availability checking now that coverage is instrumented
+        #   Ast::Merge::RSpec::MergeGemRegistry.force_check_availability!
+        def force_check_availability!
+          registered_gems.each do |tag|
+            # This will trigger gem_works? which loads the gem
+            # Results are cached, so subsequent calls are fast
+            available?(tag)
+          end
+          nil
+        end
+
         # Get registration info for a gem
         #
         # @param tag_name [Symbol] the tag name

data/lib/ast/merge/rspec/setup.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Ast::Merge RSpec Setup (Registry Only)
+#
+# This file loads ONLY the registry and helper classes without configuring RSpec.
+# It's used in the ast-merge test suite to allow registering known gems before
+# SimpleCov loads the library code.
+#
+# DO NOT load this in merge gem test suites - they should use require "ast/merge/rspec"
+# which includes the full RSpec configuration.
+#
+# @example Loading in ast-merge's spec_helper.rb (BEFORE requiring ast-merge)
+#   require "ast/merge/rspec/setup"
+#
+#   # Now you can register known gems:
+#   Ast::Merge::RSpec::MergeGemRegistry.register_known_gems(:markly_merge, :prism_merge)
+#
+# @example For merge gem test suites (normal pattern)
+#   # Don't use this file! Use the full loader instead:
+#   require "ast/merge/rspec"  # Loads setup + RSpec configuration
+
+# Load only the registry - no RSpec configuration
+require_relative "merge_gem_registry"
+require_relative "dependency_tags_helpers"

data/lib/ast/merge/version.rb

@@ -5,7 +5,7 @@ module Ast
     # Version information for Ast::Merge
     module Version
       # Current version of the ast-merge gem
-      VERSION = "4.0.3"
+      VERSION = "4.0.4"
     end
     VERSION = Version::VERSION # traditional location
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ast-merge
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Peter H. Boling
@@ -355,7 +355,10 @@ files:
 - lib/ast/merge/recipe/script_loader.rb
 - lib/ast/merge/rspec.rb
 - lib/ast/merge/rspec/dependency_tags.rb
+- lib/ast/merge/rspec/dependency_tags_config.rb
+- lib/ast/merge/rspec/dependency_tags_helpers.rb
 - lib/ast/merge/rspec/merge_gem_registry.rb
+- lib/ast/merge/rspec/setup.rb
 - lib/ast/merge/rspec/shared_examples.rb
 - lib/ast/merge/rspec/shared_examples/conflict_resolver_base.rb
 - lib/ast/merge/rspec/shared_examples/debug_logger.rb
@@ -382,10 +385,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://ast-merge.galtzo.com/
-  source_code_uri: https://github.com/kettle-rb/ast-merge/tree/v4.0.3
-  changelog_uri: https://github.com/kettle-rb/ast-merge/blob/v4.0.3/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-rb/ast-merge/tree/v4.0.4
+  changelog_uri: https://github.com/kettle-rb/ast-merge/blob/v4.0.4/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-rb/ast-merge/issues
-  documentation_uri: https://www.rubydoc.info/gems/ast-merge/4.0.3
+  documentation_uri: https://www.rubydoc.info/gems/ast-merge/4.0.4
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/kettle-rb/ast-merge/wiki
   news_uri: https://www.railsbling.com/tags/ast-merge