Class: Git::Lib

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

Constant Summary collapse

@@semaphore = 
Mutex.new

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Lib.



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

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(paths = '.', options = {}) ⇒ Object

updates the repository index using the working directory content

lib.add('path/to/file')
lib.add(['path/to/file1','path/to/file2'])
lib.add(:all => true)

options:

:all => true
:force => true

Parameters:

  • paths (String, Array) (defaults to: '.') —

    files paths to be added to the repository

  • options (Hash) (defaults to: {}) 


504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/git/lib.rb', line 504

def add(paths='.',options={})
  arr_opts = []
  
  arr_opts << '--all' if options[:all]
  arr_opts << '--force' if options[:force]

  arr_opts << '--' 

  arr_opts << paths
  
  arr_opts.flatten!

  command('add', arr_opts)
end

#apply(patch_file) ⇒ Object 



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

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

#apply_mail(patch_file) ⇒ Object 



576
577
578
579
580
 
# File 'lib/git/lib.rb', line 576

def apply_mail(patch_file)
  arr_opts = []
  arr_opts << '--' << patch_file 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



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/git/lib.rb', line 796

def archive(sha, file = nil, opts = {})
  opts[:format] ||= 'zip'
  
  if opts[:format] == 'tgz'
    opts[:format] = 'tar' 
    opts[:add_gzip] = true
  end
  
  if !file
    tempfile = Tempfile.new('archive')
    file = tempfile.path
    # delete it now, before we write to it, so that Ruby doesn't delete it
    # when it finalizes the Tempfile.
    tempfile.close!
  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]
  command('archive', arr_opts, true, (opts[:add_gzip] ? '| gzip' : '') + " > #{escape file}")
  return file
end

#branch_current ⇒ Object 



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

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

#branch_delete(branch) ⇒ Object 



619
620
621
 
# File 'lib/git/lib.rb', line 619

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

#branch_new(branch) ⇒ Object 



615
616
617
 
# File 'lib/git/lib.rb', line 615

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

#branches_all ⇒ Object 



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

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 



296
297
298
 
# File 'lib/git/lib.rb', line 296

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

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



623
624
625
626
627
628
629
630
 
# File 'lib/git/lib.rb', line 623

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

#checkout_file(version, file) ⇒ Object 



632
633
634
635
636
637
 
# File 'lib/git/lib.rb', line 632

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

#checkout_index(opts = {}) ⇒ Object 



779
780
781
782
783
784
785
786
787
 
# File 'lib/git/lib.rb', line 779

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

#clean(opts = {}) ⇒ Object 



550
551
552
553
554
555
556
557
 
# File 'lib/git/lib.rb', line 550

def clean(opts = {})
  arr_opts = [] 
  arr_opts << '--force' if opts[:force]
  arr_opts << '-d' if opts[:d]
  arr_opts << '-x' if opts[:x]

  command('clean', arr_opts)
end

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

tries to clone the given repo

returns :repository (if bare)

{:working_directory} otherwise

accepts options:

:bare::      no working directory
:branch::    name of branch to track (rather than 'master')
:depth::     the number of commits back to pull
:origin::    name of remote (same as remote)
:path::      directory where the repo will be cloned
:remote::    name of remote (rather than 'origin')
:recursive:: after the clone is created, initialize all submodules within, using their default settings.

TODO - make this work with SSH password or auth_key



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/git/lib.rb', line 59

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 << '--branch' << opts[:branch] if opts[:branch]
  arr_opts << '--depth' << opts[:depth].to_i if opts[:depth] && opts[:depth].to_i > 0
  arr_opts << '--config' << opts[:config] if opts[:config]
  arr_opts << '--origin' << opts[:remote] || opts[:origin] if opts[:remote] || opts[:origin]
  arr_opts << '--recursive' if opts[:recursive]

  arr_opts << '--'

  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 



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

def commit(message, opts = {})
  arr_opts = []
  arr_opts << "--message=#{message}" if message
  arr_opts << '--amend' << '--no-edit' if opts[:amend]
  arr_opts << '--all' if opts[:add_all] || opts[: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



174
175
176
177
178
 
# File 'lib/git/lib.rb', line 174

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 



762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/git/lib.rb', line 762

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] }.flatten if opts[:parents]
  command('commit-tree', arr_opts, true, "< #{escape t.path}")
end

#config_get(name) ⇒ Object 



424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/git/lib.rb', line 424

def config_get(name)
  do_get = lambda do |path|
    command('config', ['--get', name])
  end

  if @git_dir
    Dir.chdir(@git_dir, &do_get)
  else
    build_list.call
  end
end

#config_list ⇒ Object 



