git 5.6.1 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8ec4da3066f7c301611783c89f0a127f6c8ad4e7cf2467db9fe9071b7e0f943
-  data.tar.gz: 10fc3f33082886e7ca47e1ea97bd50075ffb15afbb91e1b309d9a12168a590ac
+  metadata.gz: 7c23ed7b58cd8f2297c9291b8a0e1686f294abe6c82bbf8673c3651b65cc635d
+  data.tar.gz: dd17a339711522080bdb94827173ce404cc918a434f829c26b73d416bd90e742
 SHA512:
-  metadata.gz: 91e896c14c04e2135468d70031721cfbb29ba873284160f208315025bacc331a0fefaa04c837467d33b284253a04267ee8f4c003ea564770d619f9365ecb1b73
-  data.tar.gz: 03c6e84729ce4a4e6809cf53b92a6bcfb48572f1b8724e83cc451e829d1357b93da286e8fd6c669ddce3aa946cb0890237008992b9230e8cf41991e291fb8f76
+  metadata.gz: 027eb2ff2a491e56a5d9f42a6b6758fa8b54465c0b0c8f990071aa0d84cdae40f489428353bd777f4638f73958e74fe8f9b62254cb50d1f4ba01ccef17039ac2
+  data.tar.gz: a69634e5053eb693c08869740abc71ce69cab965a366593040107b158b64bb83ad42521aedc952ce069031ea1ced7de5a58d127cf091651f479632b057301485

data/CHANGELOG.md

@@ -5,6 +5,13 @@
 
 # Change Log
 
