git 1.19.1 → 5.5.0

data/lib/git/commands/checkout_index.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    # Implements the `git checkout-index` command
+    #
+    # This command copies all files listed in the index to the working directory
+    # (not overwriting existing files). It is typically used to populate a new
+    # working directory from the current index, optionally scoped to a specific
+    # path or prefix.
+    #
+    # @example Typical usage
+    #   checkout_index = Git::Commands::CheckoutIndex.new(execution_context)
+    #   checkout_index.call(all: true)
+    #   checkout_index.call(all: true, force: true)
+    #   checkout_index.call('path/to/file.txt')
+    #   checkout_index.call(all: true, prefix: 'output/')
+    #
+    # @note `arguments` block audited against https://git-scm.com/docs/git-checkout-index/2.53.0
+    #
+    # @see https://git-scm.com/docs/git-checkout-index git-checkout-index
+    #
+    # @see Git::Commands
+    #
+    # @api private
+    #
+    class CheckoutIndex < Git::Commands::Base
+      arguments do
+        literal 'checkout-index'
+        flag_option %i[index u]
+        flag_option %i[quiet q]
+        flag_option %i[all a]
+        flag_option %i[force f]
+        flag_option %i[no_create n]
+        value_option :prefix, inline: true
+        value_option :stage, inline: true
+        flag_option :temp
+        flag_option :ignore_skip_worktree_bits
+        end_of_options
+        operand :file, required: false, repeatable: true
+      end
+
+      # @overload call(*file, **options)
+      #
+      #     Execute the `git checkout-index` command
+      #
+      #     @param file [Array<String>] zero or more file paths to check out
+      #
+      #       When empty, no files are checked out individually (use `:all` to check
+      #       out everything).
+      #
+      #     @param options [Hash] command options
+      #
+      #     @option options [Boolean, nil] :index (nil) update stat information for the
+      #       checked out entries in the index file
+      #
+      #       Alias: `:u`
+      #
+      #     @option options [Boolean, nil] :quiet (nil) suppress messages when files
+      #       exist or are not in the index
+      #
+      #       Alias: `:q`
+      #
+      #     @option options [Boolean, nil] :all (nil) check out all files in the index
+      #
+      #       Alias: `:a`
+      #
+      #     @option options [Boolean, nil] :force (nil) force overwrite of existing files
+      #
+      #       Alias: `:f`
+      #
+      #     @option options [Boolean, nil] :no_create (nil) don't checkout new files,
+      #       only refresh files already checked out
+      #
+      #       Alias: `:n`
+      #
+      #     @option options [String] :prefix (nil) write file content under the given
+      #       directory prefix instead of the working directory root
+      #
+      #     @option options [String] :stage (nil) check out from the named stage
+      #
+      #       Pass `'1'`, `'2'`, or `'3'` for a specific stage number, or `'all'` to
+      #       check out all stages (automatically implies `--temp`).
+      #
+      #     @option options [Boolean, nil] :temp (nil) write file content to temporary
+      #       files near the target location instead of checking them out
+      #
+      #     @option options [Boolean, nil] :ignore_skip_worktree_bits (nil) check out
+      #       all files, including those with the skip-worktree bit set
+      #
+      #     @return [Git::CommandLine::Result] the result of calling `git checkout-index`
+      #
+      #     @raise [ArgumentError] if unsupported options are provided
+      #
+      #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      #   @api public
+      #
+      def call(*, **)
+        super
+      end
+    end
+  end
+end

