git 1.19.1 → 5.5.0

data/lib/git/commands/maintenance/start.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Maintenance
+      # Initialize and start background maintenance on the current repository
+      #
+      # @example Start background maintenance with default scheduler
+      #   Git::Commands::Maintenance::Start.new(execution_context).call
+      #
+      # @example Start with a specific scheduler
+      #   Git::Commands::Maintenance::Start.new(execution_context).call(scheduler: 'crontab')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-maintenance/2.54.0
+      #
+      # @see Git::Commands::Maintenance Git::Commands::Maintenance for the full sub-command list
+      #
+      # @see https://git-scm.com/docs/git-maintenance git-maintenance documentation
+      #
+      # @api private
+      #
+      class Start < Git::Commands::Base
+        requires_git_version '2.30.0'
+
+        arguments do
+          literal 'maintenance'
+          literal 'start'
+
+          value_option :scheduler, inline: true
+          execution_option :env
+        end
+
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [String] :scheduler (nil) command option key; see overload docs
+        #     for the full option list
+        #
+        #   @overload call(**options)
+        #
+        #     Initialize config values and start background maintenance
+        #
+        #     This performs the same config updates as `register`, then updates
+        #     the background scheduler to run `git maintenance run --scheduled`
+        #     on an hourly basis.
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [String] :scheduler (nil) specify the scheduler to use
+        #
+        #       Must be one of 'auto', 'crontab', 'systemd-timer', 'launchctl', or 'schtasks'.
+        #       When 'auto', the appropriate platform-specific scheduler is used.
+        #       Default is 'auto'.
+        #
+        #     @option options [Hash] :env (nil) environment variables to set for the git
+        #       process; merged with the default environment; not passed to the git CLI
+        #
+        #     @return [Git::CommandLine::Result] the result of calling `git maintenance start`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @raise [Git::VersionError] if git version is below 2.30.0
+      end
+    end
+  end
+end

data/lib/git/commands/maintenance/stop.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Maintenance
+      # Halt the background maintenance schedule
+      #
+      # @example Stop background maintenance
+      #   Git::Commands::Maintenance::Stop.new(execution_context).call
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-maintenance/2.54.0
+      #
+      # @see Git::Commands::Maintenance Git::Commands::Maintenance for the full sub-command list
+      #
+      # @see https://git-scm.com/docs/git-maintenance git-maintenance documentation
+      #
+      # @api private
+      #
+      class Stop < Git::Commands::Base
+        requires_git_version '2.30.0'
+
+        arguments do
+          literal 'maintenance'
+          literal 'stop'
+
+          execution_option :env
+        end
+
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Hash] :env (nil) command option key; see overload docs
+        #     for the full option list
+        #
+        #   @overload call(**options)
+        #
+        #     Halt the background maintenance schedule
+        #
+        #     The current repository is not removed from the list of maintained
+        #     repositories, in case the background maintenance is restarted later.
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Hash] :env (nil) environment variables to set for the git
+        #       process; merged with the default environment; not passed to the git CLI
+        #
+        #     @return [Git::CommandLine::Result] the result of calling `git maintenance stop`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @raise [Git::VersionError] if git version is below 2.30.0
+      end
+    end
+  end
+end

