git 5.5.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a27bcb58894e06dd36f368c545d7800e95b2106122d222f98e43e4776117d38
-  data.tar.gz: a59267db8db5a09e843914400be509c574670d824882b8c7a0c80f3e38945238
+  metadata.gz: fb847c9e15258e66f25f6856a2ceb170213e9ae310d061035ef23501e6e0cd72
+  data.tar.gz: eca3a73ec5bf9f979d4576375062ceaeb71a78b54f12660b3b4386c2920792e9
 SHA512:
-  metadata.gz: c60016fdfb41208d18ab63e36fb24a26c5a4cbc73978d44bab657ffb4ee8395d9c774311a752ae91e474b36d3b11d9eafb0c5ce1f54d8202068057d50b6c1093
-  data.tar.gz: 24656d7407eeea1ae1f92a8748eee1e65cdba4bafb9409ca0a96a819cfe7e3e2be4d9838fa3369464ccf908d5a7313de884a2e11c750f23664d88fcaa157f3dd
+  metadata.gz: 3842eadabba8c7bead2147b438ca51597ca0acc129b7d33b41f942750d29cb7e5910b1ca92e3f50cf7bc440afb9f5ed203a97f38b72c19b09025f4e7317849f2
+  data.tar.gz: 558adf7d3f23639b9143dcf3b9092739caba6415e066a8273f491f0589f3af06851dc15fd1776b2bad3e406d01429da76cce72c7e05f3c7ac57858bc3a771645

data/CHANGELOG.md

@@ -5,6 +5,18 @@
 
 # Change Log
 