440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/git/lib.rb', line 440

def config_list
  build_list = lambda do |path|
    parse_config_list command_lines('config', ['--list'])
  end
  
  if @git_dir
    Dir.chdir(@git_dir, &build_list)
  else
    build_list.call
  end
end

#config_remote(name) ⇒ Object 



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

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



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

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

#conflicts ⇒ Object

:yields: file, your, their



654
655
656
657
658
659
660
661
662
663
 
# File 'lib/git/lib.rb', line 654

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

#current_command_version ⇒ Object

returns the current version of git, as an Array of Fixnums.



823
824
825
826
827
 
# File 'lib/git/lib.rb', line 823

def current_command_version
  output = command('version', [], false)
  version = output[/\d+\.\d+(\.\d+)+/]
  version.split('.').collect {|i| i.to_i}
end

#describe(committish = nil, opts = {}) ⇒ Object

Returns most recent tag that is reachable from a commit

accepts options:

:all
:tags
:contains
:debug
:exact_match
:dirty
:abbrev
:candidates
:long
:always
:math

@param [String|NilClass] committish target commit sha or object name
@param [{Symbol=>Object}] opts the given options
@return [String] the tag name



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/git/lib.rb', line 104

def describe(committish=nil, opts={})
  arr_opts = []

  arr_opts << '--all' if opts[:all]
  arr_opts << '--tags' if opts[:tags]
  arr_opts << '--contains' if opts[:contains]
  arr_opts << '--debug' if opts[:debug]
  arr_opts << '--long' if opts[:long]
  arr_opts << '--always' if opts[:always]
  arr_opts << '--exact-match' if opts[:exact_match] || opts[:"exact-match"]
  
  arr_opts << '--dirty' if opts['dirty'] == true
  arr_opts << "--dirty=#{opts['dirty']}" if opts['dirty'].is_a?(String)

  arr_opts << "--abbrev=#{opts['abbrev']}" if opts[:abbrev]
  arr_opts << "--candidates=#{opts['candidates']}" if opts[:candidates]
  arr_opts << "--match=#{opts['match']}" if opts[:match]
  
  arr_opts << committish if committish

  return command('describe', arr_opts)
end

#diff_files ⇒ Object

compares the index and the working directory



375
376
377
 
# File 'lib/git/lib.rb', line 375

def diff_files
  diff_as_hash('diff-files')
end

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



345
346
347
348
349
350
351
352
 
# File 'lib/git/lib.rb', line 345

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



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

def diff_index(treeish)
  diff_as_hash('diff-index', treeish)
end

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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/git/lib.rb', line 354

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



711
712
713
714
715
716
717
 
# File 'lib/git/lib.rb', line 711

def fetch(remote, opts)
  arr_opts = [remote]
  arr_opts << '--tags' if opts[:t] || opts[:tags]
  arr_opts << '--prune' if opts[:p] || opts[:prune]

  command('fetch', arr_opts)
end

#full_log_commits(opts = {}) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/git/lib.rb', line 137

def full_log_commits(opts={})
  arr_opts = log_common_options(opts)

  arr_opts << '--pretty=raw'
  arr_opts << "--skip=#{opts[:skip]}" if opts[:skip]
   
  arr_opts += log_path_options(opts)
  
  full_log = command_lines('log', arr_opts, true)

  process_commit_log_data(full_log)
end

#full_tree(sha) ⇒ Object 



288
289
290
 
# File 'lib/git/lib.rb', line 288

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

#gc ⇒ Object 



746
747
748
 
# File 'lib/git/lib.rb', line 746

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

#global_config_get(name) ⇒ Object 



436
437
438
 
# File 'lib/git/lib.rb', line 436

def global_config_get(name)
  command('config', ['--global', '--get', name], false)
end

#global_config_list ⇒ Object 



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

def global_config_list
  parse_config_list command_lines('config', ['--global', '--list'], false)
end

#global_config_set(name, value) ⇒ Object 



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

def global_config_set(name, value)
  command('config', ['--global', name, value], false)
end

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

returns hash

tree-ish

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

tree-ish

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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/git/lib.rb', line 324

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 



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

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

#init(opts = {}) ⇒ Object

creates or reinitializes the repository

options:

:bare
:working_directory



36
37
38
39
40
41
 
# File 'lib/git/lib.rb', line 36

def init(opts={})
  arr_opts = []
  arr_opts << '--bare' if opts[:bare]

  command('init', arr_opts, false)
end

#list_files(ref_dir) ⇒ Object 



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

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 



127
128
129
130
131
132
133
134
135
 
# File 'lib/git/lib.rb', line 127

