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,119 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Retrieve config entries matching a name regex
9
+ #
10
+ # Wraps `git config --get-regexp` to return all config entries whose
11
+ # key name matches the given regular expression.
12
+ #
13
+ # @example Get all entries matching a pattern
14
+ # cmd = Git::Commands::ConfigOptionSyntax::GetRegexp.new(lib)
15
+ # cmd.call('remote\..*\.url')
16
+ #
17
+ # @example Get matching entries with value filter
18
+ # cmd = Git::Commands::ConfigOptionSyntax::GetRegexp.new(lib)
19
+ # cmd.call('remote\..*\.url', 'github')
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
26
+ #
27
+ # @api private
28
+ #
29
+ class GetRegexp < Git::Commands::Base
30
+ arguments do
31
+ literal 'config'
32
+ literal '--get-regexp'
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
+ # Type constraint
46
+ value_option :type, inline: true
47
+
48
+ # Output modifiers
49
+ flag_option :show_origin
50
+ flag_option :show_scope
51
+ flag_option %i[null z]
52
+ flag_option :name_only
53
+
54
+ # Operands
55
+ end_of_options
56
+ operand :name_regex, required: true
57
+ operand :value_regex
58
+ end
59
+
60
+ # git config --get-regexp exits 1 when no match is found (not an error)
61
+ allow_exit_status 0..1
62
+
63
+ # @overload call(name_regex, value_regex = nil, **options)
64
+ #
65
+ # Execute the `git config --get-regexp` command
66
+ #
67
+ # @param name_regex [String] regex pattern to match config key names
68
+ #
69
+ # @param value_regex [String, nil] optional regex to filter values
70
+ #
71
+ # @param options [Hash] command options
72
+ #
73
+ # @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
74
+ #
75
+ # @option options [Boolean, nil] :system (nil) read from system config
76
+ #
77
+ # @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
78
+ #
79
+ # @option options [Boolean, nil] :worktree (nil) read from worktree config
80
+ #
81
+ # @option options [String] :file (nil) read from the specified file
82
+ #
83
+ # Alias: :f
84
+ #
85
+ # @option options [String] :blob (nil) read from the specified blob
86
+ #
87
+ # @option options [Boolean, nil] :includes (nil) respect include directives in
88
+ # config files (`--includes`)
89
+ #
90
+ # @option options [Boolean, nil] :no_includes (nil) ignore include directives in
91
+ # config files (`--no-includes`)
92
+ #
93
+ # @option options [String] :type (nil) ensure values conform to the given type
94
+ #
95
+ # @option options [Boolean, nil] :show_origin (nil) show the origin of each config entry
96
+ #
97
+ # @option options [Boolean, nil] :show_scope (nil) show the scope of each config entry
98
+ #
99
+ # @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
100
+ #
101
+ # Alias: :z
102
+ #
103
+ # @option options [Boolean, nil] :name_only (nil) output only the names of config keys
104
+ #
105
+ # @return [Git::CommandLine::Result] the result of calling `git config --get-regexp`
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
+ #
113
+ def call(*, **)
114
+ super
115
+ end
116
+ end
117
+ end
118
+ end
119
+ end
@@ -0,0 +1,111 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Retrieve config values matching a URL
9
+ #
10
+ # Wraps `git config --get-urlmatch` to return config entries whose
11
+ # key name matches the given name and whose URL pattern matches the
12
+ # given URL.
13
+ #
14
+ # @example Get URL-matched config
15
+ # cmd = Git::Commands::ConfigOptionSyntax::GetUrlmatch.new(lib)
16
+ # cmd.call('http', 'https://example.com')
17
+ #
18
+ # @note `arguments` block audited against https://git-scm.com/docs/git-config/2.53.0
19
+ #
20
+ # @see Git::Commands::ConfigOptionSyntax
21
+ #
22
+ # @see https://git-scm.com/docs/git-config git-config
23
+ #
24
+ # @api private
25
+ #
26
+ class GetUrlmatch < Git::Commands::Base
27
+ arguments do
28
+ literal 'config'
29
+ literal '--get-urlmatch'
30
+
31
+ # File-scope options
32
+ flag_option :global
33
+ flag_option :system
34
+ flag_option :local
35
+ flag_option :worktree
36
+ value_option %i[file f]
37
+ value_option :blob
38
+
39
+ # Type constraint
40
+ value_option :type, inline: true
41
+
42
+ # Output modifier
43
+ flag_option %i[null z]
44
+
45
+ # General read options
46
+ flag_option :includes, negatable: true
47
+
48
+ # Output modifiers
49
+ flag_option :show_scope
50
+
51
+ # Operands
52
+ end_of_options
53
+ operand :name, required: true
54
+ operand :url, required: true
55
+ end
56
+
57
+ # git config --get-urlmatch exits 1 when no match is found (not an error)
58
+ allow_exit_status 0..1
59
+
60
+ # @overload call(name, url, **options)
61
+ #
62
+ # Execute the `git config --get-urlmatch` command
63
+ #
64
+ # @param name [String] the config key name (or section prefix) to look up
65
+ #
66
+ # @param url [String] the URL to match against
67
+ #
68
+ # @param options [Hash] command options
69
+ #
70
+ # @option options [Boolean, nil] :global (nil) read from global config (`~/.gitconfig`)
71
+ #
72
+ # @option options [Boolean, nil] :system (nil) read from system config
73
+ #
74
+ # @option options [Boolean, nil] :local (nil) read from repository config (`.git/config`)
75
+ #
76
+ # @option options [Boolean, nil] :worktree (nil) read from worktree config
77
+ #
78
+ # @option options [String] :file (nil) read from the specified file
79
+ #
80
+ # Alias: :f
81
+ #
82
+ # @option options [String] :blob (nil) read from the specified blob
83
+ #
84
+ # @option options [String] :type (nil) ensure values conform to the given type
85
+ #
86
+ # @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
87
+ #
88
+ # Alias: :z
89
+ #
90
+ # @option options [Boolean, nil] :includes (nil) respect include directives in config files (`--includes`)
91
+ #
92
+ # @option options [Boolean, nil] :no_includes (nil) disable include directives
93
+ # in config files (`--no-includes`)
94
+ #
95
+ # @option options [Boolean, nil] :show_scope (nil) show the scope of each config entry
96
+ #
97
+ # @return [Git::CommandLine::Result] the result of calling `git config --get-urlmatch`
98
+ #
99
+ # @raise [ArgumentError] if unsupported options are provided
100
+ #
101
+ # @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
102
+ #
103
+ # @api public
104
+ #
105
+ def call(*, **)
106
+ super
107
+ end
108
+ end
109
+ end
110
+ end
111
+ end
@@ -0,0 +1,111 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # List all config entries
9
+ #
10
+ # Wraps `git config --list` to output all config entries visible
11
+ # from the current scope.
12
+ #
13
+ # @example List all config entries
14
+ # cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
15
+ # cmd.call
16
+ #
17
+ # @example List global config entries
18
+ # cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
19
+ # cmd.call(global: true)
20
+ #
21
+ # @example List entries from a specific file
22
+ # cmd = Git::Commands::ConfigOptionSyntax::List.new(lib)
23
+ # cmd.call(file: '/path/to/config')
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
30
+ #
31
+ # @api private
32
+ #
33
+ class List < Git::Commands::Base
34
+ arguments do
35
+ literal 'config'
36
+ literal '--list'
37
+
38
+ # File-scope options
39
+ flag_option :global
40
+ flag_option :system
41
+ flag_option :local
42
+ flag_option :worktree
43
+ value_option %i[file f]
44
+ value_option :blob
45
+
46
+ # General read options
47
+ flag_option :includes, negatable: true
48
+
49
+ # Output modifiers
50
+ flag_option :show_origin
51
+ flag_option :show_scope
52
+ flag_option %i[null z]
53
+ flag_option :name_only
54
+
55
+ # Type constraint
56
+ value_option :type, inline: true
57
+ end
58
+
59
+ # @overload call(**options)
60
+ #
61
+ # Execute the `git config --list` command
62
+ #
63
+ # @param options [Hash] command options
64
+ #
65
+ # @option options [Boolean, nil] :global (nil) list only global config entries
66
+ #
67
+ # @option options [Boolean, nil] :system (nil) list only system config entries
68
+ #
69
+ # @option options [Boolean, nil] :local (nil) list only repository config entries
70
+ #
71
+ # @option options [Boolean, nil] :worktree (nil) list only worktree config entries
72
+ #
73
+ # @option options [String] :file (nil) list entries from the specified file
74
+ #
75
+ # Alias: :f
76
+ #
77
+ # @option options [String] :blob (nil) list entries from the specified blob
78
+ #
79
+ # @option options [Boolean, nil] :includes (nil) respect include directives in config files
80
+ # (`--includes`)
81
+ #
82
+ # @option options [Boolean, nil] :no_includes (nil) suppress include directive processing
83
+ # (`--no-includes`)
84
+ #
85
+ # @option options [Boolean, nil] :show_origin (nil) show the origin of each config entry
86
+ #
87
+ # @option options [Boolean, nil] :show_scope (nil) show the scope of each config entry
88
+ #
89
+ # @option options [Boolean, nil] :null (nil) terminate values with NUL byte instead of newline
90
+ #
91
+ # Alias: :z
92
+ #
93
+ # @option options [Boolean, nil] :name_only (nil) output only the names of config keys
94
+ #
95
+ # @option options [String] :type (nil) ensure values conform to the given type
96
+ #
97
+ # @return [Git::CommandLine::Result] the result of calling `git config --list`
98
+ #
99
+ # @raise [ArgumentError] if unsupported options are provided
100
+ #
101
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
102
+ #
103
+ # @api public
104
+ #
105
+ def call(*, **)
106
+ super
107
+ end
108
+ end
109
+ end
110
+ end
111
+ end
@@ -0,0 +1,79 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Remove a config section
9
+ #
10
+ # Wraps `git config --remove-section` to remove an entire section
11
+ # from the config file.
12
+ #
13
+ # @example Remove a section
14
+ # cmd = Git::Commands::ConfigOptionSyntax::RemoveSection.new(lib)
15
+ # cmd.call('old-section')
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
22
+ #
23
+ # @api private
24
+ class RemoveSection < Git::Commands::Base
25
+ arguments do
26
+ literal 'config'
27
+ literal '--remove-section'
28
+
29
+ # File-scope options
30
+ flag_option :global
31
+ flag_option :system
32
+ flag_option :local
33
+ flag_option :worktree
34
+ value_option %i[file f]
35
+ value_option :blob
36
+
37
+ # Operands
38
+ end_of_options
39
+ operand :name, required: true
40
+ end
41
+
42
+ # @!method call(*, **options)
43
+ #
44
+ # @param options [Hash] command options
45
+ #
46
+ # @option options [Boolean, nil] :global (nil) command option key; see
47
+ # overload docs for the full option list
48
+ #
49
+ # @overload call(name, **options)
50
+ #
51
+ # Execute the `git config --remove-section` command
52
+ #
53
+ # @param name [String] the section name to remove
54
+ #
55
+ # @param options [Hash] command options
56
+ #
57
+ # @option options [Boolean, nil] :global (nil) remove from global config (`~/.gitconfig`)
58
+ #
59
+ # @option options [Boolean, nil] :system (nil) remove from system config
60
+ #
61
+ # @option options [Boolean, nil] :local (nil) remove from repository config (`.git/config`)
62
+ #
63
+ # @option options [Boolean, nil] :worktree (nil) remove from worktree config
64
+ #
65
+ # @option options [String] :file (nil) remove from the specified file
66
+ #
67
+ # Alias: :f
68
+ #
69
+ # @option options [String] :blob (nil) read from the specified blob
70
+ #
71
+ # @return [Git::CommandLine::Result] the result of calling `git config --remove-section`
72
+ #
73
+ # @raise [ArgumentError] if unsupported options are provided
74
+ #
75
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
76
+ end
77
+ end
78
+ end
79
+ end
@@ -0,0 +1,83 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Rename a config section
9
+ #
10
+ # Wraps `git config --rename-section` to rename a section in the
11
+ # config file.
12
+ #
13
+ # @example Rename a section
14
+ # cmd = Git::Commands::ConfigOptionSyntax::RenameSection.new(lib)
15
+ # cmd.call('old-section', 'new-section')
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
22
+ #
23
+ # @api private
24
+ #
25
+ class RenameSection < Git::Commands::Base
26
+ arguments do
27
+ literal 'config'
28
+ literal '--rename-section'
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
+ # Operands
39
+ end_of_options
40
+ operand :old_name, required: true
41
+ operand :new_name, required: true
42
+ end
43
+
44
+ # @!method call(*, **options)
45
+ #
46
+ # @param options [Hash] command options
47
+ #
48
+ # @option options [Boolean, nil] :global (nil) command option key; see
49
+ # overload docs for the full option list
50
+ #
51
+ # @overload call(old_name, new_name, **options)
52
+ #
53
+ # Execute the `git config --rename-section` command
54
+ #
55
+ # @param old_name [String] the current section name
56
+ #
57
+ # @param new_name [String] the new section name
58
+ #
59
+ # @param options [Hash] command options
60
+ #
61
+ # @option options [Boolean, nil] :global (nil) operate on global config (`~/.gitconfig`)
62
+ #
63
+ # @option options [Boolean, nil] :system (nil) operate on system config
64
+ #
65
+ # @option options [Boolean, nil] :local (nil) operate on repository config (`.git/config`)
66
+ #
67
+ # @option options [Boolean, nil] :worktree (nil) operate on worktree config
68
+ #
69
+ # @option options [String] :file (nil) operate on the specified file
70
+ #
71
+ # Alias: :f
72
+ #
73
+ # @option options [String] :blob (nil) read from the specified blob
74
+ #
75
+ # @return [Git::CommandLine::Result] the result of calling `git config --rename-section`
76
+ #
77
+ # @raise [ArgumentError] if unsupported options are provided
78
+ #
79
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
80
+ end
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,109 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/commands/base'
4
+
5
+ module Git
6
+ module Commands
7
+ module ConfigOptionSyntax
8
+ # Replace all matching values for a config key
9
+ #
10
+ # Wraps `git config --replace-all` to replace all entries matching the
11
+ # given key and optional value regex with a new value.
12
+ #
13
+ # @example Replace all values for a key
14
+ # cmd = Git::Commands::ConfigOptionSyntax::ReplaceAll.new(lib)
15
+ # cmd.call('core.autocrlf', 'true')
16
+ #
17
+ # @example Replace values matching a pattern
18
+ # cmd = Git::Commands::ConfigOptionSyntax::ReplaceAll.new(lib)
19
+ # cmd.call('core.autocrlf', 'true', 'false')
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 ReplaceAll < Git::Commands::Base
30
+ arguments do
31
+ literal 'config'
32
+ literal '--replace-all'
33
+
34
+ # Write modifiers
35
+ value_option :comment
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
+ # Value matching
46
+ flag_option :fixed_value
47
+
48
+ # Type constraint
49
+ value_option :type, inline: true
50
+ flag_option :no_type
51
+
52
+ # Operands
53
+ end_of_options
54
+ operand :name, required: true
55
+ operand :value, required: true
56
+ operand :value_regex
57
+ end
58
+
59
+ # @!method call(*, **options)
60
+ #
61
+ # @param options [Hash] command options
62
+ #
63
+ # @option options [Boolean, nil] :global (nil) command option key; see
64
+ # overload docs for the full option list
65
+ #
66
+ # @overload call(name, value, value_regex = nil, **options)
67
+ #
68
+ # Execute the `git config --replace-all` command
69
+ #
70
+ # @param name [String] the config key name
71
+ #
72
+ # @param value [String] the new value to set
73
+ #
74
+ # @param value_regex [String, nil] (nil) optional regex to match existing values to replace
75
+ #
76
+ # @param options [Hash] command options
77
+ #
78
+ # @option options [Boolean, nil] :global (nil) write to global config (`~/.gitconfig`)
79
+ #
80
+ # @option options [Boolean, nil] :system (nil) write to system config
81
+ #
82
+ # @option options [Boolean, nil] :local (nil) write to repository config (`.git/config`)
83
+ #
84
+ # @option options [Boolean, nil] :worktree (nil) write to worktree config
85
+ #
86
+ # @option options [String] :file (nil) write to the specified file
87
+ #
88
+ # Alias: :f
89
+ #
90
+ # @option options [String] :blob (nil) read from the specified blob
91
+ #
92
+ # @option options [String] :comment (nil) append a comment at the end of new or modified lines
93
+ #
94
+ # @option options [Boolean, nil] :fixed_value (nil) treat the value regex as an exact string
95
+ #
96
+ # @option options [String] :type (nil) ensure the value conforms to the given type
97
+ #
98
+ # @option options [Boolean, nil] :no_type (nil) unset the previously set type specifier;
99
+ # `true` emits `--no-type`
100
+ #
101
+ # @return [Git::CommandLine::Result] the result of calling `git config --replace-all`
102
+ #
103
+ # @raise [ArgumentError] if unsupported options are provided
104
+ #
105
+ # @raise [Git::FailedError] if git exits with a non-zero exit status
106
+ end
107
+ end
108
+ end
109
+ end