git 4.3.2 → 5.0.0.beta.2

data/lib/git/commands/write_tree.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    # Implements the `git write-tree` command
+    #
+    # Creates a tree object using the current index and prints the SHA-1 name of
+    # the new tree object to standard output. The index must be in a fully
+    # merged state.
+    #
+    # @example Write the current index as a tree object
+    #   write_tree = Git::Commands::WriteTree.new(execution_context)
+    #   result = write_tree.call
+    #   sha = result.stdout   # => "abc123..."
+    #
+    # @example Write only a subdirectory as a tree object
+    #   write_tree = Git::Commands::WriteTree.new(execution_context)
+    #   result = write_tree.call(prefix: 'lib/')
+    #
+    # @example Allow missing objects in the object database
+    #   write_tree = Git::Commands::WriteTree.new(execution_context)
+    #   result = write_tree.call(missing_ok: true)
+    #
+    # @note `arguments` block audited against https://git-scm.com/docs/git-write-tree/2.53.0
+    #
+    # @see https://git-scm.com/docs/git-write-tree git-write-tree
+    #
+    # @see Git::Commands
+    #
+    # @api private
+    #
+    class WriteTree < Git::Commands::Base
+      arguments do
+        literal 'write-tree'
+        flag_option :missing_ok
+        value_option :prefix, inline: true
+      end
+
+      # @!method call(*, **)
+      #
+      #   @overload call(**options)
+      #
+      #     Execute the `git write-tree` command
+      #
+      #     @param options [Hash] command options
+      #
+      #     @option options [Boolean, nil] :missing_ok (nil) disable the check that
+      #       all objects referenced by the directory exist in the object
+      #       database
+      #
+      #     @option options [String] :prefix (nil) write a tree object that
+      #       represents a subdirectory
+      #
+      #       The prefix path should end with `/` (e.g., `'lib/'`).
+      #
+      #     @return [Git::CommandLineResult] the result of calling `git write-tree`
+      #
+      #     @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.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative 'commands/base'
+require_relative 'commands/add'
+require_relative 'commands/am'
+require_relative 'commands/apply'
+require_relative 'commands/archive'
+require_relative 'commands/branch'
+require_relative 'commands/cat_file'
+require_relative 'commands/checkout'
+require_relative 'commands/checkout_index'
+require_relative 'commands/clean'
+require_relative 'commands/clone'
+require_relative 'commands/commit'
+require_relative 'commands/commit_tree'
+require_relative 'commands/config_option_syntax'
+require_relative 'commands/describe'
+require_relative 'commands/diff'
+require_relative 'commands/diff_files'
+require_relative 'commands/diff_index'
+require_relative 'commands/fetch'
+require_relative 'commands/fsck'
+require_relative 'commands/gc'
+require_relative 'commands/grep'
+require_relative 'commands/init'
+require_relative 'commands/log'
+require_relative 'commands/ls_files'
+require_relative 'commands/ls_remote'
+require_relative 'commands/ls_tree'
+require_relative 'commands/maintenance'
+require_relative 'commands/merge'
+require_relative 'commands/merge_base'
+require_relative 'commands/mv'
+require_relative 'commands/name_rev'
+require_relative 'commands/pull'
+require_relative 'commands/push'
+require_relative 'commands/read_tree'
+require_relative 'commands/remote'
+require_relative 'commands/repack'
+require_relative 'commands/reset'
+require_relative 'commands/rev_parse'
+require_relative 'commands/revert'
+require_relative 'commands/rm'
+require_relative 'commands/show'
+require_relative 'commands/show_ref'
+require_relative 'commands/stash'
+require_relative 'commands/status'
+require_relative 'commands/symbolic_ref'
+require_relative 'commands/tag'
+require_relative 'commands/update_ref'
+require_relative 'commands/version'
+require_relative 'commands/worktree'
+require_relative 'commands/write_tree'
+
+module Git
+  # Internal command layer for the git gem
+  #
+  # Each git operation is represented by a class within this namespace. Command
+  # classes define the CLI contract via the {Arguments} DSL, bind caller-supplied
+  # parameters to command-line flags and operands, execute the subprocess through
+  # {Git::CommandLine}, and return a raw {Git::CommandLineResult}.
+  #
+  # Commands do **not** parse output — that responsibility belongs to the
+  # {Git::Parsers} layer, orchestrated by the facade ({Git::Repository}).
+  #
+  # All classes in this namespace are internal (`@api private`). End users
+  # should interact with the public API on {Git::Repository} instead.
+  #
+  # ## Architecture
+  #
+  # ```
+  # Git::Repository (public API / facade — orchestrates commands + parsers)
+  #   └── Git::Commands::* (defines CLI API, binds args, executes)
+  #         └── Git::CommandLine (subprocess execution)
+  # ```
+  #
+  # Simple commands inherit from {Commands::Base} and only need an `arguments`
+  # block. Multi-mode git commands (e.g., `git branch`, `git stash`) are split
+  # into namespace modules with one class per mode.
+  #
+  # @api private
+  #
+  # @see Git::Commands::Base
+  # @see Git::Commands::Arguments
+  #
+  module Commands; end
+end

data/lib/git/config.rb

@@ -3,6 +3,23 @@
 module Git
   # The global configuration for this gem
   class Config
+    # Returns the process-wide singleton {Git::Config} instance
+    #
+    # All calls to {Git.configure}, {Git.config}, and the {Git::ExecutionContext}
+    # classes resolve global configuration through this method.
+    #
+    # @example Read the configured binary path
+    #   Git::Config.instance.binary_path  #=> "git"
+    #
+    # @example Mutate the singleton (same as Git.configure { |c| ... })
+    #   Git::Config.instance.binary_path = '/usr/local/bin/git'
+    #
+    # @return [Git::Config] the singleton config object
+    #
+    def self.instance
+      @instance ||= new
+    end
+
     attr_writer :binary_path, :git_ssh, :timeout
 
     def initialize

data/lib/git/config_entry_info.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Git
+  # Represents a single Git configuration entry
+  #
+  # Returned by {Git::Configuring} read operations such as {Git::Configuring#config_get},
+  # {Git::Configuring#config_get_all}, {Git::Configuring#config_list}, and their
+  # related methods.
+  #
+  # @example Create a ConfigEntryInfo
+  #   entry = Git::ConfigEntryInfo.new(
+  #     scope: 'local',
+  #     origin: 'file:.git/config',
+  #     key: 'remote.origin.url',
+  #     value: 'https://github.com/ruby-git/ruby-git'
+  #   )
+  #   entry.section    # => "remote"
+  #   entry.subsection # => "origin"
+  #   entry.variable   # => "url"
+  #
+  # @api public
+  #
+  # @!attribute [r] scope
+  #
+  #   The scope of the configuration entry
+  #
+  #   May be one of `"system"`, `"global"`, `"local"`, `"worktree"`, `"command"`,
+  #   `"file"`, or `"blob"`. The `"command"` scope is used for values supplied
+  #   via the command line (including default values from `--default`).
+  #
+  #   @return [String] the config scope string (e.g. `"local"`, `"global"`)
+  #
+  # @!attribute [r] origin
+  #
+  #   Where the configuration entry originates
+  #
+  #   The origin is in the format `<origin-type>:<actual-origin>` and is never
+  #   blank. The origin type prefix is one of `file:`, `blob:`, `command line:`,
+  #   or `standard input:`.
+  #
+  #   `nil` when the git command used to retrieve this entry does not support
+  #   `--show-origin` (currently only `--get-urlmatch`).
+  #
+  #   @return [String, nil] the origin path in the format `<type>:<path>`, or `nil`
+  #
+  # @!attribute [r] key
+  #
+  #   The full dotted key name of the configuration entry (e.g., `remote.origin.url`)
+  #
+  #   @return [String] the full dotted key name (e.g. `remote.origin.url`)
+  #
+  # @!attribute [r] value
+  #
+  #   The value of the configuration entry
+  #
+  #   @return [String] the string value of this entry
+  #
+  ConfigEntryInfo = Data.define(:scope, :origin, :key, :value) do
+    # Returns the section component of the key (everything before the first dot)
+    #
+    # Returns an empty string when the key contains no dot.
+    #
+    # @example Section component of a dotted key
+    #   entry.section # => "remote"
+    #
+    # @return [String] the section name, or an empty string when the key has no dot
+    #
+    def section = first_dot ? key[0...first_dot] : ''
+
+    # Returns the subsection component of the key (everything between the first and last dot)
+    #
+    # Returns an empty string when the key has zero or one dot (no subsection).
+    #
+    # @example Subsection component of a dotted key
+    #   entry.subsection # => "origin"
+    #
+    # @return [String] the subsection name, or an empty string when there is no subsection
+    #
+    def subsection = first_dot && first_dot != last_dot ? key[(first_dot + 1)...last_dot] : ''
+
+    # Returns the variable component of the key (everything after the last dot)
+    #
+    # Returns the full key when the key contains no dot.
+    #
+    # @example Variable component of a dotted key
+    #   entry.variable # => "url"
+    #
+    # @return [String] the variable name (everything after the last dot)
+    #
+    def variable = last_dot ? key[(last_dot + 1)..] : key
+
+    private
+
+    # Returns the index of the first dot in the key, or nil if none exists
+    #
+    # @return [Integer, nil] the zero-based index of the first dot, or `nil`
+    #
+    def first_dot = key.index('.')
+
+    # Returns the index of the last dot in the key, or nil if none exists
+    #
+    # @return [Integer, nil] the zero-based index of the last dot, or `nil`
+    #
+    def last_dot = key.rindex('.')
+  end
+end