binary-merge 7.1.1 → 7.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbba43e2ced0cc3c802f60d5b4ac81b997a9e0f3312a79e219b7db09eb87d724
-  data.tar.gz: 686b68c0d0f824e047fab2caf9381217223ff9efd646c3a9ebe3076f6d27d470
+  metadata.gz: e44595c3208c046ae8140cc0151c9202f79173c8bf6a2a0c04ffc9d898320ddf
+  data.tar.gz: 5b52152c70810249660103bb8440b3e67f63c8618a12d6b86ca9a14b6b939f7b
 SHA512:
-  metadata.gz: c0ad7e02abaa2b03982d1809cb3e3c04c49b3d361b7463e32f0d8a435b7b91fbbec0f4e572f9ef53aa1489235c896a1e975775651a33614bdb1047a7a3f56637
-  data.tar.gz: 8428f548fc35df0be04e787771f18430460c198b069b05ec4aa52bc09ed23d01ed7e4ae2689d3d2a929cd51a62836b04032b6c7ce4a13a5cdc061bf02f001ae1
+  metadata.gz: 172e31e494e2f283239071cee63f26ea8e79948acc06c4f9752713f18d6a3fd3e9da8a5755c5d4e29edf8c0fdd6586434bac4b8b3f5f367d6e49c7397af31e24
+  data.tar.gz: 1fcf18dbbaf050c487b8f59eedc442d57b79c1bb8c2240d4ac2a415e431f1fc41dd0e5d726b2c118e2e8cc7c23c77e33b9ac3a39a0fac8994719260e3e1c6727

data/README.md

@@ -51,7 +51,7 @@ unsafe mutation diagnostics for schema-specific parser gems such as
 
 ### Compatibility
 
-Compatible with MRI Ruby 4.0.0+, and concordant releases of JRuby, and TruffleRuby.
+Compatible with MRI Ruby 4.0.0+, JRuby, and TruffleRuby.
 CI workflows and Appraisals are generated for MRI Ruby 4.0.0+.
 This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
 may be higher than the gem's runtime compatibility floor when legacy Rubies are
@@ -119,20 +119,12 @@ See [SECURITY.md][🔐security].
 ## 🤝 Contributing
 
 If you need some ideas of where to help, you could work on adding more code coverage,
-or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues] or [PRs][🤝gh-pulls],
-or use the gem and think about how it could be better.
+check [issues][🤝gh-issues] or [PRs][🤝gh-pulls], or use the gem and think about how it could be better.
 
 We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
 
 See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
 
-### Code Coverage
-
-<details markdown="1">
-<summary>Coverage service badges</summary>
-
-</details>
-
 ## 📌 Versioning
 
 This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.

