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,66 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'git/tag_info'
4
+ require 'git/tag_delete_failure'
5
+
6
+ module Git
7
+ # Represents the result of a tag delete operation
8
+ #
9
+ # This is an immutable data object returned by {Git::Commands::Tag::Delete#call}.
10
+ # It contains information about which tags were successfully deleted and which
11
+ # failed to be deleted, along with the reason for each failure.
12
+ #
13
+ # Git's `git tag -d` command uses "best effort" semantics - it deletes as many
14
+ # tags as possible and reports errors for those that couldn't be deleted. This
15
+ # result object reflects that behavior, allowing callers to inspect both
16
+ # successes and failures.
17
+ #
18
+ # @example Successful deletion of all tags
19
+ # result = tag_delete.call('v1.0.0', 'v2.0.0')
20
+ # result.success? #=> true
21
+ # result.deleted.map(&:name) #=> ['v1.0.0', 'v2.0.0']
22
+ # result.not_deleted #=> []
23
+ #
24
+ # @example Partial failure (some tags deleted, some not found)
25
+ # result = tag_delete.call('v1.0.0', 'nonexistent', 'v2.0.0')
26
+ # result.success? #=> false
27
+ # result.deleted.map(&:name) #=> ['v1.0.0', 'v2.0.0']
28
+ # result.not_deleted.first.name #=> 'nonexistent'
29
+ # result.not_deleted.first.error_message #=> "tag 'nonexistent' not found."
30
+ #
31
+ # @see Git::TagInfo
32
+ #
33
+ # @see Git::TagDeleteFailure
34
+ #
35
+ # @see Git::Commands::Tag::Delete
36
+ #
37
+ # @api public
38
+ #
39
+ # @!attribute [r] deleted
40
+ # Tags that were successfully deleted
41
+ #
42
+ # @return [Array<Git::TagInfo>]
43
+ #
44
+ # @!attribute [r] not_deleted
45
+ # Tags that could not be deleted, with the reason for each failure
46
+ #
47
+ # @return [Array<Git::TagDeleteFailure>]
48
+ #
49
+ TagDeleteResult = Data.define(:deleted, :not_deleted) do
50
+ # Returns true if all requested tags were successfully deleted
51
+ #
52
+ # @example Check if the delete operation succeeded
53
+ # result = tag_delete.call('v1.0.0')
54
+ # if result.success?
55
+ # puts "All tags deleted successfully"
56
+ # else
57
+ # puts "Some tags could not be deleted:"
58
+ # result.not_deleted.each { |f| puts " #{f.name}: #{f.error_message}" }
59
+ # end
60
+ #
61
+ # @return [Boolean] true if no tags failed to delete, false otherwise
62
+ def success?
63
+ not_deleted.empty?
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,99 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'time'
4
+
5
+ require 'git/author_info'
6
+
7
+ module Git
8
+ # Value object representing tag metadata from git tag output
9
+ #
10
+ # This is a lightweight, immutable data structure returned by tag listing
11
+ # commands. It contains only the data parsed from git output without any
12
+ # repository context or operations.
13
+ #
14
+ # The tagger identity is a nested {Git::AuthorInfo}. Its `date` is a `Time`
15
+ # parsed from git's strict ISO 8601 output, not an ISO 8601 string.
16
+ #
17
+ # @example Annotated tag
18
+ # info = Git::TagInfo.new(
19
+ # name: 'v1.0.0',
20
+ # oid: 'abc123def456', # tag object's ID
21
+ # target_oid: 'def456abc789', # commit it points to
22
+ # objecttype: 'tag',
23
+ # tagger: Git::AuthorInfo.new(
24
+ # name: 'John Doe',
25
+ # email: 'john@example.com',
26
+ # date: Time.iso8601('2024-01-15T10:30:00-08:00')
27
+ # ),
28
+ # message: 'Release version 1.0.0'
29
+ # )
30
+ # info.annotated? #=> true
31
+ # info.tagger.name #=> 'John Doe'
32
+ # info.tagger.date #=> 2024-01-15 10:30:00 -0800
33
+ #
34
+ # @example Lightweight tag
35
+ # info = Git::TagInfo.new(
36
+ # name: 'v1.0.0',
37
+ # oid: nil, # no tag object exists
38
+ # target_oid: 'def456abc789', # commit ID
39
+ # objecttype: 'commit',
40
+ # tagger: nil,
41
+ # message: nil
42
+ # )
43
+ # info.lightweight? #=> true
44
+ # info.tagger #=> nil
45
+ #
46
+ # @see Git::Repository::ObjectOperations#tag_list for the repository method
47
+ # that returns these
48
+ #
49
+ # @see Git::Commands::Tag::List for the command that produces these
50
+ #
51
+ # @see Git::AuthorInfo for the nested tagger identity
52
+ #
53
+ # @api public
54
+ #
55
+ # @!attribute [r] name
56
+ # @return [String] the tag name (e.g., 'v1.0.0')
57
+ #
58
+ # @!attribute [r] oid
59
+ # The object ID of the tag object itself.
60
+ #
61
+ # For annotated tags, this is the tag object's ID. For lightweight tags,
62
+ # this is nil because lightweight tags are not objects in the git database.
63
+ #
64
+ # @return [String, nil] the tag object's ID, or nil for lightweight tags
65
+ #
66
+ # @!attribute [r] target_oid
67
+ # The object ID of the commit this tag ultimately points to.
68
+ #
69
+ # For both annotated and lightweight tags, this is the commit ID that the
70
+ # tag resolves to (i.e., the dereferenced target).
71
+ #
72
+ # @return [String] the commit ID this tag points to
73
+ #
74
+ # @!attribute [r] objecttype
75
+ # @return [String] 'tag' for annotated tags, 'commit' for lightweight tags
76
+ #
77
+ # @!attribute [r] tagger
78
+ # The identity of the person who created the tag object.
79
+ #
80
+ # Lightweight tags have no tag object and therefore no tagger. The nested
81
+ # `email` has no angle brackets and the nested `date` is a `Time`.
82
+ #
83
+ # @return [Git::AuthorInfo, nil] the tagger, or nil for lightweight tags
84
+ #
85
+ # @!attribute [r] message
86
+ # @return [String, nil] the tag message, or nil for lightweight tags
87
+ #
88
+ TagInfo = Data.define(:name, :oid, :target_oid, :objecttype, :tagger, :message) do
89
+ # @return [Boolean] true if this is an annotated tag (oid is present)
90
+ def annotated?
91
+ !oid.nil?
92
+ end
93
+
94
+ # @return [Boolean] true if this is a lightweight tag (oid is nil)
95
+ def lightweight?
96
+ oid.nil?
97
+ end
98
+ end
99
+ end
data/lib/git/url.rb CHANGED
@@ -8,9 +8,10 @@ module Git
8
8
  # Any URL that can be passed to `git clone` can be parsed by this class.
