git 5.0.0.beta.5 → 5.0.0

data/lib/git/parsers/remote.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require 'git/config_entry_info'
+require 'git/remote_info'
+
+module Git
+  module Parsers
+    # Parser that builds {Git::RemoteInfo} objects from git config entries
+    #
+    # Accepts `Array<Git::ConfigEntryInfo>` as returned by
+    # {Git::Configuring#config_list} and groups entries by remote name,
+    # collecting multi-value fields and coercing boolean values.
+    #
+    # @api private
+    #
+    module Remote
+      module_function
+
+      # Parse an array of config entries into an array of RemoteInfo objects
+      #
+      # Groups entries whose key matches `remote.<name>.<variable>` by remote
+      # name and builds one {Git::RemoteInfo} per unique remote name.
+      #
+      # Non-remote config entries (keys that do not start with `remote.`) are
+      # silently ignored.
+      #
+      # @param config_entries [Array<Git::ConfigEntryInfo>] all config entries
+      #   to inspect; may contain non-remote entries
+      #
+      # @return [Array<Git::RemoteInfo>] one entry per unique remote name, in
+      #   the order the first entry for each name appeared in `config_entries`
+      #
+      # @raise [ArgumentError] if a boolean config field carries an unrecognized
+      #   value (mirrors git's own fatal-error behavior)
+      #
+      def parse_list(config_entries)
+        group_by_remote(config_entries).map { |name, pairs| build_remote_info(name, pairs) }
+      end
+
+      # Group config entries by remote name, collecting variable/value pairs
+      #
+      # @param config_entries [Array<Git::ConfigEntryInfo>]
+      #
+      # @return [Hash{String => Array}] remote name to variable/value pairs
+      #
+      # @api private
+      #
+      def group_by_remote(config_entries)
+        config_entries.each_with_object({}) do |entry, groups|
+          next unless entry.section == 'remote' && !entry.subsection.empty?
+
+          remote_name = entry.subsection
+          variable    = entry.variable.downcase
+          groups[remote_name] ||= []
+          groups[remote_name] << [variable, entry.value]
+        end
+      end
+
+      # Config variable names that hold arrays of strings
+      ARRAY_VARIABLES = %w[url pushurl fetch push].freeze
+      private_constant :ARRAY_VARIABLES
+
+      # Config variable names that hold boolean values
+      BOOLEAN_VARIABLES = %w[mirror skipdefaultupdate prune prunetags promisor].freeze
+      private_constant :BOOLEAN_VARIABLES
+
+      # Map from git config variable name to RemoteInfo field name (symbol)
+      #
+      # All keys are lowercase because `git config --list` unconditionally
+      # lowercases section names and variable names (subsection names are
+      # case-preserved, but are never used as lookup keys here).
+      VARIABLE_TO_FIELD = {
+        'url' => :url,
+        'pushurl' => :push_url,
+        'fetch' => :fetch,
+        'push' => :push,
+        'mirror' => :mirror,
+        'skipdefaultupdate' => :skip_default_update,
+        'tagopt' => :tag_opt,
+        'prune' => :prune,
+        'prunetags' => :prune_tags,
+        'receivepack' => :receivepack,
+        'uploadpack' => :uploadpack,
+        'promisor' => :promisor,
+        'partialclonefilter' => :partial_clone_filter,
+        'vcs' => :vcs
+      }.freeze
+      private_constant :VARIABLE_TO_FIELD
+
+      # True string values per git's boolean rules
+      BOOL_TRUE_VALUES = %w[true yes on 1].freeze
+      private_constant :BOOL_TRUE_VALUES
+
+      # False string values per git's boolean rules
+      BOOL_FALSE_VALUES = %w[false no off 0].freeze
+      private_constant :BOOL_FALSE_VALUES
+
+      # Build a RemoteInfo from grouped variable/value pairs
+      #
+      # @param remote_name [String]
+      #
+      # @param pairs [Array] variable/value pairs collected from config entries
+      #
+      # @return [Git::RemoteInfo]
+      #
+      # @api private
+      #
+      def build_remote_info(remote_name, pairs)
+        attrs = { name: remote_name }
+        pairs.each { |variable, value| apply_pair(attrs, variable, value) }
+        Git::RemoteInfo.new(**attrs)
+      end
+
+      # Apply a single variable/value pair to an attrs hash
+      #
+      # @param attrs [Hash] accumulator of RemoteInfo keyword arguments
+      #
+      # @param variable [String] git config variable name (e.g. 'url', 'tagopt')
+      #
+      # @param value [String] raw config value
+      #
+      # @return [void]
+      #
+      # @api private
+      #
+      def apply_pair(attrs, variable, value)
+        field = VARIABLE_TO_FIELD[variable]
+        return unless field # ignore unknown variables
+
+        if ARRAY_VARIABLES.include?(variable)
+          attrs[field] ||= []
+          attrs[field] << value
+        elsif BOOLEAN_VARIABLES.include?(variable)
+          attrs[field] = coerce_boolean(variable, value)
+        else
+          attrs[field] = value
+        end
+      end
+
+      # Coerce a git config boolean string to a Ruby boolean
+      #
+      # @param variable [String] the config variable name (for error messages)
+      #
+      # @param value [String] the raw string value from git config
+      #
+      # @return [Boolean] `true` or `false`
+      #
+      # @raise [ArgumentError] if the value is not a recognized boolean
+      #
+      # @api private
+      #
+      def coerce_boolean(variable, value)
+        normalized = value.downcase
+        return true  if BOOL_TRUE_VALUES.include?(normalized) || normalized == ''
+        return false if BOOL_FALSE_VALUES.include?(normalized)
+
+        raise ArgumentError,
+              "unrecognized boolean value #{value.inspect} for config variable #{variable.inspect}"
+      end
+    end
+  end
+end