def log_commits(opts={})
  arr_opts = log_common_options(opts)

  arr_opts << '--pretty=oneline'
 
  arr_opts += log_path_options(opts)

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

#ls_files(location = nil) ⇒ Object 



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

def ls_files(location=nil)
  hsh = {}
  command_lines('ls-files', ['--stage', location]).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_remote(location = nil) ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/git/lib.rb', line 395

def ls_remote(location=nil)
  location ||= '.'
  Hash.new{ |h,k| h[k] = {} }.tap do |hsh|
    command_lines('ls-remote', [location], false).each do |line|
      (sha, info) = line.split("\t")
      (ref, type, name) = info.split('/', 3)
      type ||= 'head'
      type = 'branches' if type == 'heads'
      value = {:ref => ref, :sha => sha}
      hsh[type].update( name.nil? ? value : { name => value })
    end
  end
end

#ls_tree(sha) ⇒ Object 



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

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

#meets_required_version? ⇒ Boolean

Returns:

  • (Boolean) 


833
834
835
 
# File 'lib/git/lib.rb', line 833

def meets_required_version?
  (self.current_command_version <=>  self.required_command_version) >= 0
end

#merge(branch, message = nil) ⇒ Object 



639
640
641
642
643
644
 
# File 'lib/git/lib.rb', line 639

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

#mv(file1, file2) ⇒ Object 



284
285
286
 
# File 'lib/git/lib.rb', line 284

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

#namerev(string) ⇒ Object 



161
162
163
 
# File 'lib/git/lib.rb', line 161

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

#object_contents(sha, &block) ⇒ Object 



268
269
270
 
# File 'lib/git/lib.rb', line 268

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

#object_size(sha) ⇒ Object 



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

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

#object_type(sha) ⇒ Object 



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

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

#parse_config(file) ⇒ Object 



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

def parse_config(file)
  parse_config_list command_lines('config', ['--list', '--file', file], false)
end

#parse_config_list(lines) ⇒ Object 



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

def parse_config_list(lines)
  hsh = {}
  lines.each do |line|
    (key, *values) = line.split('=')
    hsh[key] = values.join('=')
  end
  hsh
end

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/git/lib.rb', line 180

def process_commit_data(data, sha = nil, indent = 4)
  hsh = {
    'sha'     => sha,
    'message' => '',
    'parent'  => []
  }
  
  loop do
    key, *value = data.shift.split

    break if key.nil?

    if key == 'parent'
      hsh['parent'] << value.join(' ')
    else
      hsh[key] = value.join(' ')
    end
  end
  
  hsh['message'] = data.collect {|line| line[indent..-1]}.join("\n") + "\n"

  return hsh
end

#process_commit_log_data(data) ⇒ Object 



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

def process_commit_log_data(data)
  in_message = false
        
  hsh_array = []       

  hsh = nil

  data.each do |line|
    line = line.chomp
    
    if line[0].nil?
      in_message = !in_message 
      next
    end
   
    if in_message
      hsh['message'] << "#{line[4..-1]}\n"
      next
    end

    key, *value = line.split
    value = value.join(' ')
    
    case key
      when 'commit'
        hsh_array << hsh if hsh
        hsh = {'sha' => value, 'message' => '', 'parent' => []}
      when 'parent'
        hsh['parent'] << value
      else
        hsh[key] = value
    end
  end
  
  hsh_array << hsh if hsh
    
  return hsh_array
end

#process_tag_data(data, name, indent = 4) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/git/lib.rb', line 210

def process_tag_data(data, name, indent=4)
  hsh = {
    'name'    => name,
    'message' => ''
  }

  loop do
    key, *value = data.shift.split

    break if key.nil?

    hsh[key] = value.join(' ')
  end
  
  hsh['message'] = data.collect {|line| line[indent..-1]}.join("\n") + "\n"

  return hsh
end

#pull(remote = 'origin', branch = 'master') ⇒ Object 



731
732
733
 
# File 'lib/git/lib.rb', line 731

def pull(remote='origin', branch='master')
  command('pull', [remote, branch])
end

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



719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/git/lib.rb', line 719

def push(remote, 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) 
  
  arr_opts = []
  arr_opts << '--force'  if opts[:force] || opts[:f]
  arr_opts << remote

  command('push', arr_opts + [branch])
  command('push', ['--tags'] + arr_opts) if opts[:tags]
end

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

reads a tree into the current index file



751
752
753
754
755
756
 
# File 'lib/git/lib.rb', line 751

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

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



665
666
667
668
669
670
671
672
673
674
 
# File 'lib/git/lib.rb', line 665

