git 5.0.0.beta.2 → 5.0.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30866d1c683ae76cdb07eb526d9adecd45c8ec08bb53824c3a027984297ec256
-  data.tar.gz: a326ea01ed821d33c4edc60963cd2f6473ecaae2cad0daa82c06747456daa8dc
+  metadata.gz: '085739aa78a2d5bfacbf1f2048fb15997b8021ea40fda26715e9a66f7d2d8178'
+  data.tar.gz: f83f025bc403549cb4f4f889f2ed83ee2af9afdc2947a535345970c47ffa87b5
 SHA512:
-  metadata.gz: a0f4cc725c36422a2afa046897d89bef4597fe8120215f83b22c9814d8c1817d4b795525c2aa4edd2c8d52bf617e36bba3b181d5a67af9067a5a6b859bbd6707
-  data.tar.gz: 15957da7f84ef75aa7ad78d6eb7eac4d96aab21b56c265749c5def8a7cb035b5fdce651a395a98ce30fccab3d62c5e66f479fae621d16227c1eb1468c4372f5c
+  metadata.gz: 2769eab52af46ddc54bfea220b51f5b450e6f3e9999288f3b7d2003940dc4bf428a3b682c34ed41b36294d297ecda67abb48fa680063c396afbd1e45cbd71b75
+  data.tar.gz: 81aaa29f87a49c7cf1573e3fc1bbc32e9eb9883952c7550b69f983b73ebf33264f700d0465bb1ac390390083b8becdaefe80faebe3200adcd4d815c895cad57e

data/README.md