data/lib/git/commands/maintenance/unregister.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Maintenance
+      # Remove the current repository from background maintenance
+      #
+      # @example Unregister the repository from maintenance
+      #   Git::Commands::Maintenance::Unregister.new(execution_context).call
+      #
+      # @example Force unregister even if repository is not registered
+      #   Git::Commands::Maintenance::Unregister.new(execution_context).call(force: true)
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-maintenance/2.54.0
+      #
+      # @see Git::Commands::Maintenance Git::Commands::Maintenance for the full sub-command list
+      #
+      # @see https://git-scm.com/docs/git-maintenance git-maintenance documentation
+      #
+      # @api private
+      #
+      class Unregister < Git::Commands::Base
+        requires_git_version '2.30.0'
+
+        arguments do
+          literal 'maintenance'
+          literal 'unregister'
+
+          flag_or_value_option :config_file, negatable: true
+          flag_option :force, negatable: true
+          execution_option :env
+        end
+
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, String, nil] :config_file (nil) command option key;
+        #     see overload docs for the full option list
+        #
+        #   @overload call(**options)
+        #
+        #     Remove the current repository from background maintenance
+        #
+        #     This only removes the repository from the configured list.
+        #     It does not stop the background maintenance processes from running.
+        #
+        #     Reports an error if the current repository is not already registered,
+        #     unless `--force` is used.
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, String, nil] :config_file (nil) use a specified
+        #       config file instead of the global config (`--config-file`)
+        #
+        #       When a String, the path is passed as `--config-file <file>`.
+        #
+        #     @option options [Boolean, nil] :no_config_file (nil) disable the config file
+        #       (`--no-config-file`)
+        #
+        #     @option options [Boolean, nil] :force (nil) return success even if repository is not registered
+        #       (`--force`)
+        #
+        #     @option options [Boolean, nil] :no_force (nil) fail if the repository is not registered
+        #       (`--no-force`)
+        #
+        #     @option options [Hash] :env (nil) environment variables to set for the git
+        #       process; merged with the default environment; not passed to the git CLI
+        #
+        #     @return [Git::CommandLine::Result] the result of calling `git maintenance unregister`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @raise [Git::VersionError] if git version is below 2.30.0
+        #
+        #     @api public
+      end
+    end
+  end
+end

data/lib/git/commands/maintenance.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'maintenance/register'
+require_relative 'maintenance/run'
+require_relative 'maintenance/start'
+require_relative 'maintenance/stop'
+require_relative 'maintenance/unregister'
+
+module Git
+  module Commands
+    # Implements `git maintenance` subcommands for repository optimization
+    #
+    # Split into subclasses because each subcommand has a distinct purpose
+    # and option set:
+    #
+    # - {Maintenance::Run} — run one or more maintenance tasks
+    # - {Maintenance::Start} — initialize and start background maintenance
+    # - {Maintenance::Stop} — halt the background maintenance schedule
+    # - {Maintenance::Register} — add repository to maintenance config
+    # - {Maintenance::Unregister} — remove repository from maintenance config
+    #
+    # All subcommands require Git 2.30.0 or later.
+    #
+    # @see https://git-scm.com/docs/git-maintenance git-maintenance documentation
+    #
+    # @api private
+    #
+    module Maintenance
+    end
+  end
+end

data/lib/git/commands/merge/abort.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Merge
+      # Implements `git merge --abort` to abort an in-progress merge
+      #
+      # Aborts the current merge and reconstructs the pre-merge state.
+      # If an autostash entry is present, applies it to the worktree.
+      #
+      # @example Abort a merge
+      #   abort_cmd = Git::Commands::Merge::Abort.new(execution_context)
+      #   abort_cmd.call
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-merge/2.53.0
+      #
+      # @see Git::Commands::Merge
+      #
+      # @see https://git-scm.com/docs/git-merge git-merge
+      #
+      # @api private
+      #
+      class Abort < Git::Commands::Base
+        arguments do
+          literal 'merge'
+          literal '--abort'
+        end
+
+        # @!method call()
+        #
+        #   @overload call()
+        #
+        #     Abort the current merge and reconstruct the pre-merge state
+        #
+        #     @return [Git::CommandLine::Result] the result of calling
+        #       `git merge --abort`
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/merge/continue.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Merge
+      # Implements `git merge --continue` to complete a merge after conflict resolution
+      #
+      # After the user has resolved conflicts and staged the changes, the
+      # merge can be concluded with this command.
+      #
+      # @example Continue after resolving conflicts
+      #   continue_cmd = Git::Commands::Merge::Continue.new(execution_context)
+      #   continue_cmd.call
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-merge/2.53.0
+      #
+      # @see Git::Commands::Merge
+      #
+      # @see https://git-scm.com/docs/git-merge git-merge
+      #
+      # @api private
+      #
+      class Continue < Git::Commands::Base
+        arguments do
+          literal 'merge'
+          literal '--continue'
+        end
+
+        # @!method call()
+        #
+        #   @overload call()
+        #
+        #     Resume the in-progress merge after conflicts have been resolved
+        #
+        #     @return [Git::CommandLine::Result] the result of calling
+        #       `git merge --continue`
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/merge/quit.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Merge
+      # Implements `git merge --quit` to quit an in-progress merge
+      #
+      # Forgets about the current merge in progress. Leaves the index and
+      # working tree as-is. If an autostash entry is present, saves it to
+      # the stash list.
+      #
+      # @example Quit the merge, leaving working tree as-is
+      #   quit_cmd = Git::Commands::Merge::Quit.new(execution_context)
+      #   quit_cmd.call
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-merge/2.53.0
+      #
+      # @see Git::Commands::Merge
+      #
+      # @see https://git-scm.com/docs/git-merge git-merge
+      #
+      # @api private
+      #
+      class Quit < Git::Commands::Base
+        arguments do
+          literal 'merge'
+          literal '--quit'
+        end
+
+        # @!method call()
+        #
+        #   @overload call()
+        #
+        #     Forget about the current merge in progress, leaving the index
+        #     and working tree as-is
+        #
+        #     @return [Git::CommandLine::Result] the result of calling
+        #       `git merge --quit`
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/merge/start.rb

