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.



17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/git/lib.rb', line 17

def initialize(base = nil, logger = 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



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

def add(path = '.')
  path = path.join(' ') if path.is_a?(Array)
  command('add', path)
end

#apply(patch_file) ⇒ Object



387
388
389
390
391
# File 'lib/git/lib.rb', line 387

def apply(patch_file)
  arr_opts = []
  arr_opts << patch_file.to_s if patch_file
  command('apply', arr_opts)
end

#apply_mail(patch_file) ⇒ Object



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

def apply_mail(patch_file)
  arr_opts = []
  arr_opts << patch_file.to_s if patch_file
  command('am', arr_opts)
end

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

creates an archive file

options

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


579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
# File 'lib/git/lib.rb', line 579

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
  
  arr_opts = []
  arr_opts << "--format=#{opts[:format]}" if opts[:format]
  arr_opts << "--prefix=#{opts[:prefix]}" if opts[:prefix]
  arr_opts << "--remote=#{opts[:remote]}" if opts[:remote]
  arr_opts << sha
  arr_opts << opts[:path] if opts[:path]
  arr_opts << '| gzip' if opts[:add_gzip]
  arr_opts << "> #{file.to_s}"
  command('archive', arr_opts)
  return file
end

#branch_currentObject



214
215
216
# File 'lib/git/lib.rb', line 214

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

#branch_delete(branch) ⇒ Object



433
434
435
# File 'lib/git/lib.rb', line 433

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

#branch_new(branch) ⇒ Object



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

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

#branches_allObject



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

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



194
195
196
# File 'lib/git/lib.rb', line 194

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

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



437
438
439
440
441
442
443
444
# File 'lib/git/lib.rb', line 437

def checkout(branch, opts = {})
  arr_opts = []
  arr_opts << '-f' if opts[:force]
  arr_opts << ["-b '#{opts[:new_branch]}'"] if opts[:new_branch]      
  arr_opts << branch.to_s
  
  command('checkout', arr_opts)
end

#checkout_file(version, file) ⇒ Object



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

def checkout_file(version, file)
  arr_opts = []
  arr_opts << version.to_s
  arr_opts << file.to_s
  command('checkout', arr_opts)
end

#checkout_index(opts = {}) ⇒ Object



563
564
565
566
567
568
569
570
# File 'lib/git/lib.rb', line 563

def checkout_index(opts = {})
  arr_opts = []
  arr_opts << "--prefix=#{opts[:prefix]}" if opts[:prefix]
  arr_opts << "--force" if opts[:force]
  arr_opts << "--all" if opts[:all]
  arr_opts << ('-- ' + opts[:path_limiter]) if opts[:path_limiter].is_a? String
  command('checkout-index', arr_opts)
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



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

def clone(repository, name, opts = {})
  @path = opts[:path] || '.'
  clone_dir = opts[:path] ? File.join(@path, name) : name
  
  arr_opts = []
  arr_opts << "--bare" if opts[:bare]
  arr_opts << "-o #{opts[:remote]}" if opts[:remote]
  arr_opts << "--depth #{opts[:depth].to_i}" if opts[:depth] && opts[:depth].to_i > 0
  arr_opts << repository
  arr_opts << clone_dir
  
  command('clone', arr_opts)
  
  opts[:bare] ? {:repository => clone_dir} : {:working_directory => clone_dir}
end

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



372
373
374
375
376
377
378
# File 'lib/git/lib.rb', line 372

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

#commit_data(sha) ⇒ Object

returns useful array of raw commit object data



120
121
122
123
124
# File 'lib/git/lib.rb', line 120

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

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



545
546
547
548
549
550
551
552
553
554
555
556
557
# File 'lib/git/lib.rb', line 545

def commit_tree(tree, opts = {})
  opts[:message] ||= "commit tree #{tree}"
  t = Tempfile.new('commit-message')
  t.write(opts[:message])
  t.close
  
  arr_opts = []
  arr_opts << tree
  arr_opts << "-p #{opts[:parent]}" if opts[:parent]
  arr_opts += opts[:parents].map { |p| "-p #{p.to_s}" } if opts[:parents]
  arr_opts << "< #{t.path}"
  command('commit-tree', arr_opts)
end

#config_get(name) ⇒ Object



315
316
317
318
# File 'lib/git/lib.rb', line 315

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

#config_listObject



320
321
322
323
324
325
326
327
328
329
330
# File 'lib/git/lib.rb', line 320

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



305
306
307
308
309
310
311
312
313
# File 'lib/git/lib.rb', line 305

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 ##



353
354
355
# File 'lib/git/lib.rb', line 353

def config_set(name, value)
  command('config', [name, "'#{value}'"])
end

#conflictsObject

:yields: file, your, their



468
469
470
471
472
473
474
475
476
477
478
479
# File 'lib/git/lib.rb', line 468

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

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

#diff_filesObject

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



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

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

#full_log_commits(opts = {}) ⇒ Object



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

def full_log_commits(opts = {})
  arr_opts = ['--pretty=raw']
  arr_opts << "-#{opts[:count]}" if opts[:count]
  arr_opts << "--skip=\"#{opts[:skip]}\"" if opts[:skip]
  arr_opts << "--since=\"#{opts[:since]}\"" if opts[:since].is_a? String
  arr_opts << "--until=\"#{opts[:until]}\"" if opts[:until].is_a? String
  arr_opts << "--grep=\"#{opts[:grep]}\"" if opts[:grep].is_a? String
  arr_opts << "--author=\"#{opts[:author]}\"" if opts[:author].is_a? String
  arr_opts << "#{opts[:between][0].to_s}..#{opts[:between][1].to_s}" if (opts[:between] && opts[:between].size == 2)
  arr_opts << opts[:object] if opts[:object].is_a? String
  arr_opts << '-- ' + opts[:path_limiter] if opts[:path_limiter].is_a? String
  
  full_log = command_lines('log', arr_opts, true)
  process_commit_data(full_log)
end

#full_tree(sha) ⇒ Object



186
187
188
# File 'lib/git/lib.rb', line 186

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

#gcObject



529
530
531
# File 'lib/git/lib.rb', line 529

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]]



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

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 '#{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

