commonmarker-merge 1.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1c5a0298d4f7040ba8b86c22dc91f1fbb4eedd895de90e875b8a47825433d6b
-  data.tar.gz: 4238c1c44da0fe3799374de5541adbda0fad858738a591f70eb4993cedfd9121
+  metadata.gz: f1126115415afe06ef7afd9ce3beea218c9df6b4c222ca9d18d1b7f0dfc547eb
+  data.tar.gz: f9d5e702c16169c8a65eef5f4ed30725b5437b2f8c2c2f17f215efdb633d9e46
 SHA512:
-  metadata.gz: ae5d07a3655efd657db2921151f272a23297e487110c90aeb66e8761f5af7cc6d564793a7fc191f869cebdbad161ff026207022f9eb3ba4fd89e9ffe56bd9ee5
-  data.tar.gz: d63c2dcfea4787825cdbe04ee4be0c2b7bc7ef1b1723c244c03181fca84ff2bb8edbccd277cfc24f4340b34f0847b694532c4b4cb2edd21fb1e486fed729c5e9
+  metadata.gz: 3a2bef2e58c82db4e4f6ba3ae8f282d6562e06d49260d1196d7d2989901c25b116031740b3dd162b00b8e006efc5e92a30c3c4c1037e4dc34e8bf4305a9eb003
+  data.tar.gz: d41be46c9edb3aab281558717843bc10f82805dd2c64fc1e9522ff0eecc1945def4b4cdf115260a7814d3145e4d7dc5edf3a1946b85698422147640e5b52f701

data/lib/commonmarker/merge/version.rb

@@ -2,11 +2,10 @@
 
 module Commonmarker
   module Merge
-    # Version information for Commonmarker::Merge
     module Version
-      # Current version of the commonmarker-merge gem
-      VERSION = "1.0.0"
+      VERSION = "7.0.0"
     end
-    VERSION = Version::VERSION # traditional location
+
+    VERSION = Version::VERSION
   end
 end

data/lib/commonmarker/merge.rb

@@ -1,108 +1,170 @@
 # frozen_string_literal: true
 
-# Hard dependency - ensures commonmarker gem is installed
+require "markdown-merge"
 require "commonmarker"
 
-# External gems
-require "version_gem"
+module Commonmarker
+  module Merge
+    extend self
 
-# Shared merge infrastructure (includes tree_haver)
-require "markdown/merge"
+    PACKAGE_NAME = "commonmarker-merge"
+    BACKEND_REFERENCE = TreeHaver::BackendReference.new(id: "commonmarker", family: "native").freeze
+    TreeHaver::BackendRegistry.register(BACKEND_REFERENCE)
 
-# This gem
-require_relative "merge/version"
+    def markdown_feature_profile
+      Markdown::Merge.markdown_feature_profile
+    end
 
-module Commonmarker
-  # Smart merging for Markdown files using CommonMarker AST.
-  #
-  # Commonmarker::Merge provides intelligent merging of Markdown files by:
-  # - Parsing Markdown into AST using CommonMarker via tree_haver
-  # - Matching structural elements (headings, paragraphs, lists, etc.) between files
-  # - Preserving frozen sections marked with HTML comments
-  # - Resolving conflicts based on configurable preferences
-  #
-  # This is a thin wrapper around Markdown::Merge that:
-  # - Provides hard dependency on the commonmarker gem
-  # - Sets commonmarker-specific defaults (freeze token, inner_merge_code_blocks)
-  # - Maintains API compatibility for existing users
-  #
-  # @example Basic merge
-  #   merger = Commonmarker::Merge::SmartMerger.new(template, destination)
-  #   result = merger.merge
-  #   puts result.content if result.success?
-  #
-  # @example With freeze blocks
-  #   # In your Markdown file:
-  #   # <!-- commonmarker-merge:freeze -->
-  #   # ## Custom Section
-  #   # This content is preserved during merges.
-  #   # <!-- commonmarker-merge:unfreeze -->
-  #
-  # @see SmartMerger Main entry point for merging
-  # @see Markdown::Merge::SmartMerger Underlying implementation
-  module Merge
-    # Base error class for Commonmarker::Merge
-    # Inherits from Markdown::Merge::Error for consistency across merge gems.
-    class Error < Markdown::Merge::Error; end
-
-    # Raised when a Markdown file has parsing errors.
-    # Inherits from Markdown::Merge::ParseError for consistency across merge gems.
-    class ParseError < Markdown::Merge::ParseError; end
-
-    # Raised when the template file has syntax errors.
-    class TemplateParseError < ParseError; end
-
-    # Raised when the destination file has syntax errors.
-    class DestinationParseError < ParseError; end
-
-    # Default freeze token for commonmarker-merge
-    # @return [String]
-    DEFAULT_FREEZE_TOKEN = "commonmarker-merge"
-
-    # Default inner_merge_code_blocks setting for commonmarker-merge
-    # @return [Boolean]
-    DEFAULT_INNER_MERGE_CODE_BLOCKS = false
-
-    # Re-export shared classes from markdown-merge
-    FileAligner = Markdown::Merge::FileAligner
-    ConflictResolver = Markdown::Merge::ConflictResolver
-    MergeResult = Markdown::Merge::MergeResult
-    TableMatchAlgorithm = Markdown::Merge::TableMatchAlgorithm
-    TableMatchRefiner = Markdown::Merge::TableMatchRefiner
-    CodeBlockMerger = Markdown::Merge::CodeBlockMerger
-    NodeTypeNormalizer = Markdown::Merge::NodeTypeNormalizer
-
-    autoload :DebugLogger, "commonmarker/merge/debug_logger"
-    autoload :FreezeNode, "commonmarker/merge/freeze_node"
-    autoload :FileAnalysis, "commonmarker/merge/file_analysis"
-    autoload :SmartMerger, "commonmarker/merge/smart_merger"
-    autoload :Backend, "commonmarker/merge/backend"
-
-    class << self
-      # Eagerly load and register backend when this module is loaded
-      # This ensures the backend is available for tree_haver before any parsing happens
-      def ensure_backend_loaded!
-        Backend # Access constant to trigger autoload
-      end
+    def available_markdown_backends
+      [BACKEND_REFERENCE]
     end
