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
29
30
 
# 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
  if logger
    @logger = logger
  end
end

Instance Method Details

#add(path = '.') ⇒ Object 



362
363
364
365
 
# File 'lib/git/lib.rb', line 362

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

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

creates an archive file

options

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



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/git/lib.rb', line 569

def archive(sha, file = nil, opts = {})
  opts[:format] = 'zip' if !opts[:format]
  
  if opts[:format] == 'tgz'
    opts[:format] = 'tar' 
    opts[:add_gzip] = true
  end
  
  if !file
    file = Tempfile.new('archive').path
  end
  
  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_current ⇒ Object 



218
219
220
 
# File 'lib/git/lib.rb', line 218

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

#branch_delete(branch) ⇒ Object 



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

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

#branch_new(branch) ⇒ Object 



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

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

#branches_all ⇒ Object 



201
202
203
204
205
206
207
208
209
 
# File 'lib/git/lib.rb', line 201

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

#change_head_branch(branch_name) ⇒ Object 



197
198
199
 
# File 'lib/git/lib.rb', line 197

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

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



429
430
431
432
433
434
435
 
# File 'lib/git/lib.rb', line 429

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

#checkout_file(version, file) ⇒ Object 



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

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 



553
554
555
556
557
558
559
560
 
# File 'lib/git/lib.rb', line 553

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

TODO - make this work with SSH password or auth_key



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

def clone(repository, name, opts = {})
  @path = opts[:path] || '.'
  opts[:path] ? clone_dir = File.join(@path, name) : clone_dir = name
  
  arr_opts = []
  arr_opts << "--bare" if opts[:bare]
  arr_opts << "-o #{opts[:remote]}" if opts[:remote]
  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 



377
378
379
380
381
 
# File 'lib/git/lib.rb', line 377

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

#commit_data(sha) ⇒ Object

returns useful array of raw commit object data



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

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 



535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/git/lib.rb', line 535

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

#config_get(name) ⇒ Object 



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

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

#config_list ⇒ Object 



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

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



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

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

#conflicts ⇒ Object

yields :file, :your, :their



459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/git/lib.rb', line 459

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

compares the index and the working directory



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/git/lib.rb', line 275

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 



245
246
247
248
249
250
251
252
 
# File 'lib/git/lib.rb', line 245

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



287
288
289
290
291
292
293
294
295
296
 
# File 'lib/git/lib.rb', line 287

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 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/git/lib.rb', line 254

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 



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

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

#full_log_commits(opts = {}) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/git/lib.rb', line 77

def full_log_commits(opts = {})
  arr_opts = ['--pretty=raw']
  arr_opts << "-#{opts[:count]}" if opts[:count]
  arr_opts << "--since=\"#{opts[:since]}\"" if opts[:since].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 



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

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

#gc ⇒ Object 



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

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/git/lib.rb', line 226

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

  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

#init ⇒ Object 



32
33
34
 
# File 'lib/git/lib.rb', line 32

def init
  command('init')
end

#list_files(ref_dir) ⇒ Object 



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

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
 
# 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 << "#{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_files ⇒ Object 



298
299
300
301
302
303
304
305
306
 
# File 'lib/git/lib.rb', line 298

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 



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/git/lib.rb', line 173

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 



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

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 



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

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

#namerev(string) ⇒ Object 



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

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

#object_contents(sha, &block) ⇒ Object 



169
170
171
 
# File 'lib/git/lib.rb', line 169

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

#object_size(sha) ⇒ Object 



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

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

#object_type(sha) ⇒ Object 



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

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

#parse_config(file) ⇒ Object 



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

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 



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

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 in_message && line != ''
      hsh['message'] += line + "\n"
    end

    if (line != '') && !in_message
      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
    elsif in_message && line == ''
      in_message = false
    else
      in_message = true
    end
  end
  
  if hsh_array
    hsh_array << hsh if hsh
    hsh_array
  else
    hsh
  end
end

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



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

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

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

reads a tree into the current index file



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

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 



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

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



483
484
485
 
# File 'lib/git/lib.rb', line 483

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

#remotes ⇒ Object 



487
488
489
 
# File 'lib/git/lib.rb', line 487

def remotes
  command_lines('remote')
end

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



367
368
369
370
371
372
373
374
375
 
# File 'lib/git/lib.rb', line 367

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

#repack ⇒ Object 



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

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

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



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

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 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/git/lib.rb', line 89

def revparse(string)
  if /\w{40}/.match(string)  # passing in a sha - just no-op it
    return string
  end
        
  head = File.join(@git_dir, 'refs', 'heads', string)
  return File.read(head).chomp if File.file?(head)

  head = File.join(@git_dir, 'refs', 'remotes', string)
  return File.read(head).chomp if File.file?(head)
  
  head = File.join(@git_dir, 'refs', 'tags', string)
  return File.read(head).chomp if File.file?(head)
  
  command('rev-parse', string)
end

#stash_apply(id) ⇒ Object 



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

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

#stash_clear ⇒ Object 



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

def stash_clear
  command('stash clear')
end

#stash_list ⇒ Object 



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

def stash_list
  command('stash list')
end

#stash_save(message) ⇒ Object 



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

def stash_save(message)
  output = command('stash save', [message])
  return false unless output.match(/HEAD is now at/)
  return true
end

#stashes_all ⇒ Object 



390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/git/lib.rb', line 390

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 



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

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

#tag_sha(tag_name) ⇒ Object 



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

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 



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

def tags
  command_lines('tag')
end

#tree_depth(sha) ⇒ Object 



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

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

#unmerged ⇒ Object 



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

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

#update_ref(branch, commit) ⇒ Object 



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

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

#write_tree ⇒ Object 



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

def write_tree
  command('write-tree')
end