git 4.3.2 → 5.0.0.beta.1

data/lib/git/commands/apply.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    # Implements `git apply` to apply a patch to files and/or to the index
+    #
+    # Reads the supplied diff output (a patch) and applies it to files.
+    # Without options, the command applies the patch only to working tree files.
+    # With `index: true`, the patch is also applied to the index.
+    # With `cached: true`, the patch is only applied to the index.
+    #
+    # @example Typical usage
+    #   apply = Git::Commands::Apply.new(execution_context)
+    #   apply.call('fix.patch')
+    #   apply.call('fix.patch', cached: true)
+    #   apply.call('fix.patch', check: true)
+    #   apply.call('fix.patch', reverse: true)
+    #
+    # @note `arguments` block audited against https://git-scm.com/docs/git-apply/2.53.0
+    #
+    # @see https://git-scm.com/docs/git-apply git-apply
+    #
+    # @see Git::Commands
+    #
+    # @api private
+    #
+    class Apply < Git::Commands::Base
+      arguments do
+        literal 'apply'
+
+        # Informational flags (turn off actual apply)
+        flag_option :stat
+        flag_option :numstat
+        flag_option :summary
+        flag_option :check
+
+        # Application mode
+        flag_option :index
+        flag_option %i[intent_to_add N]
+        flag_option :three_way, as: '--3way'
+
+        # 3-way merge conflict resolution
+        flag_option :ours
+        flag_option :theirs
+        flag_option :union
+
+        # Apply behavior
+        flag_option :apply
+        flag_option :no_add
+        value_option :build_fake_ancestor, inline: true
+        flag_option %i[reverse R]
+        flag_option %i[allow_binary_replacement binary]
+        flag_option :reject
+        flag_option :z
+
+        # Strip/context levels
+        value_option :p, inline: true
+        value_option :C, inline: true
+
+        # Patch parsing
+        flag_option :unidiff_zero
+        flag_option :inaccurate_eof
+        flag_option :recount
+
+        # Application scope
+        flag_option :cached
+
+        # Whitespace handling
+        flag_option :ignore_space_change
+        flag_option :ignore_whitespace
+        value_option :whitespace, inline: true
+
+        # Path filtering
+        value_option :exclude, inline: true
+        value_option :include, inline: true
+        value_option :directory, inline: true
+
+        # Verbosity
+        flag_option %i[verbose v]
+        flag_option %i[quiet q]
+        flag_option :unsafe_paths
+        flag_option :allow_empty
+
+        # Execution
+        execution_option :chdir
+
+        end_of_options
+        operand :patch, repeatable: true
+      end
+
+      # @!method call(*, **)
+      #
+      #   @overload call(*patch, **options)
+      #
+      #     Apply one or more patch files to the working tree or index
+      #
+      #     @param patch [Array<String>] zero or more patch file paths to apply;
+      #       omit to read from standard input
+      #
+      #     @param options [Hash] command options
+      #
+      #     @option options [Boolean, nil] :stat (nil) show diffstat for the input
+      #       instead of applying
+      #
+      #       Turns off apply mode.
+      #
+      #     @option options [Boolean, nil] :numstat (nil) show numeric diffstat for
+      #       the input instead of applying
+      #
+      #       Turns off apply mode. Output is in machine-friendly decimal format.
+      #
+      #     @option options [Boolean, nil] :summary (nil) show a condensed summary of
+      #       extended header information instead of applying
+      #
+      #       Turns off apply mode.
+      #
+      #     @option options [Boolean, nil] :check (nil) check whether the patch applies
+      #       cleanly without modifying any files
+      #
+      #       Turns off apply mode.
+      #
+      #     @option options [Boolean, nil] :index (nil) apply the patch to both the
+      #       index and the working tree
+      #
+      #     @option options [Boolean, nil] :intent_to_add (nil) mark new files added by
+      #       the patch for later addition to the index
+      #
+      #       Alias: `:N`
+      #
+      #     @option options [Boolean, nil] :three_way (nil) attempt a 3-way merge if
+      #       the patch does not apply cleanly (`--3way`)
+      #
+      #     @option options [Boolean, nil] :ours (nil) resolve 3-way conflicts by
+      #       favouring our side of the conflict
+      #
+      #       Requires `:three_way`.
+      #
+      #     @option options [Boolean, nil] :theirs (nil) resolve 3-way conflicts by
+      #       favouring their side of the conflict
+      #
+      #       Requires `:three_way`.
+      #
+      #     @option options [Boolean, nil] :union (nil) resolve 3-way conflicts by
+      #       including both sides of the conflict
+      #
+      #       Requires `:three_way`.
+      #
+      #     @option options [Boolean, nil] :apply (nil) re-enable the apply step even
+      #       when a "turns off apply" flag such as `:stat` is also given
+      #
+      #     @option options [Boolean, nil] :no_add (nil) ignore additions made by the
+      #       patch; apply only the deletions
+      #
+      #     @option options [String] :build_fake_ancestor (nil) path to a
+      #       temporary index file for building a fake ancestor from the embedded
+      #       blob identities in the patch
+      #
+      #     @option options [Boolean, nil] :reverse (nil) apply the patch in reverse
+      #
+      #       Alias: `:R`
+      #
+      #     @option options [Boolean, nil] :allow_binary_replacement (nil) allow
+      #       binary patch application (no-op in Git 2.28+)
+      #
+      #       Alias: `:binary`
+      #
+      #     @option options [Boolean, nil] :reject (nil) leave rejected hunks in
+      #       `.rej` files instead of aborting
+      #
+      #     @option options [Boolean, nil] :z (nil) use NUL-terminated output for
+      #       `--numstat` pathnames (`-z`)
+      #
+      #     @option options [Integer] :p (nil) strip this many leading path
+      #       components from traditional diff paths (`-p<n>`)
+      #
+      #     @option options [Integer] :C (nil) require at least this many lines
+      #       of surrounding context before and after each change (`-C<n>`)
+      #
+      #     @option options [Boolean, nil] :unidiff_zero (nil) bypass context-line
+      #       safety checks for diffs generated with `--unified=0`
+      #
+      #     @option options [Boolean, nil] :inaccurate_eof (nil) work around diffs
+      #       that do not correctly detect a missing newline at end of file
+      #
+      #     @option options [Boolean, nil] :recount (nil) infer hunk sizes from the
+      #       patch content rather than trusting the hunk header counts
+      #
+      #     @option options [Boolean, nil] :cached (nil) apply the patch only to the
+      #       index without touching the working tree
+      #
+      #     @option options [Boolean, nil] :ignore_space_change (nil) ignore changes
+      #       in the amount of whitespace in context lines
+      #
+      #     @option options [Boolean, nil] :ignore_whitespace (nil) ignore all
+      #       whitespace differences in context lines
+      #
+      #     @option options [String] :whitespace (nil) whitespace error handling
+      #       mode: `'nowarn'`, `'warn'`, `'fix'`, `'error'`, or `'error-all'`
+      #
+      #     @option options [String] :exclude (nil) skip changes to files
+      #       matching this path pattern
+      #
+      #     @option options [String] :include (nil) apply changes only to files
+      #       matching this path pattern
+      #
+      #     @option options [String] :directory (nil) prepend this root to all
+      #       filenames in the patch
+      #
+      #     @option options [Boolean, nil] :verbose (nil) report progress to stderr
+      #
+      #       Alias: `:v`
+      #
+      #     @option options [Boolean, nil] :quiet (nil) suppress stderr output
+      #
+      #       Alias: `:q`
+      #
+      #     @option options [Boolean, nil] :unsafe_paths (nil) override the safety
+      #       check that rejects patches affecting paths outside the working area
+      #
+      #     @option options [Boolean, nil] :allow_empty (nil) do not return an error
+      #       for patches containing no diff
+      #
+      #     @option options [String] :chdir (nil) change to this directory before
+      #       running git; not passed to the git CLI
+      #
+      #     @return [Git::CommandLineResult] the result of calling `git apply`
+      #
+      #     @raise [ArgumentError] if unsupported options are provided
+      #
+      #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      #     @api public
+    end
+  end
+end

data/lib/git/commands/archive/list_formats.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+require 'git/commands/archive'
+
+module Git
+  module Commands
+    class Archive
+      # Format lister for `git archive --list`
+      #
+      # Lists all available archive formats supported by the current git
+      # installation. This is a standalone mode of `git archive` that does not
+      # require a tree-ish operand.
+      #
+      # @example List available archive formats
+      #   cmd = Git::Commands::Archive::ListFormats.new(execution_context)
+      #   result = cmd.call
+      #   result.stdout  # => "tar\ntgz\ntar.gz\nzip\n"
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-archive/2.53.0
+      #
+      # @see Git::Commands::Archive Git::Commands::Archive for the full archive command interface
+      #
+      # @see https://git-scm.com/docs/git-archive git-archive documentation
+      #
+      # @api private
+      #
+      class ListFormats < Git::Commands::Base
+        arguments do
+          literal 'archive'
+          literal '--list'
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call
+        #
+        #     Execute `git archive --list` to show available formats.
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git archive --list`
+        #
+        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      end
+    end
+  end
+end

data/lib/git/commands/archive.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    # Archive creator for files from a named tree via `git archive`
+    #
+    # Produces an archive of the specified format containing the tree structure
+    # for the named tree, and writes it to stdout (or to a file when `out:` or
+    # `output:` is given). If `prefix:` is specified it is prepended to the
+    # filenames in the archive.
+    #
+    # @example Archive HEAD as a tar stream to a file
+    #   cmd = Git::Commands::Archive.new(execution_context)
+    #   File.open('release.tar', 'wb') do |f|
+    #     cmd.call('HEAD', format: 'tar', out: f)
+    #   end
+    #
+    # @example Archive a tag with a prefix
+    #   cmd = Git::Commands::Archive.new(execution_context)
+    #   cmd.call('v1.0', format: 'zip', prefix: 'myproject-1.0/', output: 'release.zip')
+    #
+    # @example Archive a subdirectory only
+    #   cmd = Git::Commands::Archive.new(execution_context)
+    #   cmd.call('HEAD', 'src/', format: 'tar', out: io)
+    #
+    # @note `arguments` block audited against https://git-scm.com/docs/git-archive/2.53.0
+    #
+    # @see Git::Commands
+    #
+    # @see https://git-scm.com/docs/git-archive git-archive
+    #
+    # @api private
+    #
+    class Archive < Base
+      arguments do
+        literal 'archive'
+        value_option :format, inline: true
+        flag_option %i[list l]
+        flag_option %i[verbose v]
+        value_option :prefix, inline: true
+        value_option %i[output o], inline: true
+        value_option :add_file, inline: true, repeatable: true
+        value_option :add_virtual_file, inline: true, repeatable: true
+        flag_option :worktree_attributes
+        value_option :mtime, inline: true
+        value_option :remote, inline: true
+        value_option :exec, inline: true
+        execution_option :out
+        conflicts :output, :out
+
+        end_of_options
+        operand :tree_ish
+        operand :path, repeatable: true
+      end
+
+      # @!method call(*, **)
+      #
+      #   @overload call(tree_ish = nil, *path, **options)
+      #
+      #     Execute the `git archive` command.
+      #
+      #     Archive output is binary. On the capturing path (no `out:` option),
+      #     `normalize` and `chomp` are disabled so stdout bytes are returned
+      #     unchanged. When `out:` is given, the streaming path is used.
+      #
+      #     @param tree_ish [String, nil] (nil) the tree or commit to produce an archive for;
+      #       omit when using the `:list` option to enumerate available formats
+      #
+      #     @param path [Array<String>] paths within the tree to include in the archive
+      #
+      #     @param options [Hash] command options
+      #
+      #     @option options [String] :format (nil) archive format — `tar`, `zip`, `tar.gz`,
+      #       `tgz`, or any format defined via `tar.<format>.command`
+      #
+      #     @option options [Boolean, nil] :list (nil) show all available archive formats
+      #
+      #       Alias: :l
+      #
+      #     @option options [Boolean, nil] :verbose (nil) report progress to stderr
+      #
+      #       Alias: :v
+      #
+      #     @option options [String] :prefix (nil) prepend `<prefix>/` to each filename
+      #       in the archive
+      #
+      #     @option options [String] :output (nil) write the archive to this file instead
+      #       of stdout
+      #
+      #       Alias: :o
+      #
+      #     @option options [String, Array<String>] :add_file (nil) add one or more
+      #       non-tracked files to the archive; may be passed multiple times
+      #
+      #     @option options [String, Array<String>] :add_virtual_file (nil) add one or
+      #       more virtual files by `<path>:<content>`; may be passed multiple times
+      #
+      #     @option options [Boolean, nil] :worktree_attributes (nil) look for attributes in
+      #       `.gitattributes` files in the working tree as well
+      #
+      #     @option options [String] :mtime (nil) set modification time of archive entries
+      #
+      #     @option options [String] :remote (nil) retrieve a tar archive from a remote
+      #       repository instead of the local one
+      #
+      #     @option options [String] :exec (nil) path to `git-upload-archive` on the remote
+      #       side; used with `:remote`
+      #
+      #     @option options [IO, #write] :out (nil) stream archive output to this IO object
+      #       instead of capturing it; the result's `.stdout` will be `''`
+      #
+      #     @return [Git::CommandLineResult] the result of calling `git archive`
+      #
+      #     @raise [ArgumentError] if unsupported options are provided
+      #
+      #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      #
+      #     @api public
+
+      # Archive output is intrinsically binary (tar, zip, etc.) — opt out of
+      # Ruby string normalization and trailing-newline chomping so that
+      # `result.stdout` bytes are returned unchanged. Only affects the
+      # capturing path; streaming via `out:` is never normalized or chomped
+      # regardless of these settings.
+      #
+      # @return [Boolean] `false`
+      #
+      def normalize_captured_stdout? = false
+
+      # Archive output is binary, so preserve captured stdout byte-for-byte
+      # even when it ends with a newline.
+      #
+      # @return [Boolean] `false`
+      #
+      def chomp_captured_stdout? = false
+    end
+  end
+end