-  end
-end
 
-# Ensure backend is loaded and registered
-Commonmarker::Merge.ensure_backend_loaded!
-
-# Register with ast-merge's MergeGemRegistry for RSpec dependency tags
-# Only register if MergeGemRegistry is loaded (i.e., in test environment)
-if defined?(Ast::Merge::RSpec::MergeGemRegistry)
-  Ast::Merge::RSpec::MergeGemRegistry.register(
-    :commonmarker_merge,
-    require_path: "commonmarker/merge",
-    merger_class: "Commonmarker::Merge::SmartMerger",
-    test_source: "# Test\n\nParagraph",
-    category: :markdown,
-  )
-end
+    def markdown_backend_feature_profile(backend: nil)
+      requested = backend.to_s.empty? ? BACKEND_REFERENCE.id : backend.to_s
+      return unsupported_feature_result("Unsupported Markdown backend #{requested}.") unless requested == BACKEND_REFERENCE.id
+
+      markdown_feature_profile.merge(backend: BACKEND_REFERENCE.id, backend_ref: BACKEND_REFERENCE.to_h)
+    end
+
+    def markdown_plan_context(backend: nil)
+      profile = markdown_backend_feature_profile(backend: backend)
+      return profile if profile[:ok] == false
+
+      {
+        family_profile: markdown_feature_profile,
+        feature_profile: {
+          backend: profile[:backend],
+          supports_dialects: true,
+          supported_policies: []
+        }
+      }
+    end
+
+    def parse_markdown(source, dialect, backend: nil)
+      requested = backend.to_s.empty? ? BACKEND_REFERENCE.id : backend.to_s
+      return unsupported_feature_result("Unsupported Markdown backend #{requested}.") unless requested == BACKEND_REFERENCE.id
+
+      ::Commonmarker.parse(source)
+      normalized = Markdown::Merge.normalize_source(source)
+      {
+        ok: true,
+        diagnostics: [],
+        analysis: {
+          kind: "markdown",
+          dialect: dialect,
+          normalized_source: normalized,
+          root_kind: "document",
+          owners: Markdown::Merge.collect_markdown_owners(normalized)
+        },
+        policies: []
+      }
+    rescue StandardError => e
+      {
+        ok: false,
+        diagnostics: [{ severity: "error", category: "parse_error", message: e.message }],
+        policies: []
+      }
+    end
+
+    def match_markdown_owners(template, destination)
+      Markdown::Merge.match_markdown_owners(template, destination)
+    end
+
+    def merge_markdown(template_source, destination_source, dialect, backend: nil)
+      requested = backend.to_s.empty? ? BACKEND_REFERENCE.id : backend.to_s
+      return unsupported_feature_result("Unsupported Markdown backend #{requested}.") unless requested == BACKEND_REFERENCE.id
+
+      Markdown::Merge.merge_markdown(template_source, destination_source, dialect)
+    end
 