#initObject



30
31
32
# File 'lib/git/lib.rb', line 30

def init
  command('init')
end

#list_files(ref_dir) ⇒ Object



207
208
209
210
211
212
# File 'lib/git/lib.rb', line 207

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



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

def log_commits(opts = {})
  arr_opts = ['--pretty=oneline']
  arr_opts << "-#{opts[:count]}" if opts[:count]
  arr_opts << "--since=\"#{opts[:since]}\"" if opts[:since].is_a? String
  arr_opts << "--until=\"#{opts[:until]}\"" if opts[:until].is_a? String
  arr_opts << "--grep=\"#{opts[:grep]}\"" if opts[:grep].is_a? String
  arr_opts << "--author=\"#{opts[:author]}\"" if opts[:author].is_a? String
  arr_opts << "#{opts[:between][0].to_s}..#{opts[:between][1].to_s}" if (opts[:between] && opts[:between].size == 2)
  arr_opts << opts[:object] if opts[:object].is_a? String
  arr_opts << '-- ' + opts[:path_limiter] if opts[:path_limiter].is_a? String
  
  command_lines('log', arr_opts, true).map { |l| l.split.first }
end

#ls_filesObject



294
295
296
297
298
299
300
301
302
# 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
    hsh[file] = {:path => file, :mode_index => mode, :sha_index => sha, :stage => stage}
  end
  hsh
end

#ls_tree(sha) ⇒ Object



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

def ls_tree(sha)
  data = {'blob' => {}, 'tree' => {}}
  
  command_lines('ls-tree', sha.to_s).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



453
454
455
456
457
458
# File 'lib/git/lib.rb', line 453

def merge(branch, message = nil)      
  arr_opts = []
  arr_opts << ["-m '#{message}'"] if message
  arr_opts << branch.to_a.join(' ')
  command('merge', arr_opts)
end

#mv(file1, file2) ⇒ Object



182
183
184
# File 'lib/git/lib.rb', line 182

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

#namerev(string) ⇒ Object



107
108
109
# File 'lib/git/lib.rb', line 107

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

#object_contents(sha, &block) ⇒ Object



166
167
168
# File 'lib/git/lib.rb', line 166

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

#object_size(sha) ⇒ Object



115
116
117
# File 'lib/git/lib.rb', line 115

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

#object_type(sha) ⇒ Object



111
112
113
# File 'lib/git/lib.rb', line 111

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

#parse_config(file) ⇒ Object



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/git/lib.rb', line 332

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) ⇒ Object



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

def process_commit_data(data, sha = nil)
  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 << "\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



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

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

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

reads a tree into the current index file



534
535
536
537
538
539
# File 'lib/git/lib.rb', line 534

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

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



481
482
483
484
485
486
487
488
# File 'lib/git/lib.rb', line 481

def remote_add(name, url, opts = {})
  arr_opts = ['add']
  arr_opts << '-f' if opts[:with_fetch]
  arr_opts << name
  arr_opts << url
  
  command('remote', arr_opts)
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



492
493
494
# File 'lib/git/lib.rb', line 492

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

#remotesObject



496
497
498
# File 'lib/git/lib.rb', line 496

def remotes
  command_lines('remote')
end

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



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

def remove(path = '.', opts = {})
  path = path.join(' ') if path.is_a?(Array)

  arr_opts = ['-f']  # overrides the up-to-date check by default
  arr_opts << ['-r'] if opts[:recursive]
  arr_opts << path

  command('rm', arr_opts)
end

#repackObject



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

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

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



380
381
382
383
384
385
# File 'lib/git/lib.rb', line 380

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

#revparse(string) ⇒ Object



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

def revparse(string)
  return string if string =~ /\w{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) ⇒ Object



416
417
418
419
# File 'lib/git/lib.rb', line 416

def stash_apply(id)
  command('stash apply', [id])
  # Already uptodate! ---???? What then
end

#stash_clearObject



421
422
423
# File 'lib/git/lib.rb', line 421

def stash_clear
  command('stash clear')
end

#stash_listObject



425
426
427
# File 'lib/git/lib.rb', line 425

def stash_list
  command('stash list')
end

#stash_save(message) ⇒ Object



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

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

#stashes_allObject



399
400
401
402
403
404
405
406
407
408
409
# File 'lib/git/lib.rb', line 399

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



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

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

#tag_sha(tag_name) ⇒ Object



518
519
520
521
522
523
# File 'lib/git/lib.rb', line 518

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

#tagsObject



500
501
502
# File 'lib/git/lib.rb', line 500

def tags
  command_lines('tag')
end

#tree_depth(sha) ⇒ Object



190
191
192
# File 'lib/git/lib.rb', line 190

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

#unmergedObject



460
461
462
463
464
465
466
# File 'lib/git/lib.rb', line 460

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

#update_ref(branch, commit) ⇒ Object



559
560
561
# File 'lib/git/lib.rb', line 559

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

#write_treeObject



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

def write_tree
  command('write-tree')
end