git 4.4.6 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (275) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/CHANGELOG.md +348 -39
  4. data/CONTRIBUTING.md +1014 -144
  5. data/README.md +386 -504
  6. data/UPGRADING.md +1822 -0
  7. data/git.gemspec +102 -22
  8. data/lib/git/author_info.rb +65 -0
  9. data/lib/git/branch_delete_failure.rb +34 -0
  10. data/lib/git/branch_delete_result.rb +66 -0
  11. data/lib/git/branch_info.rb +237 -0
  12. data/lib/git/command_line/base.rb +247 -0
  13. data/lib/git/command_line/capturing.rb +308 -0
  14. data/lib/git/command_line/result.rb +88 -0
  15. data/lib/git/command_line/streaming.rb +236 -0
  16. data/lib/git/command_line.rb +45 -323
  17. data/lib/git/commands/add.rb +139 -0
  18. data/lib/git/commands/am/abort.rb +43 -0
  19. data/lib/git/commands/am/apply.rb +263 -0
  20. data/lib/git/commands/am/continue.rb +43 -0
  21. data/lib/git/commands/am/quit.rb +43 -0
  22. data/lib/git/commands/am/retry.rb +49 -0
  23. data/lib/git/commands/am/show_current_patch.rb +64 -0
  24. data/lib/git/commands/am/skip.rb +42 -0
  25. data/lib/git/commands/am.rb +33 -0
  26. data/lib/git/commands/apply.rb +242 -0
  27. data/lib/git/commands/archive/list_formats.rb +46 -0
  28. data/lib/git/commands/archive.rb +145 -0
  29. data/lib/git/commands/arguments.rb +4521 -0
  30. data/lib/git/commands/base.rb +522 -0
  31. data/lib/git/commands/branch/copy.rb +102 -0
  32. data/lib/git/commands/branch/create.rb +177 -0
  33. data/lib/git/commands/branch/delete.rb +88 -0
  34. data/lib/git/commands/branch/list.rb +178 -0
  35. data/lib/git/commands/branch/move.rb +102 -0
  36. data/lib/git/commands/branch/set_upstream.rb +86 -0
  37. data/lib/git/commands/branch/show_current.rb +49 -0
  38. data/lib/git/commands/branch/unset_upstream.rb +53 -0
  39. data/lib/git/commands/branch.rb +34 -0
  40. data/lib/git/commands/cat_file/batch.rb +385 -0
  41. data/lib/git/commands/cat_file/filtered.rb +105 -0
  42. data/lib/git/commands/cat_file/raw.rb +203 -0
  43. data/lib/git/commands/cat_file.rb +49 -0
  44. data/lib/git/commands/checkout/branch.rb +153 -0
  45. data/lib/git/commands/checkout/files.rb +116 -0
  46. data/lib/git/commands/checkout.rb +38 -0
  47. data/lib/git/commands/checkout_index.rb +106 -0
  48. data/lib/git/commands/clean.rb +102 -0
  49. data/lib/git/commands/clone.rb +241 -0
  50. data/lib/git/commands/commit.rb +273 -0
  51. data/lib/git/commands/commit_tree.rb +101 -0
  52. data/lib/git/commands/config_option_syntax/add.rb +86 -0
  53. data/lib/git/commands/config_option_syntax/get.rb +121 -0
  54. data/lib/git/commands/config_option_syntax/get_all.rb +118 -0
  55. data/lib/git/commands/config_option_syntax/get_color.rb +95 -0
  56. data/lib/git/commands/config_option_syntax/get_color_bool.rb +96 -0
  57. data/lib/git/commands/config_option_syntax/get_regexp.rb +119 -0
  58. data/lib/git/commands/config_option_syntax/get_urlmatch.rb +111 -0
  59. data/lib/git/commands/config_option_syntax/list.rb +111 -0
  60. data/lib/git/commands/config_option_syntax/remove_section.rb +79 -0
  61. data/lib/git/commands/config_option_syntax/rename_section.rb +83 -0
  62. data/lib/git/commands/config_option_syntax/replace_all.rb +109 -0
  63. data/lib/git/commands/config_option_syntax/set.rb +119 -0
  64. data/lib/git/commands/config_option_syntax/unset.rb +92 -0
  65. data/lib/git/commands/config_option_syntax/unset_all.rb +94 -0
  66. data/lib/git/commands/config_option_syntax.rb +56 -0
  67. data/lib/git/commands/describe.rb +156 -0
  68. data/lib/git/commands/diff.rb +657 -0
  69. data/lib/git/commands/diff_files.rb +519 -0
  70. data/lib/git/commands/diff_index.rb +499 -0
  71. data/lib/git/commands/fetch.rb +354 -0
  72. data/lib/git/commands/fsck.rb +138 -0
  73. data/lib/git/commands/gc.rb +134 -0
  74. data/lib/git/commands/grep.rb +339 -0
  75. data/lib/git/commands/init.rb +101 -0
  76. data/lib/git/commands/log.rb +634 -0
  77. data/lib/git/commands/ls_files.rb +195 -0
  78. data/lib/git/commands/ls_remote.rb +161 -0
  79. data/lib/git/commands/ls_tree.rb +135 -0
  80. data/lib/git/commands/maintenance/register.rb +73 -0
  81. data/lib/git/commands/maintenance/run.rb +105 -0
  82. data/lib/git/commands/maintenance/start.rb +67 -0
  83. data/lib/git/commands/maintenance/stop.rb +56 -0
  84. data/lib/git/commands/maintenance/unregister.rb +80 -0
  85. data/lib/git/commands/maintenance.rb +29 -0
  86. data/lib/git/commands/merge/abort.rb +44 -0
  87. data/lib/git/commands/merge/continue.rb +44 -0
  88. data/lib/git/commands/merge/quit.rb +46 -0
  89. data/lib/git/commands/merge/start.rb +250 -0
  90. data/lib/git/commands/merge.rb +28 -0
  91. data/lib/git/commands/merge_base.rb +91 -0
  92. data/lib/git/commands/mv.rb +82 -0
  93. data/lib/git/commands/name_rev.rb +119 -0
  94. data/lib/git/commands/pull.rb +382 -0
  95. data/lib/git/commands/push.rb +251 -0
  96. data/lib/git/commands/read_tree.rb +154 -0
  97. data/lib/git/commands/remote/add.rb +96 -0
  98. data/lib/git/commands/remote/get_url.rb +68 -0
  99. data/lib/git/commands/remote/list.rb +56 -0
  100. data/lib/git/commands/remote/prune.rb +63 -0
  101. data/lib/git/commands/remote/remove.rb +52 -0
  102. data/lib/git/commands/remote/rename.rb +76 -0
  103. data/lib/git/commands/remote/set_branches.rb +70 -0
  104. data/lib/git/commands/remote/set_head.rb +89 -0
  105. data/lib/git/commands/remote/set_url.rb +78 -0
  106. data/lib/git/commands/remote/set_url_add.rb +70 -0
  107. data/lib/git/commands/remote/set_url_delete.rb +71 -0
  108. data/lib/git/commands/remote/show.rb +77 -0
  109. data/lib/git/commands/remote/update.rb +79 -0
  110. data/lib/git/commands/remote.rb +42 -0
  111. data/lib/git/commands/repack.rb +281 -0
  112. data/lib/git/commands/reset.rb +154 -0
  113. data/lib/git/commands/rev_parse.rb +304 -0
  114. data/lib/git/commands/revert/abort.rb +45 -0
  115. data/lib/git/commands/revert/continue.rb +62 -0
  116. data/lib/git/commands/revert/quit.rb +47 -0
  117. data/lib/git/commands/revert/skip.rb +44 -0
  118. data/lib/git/commands/revert/start.rb +158 -0
  119. data/lib/git/commands/revert.rb +29 -0
  120. data/lib/git/commands/rm.rb +113 -0
  121. data/lib/git/commands/show.rb +632 -0
  122. data/lib/git/commands/show_ref/exclude_existing.rb +119 -0
  123. data/lib/git/commands/show_ref/exists.rb +75 -0
  124. data/lib/git/commands/show_ref/list.rb +149 -0
  125. data/lib/git/commands/show_ref/verify.rb +122 -0
  126. data/lib/git/commands/show_ref.rb +42 -0
  127. data/lib/git/commands/stash/apply.rb +81 -0
  128. data/lib/git/commands/stash/branch.rb +67 -0
  129. data/lib/git/commands/stash/clear.rb +43 -0
  130. data/lib/git/commands/stash/create.rb +60 -0
  131. data/lib/git/commands/stash/drop.rb +73 -0
  132. data/lib/git/commands/stash/list.rb +43 -0
  133. data/lib/git/commands/stash/pop.rb +87 -0
  134. data/lib/git/commands/stash/push.rb +112 -0
  135. data/lib/git/commands/stash/show.rb +158 -0
  136. data/lib/git/commands/stash/store.rb +72 -0
  137. data/lib/git/commands/stash.rb +38 -0
  138. data/lib/git/commands/status.rb +174 -0
  139. data/lib/git/commands/symbolic_ref/delete.rb +72 -0
  140. data/lib/git/commands/symbolic_ref/read.rb +99 -0
  141. data/lib/git/commands/symbolic_ref/update.rb +79 -0
  142. data/lib/git/commands/symbolic_ref.rb +38 -0
  143. data/lib/git/commands/tag/create.rb +142 -0
  144. data/lib/git/commands/tag/delete.rb +57 -0
  145. data/lib/git/commands/tag/list.rb +146 -0
  146. data/lib/git/commands/tag/verify.rb +71 -0
  147. data/lib/git/commands/tag.rb +26 -0
  148. data/lib/git/commands/update_ref/batch.rb +145 -0
  149. data/lib/git/commands/update_ref/delete.rb +90 -0
  150. data/lib/git/commands/update_ref/update.rb +103 -0
  151. data/lib/git/commands/update_ref.rb +42 -0
  152. data/lib/git/commands/version.rb +60 -0
  153. data/lib/git/commands/worktree/add.rb +139 -0
  154. data/lib/git/commands/worktree/list.rb +64 -0
  155. data/lib/git/commands/worktree/lock.rb +58 -0
  156. data/lib/git/commands/worktree/management_base.rb +51 -0
  157. data/lib/git/commands/worktree/move.rb +66 -0
  158. data/lib/git/commands/worktree/prune.rb +67 -0
  159. data/lib/git/commands/worktree/remove.rb +63 -0
  160. data/lib/git/commands/worktree/repair.rb +71 -0
  161. data/lib/git/commands/worktree/unlock.rb +47 -0
  162. data/lib/git/commands/worktree.rb +43 -0
  163. data/lib/git/commands/write_tree.rb +68 -0
  164. data/lib/git/commands.rb +88 -0
  165. data/lib/git/config.rb +64 -1
  166. data/lib/git/config_entry_info.rb +106 -0
  167. data/lib/git/configuring.rb +795 -0
  168. data/lib/git/detached_head_info.rb +57 -0
  169. data/lib/git/diff.rb +295 -12
  170. data/lib/git/diff_file_numstat_info.rb +31 -0
  171. data/lib/git/diff_file_patch_info.rb +136 -0
  172. data/lib/git/diff_file_raw_info.rb +129 -0
  173. data/lib/git/diff_info.rb +162 -0
  174. data/lib/git/diff_path_status.rb +80 -19
  175. data/lib/git/diff_result.rb +34 -0
  176. data/lib/git/diff_stats.rb +66 -14
  177. data/lib/git/dirstat_info.rb +102 -0
  178. data/lib/git/encoding_utils.rb +57 -1
  179. data/lib/git/errors.rb +107 -26
  180. data/lib/git/escaped_path.rb +55 -3
  181. data/lib/git/execution_context/global.rb +31 -0
  182. data/lib/git/execution_context/repository.rb +151 -0
  183. data/lib/git/execution_context.rb +559 -0
  184. data/lib/git/factories.rb +1049 -0
  185. data/lib/git/file_ref.rb +77 -0
  186. data/lib/git/fsck_object.rb +17 -9
  187. data/lib/git/fsck_result.rb +27 -16
  188. data/lib/git/log.rb +172 -65
  189. data/lib/git/object.rb +323 -108
  190. data/lib/git/parsers/branch.rb +240 -0
  191. data/lib/git/parsers/cat_file.rb +111 -0
  192. data/lib/git/parsers/config_entry.rb +110 -0
  193. data/lib/git/parsers/diff.rb +792 -0
  194. data/lib/git/parsers/fsck.rb +144 -0
  195. data/lib/git/parsers/grep.rb +42 -0
  196. data/lib/git/parsers/ls_remote.rb +79 -0
  197. data/lib/git/parsers/ls_tree.rb +58 -0
  198. data/lib/git/parsers/remote.rb +162 -0
  199. data/lib/git/parsers/stash.rb +292 -0
  200. data/lib/git/parsers/status.rb +251 -0
  201. data/lib/git/parsers/tag.rb +341 -0
  202. data/lib/git/parsers/worktree.rb +185 -0
  203. data/lib/git/path_resolver.rb +274 -0
  204. data/lib/git/remote_info.rb +203 -0
  205. data/lib/git/repository/branching.rb +796 -0
  206. data/lib/git/repository/committing.rb +221 -0
  207. data/lib/git/repository/context_helpers.rb +454 -0
  208. data/lib/git/repository/diffing.rb +743 -0
  209. data/lib/git/repository/inspecting.rb +252 -0
  210. data/lib/git/repository/logging.rb +410 -0
  211. data/lib/git/repository/maintenance.rb +65 -0
  212. data/lib/git/repository/merging.rb +429 -0
  213. data/lib/git/repository/object_operations.rb +1334 -0
  214. data/lib/git/repository/remote_operations.rb +772 -0
  215. data/lib/git/repository/shared_private.rb +120 -0
  216. data/lib/git/repository/staging.rb +409 -0
  217. data/lib/git/repository/stashing.rb +619 -0
  218. data/lib/git/repository/status_operations.rb +196 -0
  219. data/lib/git/repository/worktree_operations.rb +252 -0
  220. data/lib/git/repository.rb +204 -1
  221. data/lib/git/stash_info.rb +102 -0
  222. data/lib/git/status_file_info.rb +258 -0
  223. data/lib/git/status_info.rb +189 -0
  224. data/lib/git/system_call_guard.rb +95 -0
  225. data/lib/git/tag_delete_failure.rb +34 -0
  226. data/lib/git/tag_delete_result.rb +66 -0
  227. data/lib/git/tag_info.rb +99 -0
  228. data/lib/git/url.rb +12 -5
  229. data/lib/git/version.rb +111 -2
  230. data/lib/git/version_constraint.rb +85 -0
  231. data/lib/git/worktree_info.rb +128 -0
  232. data/lib/git.rb +319 -332
  233. metadata +318 -74
  234. data/.commitlintrc.yml +0 -38
  235. data/.github/copilot-instructions.md +0 -2733
  236. data/.github/issue_template.md +0 -15
  237. data/.github/pull_request_template.md +0 -17
  238. data/.github/workflows/continuous_integration.yml +0 -120
  239. data/.github/workflows/enforce_conventional_commits.yml +0 -29
  240. data/.github/workflows/experimental_continuous_integration.yml +0 -59
  241. data/.github/workflows/release.yml +0 -53
  242. data/.gitignore +0 -15
  243. data/.husky/commit-msg +0 -1
  244. data/.release-please-manifest.json +0 -3
  245. data/.rubocop.yml +0 -55
  246. data/.rubocop_todo.yml +0 -12
  247. data/Gemfile +0 -5
  248. data/Rakefile +0 -18
  249. data/lib/git/args_builder.rb +0 -111
  250. data/lib/git/author.rb +0 -16
  251. data/lib/git/base.rb +0 -1140
  252. data/lib/git/branch.rb +0 -423
  253. data/lib/git/branches.rb +0 -68
  254. data/lib/git/command_line_result.rb +0 -92
  255. data/lib/git/index.rb +0 -6
  256. data/lib/git/lib.rb +0 -2333
  257. data/lib/git/path.rb +0 -38
  258. data/lib/git/remote.rb +0 -39
  259. data/lib/git/stash.rb +0 -26
  260. data/lib/git/stashes.rb +0 -56
  261. data/lib/git/status.rb +0 -159
  262. data/lib/git/working_directory.rb +0 -6
  263. data/lib/git/worktree.rb +0 -39
  264. data/lib/git/worktrees.rb +0 -47
  265. data/package.json +0 -10
  266. data/redesign/1_architecture_existing.md +0 -66
  267. data/redesign/2_architecture_redesign.md +0 -130
  268. data/redesign/3_architecture_implementation.md +0 -138
  269. data/redesign/index.md +0 -34
  270. data/release-please-config.json +0 -36
  271. data/tasks/gem_tasks.rake +0 -10
  272. data/tasks/rubocop.rake +0 -12
  273. data/tasks/test.rake +0 -13
  274. data/tasks/test_gem.rake +0 -12
  275. data/tasks/yard.rake +0 -23
