/
base.rb
666 lines (586 loc) · 20.3 KB
/
base.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
require 'git/base/factory'
module Git
# Git::Base is the main public interface for interacting with Git commands.
#
# Instead of creating a Git::Base directly, obtain a Git::Base instance by
# calling one of the follow {Git} class methods: {Git.open}, {Git.init},
# {Git.clone}, or {Git.bare}.
#
class Base
include Git::Base::Factory
# (see Git.bare)
def self.bare(git_dir, options = {})
normalize_paths(options, default_repository: git_dir, bare: true)
self.new(options)
end
# (see Git.clone)
def self.clone(repository, name, options = {})
new_options = Git::Lib.new(nil, options[:log]).clone(repository, name, options)
normalize_paths(new_options, bare: options[:bare] || options[:mirror])
self.new(new_options)
end
# Returns (and initialize if needed) a Git::Config instance
#
# @return [Git::Config] the current config instance.
def self.config
@@config ||= Config.new
end
# (see Git.init)
def self.init(directory = '.', options = {})
normalize_paths(options, default_working_directory: directory, default_repository: directory, bare: options[:bare])
init_options = {
:bare => options[:bare],
:initial_branch => options[:initial_branch]
}
directory = options[:bare] ? options[:repository] : options[:working_directory]
FileUtils.mkdir_p(directory) unless File.exist?(directory)
# TODO: this dance seems awkward: this creates a Git::Lib so we can call
# init so we can create a new Git::Base which in turn (ultimately)
# creates another/different Git::Lib.
#
# TODO: maybe refactor so this Git::Bare.init does this:
# self.new(opts).init(init_opts) and move all/some of this code into
# Git::Bare#init. This way the init method can be called on any
# repository you have a Git::Base instance for. This would not
# change the existing interface (other than adding to it).
#
Git::Lib.new(options).init(init_options)
self.new(options)
end
# (see Git.open)
def self.open(working_dir, options = {})
normalize_paths(options, default_working_directory: working_dir)
self.new(options)
end
# Create an object that executes Git commands in the context of a working
# copy or a bare repository.
#
# @param [Hash] options The options for this command (see list of valid
# options below)
#
# @option options [Pathname] :working_dir the path to the root of the working
# directory. Should be `nil` if executing commands on a bare repository.
#
# @option options [Pathname] :repository used to specify a non-standard path to
# the repository directory. The default is `"#{working_dir}/.git"`.
#
# @option options [Pathname] :index used to specify a non-standard path to an
# index file. The default is `"#{working_dir}/.git/index"`
#
# @option options [Logger] :log A logger to use for Git operations. Git
# commands are logged at the `:info` level. Additional logging is done
# at the `:debug` level.
#
# @return [Git::Base] an object that can execute git commands in the context
# of the opened working copy or bare repository
#
def initialize(options = {})
if working_dir = options[:working_directory]
options[:repository] ||= File.join(working_dir, '.git')
options[:index] ||= File.join(options[:repository], 'index')
end
if options[:log]
@logger = options[:log]
@logger.info("Starting Git")
else
@logger = nil
end
@working_directory = options[:working_directory] ? Git::WorkingDirectory.new(options[:working_directory]) : nil
@repository = options[:repository] ? Git::Repository.new(options[:repository]) : nil
@index = options[:index] ? Git::Index.new(options[:index], false) : nil
end
# changes current working directory for a block
# to the git working directory
#
# example
# @git.chdir do
# # write files
# @git.add
# @git.commit('message')
# end
def chdir # :yields: the Git::Path
Dir.chdir(dir.path) do
yield dir.path
end
end
#g.config('user.name', 'Scott Chacon') # sets value
#g.config('user.email', 'email@email.com') # sets value
#g.config('user.email', 'email@email.com', file: 'path/to/custom/config) # sets value in file
#g.config('user.name') # returns 'Scott Chacon'
#g.config # returns whole config hash
def config(name = nil, value = nil, options = {})
if name && value
# set value
lib.config_set(name, value, options)
elsif name
# return value
lib.config_get(name)
else
# return hash
lib.config_list
end
end
# returns a reference to the working directory
# @git.dir.path
# @git.dir.writeable?
def dir
@working_directory
end
# returns reference to the git index file
def index
@index
end
# returns reference to the git repository directory
# @git.dir.path
def repo
@repository
end
# returns the repository size in bytes
def repo_size
Dir.glob(File.join(repo.path, '**', '*'), File::FNM_DOTMATCH).reject do |f|
f.include?('..')
end.map do |f|
File.expand_path(f)
end.uniq.map do |f|
File.stat(f).size.to_i
end.reduce(:+)
end
def set_index(index_file, check = true)
@lib = nil
@index = Git::Index.new(index_file.to_s, check)
end
def set_working(work_dir, check = true)
@lib = nil
@working_directory = Git::WorkingDirectory.new(work_dir.to_s, check)
end
# returns +true+ if the branch exists locally
def is_local_branch?(branch)
branch_names = self.branches.local.map {|b| b.name}
branch_names.include?(branch)
end
# returns +true+ if the branch exists remotely
def is_remote_branch?(branch)
branch_names = self.branches.remote.map {|b| b.name}
branch_names.include?(branch)
end
# returns +true+ if the branch exists
def is_branch?(branch)
branch_names = self.branches.map {|b| b.name}
branch_names.include?(branch)
end
# this is a convenience method for accessing the class that wraps all the
# actual 'git' forked system calls. At some point I hope to replace the Git::Lib
# class with one that uses native methods or libgit C bindings
def lib
@lib ||= Git::Lib.new(self, @logger)
end
# Run a grep for 'string' on the HEAD of the git repository
#
# @example Limit grep's scope by calling grep() from a specific object:
# git.object("v2.3").grep('TODO')
#
# @example Using grep results:
# git.grep("TODO").each do |sha, arr|
# puts "in blob #{sha}:"
# arr.each do |line_no, match_string|
# puts "\t line #{line_no}: '#{match_string}'"
# end
# end
#
# @return [Hash<String, Array>] a hash of arrays
# ```Ruby
# {
# 'tree-ish1' => [[line_no1, match_string1], ...],
# 'tree-ish2' => [[line_no1, match_string1], ...],
# ...
# }
# ```
#
def grep(string, path_limiter = nil, opts = {})
self.object('HEAD').grep(string, path_limiter, opts)
end
# updates the repository index using the working directory content
#
# @example
# git.add
# git.add('path/to/file')
# git.add(['path/to/file1','path/to/file2'])
# git.add(:all => true)
#
# options:
# :all => true
#
# @param [String,Array] paths files paths to be added (optional, default='.')
# @param [Hash] options
# @option options [boolean] :all
# Update the index not only where the working tree has a file matching
# <pathspec> but also where the index already has an entry.
# See [the --all option to git-add](https://git-scm.com/docs/git-add#Documentation/git-add.txt--A)
# for more details.
#
def add(paths = '.', **options)
self.lib.add(paths, options)
end
# removes file(s) from the git repository
def remove(path = '.', opts = {})
self.lib.remove(path, opts)
end
# resets the working directory to the provided commitish
def reset(commitish = nil, opts = {})
self.lib.reset(commitish, opts)
end
# resets the working directory to the commitish with '--hard'
def reset_hard(commitish = nil, opts = {})
opts = {:hard => true}.merge(opts)
self.lib.reset(commitish, opts)
end
# cleans the working directory
#
# options:
# :force
# :d
# :ff
#
def clean(opts = {})
self.lib.clean(opts)
end
# returns the most recent tag that is reachable from a commit
#
# options:
# :all
# :tags
# :contains
# :debug
# :exact_match
# :dirty
# :abbrev
# :candidates
# :long
# :always
# :match
#
def describe(committish=nil, opts={})
self.lib.describe(committish, opts)
end
# reverts the working directory to the provided commitish.
# Accepts a range, such as comittish..HEAD
#
# options:
# :no_edit
#
def revert(commitish = nil, opts = {})
self.lib.revert(commitish, opts)
end
# commits all pending changes in the index file to the git repository
#
# options:
# :all
# :allow_empty
# :amend
# :author
#
def commit(message, opts = {})
self.lib.commit(message, opts)
end
# commits all pending changes in the index file to the git repository,
# but automatically adds all modified files without having to explicitly
# calling @git.add() on them.
def commit_all(message, opts = {})
opts = {:add_all => true}.merge(opts)
self.lib.commit(message, opts)
end
# checks out a branch as the new git working directory
def checkout(branch = 'master', opts = {})
self.lib.checkout(branch, opts)
end
# checks out an old version of a file
def checkout_file(version, file)
self.lib.checkout_file(version,file)
end
# fetches changes from a remote branch - this does not modify the working directory,
# it just gets the changes from the remote if there are any
def fetch(remote = 'origin', opts={})
self.lib.fetch(remote, opts)
end
# pushes changes to a remote repository - easiest if this is a cloned repository,
# otherwise you may have to run something like this first to setup the push parameters:
#
# @git.config('remote.remote-name.push', 'refs/heads/master:refs/heads/master')
#
def push(remote = 'origin', branch = 'master', opts = {})
# Small hack to keep backwards compatibility with the 'push(remote, branch, tags)' method signature.
opts = {:tags => opts} if [true, false].include?(opts)
self.lib.push(remote, branch, opts)
end
# merges one or more branches into the current working branch
#
# you can specify more than one branch to merge by passing an array of branches
def merge(branch, message = 'merge', opts = {})
self.lib.merge(branch, message, opts)
end
# iterates over the files which are unmerged
def each_conflict(&block) # :yields: file, your_version, their_version
self.lib.conflicts(&block)
end
# pulls the given branch from the given remote into the current branch
#
# @git.pull # pulls from origin/master
# @git.pull('upstream') # pulls from upstream/master
# @git.pull('upstream', 'develope') # pulls from upstream/develop
#
def pull(remote='origin', branch='master')
self.lib.pull(remote, branch)
end
# returns an array of Git:Remote objects
def remotes
self.lib.remotes.map { |r| Git::Remote.new(self, r) }
end
# adds a new remote to this repository
# url can be a git url or a Git::Base object if it's a local reference
#
# @git.add_remote('scotts_git', 'git://repo.or.cz/rubygit.git')
# @git.fetch('scotts_git')
# @git.merge('scotts_git/master')
#
# Options:
# :fetch => true
# :track => <branch_name>
def add_remote(name, url, opts = {})
url = url.repo.path if url.is_a?(Git::Base)
self.lib.remote_add(name, url, opts)
Git::Remote.new(self, name)
end
# sets the url for a remote
# url can be a git url or a Git::Base object if it's a local reference
#
# @git.set_remote_url('scotts_git', 'git://repo.or.cz/rubygit.git')
#
def set_remote_url(name, url)
url = url.repo.path if url.is_a?(Git::Base)
self.lib.remote_set_url(name, url)
Git::Remote.new(self, name)
end
# removes a remote from this repository
#
# @git.remove_remote('scott_git')
def remove_remote(name)
self.lib.remote_remove(name)
end
# returns an array of all Git::Tag objects for this repository
def tags
self.lib.tags.map { |r| tag(r) }
end
# Creates a new git tag (Git::Tag)
#
# @example
# repo.add_tag('tag_name', object_reference)
# repo.add_tag('tag_name', object_reference, {:options => 'here'})
# repo.add_tag('tag_name', {:options => 'here'})
#
# @param [String] name The name of the tag to add
# @param [Hash] options Opstions to pass to `git tag`.
# See [git-tag](https://git-scm.com/docs/git-tag) for more details.
# @option options [boolean] :annotate Make an unsigned, annotated tag object
# @option options [boolean] :a An alias for the `:annotate` option
# @option options [boolean] :d Delete existing tag with the given names.
# @option options [boolean] :f Replace an existing tag with the given name (instead of failing)
# @option options [String] :message Use the given tag message
# @option options [String] :m An alias for the `:message` option
# @option options [boolean] :s Make a GPG-signed tag.
#
def add_tag(name, *options)
self.lib.tag(name, *options)
self.tag(name)
end
# deletes a tag
def delete_tag(name)
self.lib.tag(name, {:d => true})
end
# creates an archive file of the given tree-ish
def archive(treeish, file = nil, opts = {})
self.object(treeish).archive(file, opts)
end
# repacks the repository
def repack
self.lib.repack
end
def gc
self.lib.gc
end
def apply(file)
if File.exist?(file)
self.lib.apply(file)
end
end
def apply_mail(file)
self.lib.apply_mail(file) if File.exist?(file)
end
# Shows objects
#
# @param [String|NilClass] objectish the target object reference (nil == HEAD)
# @param [String|NilClass] path the path of the file to be shown
# @return [String] the object information
def show(objectish=nil, path=nil)
self.lib.show(objectish, path)
end
## LOWER LEVEL INDEX OPERATIONS ##
def with_index(new_index) # :yields: new_index
old_index = @index
set_index(new_index, false)
return_value = yield @index
set_index(old_index)
return_value
end
def with_temp_index &blk
# Workaround for JRUBY, since they handle the TempFile path different.
# MUST be improved to be safer and OS independent.
if RUBY_PLATFORM == 'java'
temp_path = "/tmp/temp-index-#{(0...15).map{ ('a'..'z').to_a[rand(26)] }.join}"
else
tempfile = Tempfile.new('temp-index')
temp_path = tempfile.path
tempfile.close
tempfile.unlink
end
with_index(temp_path, &blk)
end
def checkout_index(opts = {})
self.lib.checkout_index(opts)
end
def read_tree(treeish, opts = {})
self.lib.read_tree(treeish, opts)
end
def write_tree
self.lib.write_tree
end
def write_and_commit_tree(opts = {})
tree = write_tree
commit_tree(tree, opts)
end
def update_ref(branch, commit)
branch(branch).update_ref(commit)
end
def ls_files(location=nil)
self.lib.ls_files(location)
end
def with_working(work_dir) # :yields: the Git::WorkingDirectory
return_value = false
old_working = @working_directory
set_working(work_dir)
Dir.chdir work_dir do
return_value = yield @working_directory
end
set_working(old_working)
return_value
end
def with_temp_working &blk
tempfile = Tempfile.new("temp-workdir")
temp_dir = tempfile.path
tempfile.close
tempfile.unlink
Dir.mkdir(temp_dir, 0700)
with_working(temp_dir, &blk)
end
# runs git rev-parse to convert the objectish to a full sha
#
# @example
# git.revparse("HEAD^^")
# git.revparse('v2.4^{tree}')
# git.revparse('v2.4:/doc/index.html')
#
def revparse(objectish)
self.lib.revparse(objectish)
end
def ls_tree(objectish)
self.lib.ls_tree(objectish)
end
def cat_file(objectish)
self.lib.object_contents(objectish)
end
# returns the name of the branch the working directory is currently on
def current_branch
self.lib.branch_current
end
private
# Normalize options before they are sent to Git::Base.new
#
# Updates the options parameter by setting appropriate values for the following keys:
# * options[:working_directory]
# * options[:repository]
# * options[:index]
#
# All three values will be set to absolute paths. An exception is that
# :working_directory will be set to nil if bare is true.
#
private_class_method def self.normalize_paths(
options, default_working_directory: nil, default_repository: nil, bare: false
)
normalize_working_directory(options, default: default_working_directory, bare: bare)
normalize_repository(options, default: default_repository, bare: bare)
normalize_index(options)
end
# Normalize options[:working_directory]
#
# If working with a bare repository, set to `nil`.
# Otherwise, set to the first non-nil value of:
# 1. `options[:working_directory]`,
# 2. the `default` parameter, or
# 3. the current working directory
#
# Finally, if options[:working_directory] is a relative path, convert it to an absoluite
# path relative to the current directory.
#
private_class_method def self.normalize_working_directory(options, default:, bare: false)
working_directory =
if bare
nil
else
File.expand_path(options[:working_directory] || default || Dir.pwd)
end
options[:working_directory] = working_directory
end
# Normalize options[:repository]
#
# If working with a bare repository, set to the first non-nil value out of:
# 1. `options[:repository]`
# 2. the `default` parameter
# 3. the current working directory
#
# Otherwise, set to the first non-nil value of:
# 1. `options[:repository]`
# 2. `.git`
#
# Next, if options[:repository] refers to a *file* and not a *directory*, set
# options[:repository] to the contents of that file. This is the case when
# working with a submodule or a secondary working tree (created with git worktree
# add). In these cases the repository is actually contained/nested within the
# parent's repository directory.
#
# Finally, if options[:repository] is a relative path, convert it to an absolute
# path relative to:
# 1. the current directory if working with a bare repository or
# 2. the working directory if NOT working with a bare repository
#
private_class_method def self.normalize_repository(options, default:, bare: false)
repository =
if bare
File.expand_path(options[:repository] || default || Dir.pwd)
else
File.expand_path(options[:repository] || '.git', options[:working_directory])
end
if File.file?(repository)
repository = File.expand_path(File.open(repository).read[8..-1].strip, options[:working_directory])
end
options[:repository] = repository
end
# Normalize options[:index]
#
# If options[:index] is a relative directory, convert it to an absolute
# directory relative to the repository directory
#
private_class_method def self.normalize_index(options)
index = File.expand_path(options[:index] || 'index', options[:repository])
options[:index] = index
end
end
end