data/lib/git/commands/clean.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    # Remove untracked files from the working tree
+    #
+    # Cleans the working tree by recursively removing files that are not under
+    # version control. Only files unknown to Git are removed by default; with
+    # `:x` also removes ignored files; with `:X` removes only ignored files.
+    #
+    # @example Typical usage
+    #   clean = Git::Commands::Clean.new(execution_context)
+    #   clean.call(force: true)
+    #   clean.call(force: true, d: true)
+    #   clean.call(force: 2)
+    #   clean.call(dry_run: true)
+    #   clean.call(force: true, exclude: '*.log')
+    #   clean.call(force: true, X: true)
+    #   clean.call(force: true, pathspec: ['tmp/', 'build/'])
+    #
+    # @note `arguments` block audited against https://git-scm.com/docs/git-clean/2.53.0
+    #
+    # @see Git::Commands
+    #
+    # @see https://git-scm.com/docs/git-clean git-clean
+    #
+    # @api private
+    #
+    class Clean < Git::Commands::Base
+      arguments do
+        literal 'clean'
+        flag_option :d
+        flag_option %i[force f], max_times: 2
+        flag_option %i[dry_run n]
+        flag_option %i[quiet q]
+        value_option %i[exclude e], inline: true, repeatable: true
+        flag_option :x
+        flag_option :X
+        execution_option :chdir
+        end_of_options
+        value_option :pathspec, as_operand: true, repeatable: true
+      end
+
+      # @overload call(**options)
+      #
+      #     Execute the git clean command
+      #
+      #     @param options [Hash] command options
+      #
+      #     @option options [Boolean, nil] :d (nil) recurse into untracked directories
+      #
+      #     @option options [Boolean, Integer, nil] :force (nil) force the removal of untracked files
+      #
+      #       When `clean.requireForce` is not set to `false`, git-clean will refuse to
+      #       delete files or directories unless this option is given.
+      #
+      #       Pass `true` or `1` to emit `--force` once. Pass `2` to emit `--force --force`,
+      #       which also removes untracked nested git repositories (directories with a
+      #       `.git` subdirectory).
+      #
+      #       Alias: `:f`
+      #
+      #     @option options [Boolean, nil] :dry_run (nil) don't actually remove anything, just
+      #       show what would be done
+      #
+      #       Alias: `:n`
+      #
+      #     @option options [Boolean, nil] :quiet (nil) be quiet, only report errors
+      #
+      #       Alias: `:q`
+      #
+      #     @option options [String, Array<String>] :exclude (nil) use the given exclude
+      #       pattern in addition to the standard ignore rules
+      #
+      #       May be specified multiple times. Alias: `:e`
+      #
+      #     @option options [Boolean, nil] :x (nil) don't use the standard ignore rules
+      #
+      #     @option options [Boolean, nil] :X (nil) remove only files ignored by Git
+      #
+      #     @option options [String, Array<String>] :pathspec (nil) limit cleaning to files
+      #       matching the given pathspec(s)
+      #
+      #     @option options [String, nil] :chdir (nil) change to this directory before
+      #       running git; not passed to the git CLI
+      #
+      #     @return [Git::CommandLine::Result] the result of calling `git clean`
+      #
+      #     @raise [ArgumentError] if unsupported options are provided
+      #
+      #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      #   @api public
+      #
+      def call(*, **)
+        super
+      end
+    end
+  end
+end