@@ -0,0 +1,101 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ # Implements the `git commit-tree` command
8
+ #
9
+ # Creates a new commit object based on the provided tree object and emits the
10
+ # new commit object id on stdout. The log message is provided via `-m` or `-F`
11
+ # options; multiple instances of either are concatenated as separate paragraphs.
12
+ #
13
+ # @example Typical usage
14
+ # commit_tree = Git::Commands::CommitTree.new(execution_context)
15
+ # commit_tree.call('abc123', m: 'Initial commit')
16
+ # commit_tree.call('abc123', p: %w[parent1 parent2], m: 'Merge')
17
+ # commit_tree.call('abc123', m: 'Signed', gpg_sign: true)
18
+ #
19
+ # @note `arguments` block audited against https://git-scm.com/docs/git-commit-tree/2.53.0
20
+ #
21
+ # @see Git::Commands
22
+ #
23
+ # @see https://git-scm.com/docs/git-commit-tree git-commit-tree
24
+ #
25
+ # @api private
26
+ #
27
+ class CommitTree < Git::Commands::Base
28
+ arguments do
29
+ literal 'commit-tree'
30
+
31
+ # Parent commits — each -p adds a parent object
32
+ value_option :p, repeatable: true
33
+
34
+ # GPG signing — -S[<keyid>] / --gpg-sign[=<keyid>] / --no-gpg-sign
35
+ flag_or_value_option %i[gpg_sign S], negatable: true, inline: true
36
+
37
+ # Commit log message paragraphs
38
+ value_option :m, repeatable: true, allow_empty: true
39
+
40
+ # Read commit log message from file(s)
41
+ value_option :F, repeatable: true
42
+
43
+ end_of_options
44
+
45
+ # The tree object to create a commit from
46
+ operand :tree, required: true
47
+ end
48
+
49
+ # @overload call(tree, **options)
50
+ #
51
+ # Execute the `git commit-tree` command
52
+ #
53
+ # @param tree [String] an existing tree object SHA
54
+ #
55
+ # @param options [Hash] command options
56
+ #
57
+ # @option options [String, Array<String>] :p (nil) parent commit
58
+ # object id(s)
59
+ #
60
+ # Each value adds a `-p <parent>` flag. A commit may have zero or
61
+ # more parents. With exactly one parent it is an ordinary commit;
62
+ # with more than one it is a merge commit. Initial (root) commits
63
+ # have no parents.
64
+ #
65
+ # @option options [Boolean, String, nil] :gpg_sign (nil) sign the
66
+ # commit with GPG (`--gpg-sign`)
67
+ #
68
+ # Pass a key-ID string to select the signing key; pass `true` to use
69
+ # the committer identity. Alias: `:S`
70
+ #
71
+ # @option options [Boolean, nil] :no_gpg_sign (nil) countermand commit.gpgSign
72
+ # configuration (`--no-gpg-sign`)
73
+ #
74
+ # @option options [String, Array<String>] :m (nil) a paragraph
75
+ # in the commit log message
76
+ #
77
+ # Can be given more than once; each message becomes its own paragraph.
78
+ #
79
+ # @option options [String, Array<String>] :F (nil) read the commit
80
+ # log message from the given file
81
+ #
82
+ # Use `"-"` to read from standard input. Can be given more than
83
+ # once; each file's content becomes its own paragraph.
84
+ #
85
+ # @return [Git::CommandLine::Result] the result of calling
86
+ # `git commit-tree`
87
+ #
88
+ # @raise [ArgumentError] if unsupported options are provided
89
+ #
90
+ # @raise [ArgumentError] if the tree operand is missing
91
+ #
92
+ # @raise [Git::FailedError] if git exits with a non-zero exit
93
+ # status
94
+ #
95
+ # @api public
96
+ def call(*, **)
97
+ super
98
+ end
99
+ end
100
+ end
101
+ end
@@ -0,0 +1,86 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Append a value to a multi-valued config key
9
+ #
10
+ # Wraps `git config --add` to add a new line to a config key without
11
+ # altering existing values.
12
+ #
13
+ # @example Add a value to a multi-valued key
14
+ # cmd = Git::Commands::ConfigOptionSyntax::Add.new(lib)
15
+ # cmd.call('remote.origin.fetch', '+refs/heads/*:refs/remotes/origin/*')
16
+ #
17
+ # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
18
+ #
19
+ # @see Git::Commands::ConfigOptionSyntax
20
+ #
21
+ # @see https://git-scm.com/docs/git-config git-config documentation
22
+ #
23
+ # @api private
24
+ #
25
+ class Add < Git::Commands::Base
26
+ arguments do
27
+ literal 'config'
28
+ literal '--add'
29
+
30
+ # File-scope options
31
+ flag_option :global
32
+ flag_option :system
33
+ flag_option :local
34
+ flag_option :worktree
35
+ value_option %i[file f]
36
+ value_option :blob
37
+
38
+ # Type constraint
39
+ value_option :type, inline: true
40
+
41
+ # Operands
42
+ end_of_options
43
+ operand :name, required: true
44
+ operand :value, required: true
45
+ end
46
+
47
+ # @overload call(name, value, **options)
48
+ #
49
+ # Execute the `git config --add` command
50
+ #
51
+ # @param name [String] the config key name
52
+ #
53
+ # @param value [String] the value to append
54
+ #
55
+ # @param options [Hash] command options
56
+ #
57
+ # @option options [Boolean, nil] :global (nil) write to global config (`~/.gitconfig`)
58
+ #
59
+ # @option options [Boolean, nil] :system (nil) write to system config
60
+ #
61
+ # @option options [Boolean, nil] :local (nil) write to repository config (`.git/config`)
62
+ #
63
+ # @option options [Boolean, nil] :worktree (nil) write to worktree config
64
+ #
65
+ # @option options [String] :file (nil) write to the specified file
66
+ #
67
+ # Alias: :f
68
+ #
69
+ # @option options [String] :blob (nil) read from the specified blob
70
+ #
71
+ # @option options [String] :type (nil) ensure the value conforms to the given type
72
+ #
73
+ # @return [Git::CommandLine::Result] the result of calling `git config --add`
74
+ #
75
+ # @raise [ArgumentError] if unsupported options are provided
76
+ #
77
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
78
+ #
79
+ # @api public
80
+ def call(*, **)
81
+ super
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,121 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Retrieve a single config value by exact key name
9
+ #
10
+ # Wraps `git config --get` to return the value of the last-matching
11
+ # config entry for the given key name.
12
+ #
13
+ # @example Get a local config value
14
+ # cmd = Git::Commands::ConfigOptionSyntax::Get.new(lib)
15
+ # cmd.call('user.name')
16
+ #
17
+ # @example Get a global config value
18
+ # cmd = Git::Commands::ConfigOptionSyntax::Get.new(lib)
19
+ # cmd.call('user.name', global: true)
20
+ #
21
+ # @example Get a value with a type constraint
22
+ # cmd = Git::Commands::ConfigOptionSyntax::Get.new(lib)
23
+ # cmd.call('core.bare', type: 'bool')
24
+ #
25
+ # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
26
+ #
27
+ # @see Git::Commands::ConfigOptionSyntax
28
+ #
29
+ # @see https://git-scm.com/docs/git-config git-config documentation
30
+ #
31
+ # @api private
32
+ class Get < Git::Commands::Base
33
+ arguments do
34
+ literal 'config'
35
+ literal '--get'
36
+
37
+ # File-scope options
38
+ flag_option :global
39
+ flag_option :system
40
+ flag_option :local
41
+ flag_option :worktree
42
+ value_option %i[file f]
43
+ value_option :blob
44
+
45
+ # General read options
46
+ flag_option :includes, negatable: true
47
+
48
+ # Type constraint
49
+ value_option :type, inline: true
50
+
51
+ # Output modifiers
52
+ flag_option :show_origin
53
+ flag_option :show_scope
54
+ flag_option %i[null z]
55
+ value_option :default
56
+
57
+ # Operands
58
+ end_of_options
59
+ operand :name, required: true
60
+ operand :value_regex
61
+ end
62
+
63
+ # git config --get exits 1 when the key is not found (not an error)
64
+ allow_exit_status 0..1
65
+
66
+ # @overload call(name, value_regex = nil, **options)
67
+ #
68
+ # Execute the `git config --get` command
69
+ #
70
+ # @param name [String] the config key name to look up
71
+ #
72
+ # @param value_regex [String, nil] (nil) optional regex to filter the value
73
+ #
74
+ # @param options [Hash] command options
75
+ #
76
+ # @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
77
+ #
78
+ # @option options [Boolean, nil] :system (nil) read from system config
79
+ #
80
+ # @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
81
+ #
82
+ # @option options [Boolean, nil] :worktree (nil) read from worktree config
83
+ #
84
+ # @option options [String] :file (nil) read from the specified file
85
+ #
86
+ # Alias: :f
87
+ #
88
+ # @option options [String] :blob (nil) read from the specified blob
89
+ #
90
+ # @option options [Boolean, nil] :includes (nil) respect include directives in config files (`--includes`)
91
+ #
92
+ # @option options [Boolean, nil] :no_includes (nil) do not respect include directives
93
+ # in config files (`--no-includes`)
94
+ #
95
+ # @option options [String] :type (nil) ensure the value conforms to the given type
96
+ #
97
+ # @option options [Boolean, nil] :show_origin (nil) show the origin of the config value
98
+ #
99
+ # @option options [Boolean, nil] :show_scope (nil) show the scope of the config value
100
+ #
101
+ # @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
102
+ #
103
+ # Alias: :z
104
+ #
105
+ # @option options [String] :default (nil) default value when the key is not found
106
+ #
107
+ # @return [Git::CommandLine::Result] the result of calling `git config --get`
108
+ #
109
+ # @raise [ArgumentError] if unsupported options are provided
110
+ #
111
+ # @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
112
+ #
113
+ # @api public
114
+ #
115
+ def call(*, **)
116
+ super
117
+ end
118
+ end
119
+ end
120
+ end
121
+ end
@@ -0,0 +1,118 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Retrieve all values for a multi-valued config key
9
+ #
10
+ # Wraps `git config --get-all` to return all values matching the given
11
+ # key name, one per line.
12
+ #
13
+ # @example Get all values for a key
14
+ # cmd = Git::Commands::ConfigOptionSyntax::GetAll.new(lib)
15
+ # cmd.call('remote.origin.fetch')
16
+ #
17
+ # @example Get all values with a value pattern
18
+ # cmd = Git::Commands::ConfigOptionSyntax::GetAll.new(lib)
19
+ # cmd.call('remote.origin.fetch', '\\+refs/heads/.*')
20
+ #
21
+ # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
22
+ #
23
+ # @see Git::Commands::ConfigOptionSyntax
24
+ #
25
+ # @see https://git-scm.com/docs/git-config git-config documentation
26
+ #
27
+ # @api private
28
+ class GetAll < Git::Commands::Base
29
+ arguments do
30
+ literal 'config'
31
+ literal '--get-all'
32
+
33
+ # File-scope options
34
+ flag_option :global
35
+ flag_option :system
36
+ flag_option :local
37
+ flag_option :worktree
38
+ value_option %i[file f]
39
+ value_option :blob
40
+
41
+ # General read options
42
+ flag_option :includes, negatable: true
43
+
44
+ # Type constraint
45
+ value_option :type, inline: true
46
+ flag_option :no_type
47
+
48
+ # Output modifiers
49
+ flag_option :show_origin
50
+ flag_option :show_scope
51
+ flag_option %i[null z]
52
+
53
+ # Operands
54
+ end_of_options
55
+ operand :name, required: true
56
+ operand :value_regex
57
+ end
58
+
59
+ # git config --get-all exits 1 when the key is not found (not an error)
60
+ allow_exit_status 0..1
61
+
62
+ # @overload call(name, value_regex = nil, **options)
63
+ #
64
+ # Execute the `git config --get-all` command
65
+ #
66
+ # @param name [String] the config key name to look up
67
+ #
68
+ # @param value_regex [String, nil] (nil) optional regex to filter values
69
+ #
70
+ # @param options [Hash] command options
71
+ #
72
+ # @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
73
+ #
74
+ # @option options [Boolean, nil] :system (nil) read from system config
75
+ #
76
+ # @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
77
+ #
78
+ # @option options [Boolean, nil] :worktree (nil) read from worktree config
79
+ #
80
+ # @option options [String] :file (nil) read from the specified file
81
+ #
82
+ # Alias: :f
83
+ #
84
+ # @option options [String] :blob (nil) read from the specified blob
85
+ #
86
+ # @option options [Boolean, nil] :includes (nil) follow include directives in config files
87
+ # (`--includes`)
88
+ #
89
+ # @option options [Boolean, nil] :no_includes (nil) suppress include directive processing
90
+ # (`--no-includes`)
91
+ #
92
+ # @option options [String] :type (nil) ensure values conform to the given type
93
+ #
94
+ # @option options [Boolean, nil] :no_type (nil) unset the previously set type specifier;
95
+ # `true` emits `--no-type`
96
+ #
97
+ # @option options [Boolean, nil] :show_origin (nil) show the origin of each config value
98
+ #
99
+ # @option options [Boolean, nil] :show_scope (nil) show the scope of each config value
100
+ #
101
+ # @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
102
+ #
103
+ # Alias: :z
104
+ #
105
+ # @return [Git::CommandLine::Result] the result of calling `git config --get-all`
106
+ #
107
+ # @raise [ArgumentError] if unsupported options are provided
108
+ #
109
+ # @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
110
+ #
111
+ # @api public
112
+ def call(*, **)
113
+ super
114
+ end
115
+ end
116
+ end
117
+ end
118
+ end
@@ -0,0 +1,95 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Retrieve an ANSI color string from config
9
+ #
10
+ # Wraps `git config --get-color` to look up a color configuration
11
+ # and output the ANSI escape sequence for that color.
12
+ #
13
+ # @example Get a color config value
14
+ # cmd = Git::Commands::ConfigOptionSyntax::GetColor.new(lib)
15
+ # cmd.call('color.diff.new')
16
+ #
17
+ # @example Get a color config value with a default
18
+ # cmd = Git::Commands::ConfigOptionSyntax::GetColor.new(lib)
19
+ # cmd.call('color.diff.new', 'green')
20
+ #
21
+ # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
22
+ #
23
+ # @see Git::Commands::ConfigOptionSyntax
24
+ #
25
+ # @see https://git-scm.com/docs/git-config git-config documentation
26
+ #
27
+ # @api private
28
+ #
29
+ class GetColor < Git::Commands::Base
30
+ arguments do
31
+ literal 'config'
32
+ literal '--get-color'
33
+
34
+ # File-scope options
35
+ flag_option :global
36
+ flag_option :system
37
+ flag_option :local
38
+ flag_option :worktree
39
+ value_option %i[file f]
40
+ value_option :blob
41
+
42
+ # General read options
43
+ flag_option :includes, negatable: true
44
+
45
+ # Operands
46
+ end_of_options
47
+ operand :name, required: true
48
+ operand :default
49
+ end
50
+
51
+ # @overload call(name, default = nil, **options)
52
+ #
53
+ # Execute the `git config --get-color` command
54
+ #
55
+ # @param name [String] the color config key name to look up
56
+ #
57
+ # @param default [String, nil] (nil) fallback color when the key is not set
58
+ #
59
+ # @param options [Hash] command options
60
+ #
61
+ # @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
62
+ #
63
+ # @option options [Boolean, nil] :system (nil) read from system config
64
+ #
65
+ # @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
66
+ #
67
+ # @option options [Boolean, nil] :worktree (nil) read from worktree config
68
+ #
69
+ # @option options [String] :file (nil) read from the specified file
70
+ #
71
+ # Alias: :f
72
+ #
73
+ # @option options [String] :blob (nil) read from the specified blob
74
+ #
75
+ # @option options [Boolean, nil] :includes (nil) respect include directives in config files
76
+ # (`--includes`)
77
+ #
78
+ # @option options [Boolean, nil] :no_includes (nil) suppress include directive processing
79
+ # (`--no-includes`)
80
+ #
81
+ # @return [Git::CommandLine::Result] the result of calling `git config --get-color`
82
+ #
83
+ # @raise [ArgumentError] if unsupported options are provided
84
+ #
85
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
86
+ #
87
+ # @api public
88
+ #
89
+ def call(*, **)
90
+ super
91
+ end
92
+ end
93
+ end
94
+ end
95
+ end
@@ -0,0 +1,96 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Query whether color output is enabled for a config key
9
+ #
10
+ # Wraps `git config --get-colorbool` to check whether color output
11
+ # should be used. This command has no subcommand equivalent even in
12
+ # git 2.46.0 — it exists only in the option-syntax interface.
13
+ #
14
+ # @example Query whether color is enabled for diff
15
+ # cmd = Git::Commands::ConfigOptionSyntax::GetColorBool.new(lib)
16
+ # cmd.call('color.diff')
17
+ #
18
+ # @example Query with explicit stdout-is-tty hint
19
+ # cmd = Git::Commands::ConfigOptionSyntax::GetColorBool.new(lib)
20
+ # cmd.call('color.diff', 'true')
21
+ #
22
+ # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
23
+ #
24
+ # @see Git::Commands::ConfigOptionSyntax
25
+ #
26
+ # @see https://git-scm.com/docs/git-config git-config documentation
27
+ #
28
+ # @api private
29
+ #
30
+ class GetColorBool < Git::Commands::Base
31
+ arguments do
32
+ literal 'config'
33
+ literal '--get-colorbool'
34
+
35
+ # File-scope options
36
+ flag_option :global
37
+ flag_option :system
38
+ flag_option :local
39
+ flag_option :worktree
40
+ value_option %i[file f]
41
+ value_option :blob
42
+
43
+ # General read options
44
+ flag_option :includes, negatable: true
45
+
46
+ # Operands
47
+ end_of_options
48
+ operand :name, required: true
49
+ operand :stdout_is_tty
50
+ end
51
+
52
+ # git config --get-colorbool exits 0 for color=yes, 1 for color=no
53
+ allow_exit_status 0..1
54
+
55
+ # @overload call(name, stdout_is_tty = nil, **options)
56
+ #
57
+ # Execute the `git config --get-colorbool` command
58
+ #
59
+ # @param name [String] the color config key name to query
60
+ #
61
+ # @param stdout_is_tty [String, nil] (nil) hint whether stdout is a TTY (`"true"` or `"false"`)
62
+ #
63
+ # @param options [Hash] command options
64
+ #
65
+ # @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
66
+ #
67
+ # @option options [Boolean, nil] :system (nil) read from system config
68
+ #
69
+ # @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
70
+ #
71
+ # @option options [Boolean, nil] :worktree (nil) read from worktree config
72
+ #
73
+ # @option options [String] :file (nil) read from the specified file
74
+ #
75
+ # Alias: :f
76
+ #
77
+ # @option options [String] :blob (nil) read from the specified blob
78
+ #
79
+ # @option options [Boolean, nil] :includes (nil) respect include directives in config files (`--includes`)
80
+ #
81
+ # @option options [Boolean, nil] :no_includes (nil) disable include directive processing (`--no-includes`)
82
+ #
83
+ # @return [Git::CommandLine::Result] the result of calling `git config --get-colorbool`
84
+ #
85
+ # @raise [ArgumentError] if unsupported options are provided
86
+ #
87
+ # @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
88
+ #
89
+ # @api public
90
+ def call(*, **)
91
+ super
92
+ end
93
+ end
94
+ end
95
+ end
96
+ end