zip-merge 7.1.1 → 7.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a9683e713ef24a65e74b003579e4c54bf369859b740dcbd6f56ef788942e858
-  data.tar.gz: 13488970a1b826964bd9bc478c1e85c301e37f88c561127883f04a3bdf419662
+  metadata.gz: ab8707f72ab19bcb5d7fa6ac1dff9e120b6359913377a27a0068fa25c7811550
+  data.tar.gz: ec42f4edba8322a35f933367b172b414a18aaa32af0af976b962214122c6dfb4
 SHA512:
-  metadata.gz: 2d0d142fe3be5c9c838bbe288e5b5ffaeb3a94742bf9a66a1fc7bfc7e6739d903cf469a41786cdfc1a1f30ca7f20edda28877b14a6a78c6345a66aac6c5dc678
-  data.tar.gz: b114ba117f07c46042de4ff98048825e3390b6157ca5e0fa96b8106311bd3e2ee972c9a93c7cb85099d1b5b8fa13e33a350ac89bcda26da9a8ef01449e13a214
+  metadata.gz: eb36f6b3bfd9e0a1c338c33a9772a57f8bd16f7e90eca6b27c1c339c6a88ece6508f6528af4e5a74d801e21bb9c0b2f85275e4bf03665ec495109984798be7c6
+  data.tar.gz: 275ba874d435f03ab9619940f2d8add76aac49c1ae9cb29278955b00c11c19b40d78c12353ec3e3f1aa57acc71d22332693899abe524adbf0d6d67726315df08

data/README.md

@@ -56,7 +56,7 @@ renderer.
 
 ### 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
@@ -132,20 +132,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/zip/merge/provider.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Zip
+  module Merge
+    # Validates ZIP inputs while applying the safety-first opaque binary policy.
+    # rubocop:disable Metrics/MethodLength -- provider envelope is one public result contract
+    class Provider < Binary::Merge::Provider
+      PARSE_ERRORS = [RuntimeError, NoMethodError, TypeError, KeyError].freeze
+
+      def provider_id = 'ruby.zip'
+      def family = 'zip'
+
+      def capabilities
+        {
+          operations: Ast::Merge::ProviderContract::OPERATIONS,
+          dialects: %i[zip],
+          backends: [Zip::Merge::BACKEND_REFERENCE.id.to_sym],
+          profiles: %i[opaque_archive],
+          role: :workflow,
+          source_preservation: %i[exact_source opaque_conflict_retains_ours]
+        }.freeze
+      end
+
+      def analyze(request)
+        inventory = parse(request.fetch(:source), :source, :analyze, request)
+        return inventory if provider_result?(inventory)
+
+        result(:analyze, request, analysis: inventory)
+      end
+
+      def diff2(request)
+        failure = validate_sources(request, :diff2, before_source: :before, after_source: :after)
+        failure || super
+      end
+
+      def merge2(request)
+        failure = validate_sources(request, :merge2, current_source: :current, incoming_source: :incoming)
+        failure || super
+      end
+
+      def merge3(request)
+        failure = validate_sources(
+          request,
+          :merge3,
+          base_source: :base,
+          ours_source: :ours,
+          theirs_source: :theirs
+        )
+        failure || super
+      end
+
+      private
+
+      def validate_sources(request, operation, roles)
+        roles.each do |request_key, source_role|
+          parsed = parse(request.fetch(request_key), source_role, operation, request)
+          return parsed if provider_result?(parsed)
+        end
+        nil
+      end
+
+      def parse(source, source_role, operation, request)
+        Zip::Merge.parse_zip_inventory(source)
+      rescue *PARSE_ERRORS => e
+        failure(
+          operation,
+          request,
+          category: :parse_error,
+          message: "Invalid ZIP #{source_role} source: #{e.message}",
+          source_role: source_role
+        )
+      end
+
+      def provider_result?(value)
+        value.is_a?(Hash) && value[:schema] == Ast::Merge::ProviderContract::RESULT_SCHEMA
+      end
+
+      def envelope(request, **fields)
+        {
+          provider: {
+            provider_id: provider_id,
+            family: family,
+            dialect: request[:dialect] || :zip,
+            backend: request[:backend],
+            package: 'zip-merge',
+            package_version: Zip::Merge::Version::VERSION
+          },
+          profile: { profile_id: request[:profile_id] || :opaque_archive }
+        }.merge(fields)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end
+
+# Provider registration entry point.
+module Zip
+  # ZIP provider registration.
+  module Merge
+    module_function
+
+    def merge_provider
+      @merge_provider ||= Provider.new
+    end
+
+    def register_provider!
+      Ast::Merge.register_provider(merge_provider, replace: true)
+    end
+  end
+end

data/lib/zip/merge/version.rb

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

@@ -389,5 +389,7 @@ end
 
 require 'binary/merge'
 require_relative 'merge/backend'
+require_relative 'merge/provider'
 
 Zip::Merge.register_backend!
+Zip::Merge.register_provider!

data/sig/zip/merge.rbs

@@ -1,5 +1,18 @@
 module Zip
   module Merge
+    class Provider < Binary::Merge::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: zip-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/zip-merge.rb
 - lib/zip/merge.rb
 - lib/zip/merge/backend.rb
+- lib/zip/merge/provider.rb
 - lib/zip/merge/version.rb
 - sig/zip/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/zip-merge/7.1.1
+  documentation_uri: https://www.rubydoc.info/gems/zip-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/zip-merge