-Commonmarker::Merge::Version.class_eval do
-  extend VersionGem::Basic
+    def merge_markdown_with_reviewed_nested_outputs(template_source, destination_source, dialect, review_state, applied_children, backend: nil)
+      requested = backend.to_s.empty? ? BACKEND_REFERENCE.id : backend.to_s
+      return unsupported_feature_result("Unsupported Markdown backend #{requested}.") unless requested == BACKEND_REFERENCE.id
+
+      Markdown::Merge.merge_markdown_with_reviewed_nested_outputs(
+        template_source,
+        destination_source,
+        dialect,
+        review_state,
+        applied_children
+      )
+    end
+
+    def merge_markdown_with_reviewed_nested_outputs_from_replay_bundle(template_source, destination_source, dialect, replay_bundle, backend: nil)
+      requested = backend.to_s.empty? ? BACKEND_REFERENCE.id : backend.to_s
+      return unsupported_feature_result("Unsupported Markdown backend #{requested}.") unless requested == BACKEND_REFERENCE.id
+
+      Markdown::Merge.merge_markdown_with_reviewed_nested_outputs_from_replay_bundle(
+        template_source,
+        destination_source,
+        dialect,
+        replay_bundle
+      )
+    end
+
+    def merge_markdown_with_reviewed_nested_outputs_from_replay_bundle_envelope(template_source, destination_source, dialect, envelope, backend: nil)
+      requested = backend.to_s.empty? ? BACKEND_REFERENCE.id : backend.to_s
+      return unsupported_feature_result("Unsupported Markdown backend #{requested}.") unless requested == BACKEND_REFERENCE.id
+
+      Markdown::Merge.merge_markdown_with_reviewed_nested_outputs_from_replay_bundle_envelope(
+        template_source,
+        destination_source,
+        dialect,
+        envelope
+      )
+    end
+
+    def merge_markdown_with_reviewed_nested_outputs_from_review_state(template_source, destination_source, dialect, review_state, backend: nil)
+      requested = backend.to_s.empty? ? BACKEND_REFERENCE.id : backend.to_s
+      return unsupported_feature_result("Unsupported Markdown backend #{requested}.") unless requested == BACKEND_REFERENCE.id
+
+      Markdown::Merge.merge_markdown_with_reviewed_nested_outputs_from_review_state(
+        template_source,
+        destination_source,
+        dialect,
+        review_state
+      )
+    end
+
+    def merge_markdown_with_reviewed_nested_outputs_from_review_state_envelope(template_source, destination_source, dialect, envelope, backend: nil)
+      requested = backend.to_s.empty? ? BACKEND_REFERENCE.id : backend.to_s
+      return unsupported_feature_result("Unsupported Markdown backend #{requested}.") unless requested == BACKEND_REFERENCE.id
+
+      Markdown::Merge.merge_markdown_with_reviewed_nested_outputs_from_review_state_envelope(
+        template_source,
+        destination_source,
+        dialect,
+        envelope
+      )
+    end
+
+    def markdown_embedded_families(analysis)
+      Markdown::Merge.markdown_embedded_families(analysis)
+    end
+
+    def unsupported_feature_result(message)
+      {
+        ok: false,
+        diagnostics: [{ severity: "error", category: "unsupported_feature", message: message }],
+        policies: []
+      }
+    end
+
+    module_function(
+      :markdown_feature_profile,
+      :available_markdown_backends,
+      :markdown_backend_feature_profile,
+      :markdown_plan_context,
+      :parse_markdown,
+      :match_markdown_owners,
+      :merge_markdown,
+      :merge_markdown_with_reviewed_nested_outputs,
+      :merge_markdown_with_reviewed_nested_outputs_from_replay_bundle,
+      :merge_markdown_with_reviewed_nested_outputs_from_replay_bundle_envelope,
+      :merge_markdown_with_reviewed_nested_outputs_from_review_state,
+      :merge_markdown_with_reviewed_nested_outputs_from_review_state_envelope,
+      :markdown_embedded_families,
+      :unsupported_feature_result
+    )
+  end
 end

data/lib/commonmarker-merge.rb

