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: {})


523
524
525
526
527
528
529
530
531
532
533
534
535
536
# File 'lib/git/lib.rb', line 523

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



591
592
593
594
595
# File 'lib/git/lib.rb', line 591

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

#apply_mail(patch_file) ⇒ Object



597
598
599
600
601
# File 'lib/git/lib.rb', line 597

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


837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'lib/git/lib.rb', line 837

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_contains(commit, branch_name = "") ⇒ Object



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

def branch_contains(commit, branch_name="")
  command("branch",  [branch_name, "--contains", commit])
end

#branch_currentObject



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

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

#branch_delete(branch) ⇒ Object



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

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

#branch_new(branch) ⇒ Object



638
639
640
# File 'lib/git/lib.rb', line 638

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

#branches_allObject



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

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



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

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

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



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

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



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

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

#checkout_index(opts = {}) ⇒ Object



820
821
822
823
824
825
826
827
828
# File 'lib/git/lib.rb', line 820

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



571
572
573
574
575
576
577
578
# File 'lib/git/lib.rb', line 571

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
80
# 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 << "--mirror" if opts[:mirror]

  arr_opts << '--'

  arr_opts << repository
  arr_opts << clone_dir

  command('clone', arr_opts)

  (opts[:bare] or opts[:mirror]) ? {:repository => clone_dir} : {:working_directory => clone_dir}
end

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



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

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]
  arr_opts << "--date=#{opts[:date]}" if opts[:date].is_a? String

  command('commit', arr_opts)
end

#commit_data(sha) ⇒ Object

returns useful array of raw commit object data



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

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



803
804
805
806
807
808
809
810
811
812
813
814
# File 'lib/git/lib.rb', line 803

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



443
444
445
446
447
448
449
450
451
452
453
# File 'lib/git/lib.rb', line 443

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

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

#config_listObject



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

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



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

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



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

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

#conflictsObject

:yields: file, your, their



677
678
679
680
681
682
683
684
685
686
# File 'lib/git/lib.rb', line 677

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_versionObject

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



864
865
866
867
868
# File 'lib/git/lib.rb', line 864

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


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

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_filesObject

compares the index and the working directory



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

def diff_files
  diff_as_hash('diff-files')
end

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



349
350
351
352
353
354
355
356
# File 'lib/git/lib.rb', line 349

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



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

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

#diff_name_status(reference1 = nil, reference2 = nil, opts = {}) ⇒ Object



378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'lib/git/lib.rb', line 378

def diff_name_status(reference1 = nil, reference2 = nil, opts = {})
  opts_arr = ['--name-status']
  opts_arr << reference1 if reference1
  opts_arr << reference2 if reference2

  opts_arr << '--' << opts[:path] if opts[:path]

  command_lines('diff', opts_arr).inject({}) do |memo, line|
    status, path = line.split("\t")
    memo[path] = status
    memo
  end
end

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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/git/lib.rb', line 358

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



745
746
747
748
749
750
751
752
# File 'lib/git/lib.rb', line 745

def fetch(remote, opts)
  arr_opts = [remote]
  arr_opts << opts[:ref] if opts[:ref]
  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



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

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



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

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

#gcObject



787
788
789
# File 'lib/git/lib.rb', line 787

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

#global_config_get(name) ⇒ Object



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

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

#global_config_listObject



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

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

#global_config_set(name, value) ⇒ Object



507
508
509
# File 'lib/git/lib.rb', line 507

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



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

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_filesObject



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

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



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

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



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

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



402
403
404
405
406
407
408
409
410
411
412
# File 'lib/git/lib.rb', line 402

def ls_files(location=nil)
  location ||= '.'
  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



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

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



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

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)


874
875
876
# File 'lib/git/lib.rb', line 874

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

#merge(branch, message = nil) ⇒ Object



662
663
664
665
666
667
# File 'lib/git/lib.rb', line 662

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



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

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

#namerev(string) ⇒ Object



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

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

#object_contents(sha, &block) ⇒ Object



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

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

#object_size(sha) ⇒ Object



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

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

#object_type(sha) ⇒ Object



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

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

#parse_config(file) ⇒ Object



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

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

#parse_config_list(lines) ⇒ Object



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

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



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

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



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

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



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

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



772
773
774
# File 'lib/git/lib.rb', line 772

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

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



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
# File 'lib/git/lib.rb', line 754

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 << '--mirror'  if opts[:mirror]
  arr_opts << '--delete'  if opts[:delete]
  arr_opts << '--force'  if opts[:force] || opts[:f]
  arr_opts << remote

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

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

reads a tree into the current index file



792
793
794
795
796
797
# File 'lib/git/lib.rb', line 792

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



688
689
690
691
692
693
694
695
696
697
# File 'lib/git/lib.rb', line 688

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



707
708
709
# File 'lib/git/lib.rb', line 707

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

#remote_set_url(name, url) ⇒ Object



699
700
701
702
703
704
705
# File 'lib/git/lib.rb', line 699

def remote_set_url(name, url)
  arr_opts = ['set-url']
  arr_opts << name
  arr_opts << url

  command('remote', arr_opts)
end

#remotesObject



711
712
713
# File 'lib/git/lib.rb', line 711

def remotes
  command_lines('remote')
end

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



538
539
540
541
542
543
544
545
546
547
548
549
550
# File 'lib/git/lib.rb', line 538

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

  command('rm', arr_opts)
end

#repackObject



783
784
785
# File 'lib/git/lib.rb', line 783

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

#required_command_versionObject



870
871
872
# File 'lib/git/lib.rb', line 870

def required_command_version
  [1, 6]
end

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



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

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



580
581
582
583
584
585
586
587
588
589
# File 'lib/git/lib.rb', line 580

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



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

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



493
494
495
496
497
498
499
# File 'lib/git/lib.rb', line 493

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



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

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

#stash_clearObject



630
631
632
# File 'lib/git/lib.rb', line 630

def stash_clear
  command('stash clear')
end

#stash_listObject



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

def stash_list
  command('stash list')
end

#stash_save(message) ⇒ Object



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

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

#stashes_allObject



603
604
605
606
607
608
609
610
611
612
613
614
615
# File 'lib/git/lib.rb', line 603

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

#tag(name, *opts) ⇒ Object



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
# File 'lib/git/lib.rb', line 719

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

  if opts[:m] || opts[:message]
    arr_opts << '-m' << (opts[:m] || opts[:message])
  end

  command('tag', arr_opts)
end

#tag_data(name) ⇒ Object



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

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



776
777
778
779
780
781
# File 'lib/git/lib.rb', line 776

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

#tagsObject



715
716
717
# File 'lib/git/lib.rb', line 715

def tags
  command_lines('tag')
end

#tree_depth(sha) ⇒ Object



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

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

#unmergedObject



669
670
671
672
673
674
675
# File 'lib/git/lib.rb', line 669

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

#update_ref(branch, commit) ⇒ Object



816
817
818
# File 'lib/git/lib.rb', line 816

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

#write_treeObject



799
800
801
# File 'lib/git/lib.rb', line 799

def write_tree
  command('write-tree')
end