data/lib/git/remote.rb

@@ -121,9 +121,7 @@ module Git
     #
     def branch(branch = nil)
       branch ||= remote_repository.current_branch
-      remote_tracking_branch = "#{@name}/#{branch}"
-      branch_info = build_branch_info(remote_tracking_branch)
-      Git::Branch.new(@base, branch_info)
+      Git::Branch.new(@base, "#{@name}/#{branch}")
     end
 
     # Removes this remote from the repository
@@ -159,24 +157,5 @@ module Git
     def remote_repository
       @base
     end
-
-    # Builds branch metadata for a remote-tracking branch
-    #
-    # @param refname [String] remote-tracking branch name (for example,
-    #   `'origin/main'`)
-    #
-    # @return [Git::BranchInfo] minimal branch metadata for constructing
-    #   {Git::Branch}
-    #
-    def build_branch_info(refname)
-      Git::BranchInfo.new(
-        refname: refname,
-        target_oid: nil,
-        current: false,
-        worktree: false,
-        symref: nil,
-        upstream: nil
-      )
-    end
   end
 end

data/lib/git/remote_info.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module Git
+  # Value object representing a configured git remote
+  #
+  # Each instance holds the parsed configuration for a single remote as read
+  # from the repository's git config. Multi-value fields (`:url`, `:push_url`,
+  # `:fetch`, `:push`) are always `Array<String>` (never `nil`; may be empty).
+  # All other fields are nilable except `:name`.
+  #
+  # @example Minimal remote (fetch-only, one URL)
+  #   info = Git::RemoteInfo.new(
+  #     name: 'origin',
+  #     url: ['https://github.com/ruby-git/ruby-git.git'],
+  #     push_url: [],
+  #     fetch: ['+refs/heads/*:refs/remotes/origin/*'],
+  #     push: []
+  #   )
+  #   info.name   # => "origin"
+  #   info.url    # => ["https://github.com/ruby-git/ruby-git.git"]
+  #   info.prune  # => nil
+  #
+  # @api public
+  #
+  # @!attribute [r] name
+  #   @return [String] the name of the remote (e.g. `'origin'`)
+  #
+  # @!attribute [r] url
+  #   @return [Array<String>] the fetch URL(s) for this remote (`remote.<name>.url`)
+  #
+  # @!attribute [r] push_url
+  #   @return [Array<String>] the push URL(s) for this remote (`remote.<name>.pushurl`)
+  #
+  # @!attribute [r] fetch
+  #   @return [Array<String>] the fetch refspec(s) for this remote (`remote.<name>.fetch`)
+  #
+  # @!attribute [r] push
+  #   @return [Array<String>] the push refspec(s) for this remote (`remote.<name>.push`)
+  #
+  # @!attribute [r] mirror
+  #   @return [Boolean, nil] `true`/`false` per `remote.<name>.mirror`, or `nil` when not set
+  #
+  # @!attribute [r] skip_default_update
+  #   @return [Boolean, nil] `true`/`false` per `remote.<name>.skipDefaultUpdate`, or `nil` when not set
+  #
+  # @!attribute [r] tag_opt
+  #   @return [String, nil] the tag-fetching option (`remote.<name>.tagOpt`), or `nil` when not set
+  #
+  # @!attribute [r] prune
+  #   @return [Boolean, nil] `true`/`false` per `remote.<name>.prune`; `nil` inherits `fetch.prune`
+  #
+  # @!attribute [r] prune_tags
+  #   @return [Boolean, nil] `true`/`false` per `remote.<name>.pruneTags`; `nil` inherits `fetch.pruneTags`
+  #
+  # @!attribute [r] receivepack
+  #   @return [String, nil] the `git-receive-pack` path on the remote (`remote.<name>.receivepack`)
+  #
+  # @!attribute [r] uploadpack
+  #   @return [String, nil] the `git-upload-pack` path on the remote (`remote.<name>.uploadpack`)
+  #
+  # @!attribute [r] promisor
+  #   @return [Boolean, nil] `true`/`false` per `remote.<name>.promisor`, or `nil` when not set
+  #
+  # @!attribute [r] partial_clone_filter
+  #   @return [String, nil] the partial-clone object filter (`remote.<name>.partialclonefilter`)
+  #
+  # @!attribute [r] vcs
+  #   @return [String, nil] the VCS type for git-remote helpers (`remote.<name>.vcs`)
+  #
+  RemoteInfo = Data.define(
+    :name,
+    :url,
+    :push_url,
+    :fetch,
+    :push,
+    :mirror,
+    :skip_default_update,
+    :tag_opt,
+    :prune,
+    :prune_tags,
+    :receivepack,
+    :uploadpack,
+    :promisor,
+    :partial_clone_filter,
+    :vcs
+  ) do
+    # Create a new RemoteInfo
+    #
+    # @param name [String] the name of the remote (required)
+    #
+    # @param url [Array<String>] fetch URLs (default `[]`)
+    #
+    # @param push_url [Array<String>] push URLs (default `[]`)
+    #
+    # @param fetch [Array<String>] fetch refspecs (default `[]`)
+    #
+    # @param push [Array<String>] push refspecs (default `[]`)
+    #
+    # @param mirror [Boolean, nil] mirror flag (default `nil`)
+    #
+    # @param skip_default_update [Boolean, nil] skip-default-update flag (default `nil`)
+    #
+    # @param tag_opt [String, nil] tag-fetching option (default `nil`)
+    #
+    # @param prune [Boolean, nil] prune flag (default `nil`)
+    #
+    # @param prune_tags [Boolean, nil] prune-tags flag (default `nil`)
+    #
+    # @param receivepack [String, nil] receive-pack path (default `nil`)
+    #
+    # @param uploadpack [String, nil] upload-pack path (default `nil`)
+    #
+    # @param promisor [Boolean, nil] promisor flag (default `nil`)
+    #
+    # @param partial_clone_filter [String, nil] partial-clone filter (default `nil`)
+    #
+    # @param vcs [String, nil] VCS type (default `nil`)
+    #
+    # @return [Git::RemoteInfo]
+    #
+    def initialize(
+      name:,
+      url: [],
+      push_url: [],
+      fetch: [],
+      push: [],
+      mirror: nil,
+      skip_default_update: nil,
+      tag_opt: nil,
+      prune: nil,
+      prune_tags: nil,
+      receivepack: nil,
+      uploadpack: nil,
+      promisor: nil,
+      partial_clone_filter: nil,
+      vcs: nil
+    )
+      super(
+        name:, url: Array(url), push_url: Array(push_url), fetch: Array(fetch),
+        push: Array(push), mirror:, skip_default_update:, tag_opt:, prune:,
+        prune_tags:, receivepack:, uploadpack:, promisor:, partial_clone_filter:,
+        vcs:
+      )
+    end
+  end
+end