@@ -1,4 +1,3 @@
-# For technical reasons, if we move to Zeitwerk, this cannot be require_relative.
-#   See: https://github.com/fxn/zeitwerk#for_gem_extension
-# Hook for other libraries to load this library (e.g. via bundler)
-require "commonmarker/merge"
+# frozen_string_literal: true
+
+require_relative "commonmarker/merge"

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: commonmarker-merge
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Peter H. Boling
-bindir: exe
+bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
@@ -37,295 +37,74 @@ cert_chain:
   -----END CERTIFICATE-----
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: commonmarker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: markdown-merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
-  name: version_gem
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.9
-- !ruby/object:Gem::Dependency
-  name: kettle-dev
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: bundler-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: require_bench
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-- !ruby/object:Gem::Dependency
-  name: appraisal2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: kettle-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.6
-- !ruby/object:Gem::Dependency
-  name: ruby-progressbar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: stone_checksums
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: gitmoji-regex
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-description: "☯️ Commonmarker::Merge provides smart Markdown file merging using Comrak
-  (Rust) via Commonmarker. It understands document structure including headings, lists,
-  code blocks, and tables. Perfect for merging documentation templates with customized
-  files."
+        version: '2.2'
+description: Commonmarker-backed Markdown provider gem for the Structured Merge Markdown
+  family.
 email:
-- floss@galtzo.com
+- info@structuredmerge.org
 executables: []
 extensions: []
-extra_rdoc_files:
-- CHANGELOG.md
-- CITATION.cff
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- FUNDING.md
-- LICENSE.txt
-- README.md
-- REEK
-- RUBOCOP.md
-- SECURITY.md
+extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- CITATION.cff
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- FUNDING.md
-- LICENSE.txt
-- README.md
-- REEK
-- RUBOCOP.md
-- SECURITY.md
 - lib/commonmarker-merge.rb
 - lib/commonmarker/merge.rb
-- lib/commonmarker/merge/backend.rb
-- lib/commonmarker/merge/debug_logger.rb
-- lib/commonmarker/merge/file_analysis.rb
-- lib/commonmarker/merge/freeze_node.rb
-- lib/commonmarker/merge/smart_merger.rb
 - lib/commonmarker/merge/version.rb
-- sig/commonmarker/merge.rbs
-- sig/commonmarker/merge/conflict_resolver.rbs
-- sig/commonmarker/merge/debug_logger.rbs
-- sig/commonmarker/merge/file_aligner.rbs
-- sig/commonmarker/merge/file_analysis.rbs
-- sig/commonmarker/merge/freeze_node.rbs
-- sig/commonmarker/merge/merge_result.rbs
-- sig/commonmarker/merge/smart_merger.rbs
-homepage: https://github.com/kettle-rb/commonmarker-merge
+homepage: https://github.com/structuredmerge/structuredmerge-ruby
 licenses:
-- MIT
+- AGPL-3.0-only
+- PolyForm-Small-Business-1.0.0
 metadata:
-  homepage_uri: https://commonmarker-merge.galtzo.com/
-  source_code_uri: https://github.com/kettle-rb/commonmarker-merge/tree/v1.0.0
-  changelog_uri: https://github.com/kettle-rb/commonmarker-merge/blob/v1.0.0/CHANGELOG.md
-  bug_tracker_uri: https://github.com/kettle-rb/commonmarker-merge/issues
-  documentation_uri: https://www.rubydoc.info/gems/commonmarker-merge/1.0.0
+  homepage_uri: https://structuredmerge.org
+  source_code_uri: https://github.com/structuredmerge/structuredmerge-ruby/tree/v7.0.0
+  changelog_uri: https://github.com/structuredmerge/structuredmerge-ruby/blob/v7.0.0/CHANGELOG.md
+  bug_tracker_uri: https://github.com/structuredmerge/structuredmerge-ruby/issues
+  documentation_uri: https://www.rubydoc.info/gems/commonmarker-merge/7.0.0
   funding_uri: https://github.com/sponsors/pboling
-  wiki_uri: https://github.com/kettle-rb/commonmarker-merge/wiki
-  news_uri: https://www.railsbling.com/tags/commonmarker-merge
+  wiki_uri: https://github.com/structuredmerge/structuredmerge-ruby/wiki
   discord_uri: https://discord.gg/3qme4XHNKN
   rubygems_mfa_required: 'true'
-rdoc_options:
-- "--title"
-- commonmarker-merge - ☯️ Intelligent Markdown file merging using Commonmarker AST
-  analysis
-- "--main"
-- README.md
-- "--exclude"
-- "^sig/"
-- "--line-numbers"
-- "--inline-source"
-- "--quiet"
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 4.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.5
+rubygems_version: 4.0.10
 specification_version: 4
-summary: "☯️ Intelligent Markdown file merging using Commonmarker AST analysis"
+summary: Structured Merge Commonmarker-backed Markdown analysis for Ruby
 test_files: []