git 4.3.2 → 5.0.0.beta.1

data/lib/git/commands/remote/remove.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote remove` command
+      #
+      # Removes a remote and its associated tracking refs and configuration.
+      #
+      # @example Remove a remote
+      #   remove = Git::Commands::Remote::Remove.new(execution_context)
+      #   remove.call('origin')
+      #
+      # @example Remove a remote with a name that looks like a flag
+      #   remove = Git::Commands::Remote::Remove.new(execution_context)
+      #   remove.call('-weirdremote')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class Remove < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          literal 'remove'
+
+          end_of_options
+
+          operand :name, required: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name)
+        #
+        #     Execute the `git remote remove` command
+        #
+        #     @param name [String] the remote name to remove
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote remove`
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote/rename.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote rename` command
+      #
+      # Renames a remote and updates all its remote-tracking branches and
+      # configuration settings.
+      #
+      # @example Rename a remote
+      #   rename = Git::Commands::Remote::Rename.new(execution_context)
+      #   rename.call('origin', 'upstream')
+      #
+      # @example Rename a remote with progress reporting
+      #   rename = Git::Commands::Remote::Rename.new(execution_context)
+      #   rename.call('origin', 'upstream', progress: true)
+      #
+      # @example Suppress progress output during rename
+      #   rename = Git::Commands::Remote::Rename.new(execution_context)
+      #   rename.call('origin', 'upstream', no_progress: true)
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class Rename < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          literal 'rename'
+          flag_option :progress, negatable: true
+
+          end_of_options
+
+          operand :old, required: true
+          operand :new, required: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(old, new, **options)
+        #
+        #     Execute the `git remote rename` command
+        #
+        #     @param old [String] the current remote name
+        #
+        #     @param new [String] the new remote name
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :progress (nil) enable progress reporting (`--progress`)
+        #
+        #     @option options [Boolean, nil] :no_progress (nil) suppress progress output (`--no-progress`)
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote rename`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote/set_branches.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote set-branches` command
+      #
+      # Changes the list of branches tracked for the named remote. This can be used
+      # to track a subset of the available remote branches after the initial setup.
+      #
+      # @example Set the tracked branches for a remote
+      #   set_branches = Git::Commands::Remote::SetBranches.new(execution_context)
+      #   set_branches.call('origin', 'main', 'develop')
+      #
+      # @example Append additional tracked branches without replacing existing ones
+      #   set_branches = Git::Commands::Remote::SetBranches.new(execution_context)
+      #   set_branches.call('origin', 'release/*', add: true)
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class SetBranches < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          literal 'set-branches'
+          flag_option :add
+
+          end_of_options
+
+          operand :name, required: true
+          operand :branch, repeatable: true, required: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, *branch, **options)
+        #
+        #     Execute the `git remote set-branches` command
+        #
+        #     @param name [String] the remote name to update
+        #
+        #     @param branch [Array<String>] one or more branch names or glob patterns to track
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :add (nil) append the given branches instead of replacing them
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote set-branches`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote/set_head.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote set-head` command
+      #
+      # Sets or deletes the default branch (symbolic HEAD) for the named remote.
+      #
+      # @example Set the remote HEAD to a specific branch
+      #   set_head = Git::Commands::Remote::SetHead.new(execution_context)
+      #   set_head.call('origin', 'main')
+      #
+      # @example Auto-detect the remote HEAD by querying the remote
+      #   set_head = Git::Commands::Remote::SetHead.new(execution_context)
+      #   set_head.call('origin', auto: true)
+      #
+      # @example Delete the remote HEAD symbolic ref
+      #   set_head = Git::Commands::Remote::SetHead.new(execution_context)
+      #   set_head.call('origin', delete: true)
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class SetHead < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          literal 'set-head'
+          operand :name, required: true
+          flag_option %i[auto a]
+          flag_option %i[delete d]
+          operand :branch
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, branch)
+        #
+        #     Set the remote's HEAD symbolic ref to a specific branch
+        #
+        #     @param name [String] the remote name to update
+        #
+        #     @param branch [String] the branch to set as the remote HEAD
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote set-head`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #   @overload call(name, **options)
+        #
+        #     Detect or delete the remote's HEAD symbolic ref
+        #
+        #     @param name [String] the remote name to update
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :auto (nil) detect the remote HEAD by querying the remote
+        #
+        #       Mutually exclusive with `:delete`. Alias: :a
+        #
+        #     @option options [Boolean, nil] :delete (nil) delete the configured remote HEAD symbolic ref
+        #
+        #       Mutually exclusive with `:auto`. Alias: :d
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote set-head`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote/set_url.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote set-url` command
+      #
+      # Replaces a URL in the named remote's configuration. Sets the first URL
+      # for the remote matching regex <oldurl> (or the first URL if no <oldurl>
+      # is given) to <newurl>.
+      #
+      # @example Replace the fetch URL for a remote
+      #   set_url = Git::Commands::Remote::SetUrl.new(execution_context)
+      #   set_url.call('origin', 'https://example.com/repo.git')
+      #
+      # @example Replace the push URL for a remote
+      #   set_url = Git::Commands::Remote::SetUrl.new(execution_context)
+      #   set_url.call('origin', 'https://example.com/repo.git', push: true)
+      #
+      # @example Replace a URL matching a regex
+      #   set_url = Git::Commands::Remote::SetUrl.new(execution_context)
+      #   set_url.call('origin', 'https://new.example.com/repo.git', 'old.example.com')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class SetUrl < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          literal 'set-url'
+          flag_option :push
+
+          end_of_options
+
+          operand :name, required: true
+          operand :newurl, required: true
+          operand :oldurl
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, newurl, oldurl = nil, **options)
+        #
+        #     Execute the `git remote set-url` command
+        #
+        #     @param name [String] the remote name to update
+        #
+        #     @param newurl [String] the replacement URL
+        #
+        #     @param oldurl [String, nil] a regex matching the existing URL to replace
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :push (nil) update push URLs instead of fetch URLs
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote set-url`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote/set_url_add.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote set-url --add` command
+      #
+      # Appends a new URL to the named remote's fetch or push URL list.
+      #
+      # @example Add an additional fetch URL to an existing remote
+      #   set_url_add = Git::Commands::Remote::SetUrlAdd.new(execution_context)
+      #   set_url_add.call('origin', 'https://mirror.example.com/repo.git')
+      #
+      # @example Add a push URL to an existing remote
+      #   set_url_add = Git::Commands::Remote::SetUrlAdd.new(execution_context)
+      #   set_url_add.call('origin', 'https://push.example.com/repo.git', push: true)
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class SetUrlAdd < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          literal 'set-url'
+          literal '--add'
+          flag_option :push
+
+          end_of_options
+
+          operand :name, required: true
+          operand :newurl, required: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, newurl, **options)
+        #
+        #     Execute the `git remote set-url --add` command
+        #
+        #     @param name [String] the remote name to update
+        #
+        #     @param newurl [String] the URL to append
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :push (nil) add a push URL instead of a fetch URL
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote set-url --add`
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote/set_url_delete.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote set-url --delete` command
+      #
+      # Removes all URLs matching a regex from the named remote's configured URL list.
+      # By default operates on fetch URLs; pass `push: true` to target push URLs instead.
+      #
+      # @example Delete a fetch URL matching a pattern
+      #   set_url_delete = Git::Commands::Remote::SetUrlDelete.new(execution_context)
+      #   set_url_delete.call('origin', 'github')
+      #
+      # @example Delete a push URL matching a pattern
+      #   set_url_delete = Git::Commands::Remote::SetUrlDelete.new(execution_context)
+      #   set_url_delete.call('origin', 'github', push: true)
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class SetUrlDelete < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          literal 'set-url'
+          literal '--delete'
+          flag_option :push
+
+          end_of_options
+
+          operand :name, required: true
+          operand :url, required: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, url, **options)
+        #
+        #     Execute the `git remote set-url --delete` command
+        #
+        #     @param name [String] the remote name to update
+        #
+        #     @param url [String] a regex selecting the URL or URLs to delete
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :push (nil) delete push URLs instead of fetch URLs
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote set-url --delete`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote/show.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote show` command
+      #
+      # Shows information about one or more remotes, including fetch and push URLs
+      # and branch tracking information.
+      #
+      # @example Show information about a remote
+      #   show = Git::Commands::Remote::Show.new(execution_context)
+      #   show.call('origin')
+      #
+      # @example Show cached information without contacting the remote
+      #   show = Git::Commands::Remote::Show.new(execution_context)
+      #   show.call('origin', n: true)
+      #
+      # @example Show verbose output for multiple remotes
+      #   show = Git::Commands::Remote::Show.new(execution_context)
+      #   show.call('origin', 'upstream', verbose: true)
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class Show < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          flag_option %i[verbose v]
+          literal 'show'
+          flag_option :n
+
+          end_of_options
+
+          operand :name, repeatable: true, required: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(*name, **options)
+        #
+        #     Execute the `git remote show` command
+        #
+        #     @param name [Array<String>] one or more remote names to inspect
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :verbose (nil) show the remote URL after the remote name
+        #
+        #       Alias: :v
+        #
+        #     @option options [Boolean, nil] :n (nil) do not query remote heads with `git ls-remote`
+        #
+        #       Uses cached information instead of contacting the remote server.
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote show`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote/update.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Remote
+      # `git remote update` command
+      #
+      # Fetches updates for remotes or remote groups in the repository. When neither
+      # a remote nor a group is specified, updates all remotes that are not marked
+      # with `remote.<name>.skipDefaultUpdate`.
+      #
+      # @example Fetch updates for all configured remotes
+      #   update = Git::Commands::Remote::Update.new(execution_context)
+      #   update.call
+      #
+      # @example Fetch updates for a specific remote
+      #   update = Git::Commands::Remote::Update.new(execution_context)
+      #   update.call('origin')
+      #
+      # @example Fetch updates and prune stale tracking refs
+      #   update = Git::Commands::Remote::Update.new(execution_context)
+      #   update.call('origin', prune: true)
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-remote/2.53.0
+      #
+      # @see Git::Commands::Remote
+      #
+      # @see https://git-scm.com/docs/git-remote git-remote
+      #
+      # @api private
+      #
+      class Update < Git::Commands::Base
+        arguments do
+          literal 'remote'
+          flag_option %i[verbose v]
+          literal 'update'
+          flag_option %i[prune p]
+
+          end_of_options
+
+          operand :remote_or_group, repeatable: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(*remote_or_group, **options)
+        #
+        #     Execute the `git remote update` command
+        #
+        #     @param remote_or_group [Array<String>] zero or more remote names or remote group names
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :verbose (nil) show remote URLs alongside remote names
+        #
+        #       Alias: :v
+        #
+        #     @option options [Boolean, nil] :prune (nil) prune stale tracking refs while updating remotes
+        #
+        #       Alias: :p
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git remote update`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/remote.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'remote/add'
+require_relative 'remote/get_url'
+require_relative 'remote/list'
+require_relative 'remote/prune'
+require_relative 'remote/remove'
+require_relative 'remote/rename'
+require_relative 'remote/set_branches'
+require_relative 'remote/set_head'
+require_relative 'remote/set_url'
+require_relative 'remote/set_url_add'
+require_relative 'remote/set_url_delete'
+require_relative 'remote/show'
+require_relative 'remote/update'
+
+module Git
+  module Commands
+    # Commands for managing git remotes via `git remote`
+    #
+    # This module contains command classes split by remote operation:
+    # - {Remote::List} - list configured remotes
+    # - {Remote::Add} - add a new remote
+    # - {Remote::Rename} - rename an existing remote
+    # - {Remote::Remove} - remove a remote
+    # - {Remote::SetHead} - manage a remote's default branch
+    # - {Remote::SetBranches} - configure tracked branches for a remote
+    # - {Remote::GetUrl} - retrieve fetch or push URLs
+    # - {Remote::SetUrl} - replace a remote URL
+    # - {Remote::SetUrlAdd} - append a remote URL
+    # - {Remote::SetUrlDelete} - delete a matching remote URL
+    # - {Remote::Show} - show details about one or more remotes
+    # - {Remote::Prune} - prune stale tracking refs for remotes
+    # - {Remote::Update} - update one or more remotes or groups
+    #
+    # @api private
+    #
+    # @see https://git-scm.com/docs/git-remote git-remote documentation
+    module Remote
+    end
+  end
+end