ruby-merge 7.1.1 → 7.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98b5dba95c151b6d6a08ae403679f78af429360fcd4b2a1e0c5ba023cfc5639e
-  data.tar.gz: cb85a47f7e47fbb0af358f69f8ce0503b790967f76aa04a0ad99282711cede45
+  metadata.gz: aa7e44e52e059397107051f945efaceb307742e3e40c36f61bf900ac06dd84e6
+  data.tar.gz: 1bb04482ae836481586da92f9266f0e03781d351b5ac25eb7eaf7fd83ad4f649
 SHA512:
-  metadata.gz: 830b7a910c65e024d2d160150c8efe01e0f2b1a9e789fde40b072d4bb45e0ffb60f1a6643f7d07c392661c8736af207da7a994651a35328660c478787316edcd
-  data.tar.gz: 48538e4ce4cb76543058e5a14fe94c8bc4bc3ed03f75d195c5e4d713d6e478d1e0ac4ffbf4307218a22f87918cc06ba647f4fc8037422d5fcb6a3aa89457f29a
+  metadata.gz: 1828b958a01c2017de25ef21616c5a650cf3483b20804e93c54f9158a40c8eac146bdd6cde14118fae50b2fc6e85b439072a5bce5596cadb0ee2248213fab509
+  data.tar.gz: 12f7bb144511bc0d9ff4ba0f42241666ce394f416e1e2444fd329930aae8444ce158cbee7a950a5ddccb93398816b466083ab2f40d7faf032825fdb4a934e713

data/README.md

@@ -46,7 +46,7 @@ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-ta
 
 ### 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
@@ -122,20 +122,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/ruby/merge/provider.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Ruby
+  # Portable Ruby workflow integration.
+  module Merge
+    # Ruby workflow selector delegating source-preserving operations to Prism.
+    class Provider
+      BACKEND = :prism
+      DELEGATED_PROVIDER_ID = 'ruby.ruby.prism'
+      DEFAULT_PROFILE = :source_preserving
+
+      def provider_id = 'ruby.ruby'
+      def family = 'ruby'
+
+      def capabilities
+        {
+          operations: Ast::Merge::ProviderContract::OPERATIONS,
+          dialects: %i[ruby],
+          backends: [BACKEND],
+          profiles: [DEFAULT_PROFILE],
+          role: :workflow,
+          source_preservation: Prism::Merge.merge_provider.capabilities.fetch(:source_preservation)
+        }.freeze
+      end
+
+      Ast::Merge::ProviderContract::OPERATIONS.each do |operation|
+        define_method(operation) do |request|
+          delegated = Ast::Merge.dispatch_provider(operation, delegated_request(request))
+          delegated.merge(provider: workflow_identity(request, delegated))
+        end
+      end
+
+      private
+
+      def delegated_request(request)
+        request.merge(
+          provider_id: DELEGATED_PROVIDER_ID,
+          family: :ruby,
+          dialect: :ruby,
+          backend: BACKEND,
+          profile_id: DEFAULT_PROFILE
+        )
+      end
+
+      def workflow_identity(request, delegated)
+        {
+          provider_id: provider_id,
+          family: family,
+          dialect: request[:dialect] || :ruby,
+          backend: request[:backend] || BACKEND,
+          package: PACKAGE_NAME,
+          package_version: Ruby::Merge::Version::VERSION,
+          delegated_provider: delegated_identity(delegated.fetch(:provider))
+        }
+      end
+
+      def delegated_identity(identity)
+        {
+          provider_id: identity.fetch(:provider_id),
+          backend: identity.fetch(:backend),
+          package: identity[:package],
+          package_version: identity[:package_version]
+        }.compact
+      end
+    end
+
+    class << self
+      def merge_provider
+        @merge_provider ||= Provider.new
+      end
+
+      def register_provider!(replace: false)
+        Ast::Merge.register_provider(merge_provider, replace: replace)
+      end
+    end
+  end
+end

data/lib/ruby/merge/version.rb

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

@@ -1,20 +1,10 @@
 # frozen_string_literal: true
 
 require 'digest'
+require 'prism/merge'
 require 'tree_haver'
 require 'ast/merge'
 require_relative 'merge/version'