data/lib/git/repository/branching.rb

@@ -277,7 +277,7 @@ module Git
       #
       def is_local_branch?(branch) # rubocop:disable Naming/PredicatePrefix
         Git::Deprecation.warn(
-          'Git::Repository#is_local_branch? is deprecated and will be removed in a future version. ' \
+          'Git::Repository#is_local_branch? is deprecated and will be removed in v6.0.0. ' \
           'Use Git::Repository#local_branch? instead.'
         )
         local_branch?(branch)
@@ -299,7 +299,7 @@ module Git
       #
       def is_remote_branch?(branch) # rubocop:disable Naming/PredicatePrefix
         Git::Deprecation.warn(
-          'Git::Repository#is_remote_branch? is deprecated and will be removed in a future version. ' \
+          'Git::Repository#is_remote_branch? is deprecated and will be removed in v6.0.0. ' \
           'Use Git::Repository#remote_branch? instead.'
         )
         remote_branch?(branch)
@@ -321,7 +321,7 @@ module Git
       #
       def is_branch?(branch) # rubocop:disable Naming/PredicatePrefix
         Git::Deprecation.warn(
-          'Git::Repository#is_branch? is deprecated and will be removed in a future version. ' \
+          'Git::Repository#is_branch? is deprecated and will be removed in v6.0.0. ' \
           'Use Git::Repository#branch? instead.'
         )
         branch?(branch)
@@ -499,28 +499,71 @@ module Git
       # Returns all local and remote-tracking branches as structured objects
       #
       # @example List all branches
-      #   repo.branches_all
-      #   # => [#<data Git::BranchInfo refname="main", current=true, ...>,
-      #   #     #<data Git::BranchInfo refname="remotes/origin/main", current=false, ...>]
+      #   repo.branch_list
+      #   # => [#<data Git::BranchInfo refname="refs/heads/main", current=true, ...>,
+      #   #     #<data Git::BranchInfo refname="refs/remotes/origin/main", current=false, ...>]
       #
       # @example Find the currently checked-out branch
-      #   repo.branches_all.find(&:current)
+      #   repo.branch_list.find(&:current)
       #
       # @example List only local branches
-      #   repo.branches_all.reject(&:remote?)
+      #   repo.branch_list.reject(&:remote?)
+      #
+      # @example Filter to an exact branch name
+      #   repo.branch_list('feature/auth')
+      #
+      # @example Filter using glob patterns
+      #   repo.branch_list('feature/*', 'hotfix/*')
+      #
+      # @param patterns [Array<String>] optional shell wildcard patterns passed
+      #   directly to `git branch --list`; when empty (the default) all branches
+      #   are returned. Pattern matching follows git's own rules; behavior may
+      #   differ between local and remote-tracking branches.
+      #
+      # @param remote_names [Array<String>, nil] configured remote names used to
+      #   resolve remote-tracking refs
+      #
+      #   Especially useful for remotes whose remote names contain slashes. When
+      #   omitted, the repository's configured remote names are fetched automatically.
       #
       # @return [Array<Git::BranchInfo>] parsed branch information for every
-      #   local and remote-tracking branch
+      #   local and remote-tracking branch matching the pattern
       #
-      #   Returns an empty array when the repository has no branches.
+      #   Returns an empty array when the repository has no branches or no branches
+      #   match the given pattern.
       #
       # @raise [Git::FailedError] if git exits with a non-zero exit status
       #
-      def branches_all
+      def branch_list(*patterns, remote_names: nil)
+        remote_names ||= self.remote_names
         result = Git::Commands::Branch::List.new(@execution_context).call(
-          all: true, format: Git::Parsers::Branch::FORMAT_STRING
+          *patterns, all: true, format: Git::Parsers::Branch::FORMAT_STRING
         )
-        Git::Parsers::Branch.parse_list(result.stdout)
+        Git::Parsers::Branch.parse_list(result.stdout, remote_names:)
+      end
+
+      # Returns all local and remote-tracking branches in the 4.x-compatible format
+      #
+      # Each entry is a 4-element array: `[refname, current, worktree, symref]`.
+      # The `refname` uses the short form (`main`, `remotes/origin/main`) to
+      # match the output of the legacy `Git::Lib#branches_all` method.
+      #
+      # @return [Array<Array>] array of `[refname, current, worktree, symref]` tuples
+      #
+      # @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      # @deprecated Use {#branch_list} instead, which returns richer
+      #   {Git::BranchInfo} objects.
+      #
+      def branches_all
+        Git::Deprecation.warn(
+          'Git::Repository#branches_all is deprecated and will be removed in v6.0.0. ' \
+          'Use Git::Repository#branch_list instead.'
+        )
+        branch_list.map do |info|
+          refname = info.remote? ? "remotes/#{info.remote_name}/#{info.short_name}" : info.short_name
+          [refname, info.current, info.other_worktree?, info.symref]
+        end
       end
 
       # Update a branch ref to point to a new commit
@@ -573,15 +616,7 @@ module Git
       # @raise [Git::FailedError] if git exits with a non-zero exit status
       #
       def branch(branch_name = current_branch)
-        branch_info = Git::BranchInfo.new(
-          refname: branch_name,
-          target_oid: nil,
-          current: false,
-          worktree: false,
-          symref: nil,
-          upstream: nil
-        )
-        Git::Branch.new(self, branch_info)
+        Git::Branch.new(self, branch_name)
       end
 
       # Returns a {Git::Branches} collection of all branches in the repository

data/lib/git/repository/committing.rb

@@ -73,12 +73,7 @@ module Git
       # @raise [Git::FailedError] when git exits with a non-zero exit status
       #
       def commit(message, opts = {})
