git 4.3.2 → 5.0.0.beta.1

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # List all config entries
+      #
+      # Wraps `git config --list` to output all config entries visible
+      # from the current scope.
+      #
+      # @example List all config entries
+      #   cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
+      #   cmd.call
+      #
+      # @example List global config entries
+      #   cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
+      #   cmd.call(global: true)
+      #
+      # @example List entries from a specific file
+      #   cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
+      #   cmd.call(file: '/path/to/config')
+      #
+      # @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 List < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--list'
+
+          # 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
+
+          # Output modifiers
+          flag_option :show_origin
+          flag_option :show_scope
+          flag_option %i[null z]
+          flag_option :name_only
+
+          # Type constraint
+          value_option :type, inline: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(**options)
+        #
+        #     Execute the `git config --list` command
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) list only global config entries
+        #
+        #     @option options [Boolean, nil] :system (nil) list only system config entries
+        #
+        #     @option options [Boolean, nil] :local (nil) list only repository config entries
+        #
+        #     @option options [Boolean, nil] :worktree (nil) list only worktree config entries
+        #
+        #     @option options [String] :file (nil) list entries from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) list entries 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`)
+        #
+        #     @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
+        #
+        #     @option options [String] :type (nil) ensure values conform to the given type
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --list`
+        #
+        #     @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/remove_section.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Remove a config section
+      #
+      # Wraps `git config --remove-section` to remove an entire section
+      # from the config file.
+      #
+      # @example Remove a section
+      #   cmd = Git::Commands::ConfigOptionSyntax::RemoveSection.new(lib)
+      #   cmd.call('old-section')
+      #
+      # @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 RemoveSection < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--remove-section'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, **options)
+        #
+        #     Execute the `git config --remove-section` command
+        #
+        #     @param name [String] the section name to remove
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) remove from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) remove from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) remove from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) remove from worktree config
+        #
+        #     @option options [String] :file (nil) remove from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --remove-section`
+        #
+        #     @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/rename_section.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Rename a config section
+      #
+      # Wraps `git config --rename-section` to rename a section in the
+      # config file.
+      #
+      # @example Rename a section
+      #   cmd = Git::Commands::ConfigOptionSyntax::RenameSection.new(lib)
+      #   cmd.call('old-section', 'new-section')
+      #
+      # @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 RenameSection < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--rename-section'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # Operands
+          end_of_options
+          operand :old_name, required: true
+          operand :new_name, required: true
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(old_name, new_name, **options)
+        #
+        #     Execute the `git config --rename-section` command
+        #
+        #     @param old_name [String] the current section name
+        #
+        #     @param new_name [String] the new section name
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) operate on global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) operate on system config
+        #
+        #     @option options [Boolean, nil] :local (nil) operate on repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) operate on worktree config
+        #
+        #     @option options [String] :file (nil) operate on the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --rename-section`
+        #
+        #     @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/replace_all.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Replace all matching values for a config key
+      #
+      # Wraps `git config --replace-all` to replace all entries matching the
+      # given key and optional value regex with a new value.
+      #
+      # @example Replace all values for a key
+      #   cmd = Git::Commands::ConfigOptionSyntax::ReplaceAll.new(lib)
+      #   cmd.call('core.autocrlf', 'true')
+      #
+      # @example Replace values matching a pattern
+      #   cmd = Git::Commands::ConfigOptionSyntax::ReplaceAll.new(lib)
+      #   cmd.call('core.autocrlf', 'true', 'false')
+      #
+      # @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 ReplaceAll < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--replace-all'
+
+          # Write modifiers
+          value_option :comment
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # Value matching
+          flag_option :fixed_value
+
+          # Type constraint
+          value_option :type, inline: true
+          flag_option :no_type
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :value, required: true
+          operand :value_regex
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, value, value_regex = nil, **options)
+        #
+        #     Execute the `git config --replace-all` command
+        #
+        #     @param name [String] the config key name
+        #
+        #     @param value [String] the new value to set
+        #
+        #     @param value_regex [String, nil] (nil) optional regex to match existing values to replace
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) write to global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) write to system config
+        #
+        #     @option options [Boolean, nil] :local (nil) write to repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) write to worktree config
+        #
+        #     @option options [String] :file (nil) write to the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [String] :comment (nil) append a comment at the end of new or modified lines
+        #
+        #     @option options [Boolean, nil] :fixed_value (nil) treat the value regex as an exact string
+        #
+        #     @option options [String] :type (nil) ensure the value conforms to the given type
+        #
+        #     @option options [Boolean, nil] :no_type (nil) unset the previously set type specifier;
+        #       `true` emits `--no-type`
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --replace-all`
+        #
+        #     @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/set.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Set a config value
+      #
+      # Wraps the implicit `git config <name> <value>` set mode to assign
+      # a value to a config key, optionally replacing only the entry
+      # matching a value regex.
+      #
+      # @example Set a local config value
+      #   cmd = Git::Commands::ConfigOptionSyntax::Set.new(lib)
+      #   cmd.call('user.name', 'Alice')
+      #
+      # @example Set a global config value
+      #   cmd = Git::Commands::ConfigOptionSyntax::Set.new(lib)
+      #   cmd.call('user.name', 'Alice', global: true)
+      #
+      # @example Set a value with a type constraint
+      #   cmd = Git::Commands::ConfigOptionSyntax::Set.new(lib)
+      #   cmd.call('core.bare', 'true', 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 Set < Git::Commands::Base
+        arguments do
+          literal 'config'
+
+          # Write modifiers
+          flag_option :replace_all
+          flag_option :append
+          value_option :comment
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # Value matching
+          flag_option :fixed_value
+
+          # Type constraint
+          value_option :type, inline: true
+          flag_option :no_type
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :value, required: true
+          operand :value_regex
+        end
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, value, value_regex = nil, **options)
+        #
+        #     Execute the `git config <name> <value>` command
+        #
+        #     @param name [String] the config key name to set
+        #
+        #     @param value [String] the value to assign
+        #
+        #     @param value_regex [String, nil] (nil) optional regex to match the existing value to replace
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :replace_all (nil) replace all lines matching the key
+        #
+        #     @option options [Boolean, nil] :append (nil) add a new line without altering existing values
+        #
+        #     @option options [String] :comment (nil) append a comment at the end of new or modified lines
+        #
+        #     @option options [Boolean, nil] :global (nil) write to global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) write to system config
+        #
+        #     @option options [Boolean, nil] :local (nil) write to repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) write to worktree config
+        #
+        #     @option options [String] :file (nil) write to the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [Boolean, nil] :fixed_value (nil) treat the value regex as an exact string
+        #
+        #     @option options [String] :type (nil) ensure the value conforms to the given type
+        #
+        #     @option options [Boolean, nil] :no_type (nil) unset the previously set type specifier;
+        #       `true` emits `--no-type`
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config`
+        #
+        #     @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/unset.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Remove a single config entry
+      #
+      # Wraps `git config --unset` to remove the entry matching the given
+      # key name and optional value regex.
+      #
+      # @example Unset a config key
+      #   cmd = Git::Commands::ConfigOptionSyntax::Unset.new(lib)
+      #   cmd.call('user.name')
+      #
+      # @example Unset a global config key
+      #   cmd = Git::Commands::ConfigOptionSyntax::Unset.new(lib)
+      #   cmd.call('user.name', global: 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 Unset < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--unset'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # Value matching
+          flag_option :fixed_value
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :value_regex
+        end
+
+        # git config --unset exits 5 when trying to unset a non-existent or multi-valued key
+        allow_exit_status 0..5
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, value_regex = nil, **options)
+        #
+        #     Execute the `git config --unset` command
+        #
+        #     @param name [String] the config key name to unset
+        #
+        #     @param value_regex [String, nil] (nil) optional regex to match the value to remove
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) remove from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) remove from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) remove from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) remove from worktree config
+        #
+        #     @option options [String] :file (nil) remove from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [Boolean, nil] :fixed_value (nil) treat the value regex as an exact string
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --unset`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 5)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'git/commands/base'
+
+module Git
+  module Commands
+    module ConfigOptionSyntax
+      # Remove all matching config entries
+      #
+      # Wraps `git config --unset-all` to remove all entries matching the
+      # given key name and optional value regex.
+      #
+      # @example Unset all values for a key
+      #   cmd = Git::Commands::ConfigOptionSyntax::UnsetAll.new(lib)
+      #   cmd.call('remote.origin.fetch')
+      #
+      # @example Unset all values matching a pattern
+      #   cmd = Git::Commands::ConfigOptionSyntax::UnsetAll.new(lib)
+      #   cmd.call('core.gitproxy', 'for kernel.org$')
+      #
+      # @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 UnsetAll < Git::Commands::Base
+        arguments do
+          literal 'config'
+          literal '--unset-all'
+
+          # File-scope options
+          flag_option :global
+          flag_option :system
+          flag_option :local
+          flag_option :worktree
+          value_option %i[file f]
+          value_option :blob
+
+          # Value matching
+          flag_option :fixed_value
+
+          # Operands
+          end_of_options
+          operand :name, required: true
+          operand :value_regex
+        end
+
+        # git config --unset-all exits 5 when trying to unset a non-existent key
+        allow_exit_status 0..5
+
+        # @!method call(*, **)
+        #
+        #   @overload call(name, value_regex = nil, **options)
+        #
+        #     Execute the `git config --unset-all` command
+        #
+        #     @param name [String] the config key name to unset
+        #
+        #     @param value_regex [String, nil] (nil) optional regex to match values to remove
+        #
+        #     @param options [Hash] command options
+        #
+        #     @option options [Boolean, nil] :global (nil) remove from global config (`~/.gitconfig`)
+        #
+        #     @option options [Boolean, nil] :system (nil) remove from system config
+        #
+        #     @option options [Boolean, nil] :local (nil) remove from repository config (`.git/config`)
+        #
+        #     @option options [Boolean, nil] :worktree (nil) remove from worktree config
+        #
+        #     @option options [String] :file (nil) remove from the specified file
+        #
+        #       Alias: :f
+        #
+        #     @option options [String] :blob (nil) read from the specified blob
+        #
+        #     @option options [Boolean, nil] :fixed_value (nil) treat the value regex as an exact string
+        #
+        #     @return [Git::CommandLineResult] the result of calling `git config --unset-all`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
+        #
+        #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 5)
+      end
+    end
+  end
+end