commonmarker-merge 1.0.0

data/sig/commonmarker/merge.rbs

@@ -0,0 +1,223 @@
+# Type signatures for Commonmarker::Merge
+#
+# Smart merging for Markdown files using CommonMarker AST.
+# Provides intelligent merging by parsing Markdown, matching structural elements,
+# and preserving frozen sections.
+
+module Commonmarker
+  module Merge
+    # Current version string
+    VERSION: String
+
+    # Base error class for all merge errors
+    class Error < StandardError
+    end
+
+    # Error raised when template file fails to parse
+    class TemplateParseError < Error
+      attr_reader errors: Array[untyped]
+      attr_reader content: String?
+
+      def initialize: (?String? message, ?errors: Array[untyped], ?content: String?) -> void
+    end
+
+    # Error raised when destination file fails to parse
+    class DestinationParseError < Error
+      attr_reader errors: Array[untyped]
+      attr_reader content: String?
+
+      def initialize: (?String? message, ?errors: Array[untyped], ?content: String?) -> void
+    end
+
+    # Debug logging utility for Commonmarker::Merge
+    module DebugLogger
+      extend Ast::Merge::DebugLogger
+
+      def self.env_var_name: () -> String
+      def self.env_var_name=: (String name) -> String
+      def self.log_prefix: () -> String
+      def self.log_prefix=: (String prefix) -> String
+      def self.enabled?: () -> bool
+      def self.debug: (String message, ?Hash[Symbol, untyped] context) -> void
+      def self.info: (String message) -> void
+      def self.warning: (String message) -> void
+      def self.time: [T] (String operation) { () -> T } -> T
+      def self.extract_node_info: (untyped node) -> Hash[Symbol, untyped]
+    end
+
+    # Freeze block node for Markdown files (HTML comment markers)
+    class FreezeNode < Ast::Merge::FreezeNode
+      InvalidStructureError: singleton(Ast::Merge::FreezeNode::InvalidStructureError)
+      Location: singleton(Ast::Merge::FreezeNode::Location)
+
+      attr_reader content: String
+      attr_reader nodes: Array[untyped]
+      attr_reader start_marker: String
+      attr_reader end_marker: String
+
+      def self.pattern_for: (Symbol pattern_type, ?String token) -> Regexp
+
+      def initialize: (
+        start_line: Integer,
+        end_line: Integer,
+        content: String,
+        start_marker: String,
+        end_marker: String,
+        ?nodes: Array[untyped],
+        ?pattern_type: Symbol,
+        ?reason: String?
+      ) -> void
+
+      def signature: () -> Array[Symbol | String]
+      def heading?: () -> bool
+      def paragraph?: () -> bool
+      def code_block?: () -> bool
+      def list?: () -> bool
+      def slice: () -> String
+      def inspect: () -> String
+    end
+
+    # Wrapper for CommonMarker AST nodes
+    class NodeWrapper
+      attr_reader node: untyped
+      attr_reader start_line: Integer
+      attr_reader end_line: Integer
+      attr_reader analysis: FileAnalysis?
+
+      def initialize: (
+        untyped node,
+        ?analysis: FileAnalysis?
+      ) -> void
+
+      def location: () -> Ast::Merge::FreezeNode::Location
+      def signature: () -> Array[untyped]
+      def freeze_node?: () -> bool
+      def heading?: () -> bool
+      def paragraph?: () -> bool
+      def code_block?: () -> bool
+      def list?: () -> bool
+      def html_block?: () -> bool
+      def type: () -> Symbol
+      def level: () -> Integer?
+      def text_content: () -> String
+      def slice: () -> String?
+      def inspect: () -> String
+    end
+
+    # File analysis for Markdown files
+    class FileAnalysis
+      include Ast::Merge::FileAnalysisBase
+
+      DEFAULT_FREEZE_TOKEN: String
+
+      attr_reader source: String
+      attr_reader lines: Array[String]
+      attr_reader document: untyped
+      attr_reader statements: Array[NodeWrapper | FreezeNode]
+      attr_reader freeze_blocks: Array[FreezeNode]
+      attr_reader freeze_token: String
+      attr_reader signature_generator: (^(untyped) -> Array[untyped]?)?
+      attr_reader errors: Array[untyped]
+
+      def initialize: (
+        String source,
+        ?freeze_token: String,
+        ?signature_generator: (^(untyped) -> Array[untyped]?)?
+      ) -> void
+
+      def valid?: () -> bool
+      def nodes: () -> Array[NodeWrapper | FreezeNode]
+      def line_at: (Integer line_num) -> String?
+      def normalized_line: (Integer line_num) -> String?
+      def in_freeze_block?: (Integer line_num) -> bool
+      def freeze_block_at: (Integer line_num) -> FreezeNode?
+      def signature_at: (Integer index) -> Array[untyped]?
+      def generate_signature: (untyped node) -> Array[untyped]?
+      def compute_node_signature: (untyped node) -> Array[untyped]?
+
+      private
+
+      def parse_markdown: () -> void
+      def extract_nodes: () -> Array[NodeWrapper]
+      def extract_freeze_blocks: () -> Array[FreezeNode]
+      def integrate_nodes_and_freeze_blocks: () -> Array[NodeWrapper | FreezeNode]
+    end
+
+    # Result of a Markdown merge operation
+    class MergeResult < Ast::Merge::MergeResult
+      DECISION_KEPT_TEMPLATE: Symbol
+      DECISION_KEPT_DEST: Symbol
+      DECISION_MERGED: Symbol
+      DECISION_ADDED: Symbol
+      DECISION_FREEZE_BLOCK: Symbol
+
+      attr_reader markdown_content: String
+      attr_reader decisions: Array[Hash[Symbol, untyped]]
+      attr_reader statistics: Hash[Symbol, Integer]
+
+      def initialize: (
+        ?template_analysis: FileAnalysis?,
+        ?dest_analysis: FileAnalysis?,
+        ?conflicts: Array[Hash[Symbol, untyped]],
+        ?frozen_blocks: Array[FreezeNode],
+        ?stats: Hash[Symbol, untyped]
+      ) -> void
+
+      def add_content: (String content, decision: Symbol, source: Symbol) -> void
+      def add_node: (NodeWrapper node, decision: Symbol, source: Symbol) -> void
+      def add_freeze_block: (FreezeNode freeze_node) -> void
+      def to_markdown: () -> String
+      def content: () -> String
+      def content_string: () -> String
+      def empty?: () -> bool
+
+      private
+
+      def track_statistics: (Symbol decision, Symbol source) -> void
+    end
+
+    # Smart merger for Markdown files
+    class SmartMerger
+      include Ast::Merge::MergerConfig
+
+      attr_reader template_analysis: FileAnalysis
+      attr_reader dest_analysis: FileAnalysis
+      attr_reader signature_match_preference: (Symbol | Hash[Symbol, Symbol])
+      attr_reader add_template_only_nodes: bool
+
+      def initialize: (
+        String template_content,
+        String dest_content,
+        ?signature_match_preference: (Symbol | Hash[Symbol, Symbol]),
+        ?add_template_only_nodes: bool,
+        ?freeze_token: String,
+        ?signature_generator: (^(untyped) -> Array[untyped]?)?,
+        ?node_splitter: Hash[Symbol, untyped]?
+      ) -> void
+
+      def merge: () -> MergeResult
+
+      private
+
+      def perform_merge: () -> MergeResult
+      def merge_nodes: (MergeResult result) -> void
+    end
+
+    # Conflict resolver for Markdown merges
+    class ConflictResolver
+      attr_reader template_analysis: FileAnalysis
+      attr_reader dest_analysis: FileAnalysis
+      attr_reader signature_match_preference: (Symbol | Hash[Symbol, Symbol])
+      attr_reader add_template_only_nodes: bool
+
+      def initialize: (
+        FileAnalysis template_analysis,
+        FileAnalysis dest_analysis,
+        ?signature_match_preference: (Symbol | Hash[Symbol, Symbol]),
+        ?add_template_only_nodes: bool
+      ) -> void
+
+      def resolve: (untyped boundary, MergeResult result) -> void
+    end
+  end
+end

metadata

@@ -0,0 +1,331 @@
+--- !ruby/object:Gem::Specification
+name: commonmarker-merge
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter H. Boling
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
+  ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
+  DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
+  uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
+  LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
+  mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
+  coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
+  FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
+  yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
+  to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
+  qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
+  fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
+  HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
+  A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
+  ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
+  wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
+  L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
+  GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
+  kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
+  QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
+  0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
+  DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
+  L9nRqA==
+  -----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
+  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
+- !ruby/object:Gem::Dependency
+  name: version_gem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  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."
+email:
+- floss@galtzo.com
+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
+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
+licenses:
+- MIT
+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
+  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
+  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"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.5
+specification_version: 4
+summary: "☯️ Intelligent Markdown file merging using Commonmarker AST analysis"
+test_files: []