+## [5.6.0](https://github.com/ruby-git/ruby-git/compare/v5.5.0...v5.6.0) (2026-09-12)
+
+
+### Features
+
+* **repository:** Deprecate with_* context helper blocks that declare no parameter ([231b65c](https://github.com/ruby-git/ruby-git/commit/231b65c435e9b3d9cdbf8b113b3aba9313da5110)), closes [#1835](https://github.com/ruby-git/ruby-git/issues/1835)
+
+
+### Other Changes
+
+* **export:** Describe what a failed .git removal leaves behind ([bd08096](https://github.com/ruby-git/ruby-git/commit/bd080964e44a11594202726e3823a8cafad62bd5)), closes [#1823](https://github.com/ruby-git/ruby-git/issues/1823)
+
 ## [5.5.0](https://github.com/ruby-git/ruby-git/compare/v5.4.1...v5.5.0) (2026-09-10)
 
 

data/UPGRADING.md

@@ -35,6 +35,7 @@ to update your code when upgrading from the preceding major version.
     - [`Git::Log` Enumerable interface deprecated](#gitlog-enumerable-interface-deprecated)
     - [`Git::Object::Commit#set_commit` deprecated](#gitobjectcommitset_commit-deprecated)
     - [`Git.export` `:remote` option deprecated](#gitexport-remote-option-deprecated)
+    - [Context helper blocks that declare no parameter deprecated](#context-helper-blocks-that-declare-no-parameter-deprecated)
 
 ## Upgrading to v6.0.0
 
@@ -1135,4 +1136,40 @@ observable in the result. Delete the option from the call.
 |--------------------------------------------------------------------|-------------|
 | `Git.export(url, dir, remote: name)` | `Git.export(url, dir)` |
 
+#### Context helper blocks that declare no parameter deprecated
+
+`Git::Repository#with_index`, `#with_temp_index`, `#with_working`, and
+`#with_temp_working` yield `self` in v5.x, so a block could ignore the yielded
+value and call methods on the receiver. Calling one of these helpers with a block
+that declares no positional parameter (`do ... end`, `{ }`, `{ || }`, or a block
+with only keyword or block parameters) now emits a deprecation warning. The
+behavior is otherwise unchanged: the helpers still yield `self`, and a call with
+no block still raises `LocalJumpError`.
+
+In v6.0.0 these helpers yield a separate repository bound to the other index or
+working tree instead of rebinding the receiver, and they raise `ArgumentError` for
+a block that declares no positional parameter. A call with no block also raises
+`ArgumentError` in v6.0.0 instead of `LocalJumpError`. Declare a block parameter
+and call methods on it. The parameter is required even when the block never uses
+the repository, for example a `with_temp_working` block that only writes files
+(`do |_scratch|`). Blocks that already declare a positional parameter (`|repo|`,
+`|_|`, `|repo = nil|`, `|*args|`, or a symbol-to-proc such as `&:write_tree`) do
+not warn. Both versions read the block's parameter list rather than its arity, so
+the v5.x warning and the v6.0.0 error agree on every block form.
+
+The warning detects only the block's parameter list. Adding an unused parameter
+(`|_|`) silences it but does not fix a block that still calls methods on the outer
+repository; that block does not warn and acts on the wrong repository in v6.0.0,
+so review those blocks by hand.
+
+| Deprecated call (works in v5.x, raises in v6.0.0) | Replacement |
+|---------------------------------------------------|-------------|
+| `g.with_index(path) { g.read_tree('HEAD') }` | `g.with_index(path) { \|r\| r.read_tree('HEAD') }` |
+| `g.with_temp_index { g.read_tree('HEAD') }` | `g.with_temp_index { \|r\| r.read_tree('HEAD') }` |
+| `g.with_working(dir) { g.add('.') }` | `g.with_working(dir) { \|r\| r.add('.') }` |
+| `g.with_temp_working { g.add('.') }` | `g.with_temp_working { \|r\| r.add('.') }` |
+
+`chdir` is not part of this deprecation. It yields the directory path in both
+versions.
+
 ---

data/lib/git/repository/context_helpers.rb

@@ -18,6 +18,10 @@ module Git
     # @api private
     #
     module ContextHelpers
+      # Parameter types from `Proc#parameters` that receive a positional argument
+      CONTEXT_HELPERS_POSITIONAL_PARAMETERS = %i[req opt rest].freeze
+      private_constant :CONTEXT_HELPERS_POSITIONAL_PARAMETERS
+
       # Changes the current working directory to the repository working directory
       # for the duration of the block
       #
@@ -51,9 +55,13 @@ module Git
       # yields `self`, then unconditionally restores the original execution
       # context — even if the block raises an exception.
       #
+      # Deprecated form: a block that declares no positional parameter emits a
+      # deprecation warning, because v6.0.0 yields a separate repository
+      # instead of `self`.
+      #
       # @example Read a tree into a custom index
-      #   repo.with_index('/tmp/custom.index') do
-      #     repo.read_tree('HEAD')
+      #   repo.with_index('/tmp/custom.index') do |r|
+      #     r.read_tree('HEAD')
       #   end
       #
       # @param new_index [String, Pathname] path to the replacement index file
@@ -66,7 +74,8 @@ module Git
       #
       # @yieldreturn [Object] returned as the method's return value
       #
-      def with_index(new_index) # :yields: self
+      def with_index(new_index, &block) # :yields: self
+        context_helpers_warn_if_block_declares_no_parameter(:with_index, block)
         old_context = @execution_context
         set_index(new_index, must_exist: false)
         yield self
@@ -84,10 +93,14 @@ module Git
       # are removed unconditionally after the block exits, even if the block
       # raises an exception.
       #
+      # Deprecated form: a block that declares no positional parameter emits a
+      # deprecation warning, because v6.0.0 yields a separate repository
+      # instead of `self`.
+      #
       # @example Stage changes using a temporary index
-      #   repo.with_temp_index do
-      #     repo.read_tree('HEAD')
-      #     repo.write_tree
+      #   repo.with_temp_index do |r|
+      #     r.read_tree('HEAD')
+      #     r.write_tree
       #   end
       #
       # @return [Object] the value returned by the block
@@ -98,13 +111,17 @@ module Git
       #
       # @yieldreturn [Object] returned as the method's return value
       #
-      def with_temp_index(&) # :yields: self
+      def with_temp_index(&block) # :yields: self
+        context_helpers_warn_if_block_declares_no_parameter(:with_temp_index, block)
         # Use a unique temp directory so the index file path is collision-free
         # and does not exist until git writes it. An existing empty file would
         # be treated as a corrupt index by git.
         temp_dir = Dir.mktmpdir('git-temp-index-')
         begin
-          with_index(File.join(temp_dir, 'index'), &)
+          # The inner block declares a parameter so with_index does not warn a
+          # second time under its own name; forwarding &block would.
+          # rubocop:disable-next Style/ExplicitBlockArgument
+          with_index(File.join(temp_dir, 'index')) { |repo| yield repo }
         ensure
           FileUtils.remove_entry(temp_dir, true)
         end
@@ -118,10 +135,14 @@ module Git
       # `self`, then unconditionally restores the original execution context —
       # even if the block raises an exception.
       #
+      # Deprecated form: a block that declares no positional parameter emits a
+      # deprecation warning, because v6.0.0 yields a separate repository
+      # instead of `self`.
+      #
       # @example Commit changes from a different worktree path
-      #   repo.with_working('/path/to/worktree') do
-      #     repo.add('.')
-      #     repo.commit('chore: automated update')
+      #   repo.with_working('/path/to/worktree') do |r|
+      #     r.add('.')
+      #     r.commit('chore: automated update')
       #   end
       #
       # @param work_dir [String, Pathname] path to the replacement working
@@ -138,7 +159,8 @@ module Git
       #
       # @yieldreturn [Object] returned as the method's return value
       #
-      def with_working(work_dir) # :yields: self
+      def with_working(work_dir, &block) # :yields: self
+        context_helpers_warn_if_block_declares_no_parameter(:with_working, block)
         old_context = @execution_context
         set_working(work_dir)
         Dir.chdir(dir.to_s) { yield self }
@@ -153,9 +175,14 @@ module Git
       # The temporary directory is removed unconditionally after the block
       # exits, even if the block raises an exception.
       #
+      # Deprecated form: a block that declares no positional parameter emits a
+      # deprecation warning, because v6.0.0 yields a separate repository
+      # instead of `self`.
+      #
       # @example Write files in an isolated temporary working directory
-      #   repo.with_temp_working do
+      #   repo.with_temp_working do |r|
       #     File.write('scratch.txt', 'temporary content')
+      #     r.add('scratch.txt')
       #   end
       #
       # @return [Object] the value returned by the block
@@ -168,7 +195,11 @@ module Git
       # @yieldreturn [Object] returned as the method's return value
       #
       def with_temp_working(&block) # :yields: self
-        Dir.mktmpdir('temp-workdir') { |temp_dir| with_working(temp_dir, &block) }
+        context_helpers_warn_if_block_declares_no_parameter(:with_temp_working, block)
+        # The inner block declares a parameter so with_working does not warn a
+        # second time under its own name; forwarding &block would.
+        # rubocop:disable-next Style/ExplicitBlockArgument
+        Dir.mktmpdir('temp-workdir') { |temp_dir| with_working(temp_dir) { |repo| yield repo } }
       end
 
       # Sets the git index to `index_file` and rebuilds the execution context
@@ -231,6 +262,42 @@ module Git
 
       private
 
+      # Emits a deprecation warning when `block` declares no positional parameter
+      #
+      # In v6.0.0 the `with_*` helpers yield a separate repository instead of
+      # rebinding the receiver, so a block that calls methods on the receiver
+      # (the v5.x form) acts on the wrong repository there. v6.0.0 raises
+      # `ArgumentError` for that form using this same rule: the block must
+      # declare a required, optional, or splat positional parameter. The rule
+      # reads `Proc#parameters` rather than arity because an optional parameter
+      # gives a proc an arity of zero although it receives the repository,
+      # while keyword and block parameters cannot receive it.
+      #
+      # A missing block is not checked here; the helper's `yield` raises
+      # `LocalJumpError` as before.
+      #
+      # The warning reports the helper's caller, not this helper's caller, so
+      # the location points at the block that needs changing.
+      #
+      # @param helper [Symbol] the public helper name used in the warning
+      #
+      # @param block [Proc, nil] the block passed to the helper
+      #
+      # @return [void]
+      #
+      def context_helpers_warn_if_block_declares_no_parameter(helper, block)
+        return if block.nil?
+        return if block.parameters.any? { |type, _name| CONTEXT_HELPERS_POSITIONAL_PARAMETERS.include?(type) }
+
+        Git::Deprecation.warn(
+          "Calling Git::Repository##{helper} with a block that declares no positional " \
+          'parameter is deprecated and will be removed in v6.0.0, where the helper ' \
+          'yields a separate repository instead of self. Declare a block parameter and ' \
+          "call methods on it instead: #{helper} { |repo| repo.some_method }",
+          caller_locations(2)
+        )
+      end
+
       # Resolves deprecated `check` argument semantics with `must_exist:`
       #
       # @param check [Boolean, nil] deprecated positional existence-check value

data/lib/git/version.rb

@@ -4,7 +4,7 @@ module Git
   # The current gem version
   #
   # @return [String] the current gem version
-  VERSION = '5.5.0'
+  VERSION = '5.6.0'
 
   # Represents a git version with major, minor, and patch components
   #

data/lib/git.rb

@@ -327,6 +327,11 @@ module Git
   # Exports the current HEAD (or the specific branch given in <tt>options[:branch]</tt>)
   # into the given `directory`. It then removes all traces of git from the directory.
   #
+  # Removing `.git` is not atomic. If it fails, the exported files are complete and
+  # usable, but the directory keeps whatever part of `.git` could not be deleted.
+  # Nothing is cleaned up, because the exported files are the deliverable and the
+  # leftover has to be removed by hand once the cause of the failure is fixed.
+  #
   # Takes the same options as {Git.clone} except that `:depth` defaults to 1 and
   # `:remote` is ignored with a deprecation warning.
   #
@@ -348,6 +353,10 @@ module Git
   #
   # @return [void]
   #
+  # @raise [SystemCallError] if the `.git` directory cannot be removed. The exported
+  #   files are left in place, and the directory keeps whatever part of `.git` could
+  #   not be deleted.
+  #
   def self.export(repository_url, directory = nil, options = {})
     if options.key?(:remote)
       Git::Deprecation.warn(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Scott Chacon and others
@@ -548,8 +548,8 @@ licenses:
 metadata:
   homepage_uri: http://github.com/ruby-git/ruby-git
   source_code_uri: http://github.com/ruby-git/ruby-git
-  changelog_uri: https://rubydoc.info/gems/git/5.5.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/5.5.0
+  changelog_uri: https://rubydoc.info/gems/git/5.6.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/5.6.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: