Class: Git::Lib

Inherits:
Object
  • Object
show all
Defined in:
lib/git/lib.rb

Instance Method Summary collapse

Constructor Details

#initialize(base = nil, logger = nil) ⇒ Lib

Returns a new instance of Lib.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/git/lib.rb', line 10

def initialize(base = nil, logger = nil)
  @git_dir = nil
  @git_index_file = nil
  @git_work_dir = nil
  @path = nil

  if base.is_a?(Git::Base)
    @git_dir = base.repo.path
    @git_index_file = base.index.path if base.index
    @git_work_dir = base.dir.path if base.dir
  elsif base.is_a?(Hash)
    @git_dir = base[:repository]
    @git_index_file = base[:index]
    @git_work_dir = base[:working_directory]
  end
  @logger = logger
end

Instance Method Details

#add(path = '.') ⇒ Object 



361
362
363
364
365
366
367
368
369
 
# File 'lib/git/lib.rb', line 361

def add(path = '.')
  args = ['--']
  if path.is_a?(Array)
    args += path
  else
    args << path
  end
  command('add', args)
end

#apply(patch_file) ⇒ Object 



403
404
405
406
407
 
# File 'lib/git/lib.rb', line 403

def apply(patch_file)
  args = []
  args << '--' << patch_file if patch_file
  command('apply', args)
end

#apply_mail(patch_file) ⇒ Object 



409
410
411
412
413
 
# File 'lib/git/lib.rb', line 409

def apply_mail(patch_file)
  args = []
  args << '--' << patch_file if patch_file
  command('am', args)
end

#archive(sha, file = nil, opts = {}) ⇒ Object

creates an archive file

options

:format  (zip, tar)
:prefix
:remote
:path



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/git/lib.rb', line 591

def archive(sha, file = nil, opts = {})
  opts[:format] ||= 'zip'

  if opts[:format] == 'tgz'
    opts[:format] = 'tar'
    opts[:add_gzip] = true
  end

  file ||= Tempfile.new('archive').path

  args = []
  args << "--format=#{opts[:format]}" if opts[:format]
  args << "--prefix=#{opts[:prefix]}" if opts[:prefix]
  args << "--remote=#{opts[:remote]}" if opts[:remote]
  args << sha
  args << '--' << opts[:path] if opts[:path]
  command('archive', args, true, (opts[:add_gzip] ? '| gzip' : '') + " > #{escape file}")
  return file
end

#branch_current ⇒ Object 



212
213
214
 
# File 'lib/git/lib.rb', line 212

def branch_current
  branches_all.select { |b| b[1] }.first[0] rescue nil
end

#branch_delete(branch) ⇒ Object 



452
453
454
 
# File 'lib/git/lib.rb', line 452

def branch_delete(branch)
  command('branch', ['-D', branch])
end

#branch_new(branch) ⇒ Object 



448
449
450
 
# File 'lib/git/lib.rb', line 448

def branch_new(branch)
  command('branch', branch)
end

#branches_all ⇒ Object 



196
197
198
199
200
201
202
203
 
# File 'lib/git/lib.rb', line 196

def branches_all
  arr = []
  command_lines('branch', '-a').each do |b|
    current = (b[0, 2] == '* ')
    arr << [b.gsub('* ', '').strip, current]
  end
  arr
end

#change_head_branch(branch_name) ⇒ Object 



192
193
194
 
# File 'lib/git/lib.rb', line 192

def change_head_branch(branch_name)
  command('symbolic-ref', ['HEAD', "refs/heads/#{branch_name}"])
end

#checkout(branch, opts = {}) ⇒ Object 



456
457
458
459
460
461
462
463
 
# File 'lib/git/lib.rb', line 456

def checkout(branch, opts = {})
  args = []
  args << '-f' if opts[:force]
  args << '-b' << opts[:new_branch] if opts[:new_branch]
  args << branch

  command('checkout', args)
end

#checkout_file(version, file) ⇒ Object 



465
466
467
 
# File 'lib/git/lib.rb', line 465

