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
data/lib/git/branch.rb DELETED
@@ -1,423 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'git/path'
4
-
5
- module Git
6
- # Represents a Git branch
7
- #
8
- # Branch objects provide access to branch metadata and operations like checkout,
9
- # delete, and merge. They should be obtained via {Git::Base#branch} or
10
- # {Git::Base#branches}, not constructed directly.
11
- #
12
- # @example Getting a branch
13
- # git = Git.open('.')
14
- # branch = git.branch('main')
15
- # branch.checkout
16
- #
17
- # @example Listing branches
18
- # git.branches.each { |b| puts b.name }
19
- #
20
- # @api public
21
- #
22
- class Branch
23
- # The full refname of this branch
24
- #
25
- # For local branches this is the short name (e.g. `'main'`). For
26
- # remote-tracking branches obtained via {Git::Base#branches} this includes
27
- # the `remotes/` prefix (e.g. `'remotes/origin/main'`). Branches constructed
28
- # by {Git::Remote#branch} use the `<remote>/<branch>` form (e.g.
29
- # `'origin/main'`) which does **not** populate {#remote}.
30
- #
31
- # @example
32
- # git.branch('main').full #=> 'main'
33
- # git.branch('remotes/origin/main').full #=> 'remotes/origin/main'
34
- #
35
- # @return [String] the full refname
36
- #
37
- attr_accessor :full
38
-
39
- # The remote for this branch, or `nil` for local or bare-name remote-tracking branches
40
- #
41
- # Set to a {Git::Remote} object only when this branch was initialized with a
42
- # `remotes/<remote>/` or `refs/remotes/<remote>/` prefix. `nil` for local
43
- # branches and for remote-tracking branches in `<remote>/<branch>` form
44
- # (such as those returned by {Git::Remote#branch}).
45
- #
46
- # @example
47
- # git.branch('main').remote #=> nil
48
- # git.branch('remotes/origin/main').remote #=> #<Git::Remote 'origin'>
49
- # git.remote('origin').branch('main').remote #=> nil # uses 'origin/main' form
50
- #
51
- # @return [Git::Remote, nil] the remote object, or `nil`
52
- #
53
- attr_accessor :remote
54
-
55
- # The short branch name without the remote prefix
56
- #
57
- # For branches initialized with a `remotes/` or `refs/remotes/` prefix, the
58
- # prefix is stripped and this returns the bare branch name (e.g. `'main'`
59
- # rather than `'remotes/origin/main'`). For branches in the
60
- # `<remote>/<branch>` form (such as those created by {Git::Remote#branch}),
61
- # no stripping occurs and `name` returns the full form (e.g. `'origin/main'`).
62
- #
63
- # @example
64
- # git.branch('main').name #=> 'main'
65
- # git.branch('remotes/origin/main').name #=> 'main'
66
- # git.remote('origin').branch('main').name #=> 'origin/main'
67
- #
68
- # @return [String] the branch name
69
- #
70
- attr_accessor :name
71
-
72
- # Initialize a new Branch object
73
- #
74
- # @api private
75
- #
76
- # @note Use {Git::Base#branch} or {Git::Base#branches} instead of constructing directly
77
- #
78
- # @param base [Git::Base] the git repository
79
- #
80
- # @param name [String] the full or short branch name
81
- #
82
- def initialize(base, name)
83
- @full = name
84
- @base = base
85
- @gcommit = nil
86
- @stashes = nil
87
- @remote, @name = parse_name(name)
88
- end
89
-
90
- # Returns the commit at the tip of this branch
91
- #
92
- # The result is memoized after the first call.
93
- #
94
- # @example Get the tip commit
95
- # git.branch('main').gcommit #=> #<Git::Object ...>
96
- #
97
- # @return [Git::Object] the commit at the tip of this branch
98
- #
99
- def gcommit
100
- @gcommit ||= @base.gcommit(@full)
101
- @gcommit
102
- end
103
-
104
- # Returns the stash list for this repository
105
- #
106
- # The result is memoized after the first call.
107
- #
108
- # @example Iterate over stash entries
109
- # git.branch('main').stashes.each { |s| puts s }
110
- #
111
- # @return [Git::Stashes] the stash list
112
- #
113
- def stashes
114
- @stashes ||= Git::Stashes.new(@base)
115
- end
116
-
117
- # Checks out this branch, attempting to create it first if it does not already exist
118
- #
119
- # Branch creation is attempted via {#check_if_create}; any error from that
120
- # step is silently ignored and the checkout proceeds regardless.
121
- #
122
- # **Note:** for remote-tracking branches (where {#remote} is not `nil`),
123
- # {#full} is a ref such as `'remotes/origin/main'`. Checking out a
124
- # remote-tracking ref places the repository in a **detached HEAD** state.
125
- #
126
- # @example Check out a branch
127
- # git = Git.open('.')
128
- # git.branch('main').checkout
129
- #
130
- # @return [String] git's stdout from the checkout
131
- #
132
- # @raise [Git::FailedError] if git exits with a non-zero exit status
133
- #
134
- def checkout
135
- check_if_create
136
- @base.checkout(@full)
137
- end
138
-
139
- # Archives this branch and writes the result to a file
140
- #
141
- # @example Archive to a tar file
142
- # git.branch('main').archive('/tmp/main.tar')
143
- #
144
- # @example Archive to a zip file
145
- # git.branch('main').archive('/tmp/main.zip', format: 'zip')
146
- #
147
- # @param file [String] path to the destination archive file
148
- #
149
- # @param opts [Hash] archive options (see {Git::Base#archive})
150
- #
151
- # @return [String] the path to the written archive file
152
- #
153
- # @raise [Git::FailedError] if `git archive` fails
154
- #
155
- def archive(file, opts = {})
156
- @base.lib.archive(@full, file, opts)
157
- end
158
-
159
- # Checks out this branch for the duration of a block, then restores the original branch
160
- #
161
- # If the block returns a truthy value, all pending changes are committed with the
162
- # given message before switching back to the original branch. If the block returns
163
- # a falsy value, a hard reset is performed before switching back.
164
- #
165
- # **Note:** the restore checkout is not wrapped in `ensure`. If the block,
166
- # the commit, or the reset raises an exception, the repository will be left
167
- # checked out on this branch rather than restored to the original.
168
- #
169
- # @example Commit a new file on a feature branch
170
- # git.branch('feature').in_branch('Add README') do
171
- # File.write('README.md', '# Hello')
172
- # git.add('README.md')
173
- # true # commit and return to original branch
174
- # end
175
- #
176
- # @param message [String] commit message used when the block returns truthy
177
- #
178
- # @yield Executes the block with this branch checked out
179
- #
180
- # @yieldreturn [Object] return a truthy value to commit all changes, a falsy value to hard-reset
181
- #
182
- # @return [String] git's stdout from the final checkout back to the original branch
183
- #
184
- # @raise [Git::FailedError] if any of the underlying git operations (checkout, commit, reset) fail
185
- #
186
- def in_branch(message = 'in branch work')
187
- old_current = @base.lib.branch_current
188
- checkout
189
- if yield
190
- @base.commit_all(message)
191
- else
192
- @base.reset_hard
193
- end
194
- @base.checkout(old_current)
195
- end
196
-
197
- # Creates this branch if it does not already exist
198
- #
199
- # Silently ignores any error raised during branch creation (including the case
200
- # where the branch already exists).
201
- #
202
- # @example Create a new branch
203
- # git.branch('feature').create
204
- #
205
- # @return [String, nil] git's stdout from branch creation (typically empty),
206
- # or `nil` if an error was rescued
207
- #
208
- def create
209
- check_if_create
210
- end
211
-
212
- # Deletes this branch
213
- #
214
- # **Note:** this method only works correctly for local branches. Calling it on
215
- # a remote-tracking branch (one where {#remote} is not `nil`) will attempt to
216
- # delete a *local* branch with the same short name rather than the
217
- # remote-tracking ref, which is almost certainly not what you want.
218
- # See [ruby-git#1280](https://github.com/ruby-git/ruby-git/issues/1280) for
219
- # the planned fix.
220
- #
221
- # @example Delete a local branch
222
- # git.branch('old-feature').delete
223
- #
224
- # @return [String] git's deletion output
225
- #
226
- # @raise [Git::FailedError] if the branch cannot be deleted
227
- #
228
- def delete
229
- @base.lib.branch_delete(@name)
230
- end
231
-
232
- # Returns true if this is the currently checked-out branch
233
- #
234
- # **Note:** this compares the current branch's short name against {#name}.
235
- # For a remote-tracking branch (where {#remote} is not `nil`), {#name} is
236
- # still the bare short name (e.g. `'main'`), so this will return `true`
237
- # whenever the *local* branch with that name is checked out — not the
238
- # remote-tracking ref itself.
239
- #
240
- # @example Check whether currently on main
241
- # git.branch('main').current #=> true
242
- #
243
- # @return [Boolean] whether this branch is currently checked out
244
- # @raise [Git::FailedError] if git exits with a non-zero exit status
245
- #
246
- #
247
- def current # rubocop:disable Naming/PredicateMethod
248
- @base.lib.branch_current == @name
249
- end
250
-
251
- # Returns true if this branch contains the given commit
252
- #
253
- # **Note:** this queries local branches by short name. For a remote-tracking
254
- # branch (where {#remote} is not `nil`), it checks the *local* branch with
255
- # the same {#name} rather than the remote-tracking ref, which may give an
256
- # inaccurate result.
257
- #
258
- # @example Check if a commit is reachable from this branch
259
- # git.branch('main').contains?('abc1234') #=> true
260
- #
261
- # @param commit [String] the commit SHA or ref to check
262
- #
263
- # @return [Boolean] whether this branch contains the given commit
264
- # @raise [Git::FailedError] if git exits with a non-zero exit status
265
- #
266
- #
267
- def contains?(commit)
268
- !@base.lib.branch_contains(commit, name).empty?
269
- end
270
-
271
- # Merges a branch into this branch, or merges this branch into the current branch
272
- #
273
- # @overload merge(branch, message = nil)
274
- #
275
- # Temporarily checks out this branch, merges the given branch into it,
276
- # then restores the original branch.
277
- #
278
- # **Note:** if `self` is a remote-tracking branch (where {#remote} is not
279
- # `nil`), this delegates to {#checkout} which has the detached-HEAD
280
- # side-effect described there. The remote-tracking ref will not be updated.
281
- #
282
- # @example Merge a feature branch into main
283
- # git.branch('main').merge('feature')
284
- #
285
- # @param branch [String] the name of the branch to merge into this one
286
- #
287
- # @param message [String, nil] commit message for the merge commit
288
- #
289
- # @return [String] git's stdout from the final checkout back to the original branch
290
- #
291
- # @overload merge()
292
- #
293
- # Merges this branch into the currently checked-out branch.
294
- #
295
- # @example Merge main into the current branch
296
- # git.branch('main').merge
297
- #
298
- # @return [String] git's stdout from the merge command
299
- #
300
- # @raise [Git::FailedError] if git exits with a non-zero exit status during
301
- # the merge, checkout, commit, or reset operations
302
- #
303
- def merge(branch = nil, message = nil)
304
- if branch
305
- in_branch do
306
- @base.merge(branch, message)
307
- false
308
- end
309
- # merge a branch into this one
310
- else
311
- # merge this branch into the current one
312
- @base.merge(@name)
313
- end
314
- end
315
-
316
- # Updates the git ref for this branch to point to the given commit
317
- #
318
- # The target ref depends on whether {#remote} is set:
319
- # - When {#remote} is not `nil` (i.e. the branch was initialised with a
320
- # `remotes/<remote>/` or `refs/remotes/<remote>/` prefix), updates
321
- # `refs/remotes/<remote>/<name>`.
322
- # - Otherwise updates `refs/heads/<name>`. Note that branches in the
323
- # `<remote>/<branch>` form (e.g. those returned by {Git::Remote#branch})
324
- # have `remote == nil` and therefore update `refs/heads/<remote>/<name>`,
325
- # **not** `refs/remotes/...`.
326
- #
327
- # @example Advance a local branch to a new commit
328
- # git.branch('feature').update_ref('abc1234def5678')
329
- #
330
- # @param commit [String] the commit SHA to point this branch at
331
- #
332
- # @return [String] the stdout output from `git update-ref`
333
- #
334
- # @raise [Git::FailedError] if git exits with a non-zero exit status
335
- #
336
- def update_ref(commit)
337
- if @remote
338
- @base.lib.update_ref("refs/remotes/#{@remote.name}/#{@name}", commit)
339
- else
340
- @base.lib.update_ref("refs/heads/#{@name}", commit)
341
- end
342
- end
343
-
344
- # Returns this branch as a single-element array containing its full refname
345
- #
346
- # @example Get branch as array
347
- # git.branch('main').to_a #=> ['main']
348
- #
349
- # @return [Array<String>] a single-element array containing the full refname
350
- #
351
- def to_a
352
- [@full]
353
- end
354
-
355
- # Returns the full refname of this branch as a string
356
- #
357
- # @example Get branch as string
358
- # git.branch('main').to_s #=> 'main'
359
- #
360
- # @return [String] the full refname
361
- #
362
- def to_s
363
- @full
364
- end
365
-
366
- # Regular expression for parsing branch refnames
367
- #
368
- # Matches full and short refnames, capturing an optional remote name and the
369
- # branch name. Used internally to identify remote-tracking branches.
370
- #
371
- # @api private
372
- #
373
- BRANCH_NAME_REGEXP = %r{
374
- ^
375
- # Optional 'remotes/' or 'refs/remotes/' at the beginning to specify a remote tracking branch
376
- # with a <remote_name>. <remote_name> is nil if not present.
377
- (?:
378
- (?:(?:refs/)?remotes/)(?<remote_name>[^/]+)/
379
- )?
380
- (?<branch_name>.*)
381
- $
382
- }x
383
-
384
- private
385
-
386
- # Parses a full branch name into remote and short branch name components
387
- #
388
- # Strips an optional `remotes/` or `refs/remotes/` prefix. Only inputs that begin
389
- # with one of those prefixes yield a remote object; all other inputs (including
390
- # `'origin/master'`) are treated as local branch names with a `nil` remote.
391
- #
392
- # @example Local branches
393
- # parse_name('master') #=> [nil, 'master']
394
- # parse_name('origin/master') #=> [nil, 'origin/master']
395
- #
396
- # @example Remote-tracking branches
397
- # parse_name('remotes/origin/master') #=> [#<Git::Remote 'origin'>, 'master']
398
- # parse_name('refs/remotes/origin/master') #=> [#<Git::Remote 'origin'>, 'master']
399
- #
400
- # @param name [String] the full branch name to parse
401
- #
402
- # @return [Array(Git::Remote, String)] a two-element array with the remote object
403
- # (or `nil`) and the short branch name
404
- #
405
- def parse_name(name)
406
- # Expect this will always match
407
- match = name.match(BRANCH_NAME_REGEXP)
408
- remote = match[:remote_name] ? Git::Remote.new(@base, match[:remote_name]) : nil
409
- branch_name = match[:branch_name]
410
- [remote, branch_name]
411
- end
412
-
413
- # Creates the branch if it does not already exist, ignoring errors
414
- #
415
- # @return [String, nil] stdout from branch creation, or `nil` if an error was rescued
416
- #
417
- def check_if_create
418
- @base.lib.branch_new(@name)
419
- rescue StandardError
420
- nil
421
- end
422
- end
423
- end
data/lib/git/branches.rb DELETED
@@ -1,68 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Git
4
- # object that holds all the available branches
5
- class Branches
6
- include Enumerable
7
-
8
- def initialize(base)
9
- @branches = {}
10
-
11
- @base = base
12
-
13
- @base.lib.branches_all.each do |b|
14
- @branches[b[0]] = Git::Branch.new(@base, b[0])
15
- end
16
- end
17
-
18
- def local
19
- reject(&:remote)
20
- end
21
-
22
- def remote
23
- self.select(&:remote)
24
- end
25
-
26
- # array like methods
27
-
28
- def size
29
- @branches.size
30
- end
31
-
32
- def each(&)
33
- @branches.values.each(&)
34
- end
35
-
36
- # Returns the target branch
37
- #
38
- # Example:
39
- # Given (git branch -a):
40
- # master
41
- # remotes/working/master
42
- #
43
- # g.branches['master'].full #=> 'master'
44
- # g.branches['working/master'].full => 'remotes/working/master'
45
- # g.branches['remotes/working/master'].full => 'remotes/working/master'
46
- #
47
- # @param [#to_s] branch_name the target branch name.
48
- # @return [Git::Branch] the target branch.
49
- def [](branch_name)
50
- @branches.values.each_with_object(@branches) do |branch, branches|
51
- branches[branch.full] ||= branch
52
-
53
- # This is how Git (version 1.7.9.5) works.
54
- # Lets you ignore the 'remotes' if its at the beginning of the branch full
55
- # name (even if is not a real remote branch).
56
- branches[branch.full.sub('remotes/', '')] ||= branch if branch.full =~ %r{^remotes/.+}
57
- end[branch_name.to_s]
58
- end
59
-
60
- def to_s
61
- out = ''
62
- @branches.each_value do |b|
63
- out << (b.current ? '* ' : ' ') << b.to_s << "\n"
64
- end
65
- out
66
- end
67
- end
68
- end
@@ -1,92 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Git
4
- # The result of running a git command
5
- #
6
- # This object stores the Git command executed and its status, stdout, and stderr.
7
- #
8
- # @api public
9
- #
10
- class CommandLineResult
11
- # Create a CommandLineResult object
12
- #
13
- # @example
14
- # `true`
15
- # git_cmd = %w[git version]
16
- # status = $?
17
- # stdout = "git version 2.39.1\n"
18
- # stderr = ""
19
- # result = Git::CommandLineResult.new(git_cmd, status, stdout, stderr)
20
- #
21
- # @param git_cmd [Array<String>] the git command that was executed
22
- # @param status [ProcessExecuter::ResultWithCapture] the status of the process
23
- # @param stdout [String] the processed stdout of the process
24
- # @param stderr [String] the processed stderr of the process
25
- #
26
- def initialize(git_cmd, status, stdout, stderr)
27
- @git_cmd = git_cmd
28
- @status = status
29
- @stdout = stdout
30
- @stderr = stderr
31
-
32
- # ProcessExecuter::ResultWithCapture changed the timeout? method to timed_out?
33
- # in version 4.x. This is a compatibility layer to maintain the old method name
34
- # for backward compatibility.
35
- #
36
- status.define_singleton_method(:timeout?) { timed_out? }
37
- end
38
-
39
- # @attribute [r] git_cmd
40
- #
41
- # The git command that was executed
42
- #
43
- # @example
44
- # git_cmd = %w[git version]
45
- # result = Git::CommandLineResult.new(git_cmd, $?, "", "")
46
- # result.git_cmd #=> ["git", "version"]
47
- #
48
- # @return [Array<String>]
49
- #
50
- attr_reader :git_cmd
51
-
52
- # @attribute [r] status
53
- #
54
- # The status of the process
55
- #
56
- # @example
57
- # `true`
58
- # status = $?
59
- # result = Git::CommandLineResult.new(status, "", "")
60
- # result.status #=> #<Process::Status: pid 87859 exit 0>
61
- #
62
- # @return [Process::Status]
63
- #
64
- attr_reader :status
65
-
66
- # @attribute [r] stdout
67
- #
68
- # The output of the process
69
- #
70
- # @example
71
- # stdout = "git version 2.39.1\n"
72
- # result = Git::CommandLineResult.new($?, stdout, "")
73
- # result.stdout #=> "git version 2.39.1\n"
74
- #
75
- # @return [String]
76
- #
77
- attr_reader :stdout
78
-
79
- # @attribute [r] stderr
80
- #
81
- # The error output of the process
82
- #
83
- # @example
84
- # stderr = "Tag not found\n"
85
- # result = Git::CommandLineResult.new($?, "", stderr)
86
- # result.stderr #=> "Tag not found\n"
87
- #
88
- # @return [String]
89
- #
90
- attr_reader :stderr
91
- end
92
- end
data/lib/git/index.rb DELETED
@@ -1,6 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Git
4
- class Index < Git::Path
5
- end
6
- end