data/lib/binary/merge/provider.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module Binary
+  module Merge
+    # Safety-first provider for opaque binary documents.
+    # rubocop:disable Metrics/ClassLength, Metrics/MethodLength, Metrics/ParameterLists -- provider operations and envelopes form one cohesive boundary
+    class Provider
+      def provider_id = 'ruby.binary'
+      def family = 'binary'
+
+      def capabilities
+        {
+          operations: Ast::Merge::ProviderContract::OPERATIONS,
+          dialects: %i[binary],
+          backends: %i[raw_bytes],
+          profiles: %i[opaque_document],
+          role: :workflow,
+          source_preservation: %i[exact_source opaque_conflict_retains_ours]
+        }.freeze
+      end
+
+      def analyze(request)
+        source = request.fetch(:source)
+        result(:analyze, request, analysis: { bytesize: source.bytesize, binary: true })
+      end
+
+      def diff2(request)
+        before = request.fetch(:before_source)
+        after = request.fetch(:after_source)
+        changes = before == after ? [] : [classification(before, before, after)]
+        result(:diff2, request, changes: changes, diff: { changed: before != after })
+      end
+
+      def merge2(request)
+        current = request.fetch(:current_source)
+        incoming = request.fetch(:incoming_source)
+        rendered = render(request, :ours, current)
+        fallback = if current == incoming
+                     []
+                   else
+                     [{
+                       category: :opaque_binary_preserve_current,
+                       reason: 'Opaque binary documents cannot be combined safely without a format-specific provider.'
+                     }]
+                   end
+        result(
+          :merge2,
+          request,
+          output: rendered.content,
+          changes: current == incoming ? [] : [classification(current, current, incoming)],
+          fallbacks: fallback,
+          render_report: render_report(rendered, current == incoming ? :exact_revision : :preserve_current),
+          verification: exact_verification(rendered, current)
+        )
+      end
+
+      def merge3(request)
+        base = request.fetch(:base_source)
+        ours = request.fetch(:ours_source)
+        theirs = request.fetch(:theirs_source)
+        return exact_merge3(request, :ours, ours, base, ours, theirs) if ours == theirs || base == theirs
+        return exact_merge3(request, :theirs, theirs, base, ours, theirs) if base == ours
+
+        conflicted_merge3(request, base, ours, theirs)
+      end
+
+      private
+
+      def exact_merge3(request, role, output, base, ours, theirs)
+        rendered = render(request, role, output)
+        result(
+          :merge3,
+          request,
+          output: rendered.content,
+          changes: [classification(base, ours, theirs)],
+          render_report: render_report(rendered, :exact_revision),
+          verification: exact_verification(rendered, output).merge(base_participated: true)
+        )
+      end
+
+      def conflicted_merge3(request, base, ours, theirs)
+        rendered = render(request, :ours, ours)
+        conflict = {
+          conflict_id: 'binary-conflict-root',
+          category: :opaque_edit_edit,
+          path: '',
+          change_classification: classification(base, ours, theirs)
+        }
+        failure(
+          :merge3,
+          request,
+          category: :merge_conflict,
+          message: 'Opaque binary content changed independently on both sides; retaining ours without markers.',
+          changes: [conflict.fetch(:change_classification)],
+          conflicts: [conflict],
+          conflicted_output: rendered.content,
+          render_report: render_report(rendered, :opaque_conflict_retains_ours),
+          verification: { base_participated: true, ours_preserved_exactly: rendered.content == ours }
+        )
+      end
+
+      def classification(base, ours, theirs)
+        {
+          path: '',
+          ours: base == ours ? :unchanged : :edited,
+          theirs: base == theirs ? :unchanged : :edited
+        }.freeze
+      end
+
+      def render(request, role, source)
+        Ast::Merge::SourceRender::Renderer.new.render(
+          Ast::Merge::SourceRender::Plan.new(
+            sources: {
+              base: request[:base_source].to_s,
+              ours: (request[:ours_source] || request[:current_source]).to_s,
+              theirs: request[:theirs_source].to_s
+            },
+            fragments: [source_fragment(role, source)],
+            metadata: { provider_id: provider_id }
+          )
+        )
+      end
+
+      def source_fragment(role, source)
+        if source.empty?
+          return Ast::Merge::SourceRender::SynthesizedFragment.new(
+            content: '',
+            reason: :exact_empty_source,
+            producer: provider_id,
+            metadata: { source_role: role }
+          )
+        end
+
+        Ast::Merge::SourceRender::SourceFragment.new(
+          revision: role,
+          start_line: 1,
+          end_line: [source.lines.length, 1].max,
+          metadata: { source_role: role }
+        )
+      end
+
+      def render_report(rendered, strategy)
+        {
+          strategy: strategy,
+          line_records: rendered.line_records,
+          synthesized_fragments: rendered.synthesized_fragments,
+          conflicts: rendered.conflicts,
+          verification_input: rendered.verification_input
+        }
+      end
+
+      def exact_verification(rendered, source)
+        {
+          output_reparsed: true,
+          semantic_match: rendered.content == source,
+          bytes_preserved: rendered.content.b == source.b
+        }
+      end
+
+      def result(operation, request, changes: [], fallbacks: [], render_report: {}, verification: {}, **payload)
+        Ast::Merge::ProviderResult.build(
+          operation: operation,
+          success: true,
+          envelope: envelope(
+            request,
+            changes: changes,
+            fallbacks: fallbacks,
+            render_report: render_report,
+            verification: verification
+          ),
+          **payload
+        )
+      end
+
+      def failure(operation, request, category:, message:, changes: [], conflicts: [], render_report: {},
+                  verification: {}, **payload)
+        Ast::Merge::ProviderResult.build(
+          operation: operation,
+          success: false,
+          envelope: envelope(
+            request,
+            changes: changes,
+            conflicts: conflicts,
+            diagnostics: [{ category: category, severity: :error, message: message, blocking: true }],
+            render_report: render_report,
+            verification: verification
+          ),
+          **payload
+        )
+      end
+
+      def envelope(request, **fields)
+        {
+          provider: {
+            provider_id: provider_id,
+            family: family,
+            dialect: request[:dialect] || :binary,
+            backend: request[:backend],
+            package: Binary::Merge::PACKAGE_NAME,
+            package_version: Binary::Merge::Version::VERSION
+          },
+          profile: { profile_id: request[:profile_id] || :opaque_document }
+        }.merge(fields)
+      end
+    end
+    # rubocop:enable Metrics/ClassLength, Metrics/MethodLength, Metrics/ParameterLists
+  end
+end

data/lib/binary/merge/version.rb

@@ -5,7 +5,7 @@ module Binary
     # Version namespace for this gem.
     module Version
       # Current gem version.
-      VERSION = '7.1.1'
+      VERSION = '7.1.3'
     end
     # Current gem version exposed at the traditional constant location.
     VERSION = Version::VERSION # Traditional Constant Location

data/lib/binary/merge.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require 'tree_haver'
+require 'ast/merge'
 require_relative 'merge/version'
+require_relative 'merge/provider'
 
+# Binary preservation contracts and provider registration.
 module Binary
+  # Binary merge reports, diagnostics, and the opaque-document provider.
   module Merge
     PACKAGE_NAME = 'binary-merge'
 
@@ -49,5 +53,15 @@ module Binary
         diagnostics: []
       )
     end
+
+    def merge_provider
+      @merge_provider ||= Provider.new
+    end
+
+    def register_provider!
+      Ast::Merge.register_provider(merge_provider, replace: true)
+    end
   end
 end
+
+Binary::Merge.register_provider!

data/sig/binary/merge.rbs

@@ -1,5 +1,20 @@
 module Binary
   module Merge
+    PACKAGE_NAME: String
+
+    class Provider
+      def provider_id: () -> String
+      def family: () -> String
+      def capabilities: () -> Hash[Symbol, untyped]
+      def analyze: (Hash[Symbol, untyped] request) -> Hash[Symbol, untyped]
+      def diff2: (Hash[Symbol, untyped] request) -> Hash[Symbol, untyped]
+      def merge2: (Hash[Symbol, untyped] request) -> Hash[Symbol, untyped]
+      def merge3: (Hash[Symbol, untyped] request) -> Hash[Symbol, untyped]
+    end
+
+    def self.merge_provider: () -> Provider
+    def self.register_provider!: () -> Hash[Symbol, untyped]
+
     module Version
       VERSION: String
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binary-merge
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 7.1.3
 platform: ruby
 authors:
 - Peter H. Boling
@@ -37,20 +37,34 @@ cert_chain:
   -----END CERTIFICATE-----
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ast-merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.1.3
 - !ruby/object:Gem::Dependency
   name: tree_haver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.1
+        version: 7.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.1
+        version: 7.1.3
 - !ruby/object:Gem::Dependency
   name: version_gem
   requirement: !ruby/object:Gem::Requirement
@@ -77,20 +91,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.17
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.17
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +182,7 @@ dependencies:
         version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -178,7 +192,7 @@ dependencies:
         version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: kettle-test
   requirement: !ruby/object:Gem::Requirement
@@ -208,7 +222,7 @@ dependencies:
         version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.4
+        version: 3.2.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -218,7 +232,7 @@ dependencies:
         version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.4
+        version: 3.2.5
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -285,6 +299,7 @@ files:
 - README.md
 - lib/binary-merge.rb
 - lib/binary/merge.rb
+- lib/binary/merge/provider.rb
 - lib/binary/merge/version.rb
 - sig/binary/merge.rbs
 homepage: https://github.com/structuredmerge/structuredmerge-ruby
@@ -293,10 +308,10 @@ licenses:
 - PolyForm-Small-Business-1.0.0
 metadata:
   homepage_uri: https://structuredmerge.org
-  source_code_uri: https://github.com/structuredmerge/structuredmerge-ruby/tree/v7.1.1
-  changelog_uri: https://github.com/structuredmerge/structuredmerge-ruby/blob/v7.1.1/CHANGELOG.md
+  source_code_uri: https://github.com/structuredmerge/structuredmerge-ruby/tree/v7.1.3
+  changelog_uri: https://github.com/structuredmerge/structuredmerge-ruby/blob/v7.1.3/CHANGELOG.md
   bug_tracker_uri: https://github.com/structuredmerge/structuredmerge-ruby/issues
-  documentation_uri: https://www.rubydoc.info/gems/binary-merge/7.1.1
+  documentation_uri: https://www.rubydoc.info/gems/binary-merge/7.1.3
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/structuredmerge/structuredmerge-ruby/wiki
   news_uri: https://www.railsbling.com/tags/binary-merge