data/lib/git/commands/clone.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    # Implements the `git clone` command
+    #
+    # Clones a repository into a newly created directory.
+    #
+    # @example Typical usage
+    #   clone = Git::Commands::Clone.new(execution_context)
+    #   clone.call('https://github.com/user/repo.git')
+    #   clone.call('https://github.com/user/repo.git', 'local-dir')
+    #   clone.call('https://github.com/user/repo.git', 'local-dir', bare: true)
+    #   clone.call('https://github.com/user/repo.git', 'local-dir', depth: 1)
+    #
+    # @note `arguments` block audited against https://git-scm.com/docs/git-clone/2.53.0
+    #
+    # @see https://git-scm.com/docs/git-clone git-clone
+    #
+    # @see Git::Commands
+    #
+    # @api private
+    #
+    class Clone < Git::Commands::Base
+      arguments do
+        literal 'clone'
+        value_option :template, inline: true
+        flag_option %i[local l], negatable: true
+        flag_option %i[shared s]
+        flag_option :no_hardlinks
+        flag_option %i[quiet q]
+        flag_option %i[verbose v]
+        flag_option :progress
+        flag_option %i[no_checkout n]
+        flag_option :bare
+        flag_option :mirror
+        value_option %i[origin o]
+        value_option %i[branch b]
+        value_option :revision, inline: true
+        value_option %i[upload_pack u]
+        value_option :reference, repeatable: true
+        value_option :reference_if_able, repeatable: true
+        flag_option :dissociate
+        value_option :separate_git_dir, inline: true
+        value_option :server_option, inline: true, repeatable: true
+        value_option :depth
+        value_option :shallow_since, inline: true
+        value_option :shallow_exclude, inline: true, repeatable: true
+        flag_option :single_branch, negatable: true
+        flag_option :tags, negatable: true
+        flag_or_value_option :recurse_submodules, inline: true, repeatable: true
+        flag_option :shallow_submodules, negatable: true
+        flag_option :remote_submodules, negatable: true
+        value_option %i[jobs j]
+        flag_option :sparse
+        flag_option :reject_shallow, negatable: true
+        value_option :filter, inline: true
+        flag_option :also_filter_submodules
+        value_option %i[config c], repeatable: true
+        value_option :bundle_uri, inline: true
+        value_option :ref_format, inline: true
+        end_of_options
+        operand :repository, required: true
+        operand :directory
+        execution_option :timeout
+        execution_option :chdir
+      end
+
+      # @overload call(repository, directory = nil, **options)
+      #
+      #     Execute the `git clone` command
+      #
+      #     @param repository [String] the URL or path of the repository to clone
+      #
+      #     @param directory [String, nil] the directory to clone into; git derives the
+      #       name from the repository URL when omitted
+      #
+      #     @param options [Hash] command options
+      #
+      #     @option options [String] :template (nil) directory from which templates
+      #       will be used
+      #
+      #     @option options [Boolean, nil] :local (nil) bypass the normal Git-aware transport
+      #       for local clones (`--local`)
+      #
+      #       Alias: `:l`
+      #
+      #     @option options [Boolean, nil] :no_local (nil) disable the local optimization
+      #       and use the normal transport (`--no-local`)
+      #
+      #     @option options [Boolean, nil] :shared (nil) set up a shared clone using
+      #       alternates instead of hardlinks
+      #
+      #       Alias: `:s`
+      #
+      #     @option options [Boolean, nil] :no_hardlinks (nil) force file-copy instead of
+      #       hardlinks when cloning from a local filesystem
+      #
+      #     @option options [Boolean, nil] :quiet (nil) suppress progress output to stderr
+      #
+      #       Alias: `:q`
+      #
+      #     @option options [Boolean, nil] :verbose (nil) run verbosely
+      #
+      #       Alias: `:v`
+      #
+      #     @option options [Boolean, nil] :progress (nil) force progress status even when
+      #       stderr is not a terminal
+      #
+      #     @option options [Boolean, nil] :no_checkout (nil) skip checking out HEAD after
+      #       the clone
+      #
+      #       Alias: `:n`
+      #
+      #     @option options [Boolean, nil] :bare (nil) clone as a bare repository
+      #
+      #     @option options [Boolean, nil] :mirror (nil) set up a mirror clone (implies
+      #       --bare)
+      #
+      #     @option options [String] :origin (nil) name of the remote to use instead of
+      #       "origin"
+      #
+      #       Alias: `:o`
+      #
+      #     @option options [String] :branch (nil) branch to check out after cloning
+      #
+      #       Alias: `:b`
+      #
+      #     @option options [String] :revision (nil) detach HEAD at the given revision
+      #       after cloning; incompatible with :branch and :mirror
+      #
+      #     @option options [String] :upload_pack (nil) path to git-upload-pack on the
+      #       remote (ssh only)
+      #
+      #       Alias: `:u`
+      #
+      #     @option options [String, Array<String>] :reference (nil) borrow objects from
+      #       one or more reference repositories
+      #
+      #     @option options [String, Array<String>] :reference_if_able (nil) like
+      #       :reference but skip with a warning when the reference does not exist
+      #
+      #     @option options [Boolean, nil] :dissociate (nil) stop borrowing from reference
+      #       repositories after the clone is complete
+      #
+      #     @option options [String] :separate_git_dir (nil) place the git directory at
+      #       the given path and create a gitfile symlink in the working tree
+      #
+      #     @option options [String, Array<String>] :server_option (nil) protocol-v2
+      #       server options
+      #
+      #     @option options [Integer, String] :depth (nil) create a shallow clone with
+      #       the specified number of commits
+      #
+      #     @option options [String] :shallow_since (nil) create a shallow clone with
+      #       history after the specified date
+      #
+      #     @option options [String, Array<String>] :shallow_exclude (nil) exclude
+      #       commits reachable from the specified remote branch or tag
+      #
+      #     @option options [Boolean, nil] :single_branch (nil) clone only the history for
+      #       one branch (`--single-branch`)
+      #
+      #     @option options [Boolean, nil] :no_single_branch (nil) clone history for all
+      #       branches (`--no-single-branch`)
+      #
+      #     @option options [Boolean, nil] :tags (nil) include tags in the clone (`--tags`)
+      #
+      #     @option options [Boolean, nil] :no_tags (nil) exclude tags from the clone
+      #       (`--no-tags`)
+      #
+      #     @option options [Boolean, String, Array<String>, nil] :recurse_submodules (nil)
+      #       initialize submodules after cloning; pass true for all submodules or a
+      #       pathspec string/array for a subset
+      #
+      #     @option options [Boolean, nil] :shallow_submodules (nil) clone submodules with
+      #       depth 1 (`--shallow-submodules`)
+      #
+      #     @option options [Boolean, nil] :no_shallow_submodules (nil) clone submodules
+      #       with full history (`--no-shallow-submodules`)
+      #
+      #     @option options [Boolean, nil] :remote_submodules (nil) use submodule
+      #       remote-tracking branch status (`--remote-submodules`)
+      #
+      #     @option options [Boolean, nil] :no_remote_submodules (nil) use the locally
+      #       recorded SHA-1 for submodules (`--no-remote-submodules`)
+      #
+      #     @option options [Integer, String] :jobs (nil) number of submodules fetched
+      #       concurrently
+      #
+      #       Alias: `:j`
+      #
+      #     @option options [Boolean, nil] :sparse (nil) enable sparse checkout with
+      #       top-level files only
+      #
+      #     @option options [Boolean, nil] :reject_shallow (nil) fail if source is shallow
+      #       (`--reject-shallow`)
+      #
+      #     @option options [Boolean, nil] :no_reject_shallow (nil) allow cloning from
+      #       shallow sources (`--no-reject-shallow`)
+      #
+      #     @option options [String] :filter (nil) specify a partial clone filter
+      #       (e.g., 'blob:none', 'tree:0')
+      #
+      #     @option options [Boolean, nil] :also_filter_submodules (nil) apply the partial
+      #       clone filter to submodules; requires :filter and :recurse_submodules
+      #
+      #     @option options [String, Array<String>] :config (nil) set configuration
+      #       variables in the newly-created repository
+      #
+      #       Alias: `:c`
+      #
+      #     @option options [String] :bundle_uri (nil) fetch a bundle from the given URI
+      #       before fetching from the remote
+      #
+      #     @option options [String] :ref_format (nil) specify the ref storage format
+      #       (e.g., 'files', 'reftable')
+      #
+      #     @option options [Numeric, nil] :timeout (nil) the number of seconds to wait
+      #       for the command to complete; if nil, uses the global timeout from
+      #       {Git::Config}; if 0, no timeout is enforced
+      #
+      #     @option options [String, nil] :chdir (nil) the working directory in which to
+      #       run the git clone command
+      #
+      #     @return [Git::CommandLine::Result] the result of calling `git clone`
+      #
+      #     @raise [ArgumentError] if unsupported options are provided
+      #
+      #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      #   @api public
+      #
+      def call(*, **)
+        super
+      end
+    end
+  end
+end