-        opts = opts.dup
-        if opts.key?(:add_all)
-          Git::Deprecation.warn('The :add_all option for #commit is deprecated, use :all instead')
-          opts[:all] = opts.delete(:add_all)
-        end
-
+        opts = normalize_commit_options(opts)
         SharedPrivate.assert_valid_opts!(COMMIT_ALLOWED_OPTS, **opts)
 
         call_opts = { no_edit: true }
@@ -222,6 +217,30 @@ module Git
       def write_and_commit_tree(opts = {})
         commit_tree(write_tree, opts)
       end
+
+      private
+
+      # Normalizes deprecated commit options into their supported form
+      #
+      # @param opts [Hash] caller-provided commit options
+      #
+      # @option opts [Boolean, nil] :add_all (nil) deprecated alias for `:all`
+      #
+      # @return [Hash] options with deprecated aliases translated
+      #
+      # @api private
+      #
+      def normalize_commit_options(opts)
+        opts = opts.dup
+        return opts unless opts.key?(:add_all)
+
+        Git::Deprecation.warn(
+          'The :add_all option for #commit is deprecated and will be removed in v6.0.0. ' \
+          'Use :all instead.'
+        )
+        opts[:all] = opts.delete(:add_all)
+        opts
+      end
     end
   end
 end

data/lib/git/repository/context_helpers.rb

@@ -242,7 +242,7 @@ module Git
       def context_helpers_deprecate_check_argument(check, must_exist)
         if !check.nil? && defined?(Git::Deprecation)
           Git::Deprecation.warn(
-            'The "check" argument is deprecated and will be removed in a future version. ' \
+            'The "check" argument is deprecated and will be removed in v6.0.0. ' \
             'Use "must_exist:" instead.'
           )
         end

data/lib/git/repository/diffing.rb

@@ -517,7 +517,8 @@ module Git
             opts[:path_limiter]
           elsif opts.key?(:path)
             Git::Deprecation.warn(
-              'Git::Repository#diff_path_status :path option is deprecated. Use :path_limiter instead.'
+              'Git::Repository#diff_path_status :path option is deprecated and will be removed in v6.0.0. ' \
+              'Use :path_limiter instead.'
             )
             opts[:path]
           end

data/lib/git/repository/factories.rb

@@ -750,7 +750,10 @@ module Git
         return unless opts.key?(:path)
 
         if defined?(Git::Deprecation)
-          Git::Deprecation.warn('The :path option for Git.clone is deprecated, use :chdir instead')
+          Git::Deprecation.warn(
+            'The :path option for Git.clone is deprecated and will be removed in v6.0.0. ' \
+            'Use :chdir instead.'
+          )
         end
         path = opts.delete(:path)
         opts[:chdir] ||= path
@@ -775,7 +778,8 @@ module Git
 
         if defined?(Git::Deprecation)
           Git::Deprecation.warn(
-            'The :recursive option for Git.clone is deprecated, use :recurse_submodules instead'
+            'The :recursive option for Git.clone is deprecated and will be removed in v6.0.0. ' \
+            'Use :recurse_submodules instead.'
           )
         end
         opts[:recurse_submodules] = opts.delete(:recursive)
@@ -798,7 +802,10 @@ module Git
         return unless opts.key?(:remote)
 
         if defined?(Git::Deprecation)
-          Git::Deprecation.warn('The :remote option for Git.clone is deprecated, use :origin instead')
+          Git::Deprecation.warn(
+            'The :remote option for Git.clone is deprecated and will be removed in v6.0.0. ' \
+            'Use :origin instead.'
+          )
         end
         opts[:origin] = opts.delete(:remote)
       end

data/lib/git/repository/merging.rb

@@ -48,11 +48,11 @@ module Git
       # @example Merge without committing
       #   repo.merge('feature', nil, no_commit: true)
       #
-      # @param branch [String, Array<String>, #to_s] the branch or branches to merge
-      #   into the current branch
+      # @param branch [#to_s, Array<#to_s>] the branch or branches to merge into the
+      #   current branch
       #
-      #   When an Array is given, an octopus merge is performed; a {Git::Branch}
-      #   object is coerced to a String via `#to_s`.
+      #   When an Array is given, an octopus merge is performed; each branch-ish
+      #   object (e.g., {Git::BranchInfo}) is coerced to a String via `#to_s`.
       #
       # @param message [String, nil] optional commit message for the merge commit
       #
@@ -245,7 +245,7 @@ module Git
       #
       def conflicts(&)
         Git::Deprecation.warn(
-          'Git::Repository#conflicts is deprecated and will be removed in a future version. ' \
+          'Git::Repository#conflicts is deprecated and will be removed in v6.0.0. ' \
           'Use Git::Repository#each_conflict instead.'
         )
         each_conflict(&)