+## [5.7.0](https://github.com/ruby-git/ruby-git/compare/v5.6.1...v5.7.0) (2026-10-28)
+
+
+### Features
+
+* **repository:** Deprecate the eight renamed facade aliases with warnings that name v6.0.0 ([8339117](https://github.com/ruby-git/ruby-git/commit/8339117e9fff5a1acadea73b4ccd385a5b0f1497)), closes [#1923](https://github.com/ruby-git/ruby-git/issues/1923) [#1924](https://github.com/ruby-git/ruby-git/issues/1924)
+
 ## [5.6.1](https://github.com/ruby-git/ruby-git/compare/v5.6.0...v5.6.1) (2026-09-16)
 
 

data/UPGRADING.md

@@ -17,6 +17,7 @@ to update your code when upgrading from the preceding major version.
   - [Deprecated methods](#deprecated-methods)
     - [Facade method renames](#facade-method-renames)
     - [`Git::Repository` method renames](#gitrepository-method-renames)
+    - [`Git::Repository` alias renames](#gitrepository-alias-renames)
     - [`Git::Repository` option renames](#gitrepository-option-renames)
     - [v4.x-style configuration methods](#v4x-style-configuration-methods)
     - [`Git` module mixin deprecations](#git-module-mixin-deprecations)
@@ -395,6 +396,28 @@ replacement returns, except `branches_all`.
 | `g.is_branch?(name)` | `g.branch?(name)` |
 | `g.branches_all` | `g.branch_list` — returns `Array<Git::BranchInfo>`; see the return shape change above |
 
+#### `Git::Repository` alias renames
+
+Eight `Git::Repository` methods have a second, older name carried over from v4.x.
+Earlier v5.x releases kept the older names as aliases with no warning. Later
+v5.x releases emit a deprecation warning for each one. Each old name takes the
+same arguments and returns exactly what its replacement returns.
+
+> **`diff_name_status`:** a `:path` option emits its own deprecation warning
+> after the method-name warning. Pass `:path_limiter` instead, as described
+> under "`Git::Repository` option renames" below.
+
+| Deprecated call (works in v5.x, removed in v6.0.0) | Replacement |
+|-----------------------------------------------------|-------------|
+| `g.object_contents(object)` | `g.cat_file_contents(object)` |
+| `g.object_size(object)` | `g.cat_file_size(object)` |
+| `g.object_type(object)` | `g.cat_file_type(object)` |
+| `g.commit_data(object)` | `g.cat_file_commit(object)` |
+| `g.tag_data(object)` | `g.cat_file_tag(object)` |
+| `g.revparse(objectish)` | `g.rev_parse(objectish)` |
+| `g.namerev(commit_ish)` | `g.name_rev(commit_ish)` |
+| `g.diff_name_status(from, to, opts)` | `g.diff_path_status(from, to, opts)` |
+
 #### `Git::Repository` option renames
 
 Five methods accept a v4.x option or positional argument under its old name.

data/lib/git/diff_path_status.rb

@@ -77,7 +77,7 @@ module Git
     # @return [Hash{String => String}] a mapping of file paths to status codes
     #
     def fetch_path_status
-      @fetch_path_status ||= @base.diff_name_status(@from, @to, path_limiter: @path_limiter).to_h
+      @fetch_path_status ||= @base.diff_path_status(@from, @to, path_limiter: @path_limiter).to_h
     end
 
     # Sets up legacy (base, from, to, path_limiter) instance state

data/lib/git/repository/diffing.rb

@@ -373,14 +373,42 @@ module Git
         Git::DiffPathStatus.new(Private.extract_name_status_from_raw(result.stdout))
       end
 
-      # Alias for {#diff_path_status}; provided for backward compatibility
+      # Reports each changed path with its status (deprecated name for {#diff_path_status})
+      #
+      # @example Report path statuses between HEAD and the working tree
+      #   repo.diff_name_status.to_h #=> { "lib/foo.rb" => "M" }
+      #
+      # @param from [String, nil] the first commit or object to compare
+      #
+      # @param to [String, nil] the second commit or object to compare
+      #
+      # @param opts [Hash] the options accepted by {#diff_path_status}
+      #
+      # @option opts [String, Pathname, Array<String, Pathname>, nil] :path_limiter (nil)
+      #   limit the status report to the given path(s)
+      #
+      # @option opts [String, Pathname, Array<String, Pathname>, nil] :path (nil)
+      #   **deprecated** — use `:path_limiter` instead
       #
       # @return [Git::DiffPathStatus] the name-status report for the comparison
       #
-      # @deprecated Use {#diff_path_status} instead
+      # @raise [ArgumentError] if unsupported options are provided
+      #
+      # @raise [ArgumentError] if `from` is `nil` but `to` is not OR if `from` or `to` starts with `"-"`
+      #
+      # @raise [Git::FailedError] if git exits outside the allowed range (exit code > 2)
+      #
+      # @deprecated Use {#diff_path_status} instead. Will be removed in v6.0.0.
       #
       # @see #diff_path_status
-      alias diff_name_status diff_path_status
+      #
+      def diff_name_status(from = 'HEAD', to = nil, opts = {})
+        Git::Deprecation.warn(
+          'Git::Repository#diff_name_status is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#diff_path_status instead.'
+        )
+        diff_path_status(from, to, opts)
+      end
 
       # Compares the index and the working directory
       #

data/lib/git/repository/object_operations.rb

@@ -89,17 +89,57 @@ module Git
         end
       end
 
-      # Alias for {#cat_file_contents}; retained for backward compatibility
+      # Alias for {#cat_file_contents}; kept as a legacy name and not scheduled
+      # for removal
       #
       # @see #cat_file_contents
       alias cat_file cat_file_contents
 
-      # Alias for {#cat_file_contents}
+      # Returns the raw contents of a git object (deprecated name for {#cat_file_contents})
       #
-      # @deprecated Use {#cat_file_contents} instead
+      # @overload object_contents(object)
+      #   Returns the object's raw content as a string
+      #
+      #   @example Read a blob's contents
+      #     repo.object_contents('HEAD:README.md') #=> "# My Project\n"
+      #
+      #   @param object [String] the object name (SHA, ref, `HEAD`, treeish path, etc.)
+      #
+      #   @return [String] the raw content of the object
+      #
+      # @overload object_contents(object, &block)
+      #   Streams the object's raw content to a temporary file and yields it
+      #
+      #   @example Read a large blob without buffering it in memory
+      #     repo.object_contents('HEAD:large_file.bin') { |f| process(f) }
+      #
+      #   @param object [String] the object name (SHA, ref, `HEAD`, treeish path, etc.)
+      #
+      #   @yield [file] the temporary file containing the streamed content,
+      #     positioned at the start
+      #
+      #   @yieldparam file [File] readable `IO` object positioned at the beginning
+      #     of the content
+      #
+      #   @yieldreturn [Object] the value to return from this method
+      #
+      #   @return [Object] the value returned by the block
+      #
+      # @raise [ArgumentError] if `object` starts with a hyphen
+      #
+      # @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      # @deprecated Use {#cat_file_contents} instead. Will be removed in v6.0.0.
       #
       # @see #cat_file_contents
-      alias object_contents cat_file_contents
+      #
+      def object_contents(object, &)
+        Git::Deprecation.warn(
+          'Git::Repository#object_contents is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#cat_file_contents instead.'
+        )
+        cat_file_contents(object, &)
+      end
 
       # Returns the size of a git object in bytes
       #
@@ -125,12 +165,30 @@ module Git
         Git::Commands::CatFile::Raw.new(@execution_context).call(object, s: true).stdout.chomp.to_i
       end
 
-      # Alias for {#cat_file_size}
+      # Returns the size of a git object in bytes (deprecated name for {#cat_file_size})
+      #
+      # @example Get the size of a commit object
+      #   repo.object_size('HEAD') #=> 265
+      #
+      # @param object [String] the object name (SHA, ref, `HEAD`, treeish path, etc.)
+      #
+      # @return [Integer] the size of the object in bytes
+      #
+      # @raise [ArgumentError] if `object` starts with a hyphen
+      #
+      # @raise [Git::FailedError] if git exits with a non-zero exit status
       #
-      # @deprecated Use {#cat_file_size} instead
+      # @deprecated Use {#cat_file_size} instead. Will be removed in v6.0.0.
       #
       # @see #cat_file_size
-      alias object_size cat_file_size
+      #
+      def object_size(object)
+        Git::Deprecation.warn(
+          'Git::Repository#object_size is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#cat_file_size instead.'
+        )
+        cat_file_size(object)
+      end
 
       # Returns the type of a git object
       #
@@ -157,12 +215,30 @@ module Git
         Git::Commands::CatFile::Raw.new(@execution_context).call(object, t: true).stdout.chomp
       end
 
-      # Alias for {#cat_file_type}
+      # Returns the type of a git object (deprecated name for {#cat_file_type})
+      #
+      # @example Get the type of HEAD
+      #   repo.object_type('HEAD') #=> "commit"
+      #
+      # @param object [String] the object name (SHA, ref, `HEAD`, treeish path, etc.)
+      #
+      # @return [String] the object type: `"blob"`, `"tree"`, `"commit"`, or `"tag"`
+      #
+      # @raise [ArgumentError] if `object` starts with a hyphen
+      #
+      # @raise [Git::FailedError] if git exits with a non-zero exit status
       #
-      # @deprecated Use {#cat_file_type} instead
+      # @deprecated Use {#cat_file_type} instead. Will be removed in v6.0.0.
       #
       # @see #cat_file_type
-      alias object_type cat_file_type
+      #
+      def object_type(object)
+        Git::Deprecation.warn(
+          'Git::Repository#object_type is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#cat_file_type instead.'
+        )
+        cat_file_type(object)
+      end
 
       # Returns parsed commit data for the given git object
       #
@@ -200,12 +276,28 @@ module Git
         Git::Parsers::CatFile.parse_commit(result.stdout.split("\n"), object)
       end
 
-      # Alias for {#cat_file_commit}
+      # Returns parsed commit data for a git object (deprecated name for {#cat_file_commit})
+      #
+      # @example Get commit data for HEAD
+      #   repo.commit_data('HEAD')
+      #
+      # @param object [String] the commit name (SHA, ref, `HEAD`, etc.)
       #
-      # @deprecated Use {#cat_file_commit} instead
+      # @return [Hash] the parsed commit data; see {#cat_file_commit} for the keys
+      #
+      # @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      # @deprecated Use {#cat_file_commit} instead. Will be removed in v6.0.0.
       #
       # @see #cat_file_commit
-      alias commit_data cat_file_commit
+      #
+      def commit_data(object)
+        Git::Deprecation.warn(
+          'Git::Repository#commit_data is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#cat_file_commit instead.'
+        )
+        cat_file_commit(object)
+      end
 
       # Returns parsed tag data for the given annotated tag object
       #
@@ -256,12 +348,30 @@ module Git
         Git::Parsers::CatFile.parse_tag(tdata, object)
       end
 
-      # Alias for {#cat_file_tag}
+      # Returns parsed tag data for an annotated tag (deprecated name for {#cat_file_tag})
+      #
+      # @example Get tag data for an annotated tag
+      #   repo.tag_data('v1.0.0')
+      #
+      # @param object [String] the tag name or SHA of the annotated tag object
       #
-      # @deprecated Use {#cat_file_tag} instead
+      # @return [Hash] the parsed tag data; see {#cat_file_tag} for the keys
+      #
+      # @raise [ArgumentError] if `object` starts with a hyphen
+      #
+      # @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      # @deprecated Use {#cat_file_tag} instead. Will be removed in v6.0.0.
       #
       # @see #cat_file_tag
-      alias tag_data cat_file_tag
+      #
+      def tag_data(object)
+        Git::Deprecation.warn(
+          'Git::Repository#tag_data is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#cat_file_tag instead.'
+        )
+        cat_file_tag(object)
+      end
 
       # Resolve a revision specifier to its full object ID
       #
@@ -292,7 +402,29 @@ module Git
         Git::Commands::RevParse.new(@execution_context).call(objectish, '--', revs_only: true).stdout
       end
 
-      alias revparse rev_parse
+      # Resolves a revision specifier to its full object ID (deprecated name for {#rev_parse})
+      #
+      # @example Resolve HEAD to its SHA
+      #   repo.revparse('HEAD') #=> "9b9b31e704c0b85ffdd8d2af2ded85170a5af87d"
+      #
+      # @param objectish [String] the revision specifier to resolve (branch name,
+      #   tag, abbreviated SHA, refspec, etc.)
+      #
+      # @return [String] the full object ID of the resolved object
+      #
+      # @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      # @deprecated Use {#rev_parse} instead. Will be removed in v6.0.0.
+      #
+      # @see #rev_parse
+      #
+      def revparse(objectish)
+        Git::Deprecation.warn(
+          'Git::Repository#revparse is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#rev_parse instead.'
+        )
+        rev_parse(objectish)
+      end
 
       # Returns the SHA of a named tag
       #
@@ -395,12 +527,30 @@ module Git
         Git::Commands::NameRev.new(@execution_context).call(commit_ish).stdout.split[1]
       end
 
-      # Alias for {#name_rev}
+      # Finds a symbolic name for a commit (deprecated name for {#name_rev})
+      #
+      # @example Name the current commit
+      #   repo.namerev('HEAD') #=> "main"
+      #
+      # @param commit_ish [String] the commit to name (SHA, ref, `HEAD`, etc.)
+      #
+      # @return [String, nil] the symbolic name, or `nil` if git finds none
+      #
+      # @raise [ArgumentError] if commit_ish starts with a hyphen
       #
-      # @deprecated Use {#name_rev} instead
+      # @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      # @deprecated Use {#name_rev} instead. Will be removed in v6.0.0.
       #
       # @see #name_rev
-      alias namerev name_rev
+      #
+      def namerev(commit_ish)
+        Git::Deprecation.warn(
+          'Git::Repository#namerev is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#name_rev instead.'
+        )
+        name_rev(commit_ish)
+      end
 
       # Option keys accepted by {#ls_tree}
       LS_TREE_ALLOWED_OPTS = %i[recursive path].freeze

data/lib/git/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 5.6.1
+  version: 5.7.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.6.1/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/5.6.1
+  changelog_uri: https://rubydoc.info/gems/git/5.7.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/5.7.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: