git 4.3.2 → 5.0.0.beta.1

data/lib/git/commands/config_option_syntax/get.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Retrieve a single config value by exact key name
+      #
+      # Wraps `git config --get` to return the value of the last-matching
+      # config entry for the given key name.
+      #
+      # @example Get a local config value
+      #   cmd = Git::Commands::ConfigOptionSyntax::Get.new(lib)
+      #   cmd.call('user.name')
+      #
+      # @example Get a global config value
+      #   cmd = Git::Commands::ConfigOptionSyntax::Get.new(lib)
+      #   cmd.call('user.name', global: true)
+      #
+      # @example Get a value with a type constraint
+      #   cmd = Git::Commands::ConfigOptionSyntax::Get.new(lib)
+      #   cmd.call('core.bare', type: 'bool')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
+      #
+      # @see Git::Commands::ConfigOptionSyntax
+      #
+      # @see https://git-scm.com/docs/git-config git-config documentation
+      #
+      # @api private
+      class Get < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--get'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # General read options
+          flag_option :includes, negatable: true
+
+          # Type constraint
+          value_option :type, inline: true
+
+          # Output modifiers
+          flag_option :show_origin
+          flag_option :show_scope
+          flag_option %i[null z]
+          value_option :default
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :value_regex
+        end
+
+        # git config --get exits 1 when the key is not found (not an error)
+        allow_exit_status 0..1
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, value_regex = nil, **options)
+        #
+        #     Execute the `git config --get` command
+        #
+        #     @param name [String] the config key name to look up
+        #
+        #     @param value_regex [String, nil] (nil) optional regex to filter the value
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) read from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) read from worktree config
+        #
+        #     @option options [String] :file (nil) read from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [Boolean, nil] :includes (nil) respect include directives in config files (`--includes`)
+        #
+        #     @option options [Boolean, nil] :no_includes (nil) do not respect include directives
+        #       in config files (`--no-includes`)
+        #
+        #     @option options [String] :type (nil) ensure the value conforms to the given type
+        #
+        #     @option options [Boolean, nil] :show_origin (nil) show the origin of the config value
+        #
+        #     @option options [Boolean, nil] :show_scope (nil) show the scope of the config value
+        #
+        #     @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
+        #
+        #       Alias: :z
+        #
+        #     @option options [String] :default (nil) default value when the key is not found
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --get`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits outside the allowed status range (0..1)
+      end
+    end
+  end
+end

data/lib/git/commands/config_option_syntax/get_all.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Retrieve all values for a multi-valued config key
+      #
+      # Wraps `git config --get-all` to return all values matching the given
+      # key name, one per line.
+      #
+      # @example Get all values for a key
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetAll.new(lib)
+      #   cmd.call('remote.origin.fetch')
+      #
+      # @example Get all values with a value pattern
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetAll.new(lib)
+      #   cmd.call('remote.origin.fetch', '\\+refs/heads/.*')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
+      #
+      # @see Git::Commands::ConfigOptionSyntax
+      #
+      # @see https://git-scm.com/docs/git-config git-config documentation
+      #
+      # @api private
+      class GetAll < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--get-all'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # General read options
+          flag_option :includes, negatable: true
+
+          # Type constraint
+          value_option :type, inline: true
+          flag_option :no_type
+
+          # Output modifiers
+          flag_option :show_origin
+          flag_option :show_scope
+          flag_option %i[null z]
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :value_regex
+        end
+
+        # git config --get-all exits 1 when the key is not found (not an error)
+        allow_exit_status 0..1
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, value_regex = nil, **options)
+        #
+        #     Execute the `git config --get-all` command
+        #
+        #     @param name [String] the config key name to look up
+        #
+        #     @param value_regex [String, nil] (nil) optional regex to filter values
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) read from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) read from worktree config
+        #
+        #     @option options [String] :file (nil) read from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [Boolean, nil] :includes (nil) follow include directives in config files
+        #       (`--includes`)
+        #
+        #     @option options [Boolean, nil] :no_includes (nil) suppress include directive processing
+        #       (`--no-includes`)
+        #
+        #     @option options [String] :type (nil) ensure values conform to the given type
+        #
+        #     @option options [Boolean, nil] :no_type (nil) unset the previously set type specifier;
+        #       `true` emits `--no-type`
+        #
+        #     @option options [Boolean, nil] :show_origin (nil) show the origin of each config value
+        #
+        #     @option options [Boolean, nil] :show_scope (nil) show the scope of each config value
+        #
+        #     @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
+        #
+        #       Alias: :z
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --get-all`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+      end
+    end
+  end
+end

data/lib/git/commands/config_option_syntax/get_color.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Retrieve an ANSI color string from config
+      #
+      # Wraps `git config --get-color` to look up a color configuration
+      # and output the ANSI escape sequence for that color.
+      #
+      # @example Get a color config value
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetColor.new(lib)
+      #   cmd.call('color.diff.new')
+      #
+      # @example Get a color config value with a default
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetColor.new(lib)
+      #   cmd.call('color.diff.new', 'green')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
+      #
+      # @see Git::Commands::ConfigOptionSyntax
+      #
+      # @see https://git-scm.com/docs/git-config git-config documentation
+      #
+      # @api private
+      #
+      class GetColor < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--get-color'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # General read options
+          flag_option :includes, negatable: true
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :default
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, default = nil, **options)
+        #
+        #     Execute the `git config --get-color` command
+        #
+        #     @param name [String] the color config key name to look up
+        #
+        #     @param default [String, nil] (nil) fallback color when the key is not set
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) read from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) read from worktree config
+        #
+        #     @option options [String] :file (nil) read from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [Boolean, nil] :includes (nil) respect include directives in config files
+        #       (`--includes`)
+        #
+        #     @option options [Boolean, nil] :no_includes (nil) suppress include directive processing
+        #       (`--no-includes`)
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --get-color`
+        #
+        #     @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/config_option_syntax/get_color_bool.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Query whether color output is enabled for a config key
+      #
+      # Wraps `git config --get-colorbool` to check whether color output
+      # should be used. This command has no subcommand equivalent even in
+      # git 2.46.0 — it exists only in the option-syntax interface.
+      #
+      # @example Query whether color is enabled for diff
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetColorBool.new(lib)
+      #   cmd.call('color.diff')
+      #
+      # @example Query with explicit stdout-is-tty hint
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetColorBool.new(lib)
+      #   cmd.call('color.diff', 'true')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
+      #
+      # @see Git::Commands::ConfigOptionSyntax
+      #
+      # @see https://git-scm.com/docs/git-config git-config documentation
+      #
+      # @api private
+      #
+      class GetColorBool < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--get-colorbool'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # General read options
+          flag_option :includes, negatable: true
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :stdout_is_tty
+        end
+
+        # git config --get-colorbool exits 0 for color=yes, 1 for color=no
+        allow_exit_status 0..1
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, stdout_is_tty = nil, **options)
+        #
+        #     Execute the `git config --get-colorbool` command
+        #
+        #     @param name [String] the color config key name to query
+        #
+        #     @param stdout_is_tty [String, nil] (nil) hint whether stdout is a TTY (`"true"` or `"false"`)
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) read from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) read from worktree config
+        #
+        #     @option options [String] :file (nil) read from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [Boolean, nil] :includes (nil) respect include directives in config files (`--includes`)
+        #
+        #     @option options [Boolean, nil] :no_includes (nil) disable include directive processing (`--no-includes`)
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --get-colorbool`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+      end
+    end
+  end
+end

data/lib/git/commands/config_option_syntax/get_regexp.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Retrieve config entries matching a name regex
+      #
+      # Wraps `git config --get-regexp` to return all config entries whose
+      # key name matches the given regular expression.
+      #
+      # @example Get all entries matching a pattern
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetRegexp.new(lib)
+      #   cmd.call('remote\..*\.url')
+      #
+      # @example Get matching entries with value filter
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetRegexp.new(lib)
+      #   cmd.call('remote\..*\.url', 'github')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
+      #
+      # @see Git::Commands::ConfigOptionSyntax
+      #
+      # @see https://git-scm.com/docs/git-config git-config
+      #
+      # @api private
+      #
+      class GetRegexp < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--get-regexp'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # General read options
+          flag_option :includes, negatable: true
+
+          # Type constraint
+          value_option :type, inline: true
+
+          # Output modifiers
+          flag_option :show_origin
+          flag_option :show_scope
+          flag_option %i[null z]
+          flag_option :name_only
+
+          # Operands
+          end_of_options
+          operand :name_regex, required: true
+          operand :value_regex
+        end
+
+        # git config --get-regexp exits 1 when no match is found (not an error)
+        allow_exit_status 0..1
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name_regex, value_regex = nil, **options)
+        #
+        #     Execute the `git config --get-regexp` command
+        #
+        #     @param name_regex [String] regex pattern to match config key names
+        #
+        #     @param value_regex [String, nil] optional regex to filter values
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) read from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) read from worktree config
+        #
+        #     @option options [String] :file (nil) read from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [Boolean, nil] :includes (nil) respect include directives in
+        #       config files (`--includes`)
+        #
+        #     @option options [Boolean, nil] :no_includes (nil) ignore include directives in
+        #       config files (`--no-includes`)
+        #
+        #     @option options [String] :type (nil) ensure values conform to the given type
+        #
+        #     @option options [Boolean, nil] :show_origin (nil) show the origin of each config entry
+        #
+        #     @option options [Boolean, nil] :show_scope (nil) show the scope of each config entry
+        #
+        #     @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
+        #
+        #       Alias: :z
+        #
+        #     @option options [Boolean, nil] :name_only (nil) output only the names of config keys
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --get-regexp`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+      end
+    end
+  end
+end

data/lib/git/commands/config_option_syntax/get_urlmatch.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Retrieve config values matching a URL
+      #
+      # Wraps `git config --get-urlmatch` to return config entries whose
+      # key name matches the given name and whose URL pattern matches the
+      # given URL.
+      #
+      # @example Get URL-matched config
+      #   cmd = Git::Commands::ConfigOptionSyntax::GetUrlmatch.new(lib)
+      #   cmd.call('http', 'https://example.com')
+      #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
+      #
+      # @see Git::Commands::ConfigOptionSyntax
+      #
+      # @see https://git-scm.com/docs/git-config git-config
+      #
+      # @api private
+      #
+      class GetUrlmatch < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--get-urlmatch'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # Type constraint
+          value_option :type, inline: true
+
+          # Output modifier
+          flag_option %i[null z]
+
+          # General read options
+          flag_option :includes, negatable: true
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :url, required: true
+        end
+
+        # git config --get-urlmatch exits 1 when no match is found (not an error)
+        allow_exit_status 0..1
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, url, **options)
+        #
+        #     Execute the `git config --get-urlmatch` command
+        #
+        #     @param name [String] the config key name (or section prefix) to look up
+        #
+        #     @param url [String] the URL to match against
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) read from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) read from worktree config
+        #
+        #     @option options [String] :file (nil) read from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [String] :type (nil) ensure values conform to the given type
+        #
+        #     @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
+        #
+        #       Alias: :z
+        #
+        #     @option options [Boolean, nil] :includes (nil) respect include directives in config files (`--includes`)
+        #
+        #     @option options [Boolean, nil] :no_includes (nil) disable include directives
+        #       in config files (`--no-includes`)
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --get-urlmatch`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+      end
+    end
+  end
+end