def checkout_file(version, file)
  command('checkout', [version, '--', file])
end

#checkout_index(opts = {}) ⇒ Object 



574
575
576
577
578
579
580
581
582
 
# File 'lib/git/lib.rb', line 574

def checkout_index(opts = {})
  args = []
  args << "--prefix=#{opts[:prefix]}" if opts[:prefix]
  args << "--force" if opts[:force]
  args << "--all" if opts[:all]
  args << '--' << opts[:path_limiter] if opts[:path_limiter].is_a? String

  command('checkout-index', args)
end

#clone(repository, name, opts = {}) ⇒ Object

tries to clone the given repo

returns :repository (if bare)

{:working_directory} otherwise

accepts options:

:remote:: name of remote (rather than 'origin')
:bare::   no working directory
:depth::  the number of commits back to pull

TODO - make this work with SSH password or auth_key



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/git/lib.rb', line 44

def clone(repository, name, opts = {})
  @path = opts[:path] || '.'
  clone_dir = opts[:path] ? File.join(@path, name) : name

  args = []
  args << "--bare" if opts[:bare]
  args << "-o" << opts[:remote] if opts[:remote]
  args << "--depth" << opts[:depth].to_i if opts[:depth] && opts[:depth].to_i > 0

  args << '--' << repository << clone_dir

  command('clone', args)

  opts[:bare] ? {:repository => clone_dir} : {:working_directory => clone_dir}
end

#commit(message, opts = {}) ⇒ Object 



384
385
386
387
388
389
390
 
# File 'lib/git/lib.rb', line 384

def commit(message, opts = {})
  args = ['-m', message]
  args << '-a' if opts[:add_all]
  args << '--allow-empty' if opts[:allow_empty]
  args << "--author" << opts[:author] if opts[:author]
  command('commit', args)
end

#commit_data(sha) ⇒ Object

returns useful array of raw commit object data



118
119
120
121
122
 
# File 'lib/git/lib.rb', line 118

def commit_data(sha)
  sha = sha.to_s
  cdata = command_lines('cat-file', ['commit', sha])
  process_commit_data(cdata, sha, 0)
end

#commit_tree(tree, opts = {}) ⇒ Object 



558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/git/lib.rb', line 558

def commit_tree(tree, opts = {})
  opts[:message] ||= "commit tree #{tree}"
  t = Tempfile.new('commit-message')
  t.write(opts[:message])
  t.close

  args = [tree]
  args << '-p' << opts[:parent] if opts[:parent]
  args += [opts[:parents]].map { |p| ['-p', p] }.flatten if opts[:parents]
  command('commit-tree', args, true, "< #{escape t.path}")
end

#config_get(name) ⇒ Object 



319
320
321
322
 
# File 'lib/git/lib.rb', line 319

def config_get(name)
  config_list[name]
  #command('config', ['--get', name])
end

#config_list ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/git/lib.rb', line 324

def config_list
  config = {}
  config.merge!(parse_config('~/.gitconfig'))
  config.merge!(parse_config(File.join(@git_dir, 'config')))
  #hsh = {}
  #command_lines('config', ['--list']).each do |line|
  #  (key, value) = line.split('=')
  #  hsh[key] = value
  #end
  #hsh
end

#config_remote(name) ⇒ Object 



309
310
311
312
313
314
315
316
317
 
# File 'lib/git/lib.rb', line 309

def config_remote(name)
  hsh = {}
  config_list.each do |key, value|
    if /remote.#{name}/.match(key)
      hsh[key.gsub("remote.#{name}.", '')] = value
    end
  end
  hsh
end

#config_set(name, value) ⇒ Object

WRITE COMMANDS ##



357
358
359
 
# File 'lib/git/lib.rb', line 357

def config_set(name, value)
  command('config', [name, value])
end

#conflicts ⇒ Object

:yields: file, your, their



484
485
486
487
488
489
490
491
492
493
 
# File 'lib/git/lib.rb', line 484

def conflicts # :yields: file, your, their
  self.unmerged.each do |f|
    your = Tempfile.new("YOUR-#{File.basename(f)}").path
    command('show', ":2:#{f}", true, "> #{escape your}")

    their = Tempfile.new("THEIR-#{File.basename(f)}").path
    command('show', ":3:#{f}", true, "> #{escape their}")
    yield(f, your, their)
  end
end

#diff_files ⇒ Object

compares the index and the working directory



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/git/lib.rb', line 271

def diff_files
  hsh = {}
  command_lines('diff-files').each do |line|
    (info, file) = line.split("\t")
    (mode_src, mode_dest, sha_src, sha_dest, type) = info.split
    hsh[file] = {:path => file, :mode_file => mode_src.to_s[1, 7], :mode_index => mode_dest,
                  :sha_file => sha_src, :sha_index => sha_dest, :type => type}
  end
  hsh
end

#diff_full(obj1 = 'HEAD', obj2 = nil, opts = {}) ⇒ Object 



241
242
243
244
245
246
247
248
 
# File 'lib/git/lib.rb', line 241

def diff_full(obj1 = 'HEAD', obj2 = nil, opts = {})
  diff_opts = ['-p']
  diff_opts << obj1
  diff_opts << obj2 if obj2.is_a?(String)
  diff_opts << '--' << opts[:path_limiter] if opts[:path_limiter].is_a? String

  command('diff', diff_opts)
end

#diff_index(treeish) ⇒ Object

compares the index and the repository



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/git/lib.rb', line 283

def diff_index(treeish)
  hsh = {}
  command_lines('diff-index', treeish).each do |line|
    (info, file) = line.split("\t")
    (mode_src, mode_dest, sha_src, sha_dest, type) = info.split
    hsh[file] = {:path => file, :mode_repo => mode_src.to_s[1, 7], :mode_index => mode_dest,
                  :sha_repo => sha_src, :sha_index => sha_dest, :type => type}
  end
  hsh
end

#diff_stats(obj1 = 'HEAD', obj2 = nil, opts = {}) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/git/lib.rb', line 250

def diff_stats(obj1 = 'HEAD', obj2 = nil, opts = {})
  diff_opts = ['--numstat']
  diff_opts << obj1
  diff_opts << obj2 if obj2.is_a?(String)
  diff_opts << '--' << opts[:path_limiter] if opts[:path_limiter].is_a? String

  hsh = {:total => {:insertions => 0, :deletions => 0, :lines => 0, :files => 0}, :files => {}}

  command_lines('diff', diff_opts).each do |file|
    (insertions, deletions, filename) = file.split("\t")
    hsh[:total][:insertions] += insertions.to_i
    hsh[:total][:deletions] += deletions.to_i
    hsh[:total][:lines] = (hsh[:total][:deletions] + hsh[:total][:insertions])
    hsh[:total][:files] += 1
    hsh[:files][filename] = {:insertions => insertions.to_i, :deletions => deletions.to_i}
  end

  hsh
end

#fetch(remote) ⇒ Object 



522
523
524
 
# File 'lib/git/lib.rb', line 522

def fetch(remote)
  command('fetch', remote)
end

#full_log_commits(opts = {}) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/git/lib.rb', line 78

def full_log_commits(opts = {})
  args = ['--pretty=raw']
  args << "-#{opts[:count]}" if opts[:count]
  args << "--skip=#{opts[:skip]}" if opts[:skip]
  args << "--since=#{opts[:since]}" if opts[:since].is_a? String
  args << "--until=#{opts[:until]}" if opts[:until].is_a? String
  args << "--grep=#{opts[:grep]}" if opts[:grep].is_a? String
  args << "--author=#{opts[:author]}" if opts[:author].is_a? String
  args << "#{opts[:between][0].to_s}..#{opts[:between][1].to_s}" if (opts[:between] && opts[:between].size == 2)
  args << opts[:object] if opts[:object].is_a? String
  args << '--' << opts[:path_limiter] if opts[:path_limiter].is_a? String

  full_log = command_lines('log', args, true)
  process_commit_data(full_log)
end

#full_tree(sha) ⇒ Object 



184
185
186
 
# File 'lib/git/lib.rb', line 184

def full_tree(sha)
  command_lines('ls-tree', ['-r', sha])
end

#gc ⇒ Object 



542
543
544
 
# File 'lib/git/lib.rb', line 542

def gc
  command('gc', ['--prune', '--aggressive', '--auto'])
end

#grep(string, opts = {}) ⇒ Object

returns hash

tree-ish

[[line_no, match], [line_no, match2]]

tree-ish

[[line_no, match], [line_no, match2]]



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/git/lib.rb', line 220

def grep(string, opts = {})
  opts[:object] ||= 'HEAD'

  grep_opts = ['-n']
  grep_opts << '-i' if opts[:ignore_case]
  grep_opts << '-v' if opts[:invert_match]
  grep_opts << '-e'
  grep_opts << string
  grep_opts << opts[:object] if opts[:object].is_a?(String)
  grep_opts << '--' << opts[:path_limiter] if opts[:path_limiter].is_a? String

  hsh = {}
  command_lines('grep', grep_opts).each do |line|
    if m = /(.*)\:(\d+)\:(.*)/.match(line)
      hsh[m[1]] ||= []
      hsh[m[1]] << [m[2].to_i, m[3]]
    end
  end
  hsh
end

#ignored_files ⇒ Object 



305
306
307
 
# File 'lib/git/lib.rb', line 305

def ignored_files
  command_lines('ls-files', ['--others', '-i', '--exclude-standard'])
end

#init ⇒ Object 



28
29
30
 
# File 'lib/git/lib.rb', line 28

def init
  command('init')
end

#list_files(ref_dir) ⇒ Object 



205
206
207
208
209
210
 
# File 'lib/git/lib.rb', line 205

def list_files(ref_dir)
  dir = File.join(@git_dir, 'refs', ref_dir)
  files = []
  Dir.chdir(dir) { files = Dir.glob('**/*').select { |f| File.file?(f) } } rescue nil
  files
end

#log_commits(opts = {}) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/git/lib.rb', line 64

def log_commits(opts = {})
  args = ['--pretty=oneline']
  args << "-#{opts[:count]}" if opts[:count]
  args << "--since=#{opts[:since]}" if opts[:since].is_a? String
  args << "--until=#{opts[:until]}" if opts[:until].is_a? String
  args << "--grep=#{opts[:grep]}" if opts[:grep].is_a? String
  args << "--author=#{opts[:author]}" if opts[:author].is_a? String
  args << "#{opts[:between][0].to_s}..#{opts[:between][1].to_s}" if (opts[:between] && opts[:between].size == 2)
  args << opts[:object] if opts[:object].is_a? String
  args << '--' << opts[:path_limiter] if opts[:path_limiter].is_a? String

  command_lines('log', args, true).map { |l| l.split.first }
end

#ls_files ⇒ Object 



294
295
296
297
298
299
300
301
302
303
 
# File 'lib/git/lib.rb', line 294

def ls_files
  hsh = {}
  command_lines('ls-files', '--stage').each do |line|
    (info, file) = line.split("\t")
    (mode, sha, stage) = info.split
    file = eval(file) if file =~ /^\".*\"$/ # This takes care of quoted strings returned from git
    hsh[file] = {:path => file, :mode_index => mode, :sha_index => sha, :stage => stage}
  end
  hsh
end

#ls_tree(sha) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/git/lib.rb', line 168

def ls_tree(sha)
  data = {'blob' => {}, 'tree' => {}}

  command_lines('ls-tree', sha).each do |line|
    (info, filenm) = line.split("\t")
    (mode, type, sha) = info.split
    data[type][filenm] = {:mode => mode, :sha => sha}
  end

  data
end

#merge(branch, message = nil) ⇒ Object 



469
470
471
472
473
474
 
# File 'lib/git/lib.rb', line 469

def merge(branch, message = nil)
  args = []
  args << '-m' << message if message
  args += [branch]
  command('merge', args)
end

#mv(file1, file2) ⇒ Object 



180
181
182
 
# File 'lib/git/lib.rb', line 180

def mv(file1, file2)
  command_lines('mv', ['--', file1, file2])
end

#namerev(string) ⇒ Object 



105
106
107
 
# File 'lib/git/lib.rb', line 105

def namerev(string)
  command('name-rev', string).split[1]
end

#object_contents(sha, &block) ⇒ Object 



164
165
166
 
# File 'lib/git/lib.rb', line 164

def object_contents(sha, &block)
  command('cat-file', ['-p', sha], &block)
end

#object_size(sha) ⇒ Object 



113
114
115
 
# File 'lib/git/lib.rb', line 113

def object_size(sha)
  command('cat-file', ['-s', sha]).to_i
end

#object_type(sha) ⇒ Object 



109
110
111
 
# File 'lib/git/lib.rb', line 109

def object_type(sha)
  command('cat-file', ['-t', sha])
end

#parse_config(file) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/git/lib.rb', line 336

def parse_config(file)
  hsh = {}
  file = File.expand_path(file)
  if File.file?(file)
    current_section = nil
    File.readlines(file).each do |line|
      if m = /\[(\w+)\]/.match(line)
        current_section = m[1]
      elsif m = /\[(\w+?) "(.*?)"\]/.match(line)
        current_section = "#{m[1]}.#{m[2]}"
      elsif m = /(\w+?) = (.*)/.match(line)
        key = "#{current_section}.#{m[1]}"
        hsh[key] = m[2]
      end
    end
  end
  hsh
end

#process_commit_data(data, sha = nil, indent = 4) ⇒ Object 



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
 
# File 'lib/git/lib.rb', line 124

def process_commit_data(data, sha = nil, indent = 4)
  in_message = false

  if sha
    hsh = {'sha' => sha, 'message' => '', 'parent' => []}
  else
    hsh_array = []
  end

  data.each do |line|
    line = line.chomp
    if line == ''
      in_message = !in_message
    elsif in_message
      hsh['message'] << line[indent..-1] << "\n"
    else
      data = line.split
      key = data.shift
      value = data.join(' ')
      if key == 'commit'
        sha = value
        hsh_array << hsh if hsh
        hsh = {'sha' => sha, 'message' => '', 'parent' => []}
      end
      if key == 'parent'
        hsh[key] << value
      else
        hsh[key] = value
      end
    end
  end

  if hsh_array
    hsh_array << hsh if hsh
    hsh_array
  else
    hsh
  end
end

#push(remote, branch = 'master', tags = false) ⇒ Object 



526
527
528
529
 
# File 'lib/git/lib.rb', line 526

def push(remote, branch = 'master', tags = false)
  command('push', [remote, branch])
  command('push', ['--tags', remote]) if tags
end

#read_tree(treeish, opts = {}) ⇒ Object

reads a tree into the current index file



547
548
549
550
551
552
 
# File 'lib/git/lib.rb', line 547

def read_tree(treeish, opts = {})
  args = []
  args << "--prefix=#{opts[:prefix]}" if opts[:prefix]
  args += [treeish]
  command('read-tree', args)
end

#remote_add(name, url, opts = {}) ⇒ Object 



495
496
497
498
499
500
501
 
# File 'lib/git/lib.rb', line 495

def remote_add(name, url, opts = {})
  args = ['add']
  args << '-f' if opts[:with_fetch]
  args << '--' << name << url

  command('remote', args)
end

#remote_remove(name) ⇒ Object

this is documented as such, but seems broken for some reason i’ll try to get around it some other way later



505
506
507
 
# File 'lib/git/lib.rb', line 505

def remote_remove(name)
  command('remote', ['rm', '--', name])
end

#remotes ⇒ Object 



509
510
511
 
# File 'lib/git/lib.rb', line 509

def remotes
  command_lines('remote')
end

#remove(path = '.', opts = {}) ⇒ Object 



371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/git/lib.rb', line 371

def remove(path = '.', opts = {})
  args = ['-f']  # overrides the up-to-date check by default
  args << '-r' if opts[:recursive]
  args << '--'
  if path.is_a?(Array)
    args += path
  else
    args << path
  end

  command('rm', args)
end

#repack ⇒ Object 



538
539
540
 
# File 'lib/git/lib.rb', line 538

def repack
  command('repack', ['-a', '-d'])
end

#reset(commit, opts = {}) ⇒ Object 



392
393
394
395
396
397
 
# File 'lib/git/lib.rb', line 392

def reset(commit, opts = {})
  args = []
  args << '--hard' if opts[:hard]
  args << commit if commit
  command('reset', args)
end

#revert(commit) ⇒ Object 



399
400
401
 
# File 'lib/git/lib.rb', line 399

def revert(commit)
  command('revert', ['--no-edit', commit])
end

#revparse(string) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/git/lib.rb', line 94

def revparse(string)
  return string if string =~ /[A-Fa-f0-9]{40}/  # passing in a sha - just no-op it
  rev = ['head', 'remotes', 'tags'].map do |d|
    File.join(@git_dir, 'refs', d, string)
  end.find do |path|
    File.file?(path)
  end
  return File.read(rev).chomp if rev
  command('rev-parse', string)
end

#stash_apply(id = nil) ⇒ Object 



432
433
434
435
436
437
438
 
# File 'lib/git/lib.rb', line 432

def stash_apply(id = nil)
  if id
    command('stash apply', [id])
  else
    command('stash apply')
  end
end

#stash_clear ⇒ Object 



440
441
442
 
# File 'lib/git/lib.rb', line 440

def stash_clear
  command('stash clear')
end

#stash_list ⇒ Object 



444
445
446
 
# File 'lib/git/lib.rb', line 444

def stash_list
  command('stash list')
end

#stash_save(message) ⇒ Object 



427
428
429
430
 
# File 'lib/git/lib.rb', line 427

def stash_save(message)
  output = command('stash save', ['--', message])
  output =~ /HEAD is now at/
end

#stashes_all ⇒ Object 



415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/git/lib.rb', line 415

def stashes_all
  arr = []
  filename = File.join(@git_dir, 'logs/refs/stash')
  if File.exist?(filename)
    File.open(filename).each_with_index { |line, i|
      m = line.match(/:(.*)$/)
      arr << [i, m[1].strip]
    }
  end
  arr
end

#tag(tag) ⇒ Object 



517
518
519
 
# File 'lib/git/lib.rb', line 517

def tag(tag)
  command('tag', tag)
end

#tag_sha(tag_name) ⇒ Object 



531
532
533
534
535
536
 
# File 'lib/git/lib.rb', line 531

def tag_sha(tag_name)
  head = File.join(@git_dir, 'refs', 'tags', tag_name)
  return File.read(head).chomp if File.exists?(head)

  command('show-ref',  ['--tags', '-s', tag_name])
end

#tags ⇒ Object 



513
514
515
 
# File 'lib/git/lib.rb', line 513

def tags
  command_lines('tag')
end

#tree_depth(sha) ⇒ Object 



188
189
190
 
# File 'lib/git/lib.rb', line 188

def tree_depth(sha)
  full_tree(sha).size
end

#unmerged ⇒ Object 



476
477
478
479
480
481
482
 
# File 'lib/git/lib.rb', line 476

def unmerged
  unmerged = []
  command_lines('diff', ["--cached"]).each do |line|
    unmerged << $1 if line =~ /^\* Unmerged path (.*)/
  end
  unmerged
end

#update_ref(branch, commit) ⇒ Object 



570
571
572
 
# File 'lib/git/lib.rb', line 570

def update_ref(branch, commit)
  command('update-ref', [branch, commit])
end

#write_tree ⇒ Object 



554
555
556
 
# File 'lib/git/lib.rb', line 554

def write_tree
  command('write-tree')
end