@@ -30,6 +30,7 @@ Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?log
   - [Ruby Version Support Policy](#ruby-version-support-policy)
   - [Git Version Support Policy](#git-version-support-policy)
 - [📢 Project Announcements 📢](#-project-announcements-)
+  - [2026-06-26: v5.0.0.beta.3 Released](#2026-06-26-v500beta3-released)
   - [2026-06-25: v5.0.0.beta.2 Released](#2026-06-25-v500beta2-released)
   - [2026-06-04: v5.0.0.beta.1 Released](#2026-06-04-v500beta1-released)
   - [2026-01-07: AI Policy Introduced](#2026-01-07-ai-policy-introduced)
@@ -134,15 +135,17 @@ Configure the `git` command line:
 
 ```ruby
 # Global config (in ~/.gitconfig)
-settings = Git.global_config # returns a Hash
-username = Git.global_config('user.email')
-Git.global_config('user.email', 'user@example.com')
+entries = Git.config_list(global: true)         # returns Array<Git::ConfigEntryInfo>
+entry   = Git.config_get('user.email', global: true) # returns Git::ConfigEntryInfo or nil
+email    = entry&.value                          # => "user@example.com" or nil
+Git.config_set('user.email', 'user@example.com', global: true)
 
 # Repository config
 repo = Git.open('path/to/repo')
-settings = repo.config # returns a Hash
-username = repo.config('user.email')
-repo.config('user.email', 'anotheruser@example.com')
+entries  = repo.config_list                     # returns Array<Git::ConfigEntryInfo>
+entry    = repo.config_get('user.email')        # returns Git::ConfigEntryInfo or nil
+email    = entry&.value                         # => "anotheruser@example.com" or nil
+repo.config_set('user.email', 'anotheruser@example.com')
 ```
 
 Configure the git gem:
@@ -293,8 +296,8 @@ result = repo.fsck(unreachable: true, strict: true)
 # Suppress dangling object output
 result = repo.fsck(dangling: false)
 
-repo.config('user.name')  # returns 'Scott Chacon'
-repo.config # returns whole config hash
+repo.config_get('user.name')&.value  # returns 'Scott Chacon'
+repo.config_list                     # returns Array<Git::ConfigEntryInfo>
 
 # Configuration can be set when cloning using the :config option.
 # This option can be an single configuration String or an Array
@@ -343,8 +346,8 @@ path = '/tmp/clone'
 repo = Git.clone(git_url, name, :path => path)
 repo.dir #=> /tmp/clone/ruby-git-clean
 
-repo.config('user.name', 'Scott Chacon')
-repo.config('user.email', 'email@email.com')
+repo.config_set('user.name', 'Scott Chacon')
+repo.config_set('user.email', 'email@email.com')
 
 # Clone can take a filter to tell the serve to send a partial clone
 repo = Git.clone(git_url, name, :path => path, :filter => 'tree:0')
@@ -371,7 +374,7 @@ repo.commit('message')
 repo.commit_all('message')
 
 # Sign a commit using the gpg key configured in the user.signingkey config setting
-repo.config('user.signingkey', '0A46826A')
+repo.config_set('user.signingkey', '0A46826A')
 repo.commit('message', gpg_sign: true)
 
 # Sign a commit using a specified gpg key
@@ -651,6 +654,31 @@ notes.
 
 ## 📢 Project Announcements 📢
 
+### 2026-06-26: v5.0.0.beta.3 Released
+
+The architectural redesign is approximately **93% complete** and we have published
+[`git v5.0.0.beta.3`](https://rubygems.org/gems/git/versions/5.0.0.beta.3) as our
+third pre-release.
+
+**To try the beta**, add the pre-release version to your `Gemfile`:
+
+```ruby
+gem 'git', '~> 5.0.0.beta'
+```
+
+Or install it directly:
+
+```sh
+gem install git --pre
+```
+
+The intent is full backward compatibility with v4.x, but given the size and scope of
+the redesign, some incompatibilities may exist. Please give the latest beta a try and
+[open an issue](https://github.com/ruby-git/ruby-git/issues) if you hit anything
+unexpected — your feedback helps us ship a solid v5.0.0.
+
+See [UPGRADING.md](UPGRADING.md) for a full list of deprecations and breaking changes.
+
 ### 2026-06-25: v5.0.0.beta.2 Released
 
 The architectural redesign is approximately **90% complete** and we have published

data/lib/git/repository.rb

@@ -9,7 +9,6 @@ require 'git/execution_context/repository'
 require 'git/repository/branching'
 require 'git/repository/context_helpers'
 require 'git/repository/committing'
-require 'git/repository/configuring'
 require 'git/repository/diffing'
 require 'git/repository/factories'
 require 'git/repository/inspecting'
@@ -18,6 +17,7 @@ require 'git/repository/maintenance'
 require 'git/repository/merging'
 require 'git/repository/object_operations'
 require 'git/repository/remote_operations'
+require 'git/repository/shared_private'
 require 'git/repository/staging'
 require 'git/repository/stashing'
 require 'git/repository/status_operations'
@@ -48,14 +48,13 @@ module Git
   #
   # @api public
   #
-  class Repository
+  class Repository # rubocop:disable Metrics/ClassLength
     extend Git::Repository::Factories
 
     include Git::Configuring
     include Git::Repository::Branching
     include Git::Repository::ContextHelpers
     include Git::Repository::Committing
-    include Git::Repository::Configuring
     include Git::Repository::Diffing
     include Git::Repository::Inspecting
     include Git::Repository::Logging
@@ -68,6 +67,23 @@ module Git
     include Git::Repository::StatusOperations
     include Git::Repository::WorktreeOperations
 
+    CONFIG_SET_ALLOWED_OPTS = %i[file].freeze
+    private_constant :CONFIG_SET_ALLOWED_OPTS
+
+    CONFIG_READ_ALLOWED_OPTS = %i[file].freeze
+    private_constant :CONFIG_READ_ALLOWED_OPTS
+
+    CONFIG_DEPRECATION_WARNING =
+      'Git::Repository#config is deprecated and will be removed in v6.0.0. ' \
+      'Use config_get(name), config_set(name, value), or config_list instead.'
+    private_constant :CONFIG_DEPRECATION_WARNING
+
+    GLOBAL_CONFIG_DEPRECATION_WARNING =
+      'Git::Repository#global_config is deprecated and will be removed in v6.0.0. ' \
+      'Use config_get(name, global: true), config_set(name, value, global: true), ' \
+      'or config_list(global: true) instead.'
+    private_constant :GLOBAL_CONFIG_DEPRECATION_WARNING
+
     # @return [Git::ExecutionContext::Repository] the execution context used to run
     #   git commands for this repository
     # @api private
@@ -168,6 +184,154 @@ module Git
     # @api private
     def binary_path = execution_context.binary_path
 
+    # Read or write a git configuration entry
+    #
+    # Dispatches to one of three modes depending on the arguments supplied:
+    #
+    # * **List** — `config()` returns all visible config entries as a `Hash`.
+    # * **Get** — `config(name)` returns the value for a single key as a `String`.
+    # * **Set** — `config(name, value)` writes a value and returns the raw
+    #   command result.
+    #
+    # @overload config(options = {})
+    #
+    #   @example List all config entries
+    #     repo.config #=> { "user.name" => "Alice", "core.bare" => "false" }
+    #
+    #   @example List all entries from a custom config file
+    #     repo.config(file: '/path/to/.gitconfig')
+    #     #=> { "user.name" => "Alice", "core.bare" => "false" }
+    #
+    #   @param options [Hash] options for the list operation
+    #
+    #   @option options [String, nil] :file (nil) path to a custom config file
+    #     to read from instead of the default resolution chain
+    #
+    #   @return [Hash{String => String}] all visible config entries, keyed by
+    #     their full dotted key names (e.g. `"user.name"`)
+    #
+    #   @raise [ArgumentError] if unsupported options are provided
+    #
+    # @overload config(name, options = {})
+    #
+    #   @example Read the committer name from config
+    #     repo.config('user.name') #=> "Alice"
+    #
+    #   @example Read a value from a custom config file
+    #     repo.config('user.name', file: '/path/to/.gitconfig') #=> "Alice"
+    #
+    #   @param name [String] the dotted config key to look up (e.g.
+    #     `"user.name"`)
+    #
+    #   @param options [Hash] options for the get operation
+    #
+    #   @option options [String, nil] :file (nil) path to a custom config file
+    #     to read from instead of the default resolution chain
+    #
+    #   @return [String] the value of the config entry
+    #
+    #   @raise [ArgumentError] if unsupported options are provided
+    #
+    # @overload config(name, value, options = {})
+    #
+    #   @example Set the committer name in local config
+    #     repo.config('user.name', 'Alice')
+    #
+    #   @example Write a value to a custom config file
+    #     repo.config('user.name', 'Alice', file: '/path/to/custom/config')
+    #
+    #   @param name [String] the dotted config key to write (e.g.
+    #     `"user.name"`)
+    #
+    #   @param value [#to_s] the value to assign; must not be `nil` (a `nil`
+    #     value is treated as "no value" and routes to the get overload).
+    #     Must not be a `Hash` (a Hash is treated as the `options` argument;
+    #     call `value.to_s` explicitly before passing if a stringified Hash
+    #     is genuinely needed). Any other non-nil object is converted to a
+    #     String via `#to_s` before being passed to git
+    #
+    #   @param options [Hash] options for the set operation
+    #
+    #   @option options [String, nil] :file (nil) path to a custom config file
+    #     to write to instead of the repository's default `.git/config`
+    #
+    #   @return [Git::CommandLineResult] the raw result of
+    #     `git config <name> <value>`
+    #
+    #   @raise [ArgumentError] if unsupported options are provided
+    #
+    # @raise [Git::FailedError] if git exits with a non-zero exit status
+    #
+    def config(name = nil, value = nil, options = {})
+      Git::Deprecation.warn(CONFIG_DEPRECATION_WARNING)
+      name, value, options = deprecated_normalize_config_args(name, value, options)
+
+      if !name.nil? && !value.nil?
+        deprecated_config_set(name, value, **options)
+      elsif name
+        deprecated_config_get(name, **options)
+      else
+        deprecated_config_list(**options)
+      end
+    end
+
+    # Read or write a global git configuration entry
+    #
+    # Dispatches to one of three modes depending on the arguments supplied,
+    # targeting the git global config scope (`git config --global`):
+    #
+    # * **List** — `global_config()` returns all global config entries as a `Hash`.
+    # * **Get** — `global_config(name)` returns the value for a single key as a `String`.
+    # * **Set** — `global_config(name, value)` writes a value and returns the raw
+    #   command result.
+    #
+    # @overload global_config
+    #
+    #   @example List all global config entries
+    #     repo.global_config #=> { "user.name" => "Alice", "core.autocrlf" => "false" }
+    #
+    #   @return [Hash{String => String}] all global config entries, keyed by their
+    #     full dotted key names (e.g. `"user.name"`)
+    #
+    #   @raise [Git::FailedError] if git exits with a non-zero exit status
+    #
+    # @overload global_config(name)
+    #
+    #   @example Read the global committer name
+    #     repo.global_config('user.name') #=> "Alice"
+    #
+    #   @param name [String] the dotted config key to look up (e.g. `"user.name"`)
+    #
+    #   @return [String] the value of the global config entry
+    #
+    #   @raise [Git::FailedError] if git exits with a non-zero exit status
+    #
+    # @overload global_config(name, value)
+    #
+    #   @example Set the global committer name
+    #     repo.global_config('user.name', 'Alice')
+    #
+    #   @param name [String] the dotted config key to write (e.g. `"user.name"`)
+    #
+    #   @param value [#to_s] the value to assign; any object is accepted and
+    #     converted to a String via `#to_s` before being passed to git
+    #
+    #   @return [Git::CommandLineResult] the raw result of
+    #     `git config --global <name> <value>`
+    #
+    #   @raise [Git::FailedError] if git exits with a non-zero exit status
+    #
+    def global_config(name = nil, value = nil)
+      Git::Deprecation.warn(GLOBAL_CONFIG_DEPRECATION_WARNING)
+      if !name.nil? && !value.nil?
+        deprecated_global_config_set(name, value)
+      elsif !name.nil?
+        deprecated_global_config_get(name)
+      else
+        deprecated_global_config_list
+      end
+    end
+
     # Returns the size of the repository directory in bytes
     #
     # Sums the sizes of every regular file under the repository (`.git`)
@@ -197,6 +361,63 @@ module Git
 
     private
 
+    def deprecated_normalize_config_args(name, value, options)
+      if name.is_a?(Hash)
+        raise ArgumentError, 'unexpected positional arguments after options hash' if !value.nil? || !options.empty?
+
+        [nil, nil, name]
+      elsif value.is_a?(Hash)
+        raise ArgumentError, 'unexpected third argument when second argument is options hash' unless options.empty?
+
+        [name, nil, value]
+      else
+        [name, value, options]
+      end
+    end
+
+    def deprecated_config_set(name, value, **)
+      SharedPrivate.assert_valid_opts!(CONFIG_SET_ALLOWED_OPTS, **)
+      Git::Commands::ConfigOptionSyntax::Set.new(@execution_context).call(name, value, **)
+    end
+
+    def deprecated_config_get(name, **options)
+      SharedPrivate.assert_valid_opts!(CONFIG_READ_ALLOWED_OPTS, **options)
+      opts = options[:file] ? { file: options[:file] } : {}
+      result = Git::Commands::ConfigOptionSyntax::Get.new(@execution_context).call(name, **opts)
+      raise Git::FailedError, result if result.status.exitstatus != 0
+
+      result.stdout
+    end
+
+    def deprecated_config_list(**options)
+      SharedPrivate.assert_valid_opts!(CONFIG_READ_ALLOWED_OPTS, **options)
+      opts = options[:file] ? { file: options[:file] } : {}
+      lines = Git::Commands::ConfigOptionSyntax::List.new(@execution_context).call(**opts).stdout.split("\n")
+      lines.each_with_object({}) do |line, hsh|
+        key, value = line.split('=', 2)
+        hsh[key] = value || ''
+      end
+    end
+
+    def deprecated_global_config_get(name)
+      result = Git::Commands::ConfigOptionSyntax::Get.new(@execution_context).call(name, global: true)
+      raise Git::FailedError, result if result.status.exitstatus != 0
+
+      result.stdout
+    end
+
+    def deprecated_global_config_list
+      lines = Git::Commands::ConfigOptionSyntax::List.new(@execution_context).call(global: true).stdout.split("\n")
+      lines.each_with_object({}) do |line, hsh|
+        key, value = line.split('=', 2)
+        hsh[key] = value || ''
+      end
+    end
+
+    def deprecated_global_config_set(name, value)
+      Git::Commands::ConfigOptionSyntax::Set.new(@execution_context).call(name, value, global: true)
+    end
+
     # All git config scopes are valid in a repository context
     #
     # @return [void]

data/lib/git/status.rb

@@ -172,17 +172,15 @@ module Git
 
     # Return `true` when git is configured to ignore filename case
     #
-    # Reads `core.ignoreCase` from the repository config. Returns `false` if
-    # the config value is absent or if reading it raises {Git::FailedError}.
+    # Reads `core.ignoreCase` with {Git::Repository#config_get}. Returns `false`
+    # when the config value is absent.
     #
     # @return [Boolean] `true` when `core.ignoreCase` is `"true"`
     #
     def ignore_case?
-      return @_ignore_case if defined?(@_ignore_case)
+      return @ignore_case if defined?(@ignore_case)
 
-      @_ignore_case = (@base.config('core.ignoreCase') == 'true')
-    rescue Git::FailedError
-      @_ignore_case = false
+      @ignore_case = (@base.config_get('core.ignoreCase')&.value == 'true')
     end
   end
 end

data/lib/git/version.rb

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

data/lib/git.rb

@@ -75,11 +75,11 @@ module Git
   extend Git::Configuring
 
   # @deprecated Mixing in the `Git` module is deprecated and will be removed in v6.0.0.
-  #   Use `Git.open(Dir.pwd).config(...)` instead.
+  #   Use `Git.config_get(name)`, `Git.config_set(name, value)`, or `Git.config_list` instead.
   def config(name = nil, value = nil)
     Git::Deprecation.warn(
       'Git#config is deprecated and will be removed in v6.0.0. ' \
-      'Use Git.open(Dir.pwd).config(...) instead.'
+      'Use Git.config_get(name), Git.config_set(name, value), or Git.config_list instead.'
     )
     Git.__send__(:run_config_utility, name, value, global: false)
   end
@@ -114,11 +114,13 @@ module Git
   end
 
   # @deprecated Mixing in the `Git` module is deprecated and will be removed in v6.0.0.
-  #   Use `Git.global_config(...)` instead.
+  #   Use `Git.config_get(name, global: true)`, `Git.config_set(name, value, global: true)`, or
+  #   `Git.config_list(global: true)` instead.
   def global_config(name = nil, value = nil)
     Git::Deprecation.warn(
       'Git#global_config is deprecated and will be removed in v6.0.0. ' \
-      'Use Git.global_config(...) instead.'
+      'Use Git.config_get(name, global: true), Git.config_set(name, value, global: true), ' \
+      'or Git.config_list(global: true) instead.'
     )
     Git.global_config(name, value)
   end

data/redesign/3_architecture_implementation.md

@@ -44,8 +44,8 @@ risk and allows for a gradual, controlled migration to the new architecture.
 | Phase 1 | ✅ Complete | Foundation and scaffolding | 5% | 100% |
 | Phase 2 | ✅ Complete | Migrating commands (all checklist items done) | 40% | 100% |
 | Phase 3 | ✅ Complete | Refactoring public interface — see [Facade Modules Completed](#facade-modules-completed) and [Facade coverage checklist](#facade-coverage-checklist) | 45% | 100% |
-| Phase 4 | 🔲 Not Started | Final cleanup and release | 10% | 0% |
-| **TOTAL** | -- | -- | **100%** | **90%** |
+| Phase 4 | 🚧 In Progress | Final cleanup and release — Step A complete; Steps B and C remain | 10% | 33% |
+| **TOTAL** | -- | -- | **100%** | **93%** |
 
 ### Facade Modules Completed
 
@@ -85,20 +85,32 @@ such as `Branch`, `Diff`, `Log`, `Object`, `Remote`, `Status`, `Worktree`, etc.
 
 ### Next Task
 
-#### D2 / Phase 4 is the remaining redesign step
+#### Phase 4 Step B (finalize test suite) is the next step
 
-F1 and F2 are both ✅ complete. All Phase 4 prerequisites are now satisfied, and
-the remaining unchecked redesign item is D2.
+Phase 4 **Step A — Remove old code** is ✅ complete. The atomic removal landed in
+[PR #1456](https://github.com/ruby-git/ruby-git/pull/1456) (commit `c1c53999`),
+which deleted `Git::Base` and `Git::Lib`, removed the `base_object` / `from_base`
+bridge from `Git::ExecutionContext::Repository`, and dropped the legacy `require`
+lines from `lib/git.rb`. This also satisfies the long-standing **D2** redesign
+item. The only remaining `Git::Base` / `Git::Lib` strings in `lib/` are YARD/comment
+references to historical 4.x behavior, which the Step A done-criteria explicitly
+allow.
 
-Phase 4 (final cleanup and release — deleting `Git::Base`/`Git::Lib`) can now begin.
-The first cleanup PR should remove the `base_object` / `from_base` bridge in the
-same releasable change that deletes or retires `Git::Base`.
-The following are also required and are already ✅ complete:
+The remaining redesign work is the rest of Phase 4:
+
+| Step | Status | Summary |
+| ---- | ------ | ------- |
+| A — Remove old code | ✅ Complete | `Git::Base`/`Git::Lib` and the bridge deleted ([PR #1456](https://github.com/ruby-git/ruby-git/pull/1456)) |
+| B — Finalize test suite | 🔲 Not Started | Port remaining Test::Unit coverage in `tests/units/` to RSpec, drop the `test-unit` dependency from `git.gemspec`, remove the `test`/`test-all` Rake tasks, and remove the `tests/` directory |
+| C — Update documentation | 🚧 Partial | `UPGRADING.md` and broad `@api private` coverage exist; verify `yard stats` reports no missing public-API docs and that `README.md` reflects the new entry points |
+
+The following earlier prerequisites are all ✅ complete:
 
 | Step | Status |
 | ---- | ------ |
 | C1c-2: public-API parity audit and remediation sweep | ✅ |
 | E: block-based helper/path-context methods migrated | ✅ |
+| D2: remove the `base_object` / `from_base` bridge | ✅ |
 
 Steps C1d-1, C1d-2, and C1d-3 are ✅ complete (see their detail sections below for full specs).
 
@@ -122,8 +134,8 @@ All 9 domain-object migrations are ✅ complete:
 
 The work was organized into six workstreams (A–F). All workstreams that are
 prerequisites for C1d are now ✅ complete. F1 and F2 are both ✅ complete — F2
-moved the remaining `Git` module utility methods off `Git::Lib`. Phase 4 is
-ready to proceed.
+moved the remaining `Git` module utility methods off `Git::Lib`. Phase 4 Step A
+is complete; Steps B and C remain (see [Next Task](#next-task)).
 
 **Sequencing** (see [Phase 3 dependency order](#phase-3-dependency-order) for the
 reasoning behind each edge):
@@ -1544,29 +1556,38 @@ graph LR
 
 #### Step A — Remove old code
 
+**Status: ✅ Complete.** Completed in [PR #1456](https://github.com/ruby-git/ruby-git/pull/1456)
+(commit `c1c53999`).
+
 - Delete `attr_reader :base_object`, remove `base_object:` from `#initialize`, and remove or convert `from_base`.
 - Delete the `Git::Lib` class entirely.
 - Delete the `Git::Base` class file.
 - Remove any other dead code that was part of the old implementation.
 
-**Done when**: `lib/git/lib.rb` and `lib/git/base.rb` are deleted; `Git::ExecutionContext::Repository` no longer accepts or exposes `base_object`; no references to `Git::Lib` or `Git::Base` remain in `lib/`.
+**Done when**: `lib/git/lib.rb` and `lib/git/base.rb` are deleted; `Git::ExecutionContext::Repository` no longer accepts or exposes `base_object`; no runtime references to `Git::Lib` or `Git::Base` remain in `lib/` (YARD/comment references to historical 4.x behavior are allowed). ✅ Met — the only surviving `Git::Lib`/`Git::Base` strings in `lib/` are such doc/comment references.
 
 **Planning tip**: Before generating a deletion plan, audit all remaining callers of `Git::Lib`, `Git::Base`, and `from_base` across `lib/` and `spec/`. The bridge removal and `Git::Base` deletion must land atomically in the same PR — plan for a single large deletion commit rather than incremental removals.
 
 #### Step B — Finalize test suite
 
+**Status: 🔲 Not Started.**
+
 - Convert any remaining, relevant Test::Unit tests to RSpec.
-- Remove the `test-unit` dependency from the `Gemfile`.
+- Remove the `test-unit` dependency from `git.gemspec`.
 - Ensure the RSpec suite has comprehensive coverage for the new architecture.
 
 **Done when**: The `tests/` directory is empty or removed; `test-unit` is no longer
-in `Gemfile`; RSpec is the sole test framework.
+in `git.gemspec`; RSpec is the sole test framework.
 
 #### Step C — Update documentation
 
+**Status: 🚧 Partial.**
+
 - Thoroughly document the new public API (`Git`, `Git::Repository`, etc.).
 - Mark all internal classes (`ExecutionContext`, `Commands`, `*Path`) with `@api private` in the YARD documentation.
 - Update the `README.md` and create a `UPGRADING.md` guide explaining the breaking changes for v5.0.0.
 
 **Done when**: `yard stats` reports no missing docs on public API; `UPGRADING.md`
-covers all breaking changes; `README.md` reflects the new entry points.
+covers all breaking changes; `README.md` reflects the new entry points. `UPGRADING.md`
+exists and `@api private` markers are applied broadly; remaining work is to confirm
+full public-API doc coverage and that `README.md` reflects the new entry points.

data/redesign/Phase 4 - Step A.md

@@ -1,5 +1,11 @@
 # Phase 4 / Step A — Remove Old Code: Execution Plan
 
+> **✅ Status: Complete.** All PRs in this plan (1a–1d, 2a–2c, 3a–3d, and the
+> atomic removal PR 4) have merged. The final removal landed in
+> [PR #1456](https://github.com/ruby-git/ruby-git/pull/1456) (commit `c1c53999`),
+> deleting `Git::Base`, `Git::Lib`, and the `base_object` / `from_base` bridge.
+> This document is retained as a historical record of how Step A was executed.
+
 ## Goal
 
 Delete `Git::Base`, `Git::Lib`, and the `from_base`/`base_object` bridge in a

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta.2
+  version: 5.0.0.beta.3
 platform: ruby
 authors:
 - Scott Chacon and others
@@ -602,7 +602,6 @@ files:
 - lib/git/repository.rb
 - lib/git/repository/branching.rb
 - lib/git/repository/committing.rb
-- lib/git/repository/configuring.rb
 - lib/git/repository/context_helpers.rb
 - lib/git/repository/diffing.rb
 - lib/git/repository/factories.rb
@@ -653,8 +652,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.0.0.beta.2/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/git/5.0.0.beta.2
+  changelog_uri: https://rubydoc.info/gems/git/5.0.0.beta.3/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/git/5.0.0.beta.3
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:

data/lib/git/repository/configuring.rb

@@ -1,351 +0,0 @@
-# frozen_string_literal: true
-
-require 'git/commands/config_option_syntax'
-require 'git/repository/shared_private'
-
-module Git
-  class Repository
-    # Legacy facade methods for reading and writing git configuration
-    #
-    # Provides the {#config} and {#global_config} dispatch methods for 4.x
-    # compatibility. These methods return raw `String` / `Hash` values instead of
-    # {Git::ConfigEntryInfo} objects and are retained so that internal callers such
-    # as `Git::Status` continue to work unchanged.
-    #
-    # The structured `config_*` methods (e.g. `config_get`, `config_list`) are
-    # provided by {Git::Configuring}, which is included directly into
-    # {Git::Repository}.
-    #
-    # Included by {Git::Repository}.
-    #
-    # @api public
-    #
-    module Configuring
-      # Option keys accepted by {#config} when writing a value
-      CONFIG_SET_ALLOWED_OPTS = %i[file].freeze
-      private_constant :CONFIG_SET_ALLOWED_OPTS
-
-      # Option keys accepted by {#config} when reading a single value or listing
-      CONFIG_READ_ALLOWED_OPTS = %i[file].freeze
-      private_constant :CONFIG_READ_ALLOWED_OPTS
-
-      # Read or write a git configuration entry
-      #
-      # Dispatches to one of three modes depending on the arguments supplied:
-      #
-      # * **List** — `config()` returns all visible config entries as a `Hash`.
-      # * **Get** — `config(name)` returns the value for a single key as a `String`.
-      # * **Set** — `config(name, value)` writes a value and returns the raw
-      #   command result.
-      #
-      # @overload config(options = {})
-      #
-      #   @example List all config entries
-      #     repo.config #=> { "user.name" => "Alice", "core.bare" => "false" }
-      #
-      #   @example List all entries from a custom config file
-      #     repo.config(file: '/path/to/.gitconfig')
-      #     #=> { "user.name" => "Alice", "core.bare" => "false" }
-      #
-      #   @param options [Hash] options for the list operation
-      #
-      #   @option options [String, nil] :file (nil) path to a custom config file
-      #     to read from instead of the default resolution chain
-      #
-      #   @return [Hash{String => String}] all visible config entries, keyed by
-      #     their full dotted key names (e.g. `"user.name"`)
-      #
-      #   @raise [ArgumentError] if unsupported options are provided
-      #
-      # @overload config(name, options = {})
-      #
-      #   @example Read the committer name from config
-      #     repo.config('user.name') #=> "Alice"
-      #
-      #   @example Read a value from a custom config file
-      #     repo.config('user.name', file: '/path/to/.gitconfig') #=> "Alice"
-      #
-      #   @param name [String] the dotted config key to look up (e.g.
-      #     `"user.name"`)
-      #
-      #   @param options [Hash] options for the get operation
-      #
-      #   @option options [String, nil] :file (nil) path to a custom config file
-      #     to read from instead of the default resolution chain
-      #
-      #   @return [String] the value of the config entry
-      #
-      #   @raise [ArgumentError] if unsupported options are provided
-      #
-      # @overload config(name, value, options = {})
-      #
-      #   @example Set the committer name in local config
-      #     repo.config('user.name', 'Alice')
-      #
-      #   @example Write a value to a custom config file
-      #     repo.config('user.name', 'Alice', file: '/path/to/custom/config')
-      #
-      #   @param name [String] the dotted config key to write (e.g.
-      #     `"user.name"`)
-      #
-      #   @param value [#to_s] the value to assign; must not be `nil` (a `nil`
-      #     value is treated as "no value" and routes to the get overload).
-      #     Must not be a `Hash` (a Hash is treated as the `options` argument;
-      #     call `value.to_s` explicitly before passing if a stringified Hash
-      #     is genuinely needed). Any other non-nil object is converted to a
-      #     String via `#to_s` before being passed to git
-      #
-      #   @param options [Hash] options for the set operation
-      #
-      #   @option options [String, nil] :file (nil) path to a custom config file
-      #     to write to instead of the repository's default `.git/config`
-      #
-      #   @return [Git::CommandLineResult] the raw result of
-      #     `git config <name> <value>`
-      #
-      #   @raise [ArgumentError] if unsupported options are provided
-      #
-      # @raise [Git::FailedError] if git exits with a non-zero exit status
-      #
-      def config(name = nil, value = nil, options = {})
-        name, value, options = Private.normalize_config_args(name, value, options)
-
-        if !name.nil? && !value.nil?
-          Private.config_set(@execution_context, name, value, **options)
-        elsif name
-          Private.config_get(@execution_context, name, **options)
-        else
-          Private.config_list(@execution_context, **options)
-        end
-      end
-
-      # Read or write a global git configuration entry
-      #
-      # Dispatches to one of three modes depending on the arguments supplied,
-      # targeting the git global config scope (`git config --global`):
-      #
-      # * **List** — `global_config()` returns all global config entries as a `Hash`.
-      # * **Get** — `global_config(name)` returns the value for a single key as a `String`.
-      # * **Set** — `global_config(name, value)` writes a value and returns the raw
-      #   command result.
-      #
-      # @overload global_config
-      #
-      #   @example List all global config entries
-      #     repo.global_config #=> { "user.name" => "Alice", "core.autocrlf" => "false" }
-      #
-      #   @return [Hash{String => String}] all global config entries, keyed by their
-      #     full dotted key names (e.g. `"user.name"`)
-      #
-      #   @raise [Git::FailedError] if git exits with a non-zero exit status
-      #
-      # @overload global_config(name)
-      #
-      #   @example Read the global committer name
-      #     repo.global_config('user.name') #=> "Alice"
-      #
-      #   @param name [String] the dotted config key to look up (e.g. `"user.name"`)
-      #
-      #   @return [String] the value of the global config entry
-      #
-      #   @raise [Git::FailedError] if git exits with a non-zero exit status
-      #
-      # @overload global_config(name, value)
-      #
-      #   @example Set the global committer name
-      #     repo.global_config('user.name', 'Alice')
-      #
-      #   @param name [String] the dotted config key to write (e.g. `"user.name"`)
-      #
-      #   @param value [#to_s] the value to assign; any object is accepted and
-      #     converted to a String via `#to_s` before being passed to git
-      #
-      #   @return [Git::CommandLineResult] the raw result of
-      #     `git config --global <name> <value>`
-      #
-      #   @raise [Git::FailedError] if git exits with a non-zero exit status
-      #
-      def global_config(name = nil, value = nil)
-        if !name.nil? && !value.nil?
-          Private.global_config_set(@execution_context, name, value)
-        elsif !name.nil?
-          Private.global_config_get(@execution_context, name)
-        else
-          Private.global_config_list(@execution_context)
-        end
-      end
-
-      # Private helpers local to {Git::Repository::Configuring}
-      #
-      # @api private
-      #
-      module Private
-        module_function
-
-        # Normalize `config()` positional arguments
-        #
-        # In Ruby 3.x, calling `config(file: '/path')` passes the hash as the
-        # first positional argument. This helper re-maps those patterns so that
-        # `name`, `value`, and `options` are always in their canonical positions.
-        #
-        # Raises `ArgumentError` for call shapes that are ambiguous or clearly
-        # wrong, such as passing extra positional arguments after an options Hash.
-        #
-        # @param name [String, Hash, nil] the raw first argument to {#config}
-        #
-        # @param value [Object, Hash, nil] the raw second argument to {#config}
-        #
-        # @param options [Hash] the raw third argument to {#config}
-        #
-        # @return [Array(String|nil, Object|nil, Hash)] normalized [name, value, options]
-        #
-        # @raise [ArgumentError] if extra positional arguments follow an options Hash
-        #
-        def normalize_config_args(name, value, options)
-          if name.is_a?(Hash)
-            raise ArgumentError, 'unexpected positional arguments after options hash' if !value.nil? || !options.empty?
-
-            [nil, nil, name]
-          elsif value.is_a?(Hash)
-            raise ArgumentError, 'unexpected third argument when second argument is options hash' unless options.empty?
-
-            [name, nil, value]
-          else
-            [name, value, options]
-          end
-        end
-
-        # Set a config value by key name
-        #
-        # @overload config_set(execution_context, name, value, **options)
-        #
-        #   @param execution_context [Git::ExecutionContext] the execution context
-        #
-        #   @param name [String] the dotted config key to write (e.g. `"user.name"`)
-        #
-        #   @param value [String] the value to assign
-        #
-        #   @param options [Hash] keyword options forwarded to the command
-        #
-        #   @option options [String, nil] :file (nil) path to a custom config file
-        #     to write to instead of the repository's default `.git/config`
-        #
-        #   @return [Git::CommandLineResult] the raw result of
-        #     `git config <name> <value>`
-        #
-        # @raise [ArgumentError] if unsupported options are provided
-        #
-        # @raise [Git::FailedError] if git exits with a non-zero exit status
-        #
-        def config_set(execution_context, name, value, **)
-          SharedPrivate.assert_valid_opts!(CONFIG_SET_ALLOWED_OPTS, **)
-          Git::Commands::ConfigOptionSyntax::Set.new(execution_context).call(name, value, **)
-        end
-
-        # Retrieve a config value by key name
-        #
-        # @param execution_context [Git::ExecutionContext] the execution context
-        #
-        # @param name [String] the dotted config key to look up (e.g. `"user.name"`)
-        #
-        # @param options [Hash] keyword options
-        #
-        # @option options [String, nil] :file (nil) path to a custom config file to read from
-        #
-        # @return [String] the value of the config entry
-        #
-        # @raise [ArgumentError] if unsupported options are provided
-        #
-        # @raise [Git::FailedError] if git exits with a non-zero exit status
-        #
-        def config_get(execution_context, name, **options)
-          SharedPrivate.assert_valid_opts!(CONFIG_READ_ALLOWED_OPTS, **options)
-          opts = options[:file] ? { file: options[:file] } : {}
-          result = Git::Commands::ConfigOptionSyntax::Get.new(execution_context).call(name, **opts)
-          raise Git::FailedError, result if result.status.exitstatus != 0
-
-          result.stdout
-        end
-
-        # Retrieve all config entries as a hash
-        #
-        # @param execution_context [Git::ExecutionContext] the execution context
-        #
-        # @param options [Hash] keyword options
-        #
-        # @option options [String, nil] :file (nil) path to a custom config file to read from
-        #
-        # @return [Hash{String => String}] all config entries, keyed by their full
-        #   dotted key names (e.g. `"user.name"`)
-        #
-        # @raise [ArgumentError] if unsupported options are provided
-        #
-        # @raise [Git::FailedError] if git exits with a non-zero exit status
-        #
-        def config_list(execution_context, **options)
-          SharedPrivate.assert_valid_opts!(CONFIG_READ_ALLOWED_OPTS, **options)
-          opts = options[:file] ? { file: options[:file] } : {}
-          lines = Git::Commands::ConfigOptionSyntax::List.new(execution_context).call(**opts).stdout.split("\n")
-          lines.each_with_object({}) do |line, hsh|
-            key, value = line.split('=', 2)
-            hsh[key] = value || ''
-          end
-        end
-
-        # Retrieve a global config value by key name
-        #
-        # @param execution_context [Git::ExecutionContext] the execution context
-        #
-        # @param name [String] the dotted config key to look up (e.g. `"user.name"`)
-        #
-        # @return [String] the value of the global config entry
-        #
-        # @raise [Git::FailedError] if git exits with a non-zero exit status
-        #
-        def global_config_get(execution_context, name)
-          result = Git::Commands::ConfigOptionSyntax::Get.new(execution_context).call(name, global: true)
-          raise Git::FailedError, result if result.status.exitstatus != 0
-
-          result.stdout
-        end
-
-        # Retrieve all global config entries as a hash
-        #
-        # @param execution_context [Git::ExecutionContext] the execution context
-        #
-        # @return [Hash{String => String}] all global config entries, keyed by their full
-        #   dotted key names (e.g. `"user.name"`)
-        #
-        # @raise [Git::FailedError] if git exits with a non-zero exit status
-        #
-        def global_config_list(execution_context)
-          lines = Git::Commands::ConfigOptionSyntax::List.new(execution_context).call(global: true).stdout.split("\n")
-          lines.each_with_object({}) do |line, hsh|
-            key, value = line.split('=', 2)
-            hsh[key] = value || ''
-          end
-        end
-
-        # Set a global config value by key name
-        #
-        # @param execution_context [Git::ExecutionContext] the execution context
-        #
-        # @param name [String] the dotted config key to write (e.g. `"user.name"`)
-        #
-        # @param value [#to_s] the value to assign; any object is accepted and
-        #   converted to a String via `#to_s` before being passed to git
-        #
-        # @return [Git::CommandLineResult] the raw result of
-        #   `git config --global <name> <value>`
-        #
-        # @raise [Git::FailedError] if git exits with a non-zero exit status
-        #
-        def global_config_set(execution_context, name, value)
-          Git::Commands::ConfigOptionSyntax::Set.new(execution_context).call(name, value, global: true)
-        end
-      end
-
-      private_constant :Private
-    end
-  end
-end