plain-merge 7.1.1 → 7.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5da79765d212fbd8c3734697f1bf0879be015dfee2c126b2784356b75badf72f
-  data.tar.gz: '0218ac56ff565a835d03b85cd48095a463ac415eabb1ffcf9a88ca2600fba806'
+  metadata.gz: eb21dc58d45117871ad2b96d9adaff4775cfdc8e5267e5742a3cf71d09b1ea2c
+  data.tar.gz: 896051c7f24220265b0086912e9d91f77ab28e94914720b1b4e795016029d981
 SHA512:
-  metadata.gz: 84e346b9c77e9c93eb93e38a10d0e38bf2fee19efcab787f261f321f7efecf67f2cb918f46a75bcf060ee5e5cb3ac1027476c442397fd988b61696f725e68df7
-  data.tar.gz: 426d63fd97bbc694cd05b8c3e9a2264389a9b8516db32377ea946569616adb3b95409621b995d371ae84a94fb39b2658393420d316ba2b5f26ef87161e5cee73
+  metadata.gz: bb3a96716022df3e9ce9ed6a63638a1c913ec0de744bc74b3c70625a2774a57cac56d17fd9fb766be3528512fa5eed7082f0640561b083718155c722b420eb05
+  data.tar.gz: a06b47194805436a93962350698b6f898a9f66cab476fb8929c2c7eedef2a6d1b0d3b4da3142f3cb25bc8424159041fd54fbceddcaf3c410343753e80c0a9fdf

data/README.md

@@ -51,7 +51,7 @@ callers can enter plain text analysis through
 
 ### 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
@@ -118,20 +118,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/plain/merge/provider.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module Plain
+  module Merge
+    # Coarse whole-document provider for unstructured plain text.
+    # rubocop:disable Metrics/ClassLength, Metrics/MethodLength, Metrics/ParameterLists -- provider operations and envelopes form one cohesive boundary
+    class Provider
+      def provider_id = 'ruby.text'
+      def family = 'text'
+
+      def capabilities
+        {
+          operations: Ast::Merge::ProviderContract::OPERATIONS,
+          dialects: %i[text],
+          backends: [Plain::Merge::BACKEND_REFERENCE.id.to_sym],
+          profiles: %i[coarse_document],
+          role: :workflow,
+          source_preservation: %i[exact_source whole_document_conflict]
+        }.freeze
+      end
+
+      def analyze(request)
+        result(:analyze, request, analysis: Plain::Merge.analyze_text(request.fetch(:source)))
+      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: { before: before, after: after, changes: changes })
+      end
+
+      def merge2(request)
+        merged = Plain::Merge.merge_text(request.fetch(:incoming_source), request.fetch(:current_source))
+        result(
+          :merge2,
+          request,
+          output: merged.fetch(:output),
+          render_report: { strategy: :normalized_block_merge },
+          verification: { output_rendered: true }
+        )
+      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, [source_fragment(role, output)])
+        result(
+          :merge3,
+          request,
+          output: rendered.content,
+          changes: [classification(base, ours, theirs)],
+          render_report: render_report(rendered, :exact_revision),
+          verification: { base_participated: true, output_reparsed: true, semantic_match: rendered.content == output }
+        )
+      end
+
+      def conflicted_merge3(request, base, ours, theirs)
+        conflict = {
+          conflict_id: 'text-conflict-root',
+          category: :edit_edit,
+          path: '',
+          change_classification: classification(base, ours, theirs)
+        }
+        rendered = render(
+          request,
+          [
+            Ast::Merge::SourceRender::ConflictFragment.new(
+              conflict_id: conflict.fetch(:conflict_id),
+              base: [conflict_side(:base, base)],
+              ours: [conflict_side(:ours, ours)],
+              theirs: [conflict_side(:theirs, theirs)],
+              labels: request.fetch(:labels, {}),
+              marker_size: request.fetch(:conflict_marker_size, 7),
+              metadata: { path: '', category: :edit_edit }
+            )
+          ]
+        )
+        failure(
+          :merge3,
+          request,
+          category: :merge_conflict,
+          message: 'Plain text changed independently on both sides.',
+          changes: [conflict.fetch(:change_classification)],
+          conflicts: [conflict],
+          conflicted_output: rendered.content,
+          render_report: render_report(rendered, :whole_document_conflict),
+          verification: { base_participated: true }
+        )
+      end
+
+      def classification(base, ours, theirs)
+        {
+          path: '',
+          ours: base == ours ? :unchanged : :edited,
+          theirs: base == theirs ? :unchanged : :edited
+        }.freeze
+      end
+
+      def render(request, fragments)
+        Ast::Merge::SourceRender::Renderer.new.render(
+          Ast::Merge::SourceRender::Plan.new(
+            sources: {
+              base: request[:base_source].to_s,
+              ours: request[:ours_source].to_s,
+              theirs: request[:theirs_source].to_s
+            },
+            fragments: fragments,
+            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 conflict_side(role, source)
+        return source_fragment(role, source) if !source.empty? && source.end_with?("\n")
+
+        Ast::Merge::SourceRender::SynthesizedFragment.new(
+          content: source.empty? ? '' : "#{source}\n",
+          reason: :conflict_line_boundary,
+          producer: provider_id,
+          metadata: { source_role: role, copied_source: true }
+        )
+      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 result(operation, request, changes: [], render_report: {}, verification: {}, **payload)
+        Ast::Merge::ProviderResult.build(
+          operation: operation,
+          success: true,
+          envelope: envelope(request, changes: changes, 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] || :text,
+            backend: request[:backend],
+            package: Plain::Merge::PACKAGE_NAME,
+            package_version: Plain::Merge::Version::VERSION
+          },
+          profile: { profile_id: request[:profile_id] || :coarse_document }
+        }.merge(fields)
+      end
+    end
+    # rubocop:enable Metrics/ClassLength, Metrics/MethodLength, Metrics/ParameterLists
+  end
+end

data/lib/plain/merge/version.rb

@@ -5,7 +5,7 @@ module Plain
     # 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/plain/merge.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'ast/merge'
 require 'tree_haver'
 require_relative 'merge/version'
 
@@ -13,6 +14,8 @@ module Plain
       position: 0.15
     }.freeze
 
+    autoload :Provider, 'plain/merge/provider'
+
     module_function
 
     def text_feature_profile
@@ -23,6 +26,14 @@ module Plain
       }
     end
 
+    def merge_provider
+      @merge_provider ||= Provider.new
+    end
+
+    def register_provider!(replace: false)
+      Ast::Merge.register_provider(merge_provider, replace: replace)
+    end
+
     def text_parse_request(source)
       TreeHaver::ParserRequest.new(source: source, language: 'text')
     end
@@ -263,3 +274,4 @@ end
 
 require_relative 'merge/backend'
 Plain::Merge.register_backend!
+Plain::Merge.register_provider!

data/sig/plain/merge.rbs

@@ -1,5 +1,18 @@
 module Plain
   module Merge
+    class Provider
+      def provider_id: () -> String
+      def family: () -> String
+      def capabilities: () -> Ast::Merge::provider_capabilities
+      def analyze: (Ast::Merge::provider_request request) -> Ast::Merge::provider_result
+      def diff2: (Ast::Merge::provider_request request) -> Ast::Merge::provider_result
+      def merge2: (Ast::Merge::provider_request request) -> Ast::Merge::provider_result
+      def merge3: (Ast::Merge::provider_request request) -> Ast::Merge::provider_result
+    end
+
+    def self.merge_provider: () -> Provider
+    def self.register_provider!: (?replace: bool) -> Ast::Merge::_MergeProvider
+
     module Version
       VERSION: String
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plain-merge
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 7.1.3
 platform: ruby
 authors:
 - Peter H. Boling
@@ -43,28 +43,28 @@ dependencies:
     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: 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
@@ -91,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
@@ -182,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
@@ -192,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
@@ -222,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
@@ -232,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
@@ -300,6 +300,7 @@ files:
 - lib/plain-merge.rb
 - lib/plain/merge.rb
 - lib/plain/merge/backend.rb
+- lib/plain/merge/provider.rb
 - lib/plain/merge/version.rb
 - sig/plain/merge.rbs
 homepage: https://github.com/structuredmerge/structuredmerge-ruby
@@ -308,10 +309,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/plain-merge/7.1.1
+  documentation_uri: https://www.rubydoc.info/gems/plain-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/plain-merge