9
9
  #
10
10
  # @see https://git-scm.com/docs/git-clone#_git_urls GIT URLs
11
- # @see https://github.com/sporkmonger/addressable Addresable::URI
12
11
  #
13
- # @api public
12
+ # @see https://github.com/sporkmonger/addressable Addressable::URI
13
+ #
14
+ # @api private
14
15
  #
15
16
  class URL
16
17
  # Regexp used to match a Git URL with an alternative SSH syntax
@@ -30,7 +31,7 @@ module Git
30
31
  # The URI returned can be converted back to a string with 'to_s'. This is
31
32
  # guaranteed to return the same URL string that was parsed.
32
33
  #
33
- # @example
34
+ # @example Parsing clone target from HTTPS and local paths
34
35
  # uri = Git::URL.parse('https://github.com/ruby-git/ruby-git.git')
35
36
  # #=> #<Addressable::URI:0x44c URI:https://github.com/ruby-git/ruby-git.git>
36
37
  # uri.scheme #=> "https"
@@ -54,11 +55,15 @@ module Git
54
55
 
55
56
  # The directory `git clone` would use for the repository directory for the given URL
56
57
  #
57
- # @example
58
+ # @example Deriving the clone directory name
58
59
  # Git::URL.clone_to('https://github.com/ruby-git/ruby-git.git') #=> 'ruby-git'
59
60
  #
60
61
  # @param url [String] the Git URL containing the repository directory
61
62
  #
63
+ # @param bare [Boolean] whether the repository should be cloned as bare
64
+ #
65
+ # @param mirror [Boolean] whether the repository should be cloned as a mirror
66
+ #
62
67
  # @return [String] the name of the repository directory
63
68
  #
64
69
  def self.clone_to(url, bare: false, mirror: false)