def remote_add(name, url, opts = {})
  arr_opts = ['add']
  arr_opts << '-f' if opts[:with_fetch] || opts[:fetch]
  arr_opts << '-t' << opts[:track] if opts[:track]
  arr_opts << '--'
  arr_opts << name
  arr_opts << url
  
  command('remote', arr_opts)
end

#remote_remove(name) ⇒ Object 



676
677
678
 
# File 'lib/git/lib.rb', line 676

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

#remotes ⇒ Object 



680
681
682
 
# File 'lib/git/lib.rb', line 680

def remotes
  command_lines('remote')
end

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



519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/git/lib.rb', line 519

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

  command('rm', arr_opts)
end

#repack ⇒ Object 



742
743
744
 
# File 'lib/git/lib.rb', line 742

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

#required_command_version ⇒ Object 



829
830
831
 
# File 'lib/git/lib.rb', line 829

def required_command_version
  [1, 6]
end

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



543
544
545
546
547
548
 
# File 'lib/git/lib.rb', line 543

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

#revert(commitish, opts = {}) ⇒ Object 



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

def revert(commitish, opts = {})
  # Forcing --no-edit as default since it's not an interactive session.
  opts = {:no_edit => true}.merge(opts)
  
  arr_opts = []
  arr_opts << '--no-edit' if opts[:no_edit] 
  arr_opts << commitish

  command('revert', arr_opts)
end

#revparse(string) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/git/lib.rb', line 150

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

#show(objectish = nil, path = nil) ⇒ String

Shows objects

Parameters:

  • objectish (String|NilClass) (defaults to: nil) —

    the target object reference (nil == HEAD)

  • path (String|NilClass) (defaults to: nil) —

    the path of the file to be shown

Returns:

  • (String) —

    the object information



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

def show(objectish=nil, path=nil)
  arr_opts = []

  arr_opts << (path ? "#{objectish}:#{path}" : objectish)
  
  command('show', arr_opts.compact)
end

#stash_apply(id = nil) ⇒ Object 



599
600
601
602
603
604
605
 
# File 'lib/git/lib.rb', line 599

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

#stash_clear ⇒ Object 



607
608
609
 
# File 'lib/git/lib.rb', line 607

def stash_clear
  command('stash clear')
end

#stash_list ⇒ Object 



611
612
613
 
# File 'lib/git/lib.rb', line 611

def stash_list
  command('stash list')
end

#stash_save(message) ⇒ Object 



594
595
596
597
 
# File 'lib/git/lib.rb', line 594

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

#stashes_all ⇒ Object 



582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/git/lib.rb', line 582

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(name, *opts) ⇒ Object 



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/git/lib.rb', line 688

def tag(name, *opts)
  target = opts[0].instance_of?(String) ? opts[0] : nil
  
  opts = opts.last.instance_of?(Hash) ? opts.last : {}

  if (opts[:a] || opts[:annotate]) && !(opts[:m] || opts[:message])
    raise  "Can not create an [:a|:annotate] tag without the precense of [:m|:message]."
  end

  arr_opts = []

  arr_opts << '-f' if opts[:force] || opts[:f]
  arr_opts << '-a' if opts[:a] || opts[:annotate]
  arr_opts << '-s' if opts[:s] || opts[:sign]
  arr_opts << '-d' if opts[:d] || opts[:delete]
  arr_opts << name
  arr_opts << target if target
  arr_opts << "-m #{opts[:m] || opts[:message]}" if opts[:m] || opts[:message]
  
  command('tag', arr_opts)
end

#tag_data(name) ⇒ Object 



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

def tag_data(name)
  sha = sha.to_s
  tdata = command_lines('cat-file', ['tag', name])
  process_tag_data(tdata, name, 0)
end

#tag_sha(tag_name) ⇒ Object 



735
736
737
738
739
740
 
# File 'lib/git/lib.rb', line 735

def tag_sha(tag_name)
  head = File.join(@git_dir, 'refs', 'tags', tag_name)
  return File.read(head).chomp if File.exist?(head)
  
  command('show-ref',  ['--tags', '-s', tag_name])
end

#tags ⇒ Object 



684
685
686
 
# File 'lib/git/lib.rb', line 684

def tags
  command_lines('tag')
end

#tree_depth(sha) ⇒ Object 



292
293
294
 
# File 'lib/git/lib.rb', line 292

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

#unmerged ⇒ Object 



646
647
648
649
650
651
652
 
# File 'lib/git/lib.rb', line 646

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

#update_ref(branch, commit) ⇒ Object 



775
776
777
 
# File 'lib/git/lib.rb', line 775

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

#write_tree ⇒ Object 



758
759
760
 
# File 'lib/git/lib.rb', line 758

def write_tree
  command('write-tree')
end