-require_relative 'merge/block_directive_detector'
-require_relative 'merge/block_binding_support'
-require_relative 'merge/doc_comment_support'
-require_relative 'merge/gemspec_support'
-require_relative 'merge/magic_comment_support'
-require_relative 'merge/method_similarity'
-require_relative 'merge/nocov_node_base'
-require_relative 'merge/nocov_wrapper_base'
-require_relative 'merge/rescue_semantics'
-require_relative 'merge/scaffold_chunk_support'
-require_relative 'merge/signature_support'
 
 module Ruby
   module Merge
@@ -3143,6 +3133,8 @@ module Ruby
 end
 
 Ruby::Merge.register_backend!
+require_relative 'merge/provider'
+Ruby::Merge.register_provider!
 
 TreeHaver::BackendRegistry.register_tag(
   :tslp_ruby_import_records,

data/sig/ruby/merge.rbs

@@ -1,5 +1,18 @@
 module Ruby
   module Merge
+    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!: (?replace: bool) -> untyped
+
     module Version
       VERSION: String
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-merge
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 7.1.3
 platform: ruby
 authors:
 - Peter H. Boling
@@ -43,28 +43,42 @@ 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: prism-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
@@ -91,20 +105,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 +196,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 +206,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 +236,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 +246,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
@@ -298,17 +312,7 @@ files:
 - README.md
 - lib/ruby-merge.rb
 - lib/ruby/merge.rb
-- lib/ruby/merge/block_binding_support.rb
-- lib/ruby/merge/block_directive_detector.rb
-- lib/ruby/merge/doc_comment_support.rb
-- lib/ruby/merge/gemspec_support.rb
-- lib/ruby/merge/magic_comment_support.rb
-- lib/ruby/merge/method_similarity.rb
-- lib/ruby/merge/nocov_node_base.rb
-- lib/ruby/merge/nocov_wrapper_base.rb
-- lib/ruby/merge/rescue_semantics.rb
-- lib/ruby/merge/scaffold_chunk_support.rb
-- lib/ruby/merge/signature_support.rb
+- lib/ruby/merge/provider.rb
 - lib/ruby/merge/version.rb
 - sig/ruby/merge.rbs
 homepage: https://github.com/structuredmerge/structuredmerge-ruby
@@ -317,10 +321,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/ruby-merge/7.1.1
+  documentation_uri: https://www.rubydoc.info/gems/ruby-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/ruby-merge

data/lib/ruby/merge/block_binding_support.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Ruby
-  module Merge
-    # Parser-neutral naming policy for a block-local receiver.
-    module BlockBindingSupport
-      module_function
-
-      def effective_receiver(receiver, block_var, placeholder: :__block_binding__)
-        block_var && receiver == block_var ? placeholder : receiver
-      end
-
-      def preferred_block_var(template_var, destination_var)
-        template_var if template_var && destination_var && template_var != destination_var
-      end
-
-      def merged_block_var(var, preferred_var)
-        preferred_var || var
-      end
-    end
-  end
-end

data/lib/ruby/merge/block_directive_detector.rb

@@ -1,208 +0,0 @@
-# frozen_string_literal: true
-
-module Ruby
-  module Merge
-    # Detects Ruby comment block directive pairs in source lines.
-    #
-    # This is Ruby-specific substrate behavior shared by Ruby parser providers.
-    # Parser-specific gems may consume the spans and project them into their own
-    # node types, but directive token semantics should live here.
-    class BlockDirectiveDetector
-      Span = Struct.new(:kind, :start_line, :end_line, :open_marker, :close_marker, keyword_init: true)
-
-      NOCOV_TOKEN = ':nocov:'
-      SIMPLECOV_DISABLE_RE = /\A\s*#\s*simplecov\s*:\s*disable\b/i
-      SIMPLECOV_ENABLE_RE = /\A\s*#\s*simplecov\s*:\s*enable\b/i
-      DIRECTIVE_CONTENT_RE = /\A(?::nocov:|[\w-]+:(?:freeze|unfreeze))\z/i
-
-      class << self
-        def coverage_directive_line?(line, nocov_token: NOCOV_TOKEN)
-          stripped = line.to_s.chomp
-          stripped.match?(simplecov_disable_re) ||
-            stripped.match?(simplecov_enable_re) ||
-            stripped.match?(nocov_re(nocov_token))
-        end
-
-        def directive_content?(content)
-          DIRECTIVE_CONTENT_RE.match?(content.to_s.strip) ||
-            coverage_directive_line?("# #{content}")
-        end
-
-        def simplecov_disable_re
-          SIMPLECOV_DISABLE_RE
-        end
-
-        def simplecov_enable_re
-          SIMPLECOV_ENABLE_RE
-        end
-
-        def nocov_re(nocov_token = NOCOV_TOKEN)
-          /\A\s*#\s?#{Regexp.escape(nocov_token)}\s*\z/i
-        end
-      end
-
-      def initialize(lines, freeze_token: nil, nocov_token: NOCOV_TOKEN, source_label: nil)
-        @lines = lines
-        @freeze_token = freeze_token
-        @nocov_token = nocov_token
-        @source_label = source_label
-      end
-
-      def detect_spans
-        raw_spans = []
-        raw_spans.concat(detect_freeze_spans) if @freeze_token
-        raw_spans.concat(detect_nocov_spans)
-
-        validate_no_crossing(raw_spans.sort_by(&:start_line))
-      end
-
-      private
-
-      def detector_name
-        'ruby-merge'
-      end
-
-      def directive_error_class
-        Ast::Merge::Error
-      end
-
-      def warn_prefix
-        if @source_label
-          "[#{detector_name}] BlockDirectiveDetector (#{@source_label}):"
-        else
-          "[#{detector_name}] BlockDirectiveDetector:"
-        end
-      end
-
-      def report_unbalanced(message)
-        raise directive_error_class, "#{warn_prefix} #{message}" if @source_label
-
-        warn("#{warn_prefix} #{message} - ignoring")
-      end
-
-      def detect_freeze_spans
-        freeze_pat = /\A\s*#\s?#{Regexp.escape(@freeze_token)}:freeze\b/i
-        unfreeze_pat = /\A\s*#\s?#{Regexp.escape(@freeze_token)}:unfreeze\b/i
-
-        spans = []
-        stack = []
-
-        @lines.each_with_index do |line, index|
-          line_num = index + 1
-          stripped = line.to_s.chomp
-          if stripped.match?(freeze_pat)
-            stack.push({ start_line: line_num, open_marker: stripped })
-          elsif stripped.match?(unfreeze_pat)
-            if (open = stack.pop)
-              spans << Span.new(
-                kind: :freeze,
-                start_line: open[:start_line],
-                end_line: line_num,
-                open_marker: open[:open_marker],
-                close_marker: stripped
-              )
-            else
-              report_unbalanced("unmatched #{@freeze_token}:unfreeze at line #{line_num}")
-            end
-          end
-        end
-
-        stack.each do |open|
-          report_unbalanced("unclosed #{@freeze_token}:freeze at line #{open[:start_line]}")
-        end
-
-        spans
-      end
-
-      def detect_nocov_spans
-        return [] unless @nocov_token
-
-        nocov_pat = self.class.nocov_re(@nocov_token)
-
-        spans = []
-        stack = []
-
-        @lines.each_with_index do |line, index|
-          line_num = index + 1
-          stripped = line.to_s.chomp
-          if stripped.match?(self.class.simplecov_disable_re)
-            stack.push({ start_line: line_num, open_marker: stripped })
-          elsif stripped.match?(self.class.simplecov_enable_re)
-            if (open = stack.pop)
-              spans << Span.new(
-                kind: :nocov,
-                start_line: open[:start_line],
-                end_line: line_num,
-                open_marker: open[:open_marker],
-                close_marker: stripped
-              )
-            else
-              report_unbalanced("unmatched simplecov:enable at line #{line_num}")
-            end
-          elsif stripped.match?(nocov_pat)
-            if stack.empty?
-              stack.push({ start_line: line_num, open_marker: stripped })
-            else
-              open = stack.pop
-              spans << Span.new(
-                kind: :nocov,
-                start_line: open[:start_line],
-                end_line: line_num,
-                open_marker: open[:open_marker],
-                close_marker: stripped
-              )
-            end
-          end
-        end
-
-        stack.each do |open|
-          report_unbalanced("unclosed coverage directive at line #{open[:start_line]}")
-        end
-
-        spans
-      end
-
-      def validate_no_crossing(spans)
-        valid = []
-        invalid_indices = Set.new
-
-        spans.each_with_index do |first, first_index|
-          next if invalid_indices.include?(first_index)
-
-          crossing = false
-          spans.each_with_index do |second, second_index|
-            next if first_index == second_index || invalid_indices.include?(second_index)
-            next unless crossing_spans?(first, second)
-
-            report_unbalanced("offset-overlapping #{first.kind} block " \
-              "(lines #{first.start_line}..#{first.end_line}) and #{second.kind} block " \
-              "(lines #{second.start_line}..#{second.end_line}) - both treated as plain comments")
-            invalid_indices.add(first_index)
-            invalid_indices.add(second_index)
-            crossing = true
-            break
-          end
-
-          valid << first unless crossing
-        end
-
-        valid
-      end
-
-      def crossing_spans?(first, second)
-        (first.start_line < second.start_line && first.end_line > second.start_line && first.end_line < second.end_line) ||
-          (second.start_line < first.start_line && second.end_line > first.start_line && second.end_line < first.end_line)
-      end
-
-      def top_level_spans_only(spans)
-        spans.reject do |span|
-          spans.any? do |other|
-            other != span &&
-              other.start_line <= span.start_line &&
-              other.end_line >= span.end_line
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ruby/merge/doc_comment_support.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-module Ruby
-  module Merge
-    # Ruby-specific doc-comment semantics shared by Ruby parser providers.
-    module DocCommentSupport
-      TAG_PREFIX = /\A@[a-z_]+\b/
-      EXAMPLE_TAG = /\A@example\b(?<rest>.*)\z/
-      MAGIC_COMMENT_PREFIXES = %w[
-        coding
-        encoding
-        frozen_string_literal
-        shareable_constant_value
-        typed
-        warn_indent
-      ].freeze
-
-      module_function
-
-      def normalize_comment_content(raw)
-        raw.to_s.sub(/\A\s*#\s?/, '').strip
-      end
-
-      def comment_prefix_for(raw)
-        raw.to_s[/\A\s*#\s*/] || '# '
-      end
-
-      def doc_comment_content?(raw, magic_comment: false)
-        content = normalize_comment_content(raw)
-        return false if content.empty?
-        return false if BlockDirectiveDetector.directive_content?(content)
-        return false if magic_comment || magic_comment_content?(content)
-
-        true
-      end
-
-      def magic_comment_content?(content)
-        MAGIC_COMMENT_PREFIXES.any? { |prefix| content.to_s.start_with?("#{prefix}:") }
-      end
-
-      def declared_example_language(rest)
-        match = rest.to_s.strip.match(/\A\[(?<language>[^\]]+)\]/)
-        normalize_language(match && match[:language])
-      end
-
-      def declared_example_language_for_tag(content)
-        match = EXAMPLE_TAG.match(content.to_s)
-        return unless match
-
-        declared_example_language(match[:rest])
-      end
-
-      def normalize_language(language)
-        return if language.nil?
-
-        normalized = language.to_s.strip.downcase.tr('-', '_')
-        return if normalized.empty?
-
-        normalized
-      end
-
-      def next_tag_index(normalized_lines, start_index)
-        normalized_lines.each_with_index do |content, index|
-          next if index < start_index
-
-          return index if TAG_PREFIX.match?(content)
-        end
-        nil
-      end
-
-      def example_blocks(entries)
-        normalized = entries.map { |entry| normalize_comment_content(entry[:raw]) }
-        normalized.each_with_index.filter_map do |content, tag_index|
-          match = EXAMPLE_TAG.match(content)
-          next unless match
-
-          body_start_index = tag_index + 1
-          body_end_index = next_tag_index(normalized, body_start_index) || normalized.length
-          next if body_start_index >= body_end_index
-
-          body_entries = entries[body_start_index...body_end_index]
-          next if body_entries.nil? || body_entries.empty?
-
-          {
-            tag_index: tag_index,
-            tag_line: entries[tag_index][:line],
-            tag_text: normalized[tag_index],
-            body_start_index: body_start_index,
-            body_end_index: body_end_index,
-            body_entries: body_entries,
-            declared_language: declared_example_language(match[:rest])
-          }
-        end
-      end
-    end
-  end
-end