@@ -80,7 +85,7 @@ module Git
80
85
  # This class is necessary to ensure that #to_s returns the same string
81
86
  # that was passed to the initializer.
82
87
  #
83
- # @api public
88
+ # @api private
84
89
  #
85
90
  class GitAltURI < Addressable::URI
86
91
  # Create a new GitAltURI object
@@ -90,7 +95,9 @@ module Git
90
95
  # uri.to_s #=> 'james@github.com/james/ruby-git'
91
96
  #
92
97
  # @param user [String, nil] the user from the URL or nil
98
+ #
93
99
  # @param host [String] the host from the URL
100
+ #
94
101
  # @param path [String] the path from the URL
95
102
  #
96
103
  def initialize(user:, host:, path:)
data/lib/git/version.rb CHANGED
@@ -2,6 +2,115 @@
2
2
 
3
3
  module Git
4
4
  # The current gem version
5
- # @return [String] the current gem version.
6
- VERSION = '4.4.6'
5
+ #
6
+ # @return [String] the current gem version
7
+ VERSION = '6.0.0'
8
+
9
+ # Represents a git version with major, minor, and patch components
10
+ #
11
+ # Git versions follow a strict major.minor.patch format. This class provides
12
+ # parsing from git command output (which may include platform suffixes) and
13
+ # comparison operations for version gating.
14
+ #
15
+ # @!attribute [r] major
16
+ # The major version number
17
+ #
18
+ # @return [Integer]
19
+ #
20
+ # @!attribute [r] minor
21
+ # The minor version number
22
+ #
23
+ # @return [Integer]
24
+ #
25
+ # @!attribute [r] patch
26
+ # The patch version number
27
+ #
28
+ # @return [Integer]
29
+ #
30
+ # @example Creating a version directly
31
+ # version = Git::Version.new(2, 42, 1)
32
+ # version.to_s #=> "2.42.1"
33
+ #
34
+ # @example Parsing from git version output
35
+ # Git::Version.parse('git version 2.42.1') #=> Git::Version.new(2, 42, 1)
36
+ # Git::Version.parse('2.39.2 (Apple Git-143)') #=> Git::Version.new(2, 39, 2)
37
+ #
38
+ # @example Parsing versions with platform suffixes
39
+ # Git::Version.parse('2.42.0.windows.1') #=> Git::Version.new(2, 42, 0)
40
+ #
41
+ # @example Comparing versions
42
+ # Git::Version.new(2, 42, 1) > Git::Version.new(2, 28, 0) #=> true
43
+ #
44
+ # @api public
45
+ #
46
+ Version = Data.define(:major, :minor, :patch) do
47
+ include Comparable
48
+
49
+ # Parse a version string into a Version object
50
+ #
51
+ # Handles git's version output format, stripping platform suffixes
52
+ # (like `.windows.1` or `.vfs.0`) and padding two-segment versions
53
+ # to three segments.
54
+ #
55
+ # @example Parse various version string formats
56
+ # Git::Version.parse('2.42.1') #=> Git::Version.new(2, 42, 1)
57
+ # Git::Version.parse('git version 2.42.1') #=> Git::Version.new(2, 42, 1)
58
+ # Git::Version.parse('2.42.0.windows.1') #=> Git::Version.new(2, 42, 0)
59
+ #
60
+ # @param string [String] version string to parse
61
+ #
62
+ # @return [Git::Version] the parsed version
63
+ #
64
+ # @raise [Git::UnexpectedResultError] if the string cannot be parsed as a version
65
+ #
66
+ def self.parse(string)
67
+ version_match = string&.match(/(\d+)\.(\d+)(?:\.(\d+))?/)
68
+ raise Git::UnexpectedResultError, "Invalid version: #{string.inspect}" unless version_match
69
+
70
+ major = version_match[1].to_i
71
+ minor = version_match[2].to_i
72
+ patch = (version_match[3] || '0').to_i
73
+
74
+ new(major, minor, patch)
75
+ end
76
+
77
+ # Compare this version to another
78
+ #
79
+ # @param other [Git::Version] the version to compare to
80
+ #
81
+ # @return [Integer] -1, 0, or 1
82
+ #
83
+ def <=>(other)
84
+ [major, minor, patch] <=> [other.major, other.minor, other.patch]
85
+ end
86
+
87
+ # Return the version as a dotted string
88
+ #
89
+ # @return [String] the version in "major.minor.patch" format
90
+ #
91
+ def to_s
92
+ "#{major}.#{minor}.#{patch}"
93
+ end
94
+
95
+ # Return a readable representation
96
+ #
97
+ # @return [String] inspect string
98
+ #
99
+ def inspect
100
+ "#<Git::Version #{self}>"
101
+ end
102
+
103
+ # Return the version as an array of integers
104
+ #
105
+ # Useful when legacy code expects the array shape returned by the
106
+ # deprecated `Git::Lib#current_command_version` method.
107
+ #
108
+ # @example Get version as integer components
109
+ # Git.git_version.to_a #=> [2, 42, 0]
110
+ #
111
+ # @return [Array<Integer>] [major, minor, patch]
112
+ def to_a
113
+ deconstruct
114
+ end
115
+ end
7
116
  end
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Git
4
+ # Represents a git version constraint with minimum and upper bound versions
5
+ #
6
+ # Used by {Git::Commands::Base.requires_git_version} to declare version requirements
7
+ # and by {Git::VersionError} to report constraint violations.
8
+ #
9
+ # @example Minimum version only
10
+ # constraint = Git::VersionConstraint.new(min: Git::Version.parse('2.30.0'))
11
+ # constraint.too_old?(Git::Version.parse('2.28.0')) #=> true
12
+ # constraint.too_new?(Git::Version.parse('2.28.0')) #=> false
13
+ #
14
+ # @example Upper bound only
15
+ # constraint = Git::VersionConstraint.new(before: Git::Version.parse('2.50.0'))
16
+ # constraint.too_old?(Git::Version.parse('2.51.0')) #=> false
17
+ # constraint.too_new?(Git::Version.parse('2.51.0')) #=> true
18
+ #
19
+ # @example Both bounds
20
+ # constraint = Git::VersionConstraint.new(
21
+ # min: Git::Version.parse('2.30.0'),
22
+ # before: Git::Version.parse('2.50.0')
23
+ # )
24
+ # constraint.satisfied_by?(Git::Version.parse('2.40.0')) #=> true
25
+ #
26
+ # @api public
27
+ #
28
+ VersionConstraint = Data.define(:min, :before) do
29
+ # Initialize a new VersionConstraint
30
+ #
31
+ # @param min [Git::Version, nil] minimum version (inclusive)
32
+ #
33
+ # @param before [Git::Version, nil] upper bound version (exclusive)
34
+ #
35
+ def initialize(min: nil, before: nil)
36
+ super
37
+ end
38
+
39
+ # Check if the given version is too old (below the minimum)
40
+ #
41
+ # @param version [Git::Version] the version to check
42
+ #
43
+ # @return [Boolean] true if version is below the minimum, false otherwise
44
+ #
45
+ def too_old?(version)
46
+ return false unless min
47
+
48
+ version < min
49
+ end
50
+
51
+ # Check if the given version is too new (at or past the upper bound)
52
+ #
53
+ # @param version [Git::Version] the version to check
54
+ #
55
+ # @return [Boolean] true if version is at or past the upper bound, false otherwise
56
+ #
57
+ def too_new?(version)
58
+ return false unless before
59
+
60
+ version >= before
61
+ end
62
+
63
+ # Check if the given version satisfies this constraint
64
+ #
65
+ # @param version [Git::Version] the version to check
66
+ #
67
+ # @return [Boolean] true if the version satisfies the constraint
68
+ #
69
+ def satisfied_by?(version)
70
+ !too_old?(version) && !too_new?(version)
71
+ end
72
+
73
+ # Return a human-readable representation of this constraint
74
+ #
75
+ # @return [String] the constraint in git version range form
76
+ #
77
+ def to_s
78
+ return ">= #{min}, < #{before}" if min && before
79
+ return ">= #{min}" if min
80
+ return "< #{before}" if before
81
+
82
+ 'any version'
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,128 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Git
4
+ # Immutable value object for one entry of `git worktree list`
5
+ #
6
+ # Each entry carries what `git worktree list --porcelain` reports for a
7
+ # worktree: its path, the checked-out HEAD and branch, and whether it is bare,
8
+ # detached, locked, or prunable, with the reason git gives for the last two.
9
+ #
10
+ # @example A locked linked worktree with a branch checked out
11
+ # info = Git::WorktreeInfo.new(
12
+ # path: '/tmp/wt/linked',
13
+ # head: 'f3e2c1ffb860086504eeb27b77a1d0028b68fd8f',
14
+ # branch: 'refs/heads/linked',
15
+ # bare: false,
16
+ # detached: false,
17
+ # locked: true,
18
+ # lock_reason: 'on purpose',
19
+ # prunable: false,
20
+ # prune_reason: nil
21
+ # )
22
+ #
23
+ # info.path # => '/tmp/wt/linked'
24
+ # info.head # => 'f3e2c1ffb860086504eeb27b77a1d0028b68fd8f'
25
+ # info.branch # => 'refs/heads/linked'
26
+ # info.locked? # => true
27
+ # info.lock_reason # => 'on purpose'
28
+ # info.detached? # => false
29
+ # info.to_s # => '/tmp/wt/linked'
30
+ #
31
+ # @example Pass an entry back to a worktree operation
32
+ # info = repo.worktree_list.find { |w| w.branch == 'refs/heads/linked' }
33
+ # repo.worktree_remove(info)
34
+ #
35
+ # @see Git::Repository::WorktreeOperations#worktree_list for the repository
36
+ # method that returns these
37
+ #
38
+ # @api public
39
+ #
40
+ # @!attribute [r] path
41
+ # @return [String] the worktree directory as git reports it
42
+ #
43
+ # @!attribute [r] head
44
+ # @return [String, nil] the full object ID of the checked-out HEAD commit
45
+ # (the all-zero object ID when the branch has no commits yet), or nil for a
46
+ # bare main worktree
47
+ #
48
+ # @!attribute [r] branch
49
+ # @return [String, nil] the full refname of the checked-out branch (e.g.,
50
+ # 'refs/heads/main'), or nil when the worktree is bare or detached
51
+ #
52
+ # @!attribute [r] bare
53
+ # @return [Boolean] true if this is the main worktree of a bare repository
54
+ #
55
+ # @!attribute [r] detached
56
+ # @return [Boolean] true if HEAD is detached in this worktree
57
+ #
58
+ # @!attribute [r] locked
59
+ # @return [Boolean] true if the worktree is locked
60
+ #
61
+ # @!attribute [r] lock_reason
62
+ # @return [String, nil] the reason given when the worktree was locked, or nil
63
+ # when it is not locked or was locked without a reason
64
+ #
65
+ # @!attribute [r] prunable
66
+ # @return [Boolean] true if `git worktree prune` would remove this entry
67
+ #
68
+ # @!attribute [r] prune_reason
69
+ # @return [String, nil] git's explanation of why the entry is prunable, or
70
+ # nil when it is not prunable
71
+ #
72
+ WorktreeInfo = Data.define(
73
+ :path,
74
+ :head,
75
+ :branch,
76
+ :bare,
77
+ :detached,
78
+ :locked,
79
+ :lock_reason,
80
+ :prunable,
81
+ :prune_reason
82
+ ) do
83
+ # Whether this is the main worktree of a bare repository
84
+ #
85
+ # @example
86
+ # info.bare? # => false
87
+ #
88
+ # @return [Boolean] true if the worktree is bare
89
+ def bare? = bare
90
+
91
+ # Whether HEAD is detached in this worktree
92
+ #
93
+ # @example
94
+ # info.detached? # => false
95
+ #
96
+ # @return [Boolean] true if HEAD is detached
97
+ def detached? = detached
98
+
99
+ # Whether the worktree is locked
100
+ #
101
+ # @example
102
+ # info.locked? # => true
103
+ #
104
+ # @return [Boolean] true if the worktree is locked
105
+ def locked? = locked
106
+
107
+ # Whether `git worktree prune` would remove this entry
108
+ #
109
+ # @example
110
+ # info.prunable? # => false
111
+ #
112
+ # @return [Boolean] true if the entry is prunable
113
+ def prunable? = prunable
114
+
115
+ # Returns the worktree path
116
+ #
117
+ # Lets an entry be passed directly to the worktree operations that take a
118
+ # path, such as {Git::Repository::WorktreeOperations#worktree_remove}.
119
+ #
120
+ # @example Convert to string
121
+ # info.to_s # => '/tmp/wt/linked'
122
+ #
123
+ # @return [String] the worktree path
124
+ def to_s
125
+ path
126
+ end
127
+ end
128
+ end