@@ -0,0 +1,250 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module Merge
+      # Implements `git merge` to incorporate changes from named commits
+      #
+      # Joins two or more development histories together by incorporating
+      # changes from the named commits into the current branch.
+      #
+      # @example Simple merge
+      #   merge = Git::Commands::Merge::Start.new(execution_context)
+      #   merge.call('feature')
+      #
+      # @example Merge with no fast-forward
+      #   merge.call('feature', ff: false, m: 'Merge feature branch')
+      #
+      # @example Squash merge
+      #   merge.call('feature', squash: true)
+      #
+      # @example Merge with strategy option
+      #   merge.call('feature', strategy: 'ort', strategy_option: 'theirs')
+      #
+      # @example Octopus merge (multiple branches)
+      #   merge.call('branch1', 'branch2', 'branch3')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-merge/2.53.0
+      #
+      # @see Git::Commands::Merge
+      #
+      # @see https://git-scm.com/docs/git-merge git-merge
+      #
+      # @api private
+      #
+      class Start < Git::Commands::Base
+        arguments do
+          literal 'merge'
+
+          # Commit behavior
+          flag_option :commit, negatable: true
+          flag_option %i[edit e], negatable: true
+
+          # Commit message cleanup
+          value_option :cleanup, inline: true
+
+          # Fast-forward behavior
+          flag_option :ff, negatable: true
+          flag_option :ff_only
+
+          # Signing
+          flag_or_value_option %i[gpg_sign S], negatable: true, inline: true
+
+          # Log message
+          flag_or_value_option :log, negatable: true, inline: true
+
+          # Trailers
+          flag_option :signoff, negatable: true
+
+          # Stat display
+          flag_option :stat, negatable: true
+          flag_option :compact_summary
+
+          # Squash
+          flag_option :squash
+
+          # Verification
+          flag_option :verify, negatable: true
+
+          # Strategy options
+          value_option %i[strategy s], inline: true
+          value_option %i[strategy_option X], inline: true, repeatable: true
+
+          # Signature verification
+          flag_option :verify_signatures, negatable: true
+
+          # Verbosity and progress
+          flag_option %i[quiet q]
+          flag_option %i[verbose v]
+          flag_option :progress, negatable: true
+
+          # Stash and history
+          flag_option :autostash, negatable: true
+          flag_option :allow_unrelated_histories, negatable: true
+
+          # Message options
+          value_option :m
+          value_option :into_name
+          value_option %i[file F], inline: true
+
+          # Conflict resolution
+          flag_option :rerere_autoupdate, negatable: true
+          flag_option :overwrite_ignore, negatable: true
+
+          end_of_options
+
+          # Positional: commits to merge (variadic, required)
+          operand :commit, repeatable: true, required: true
+        end
+
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :commit (nil) command option key; see overload
+        #     docs for the full option list
+        #
+        #   @overload call(*commit, **options)
+        #
+        #     Execute the git merge command
+        #
+        #     @param commit [Array<String>] one or more branch names, commit SHAs,
+        #       or refs to merge into the current branch; multiple commits create
+        #       an octopus merge
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :commit (nil) perform merge and commit the result (`--commit`)
+        #
+        #     @option options [Boolean, nil] :no_commit (nil) do not perform a merge commit (`--no-commit`)
+        #
+        #     @option options [Boolean, nil] :edit (nil) open an editor for the merge commit message (`--edit`)
+        #
+        #       Alias: `:e`
+        #
+        #     @option options [Boolean, nil] :no_edit (nil) skip the editor for the merge commit message (`--no-edit`)
+        #
+        #     @option options [String] :cleanup (nil) how the merge message will be cleaned
+        #       up before committing
+        #
+        #       Accepted values include `strip`, `whitespace`, `verbatim`,
+        #       `scissors`, and `default`. Emits `--cleanup=<mode>`.
+        #
+        #     @option options [Boolean, nil] :ff (nil) allow fast-forward merges (`--ff`)
+        #
+        #     @option options [Boolean, nil] :no_ff (nil) create a merge commit even when fast-forward is
+        #       possible (`--no-ff`)
+        #
+        #     @option options [Boolean, nil] :ff_only (nil) refuse to merge unless
+        #       fast-forward is possible; emits `--ff-only`
+        #
+        #     @option options [Boolean, String, nil] :gpg_sign (nil) GPG-sign the resulting
+        #       merge commit (`--gpg-sign`)
+        #
+        #       Pass a key ID string to select the signing key; pass `true` to use the
+        #       committer identity. Alias: `:S`
+        #
+        #     @option options [Boolean, nil] :no_gpg_sign (nil) countermand commit.gpgSign
+        #       configuration (`--no-gpg-sign`)
+        #
+        #     @option options [Boolean, Integer, nil] :log (nil) populate the merge message
+        #       with one-line commit descriptions (`--log`)
+        #
+        #       Pass an Integer `n` to limit to `n` entries (`--log=<n>`).
+        #
+        #     @option options [Boolean, nil] :no_log (nil) do not list one-line commit descriptions
+        #       (`--no-log`)
+        #
+        #     @option options [Boolean, nil] :signoff (nil) add a Signed-off-by trailer to the commit
+        #       message (`--signoff`)
+        #
+        #     @option options [Boolean, nil] :no_signoff (nil) remove a Signed-off-by trailer from the
+        #       commit message (`--no-signoff`)
+        #
+        #     @option options [Boolean, nil] :stat (nil) show a diffstat at the end of the merge (`--stat`)
+        #
+        #     @option options [Boolean, nil] :no_stat (nil) suppress the diffstat at the end of the merge (`--no-stat`)
+        #
+        #     @option options [Boolean, nil] :compact_summary (nil) show a compact summary
+        #       at the end of the merge; emits `--compact-summary`
+        #
+        #     @option options [Boolean, nil] :squash (nil) produce working tree and index
+        #       state as if a real merge happened, but do not commit; emits `--squash`
+        #
+        #     @option options [Boolean, nil] :verify (nil) run pre-merge and commit-msg hooks (`--verify`)
+        #
+        #     @option options [Boolean, nil] :no_verify (nil) bypass pre-merge and commit-msg hooks (`--no-verify`)
+        #
+        #     @option options [String] :strategy (nil) merge strategy to use
+        #       (e.g., `'ort'`, `'recursive'`, `'resolve'`, `'octopus'`, `'ours'`, `'subtree'`)
+        #
+        #       Emits `--strategy=<strategy>`. Alias: `:s`
+        #
+        #     @option options [String, Array<String>] :strategy_option (nil) pass
+        #       option(s) to the merge strategy (e.g., `'ours'`, `'theirs'`, `'patience'`)
+        #
+        #       Can be a single value or an array for multiple `--strategy-option` flags.
+        #       Emits `--strategy-option=<option>`. Alias: `:X`
+        #
+        #     @option options [Boolean, nil] :verify_signatures (nil) verify commit signatures
+        #       on the tip of the side branch (`--verify-signatures`)
+        #
+        #     @option options [Boolean, nil] :no_verify_signatures (nil) do not verify commit
+        #       signatures (`--no-verify-signatures`)
+        #
+        #     @option options [Boolean, nil] :quiet (nil) operate quietly; emits `--quiet`
+        #
+        #       Alias: `:q`
+        #
+        #     @option options [Boolean, nil] :verbose (nil) be verbose; emits `--verbose`
+        #
+        #       Alias: `:v`
+        #
+        #     @option options [Boolean, nil] :progress (nil) force progress status reporting (`--progress`)
+        #
+        #     @option options [Boolean, nil] :no_progress (nil) suppress progress status reporting (`--no-progress`)
+        #
+        #     @option options [Boolean, nil] :autostash (nil) automatically stash and unstash
+        #       the working tree before and after the operation (`--autostash`)
+        #
+        #     @option options [Boolean, nil] :no_autostash (nil) do not automatically stash and unstash
+        #       the working tree (`--no-autostash`)
+        #
+        #     @option options [Boolean, nil] :allow_unrelated_histories (nil) allow merging
+        #       histories that do not share a common ancestor (`--allow-unrelated-histories`)
+        #
+        #     @option options [Boolean, nil] :no_allow_unrelated_histories (nil) disallow merging
+        #       unrelated histories (`--no-allow-unrelated-histories`)
+        #
+        #     @option options [String] :m (nil) commit message for the merge commit;
+        #       emits `-m <msg>`
+        #
+        #     @option options [String] :into_name (nil) prepare the default merge message
+        #       as if merging to the named branch; emits `--into-name <branch>`
+        #
+        #     @option options [String] :file (nil) read the commit message from the given
+        #       file; emits `--file=<file>`. Alias: `:F`
+        #
+        #     @option options [Boolean, nil] :rerere_autoupdate (nil) allow rerere to update
+        #       the index with the auto-resolved conflict result (`--rerere-autoupdate`)
+        #
+        #     @option options [Boolean, nil] :no_rerere_autoupdate (nil) prevent rerere from
+        #       auto-updating the index (`--no-rerere-autoupdate`)
+        #
+        #     @option options [Boolean, nil] :overwrite_ignore (nil) silently overwrite ignored
+        #       files from the merge result (`--overwrite-ignore`)
+        #
+        #     @option options [Boolean, nil] :no_overwrite_ignore (nil) abort if the merge result
+        #       would overwrite any ignored files (`--no-overwrite-ignore`)
+        #
+        #     @return [Git::CommandLine::Result] the result of calling `git merge`
+        #
+        #     @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/merge.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'merge/abort'
+require_relative 'merge/continue'
+require_relative 'merge/quit'
+require_relative 'merge/start'
+
+module Git
+  module Commands
+    # Commands for joining development histories via `git merge`
+    #
+    # This module contains command classes for the initial merge ({Start}) and
+    # session management ({Continue}, {Abort}, {Quit}):
+    #
+    # - {Merge::Start} — merge one or more branches into the current branch
+    # - {Merge::Continue} — resume after resolving merge conflicts (`--continue`)
+    # - {Merge::Abort} — abort the in-progress merge (`--abort`)
+    # - {Merge::Quit} — forget the in-progress merge but leave the working tree
+    #   as-is (`--quit`)
+    #
+    # @see https://git-scm.com/docs/git-merge git-merge documentation
+    #
+    # @api private
+    #
+    module Merge
+    end
+  end
+end