git 1.19.1 → 5.5.0

data/lib/git/execution_context/repository.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'git/execution_context'
+
+module Git
+  class ExecutionContext
+    # Execution context for repository-bound git commands
+    #
+    # Manages the git environment for commands that operate within an existing
+    # repository — setting `GIT_DIR`, `GIT_WORK_TREE`, `GIT_INDEX_FILE`, and
+    # `GIT_SSH` — and prepending `--git-dir` / `--work-tree` to every git
+    # invocation via {#global_opts}.
+    #
+    # ### Construction
+    #
+    # Use {.from_hash} to build from a configuration hash:
+    #
+    #   context = Git::ExecutionContext::Repository.from_hash(repository: '/repo/.git', ...)
+    #
+    # @example Build from a configuration hash
+    #   context = Git::ExecutionContext::Repository.from_hash(
+    #     repository: '/path/to/.git',
+    #     working_directory: '/path/to'
+    #   )
+    #
+    # @api private
+    #
+    class Repository < ExecutionContext
+      # Creates a Repository context from a Hash
+      #
+      # Expected keys: `:repository`, `:working_directory`, `:index`, `:git_ssh`,
+      # `:binary_path`
+      #
+      # @example Build from a configuration hash
+      #   context = Git::ExecutionContext::Repository.from_hash(
+      #     repository: '/path/to/.git',
+      #     working_directory: '/path/to'
+      #   )
+      #
+      # @param base_hash [Hash] the hash of repository configuration values
+      #
+      # @param logger [Logger, nil] logger forwarded to the CommandLine layer;
+      #   `nil` uses a null logger (see {Git::ExecutionContext#initialize})
+      #
+      # @return [Git::ExecutionContext::Repository] the new repository context
+      #
+      def self.from_hash(base_hash, logger: nil)
+        new(
+          git_dir: base_hash[:repository],
+          git_index_file: base_hash[:index],
+          git_work_dir: base_hash[:working_directory],
+          git_ssh: base_hash.fetch(:git_ssh, :use_global_config),
+          binary_path: base_hash.fetch(:binary_path, :use_global_config),
+          logger: logger
+        )
+      end
+
+      # Creates a new repository execution context
+      #
+      # @example Create with required git_dir
+      #   Git::ExecutionContext::Repository.new(git_dir: '/path/to/.git')
+      #
+      # @param git_dir [String, nil] path to the `.git` directory
+      #
+      # @param git_work_dir [String, nil] path to the working tree
+      #
+      # @param git_index_file [String, nil] path to the index file
+      #
+      # @param binary_path [String, :use_global_config] path to the git binary
+      #
+      #   Give `:use_global_config` (the default) to use
+      #   `Git::Config.instance.binary_path`.
+      #
+      #   Passing `nil` raises `ArgumentError` — there is no "unset the
+      #   binary" semantic.
+      #
+      # @param git_ssh [String, nil, :use_global_config] the SSH wrapper path
+      #
+      #   Give `nil` to unset `GIT_SSH`, or `:use_global_config` (default)
+      #   to use `Git::Config.instance.git_ssh`.
+      #
+      # @param logger [Logger, nil] the logger to use in the CommandLine layer
+      #
+      #   Give `nil` to use a null logger (`Logger.new(nil)`).
+      #
+      # @raise [ArgumentError] if `binary_path` is `nil`
+      #
+      def initialize( # rubocop:disable Metrics/ParameterLists
+        git_dir:,
+        git_work_dir: nil,
+        git_index_file: nil,
+        binary_path: :use_global_config,
+        git_ssh: :use_global_config,
+        logger: nil
+      )
+        super(binary_path: binary_path, git_ssh: git_ssh, logger: logger)
+        @git_dir = git_dir
+        @git_work_dir = git_work_dir
+        @git_index_file = git_index_file
+      end
+
+      # @return [String, nil] path to the `.git` directory
+      attr_reader :git_dir
+
+      # @return [String, nil] path to the working tree
+      attr_reader :git_work_dir
+
+      # @return [String, nil] path to the index file
+      attr_reader :git_index_file
+
+      # Returns a new instance with the same configuration, applying `overrides`
+      #
+      # Uses raw stored values for `binary_path`, `git_ssh`, and `logger` so
+      # that `:use_global_config` sentinels are preserved across rebuilds and
+      # future changes to `Git.configure` continue to take effect.
+      #
+      # @param overrides [Hash] keyword arguments to override in the new instance
+      #
+      # @option overrides [String, nil] :git_dir path to the `.git` directory
+      #
+      # @option overrides [String, nil] :git_work_dir path to the working tree
+      #
+      # @option overrides [String, nil] :git_index_file path to the index file
+      #
+      # @option overrides [String, :use_global_config] :binary_path path to the git
+      #   binary
+      #
+      # @option overrides [String, nil, :use_global_config] :git_ssh the SSH
+      #   wrapper path
+      #
+      # @option overrides [Logger, nil] :logger the logger to use in the
+      #   CommandLine layer
+      #
+      # @return [Git::ExecutionContext::Repository] the new context
+      #
+      # @api private
+      #
+      def dup_with(**overrides)
+        self.class.new(
+          git_dir: @git_dir,
+          git_work_dir: @git_work_dir,
+          git_index_file: @git_index_file,
+          binary_path: @binary_path,
+          git_ssh: @git_ssh,
+          logger: @logger,
+          **overrides
+        )
+      end
+    end
+  end
+end