class Git::Lib

Constants

BRANCH_LINE_REGEXP
CAT_FILE_HEADER_LINE
ENV_VARIABLE_NAMES

Systen ENV variables involved in the git commands.

@return [<String>] the names of the EVN variables involved in the git commands

Attributes

git_dir[R]

The path to the Git repository directory. The default is ‘“#{git_work_dir}/.git”`.

@return [Pathname] the Git repository directory.

@see [Git repository](git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefrepositoryarepository)

git_index_file[R]

The Git index file used to stage changes (using ‘git add`) before they are committed.

@return [Pathname] the Git index file

@see [Git index file](git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefindexaindex)

git_work_dir[R]

The path to the Git working copy. The default is ‘“./.git”’.

@return [Pathname] the path to the Git working copy.

@see [Git working tree](git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefworkingtreeaworkingtree)

Public Class Methods

new(base = nil, logger = nil) click to toggle source

Create a new Git::Lib object

@param [Git::Base, Hash] base An object that passes in values for

@git_work_dir, @git_dir, and @git_index_file

@param [Logger] logger

@option base [Pathname] :working_directory @option base [Pathname] :repository @option base [Pathname] :index

# File lib/git/lib.rb, line 49
def initialize(base = nil, logger = nil)
  @git_dir = nil
  @git_index_file = nil
  @git_work_dir = nil
  @path = nil
  @logger = logger || Logger.new(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
end
warn_if_old_command(lib) click to toggle source
# File lib/git/lib.rb, line 1125
def self.warn_if_old_command(lib)
  return true if @version_checked
  @version_checked = true
  unless lib.meets_required_version?
    $stderr.puts "[WARNING] The git gem requires git #{lib.required_command_version.join('.')} or later, but only found #{lib.current_command_version.join('.')}. You should probably upgrade."
  end
  true
end

Public Instance Methods

add(paths='.',options={}) click to toggle source

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

@param [String,Array] paths files paths to be added to the repository @param [Hash] options

# File lib/git/lib.rb, line 653
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) click to toggle source
# File lib/git/lib.rb, line 748
def apply(patch_file)
  arr_opts = []
  arr_opts << '--' << patch_file if patch_file
  command('apply', *arr_opts)
end
apply_mail(patch_file) click to toggle source
# File lib/git/lib.rb, line 754
def apply_mail(patch_file)
  arr_opts = []
  arr_opts << '--' << patch_file if patch_file
  command('am', *arr_opts)
end
archive(sha, file = nil, opts = {}) click to toggle source

creates an archive file

options

:format  (zip, tar)
:prefix
:remote
:path
# File lib/git/lib.rb, line 1061
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, redirect: " > #{escape file}")
  if opts[:add_gzip]
    file_content = File.read(file)
    Zlib::GzipWriter.open(file) do |gz|
      gz.write(file_content)
    end
  end
  return file
end
branch_contains(commit, branch_name="") click to toggle source
# File lib/git/lib.rb, line 456
def branch_contains(commit, branch_name="")
  command("branch",  branch_name, "--contains", commit)
end
branch_current() click to toggle source
# File lib/git/lib.rb, line 452
def branch_current
  branches_all.select { |b| b[1] }.first[0] rescue nil
end
branch_delete(branch) click to toggle source
# File lib/git/lib.rb, line 799
def branch_delete(branch)
  command('branch', '-D', branch)
end
branch_new(branch) click to toggle source
# File lib/git/lib.rb, line 795
def branch_new(branch)
  command('branch', branch)
end
branches_all() click to toggle source
# File lib/git/lib.rb, line 395
def branches_all
  command_lines('branch', '-a').map do |line|
    match_data = line.match(BRANCH_LINE_REGEXP)
    raise GitExecuteError, 'Unexpected branch line format' unless match_data
    next nil if match_data[:not_a_branch] || match_data[:detached_ref]
    [
      match_data[:refname],
      !match_data[:current].nil?,
      !match_data[:worktree].nil?,
      match_data[:symref]
    ]
  end.compact
end
change_head_branch(branch_name) click to toggle source
# File lib/git/lib.rb, line 367
def change_head_branch(branch_name)
  command('symbolic-ref', 'HEAD', "refs/heads/#{branch_name}")
end
checkout(branch = nil, opts = {}) click to toggle source

Runs checkout command to checkout or create branch

accepts options:

:new_branch
:force
:start_point

@param [String] branch @param [Hash] opts

# File lib/git/lib.rb, line 812
def checkout(branch = nil, opts = {})
  if branch.is_a?(Hash) && opts == {}
    opts = branch
    branch = nil
  end

  arr_opts = []
  arr_opts << '-b' if opts[:new_branch] || opts[:b]
  arr_opts << '--force' if opts[:force] || opts[:f]
  arr_opts << branch if branch
  arr_opts << opts[:start_point] if opts[:start_point] && arr_opts.include?('-b')

  command('checkout', *arr_opts)
end
checkout_file(version, file) click to toggle source
# File lib/git/lib.rb, line 827
def checkout_file(version, file)
  arr_opts = []
  arr_opts << version
  arr_opts << file
  command('checkout', *arr_opts)
end
checkout_index(opts = {}) click to toggle source
# File lib/git/lib.rb, line 1044
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 = {}) click to toggle source
# File lib/git/lib.rb, line 727
def clean(opts = {})
  arr_opts = []
  arr_opts << '--force' if opts[:force]
  arr_opts << '-ff' if opts[:ff]
  arr_opts << '-d' if opts[:d]
  arr_opts << '-x' if opts[:x]

  command('clean', *arr_opts)
end
clone(repository_url, directory, opts = {}) click to toggle source

tries to clone the given repo

accepts options:

:bare::      no working directory
:branch::    name of branch to track (rather than 'master')
:depth::     the number of commits back to pull
:filter::    specify partial clone
: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

@return [Hash] the options to pass to {Git::Base.new}

# File lib/git/lib.rb, line 98
def clone(repository_url, directory, opts = {})
  @path = opts[:path] || '.'
  clone_dir = opts[:path] ? File.join(@path, directory) : directory

  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 << '--filter' << opts[:filter] if opts[:filter]
  Array(opts[:config]).each { |c| arr_opts << '--config' << c }
  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_url
  arr_opts << clone_dir

  command('clone', *arr_opts)

  return_base_opts_from_clone(clone_dir, opts)
end
commit(message, opts = {}) click to toggle source

Takes the commit message with the options and executes the commit command

accepts options:

:amend
:all
:allow_empty
:author
:date
:no_verify
:allow_empty_message
:gpg_sign (accepts true or a gpg key ID as a String)
:no_gpg_sign (conflicts with :gpg_sign)

@param [String] message the commit message to be used @param [Hash] opts the commit options to be used

# File lib/git/lib.rb, line 693
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
  arr_opts << '--no-verify' if opts[:no_verify]
  arr_opts << '--allow-empty-message' if opts[:allow_empty_message]

  if opts[:gpg_sign] && opts[:no_gpg_sign]
    raise ArgumentError, 'cannot specify :gpg_sign and :no_gpg_sign'
  elsif opts[:gpg_sign]
    arr_opts <<
      if opts[:gpg_sign] == true
        '--gpg-sign'
      else
        "--gpg-sign=#{opts[:gpg_sign]}"
      end
  elsif opts[:no_gpg_sign]
    arr_opts << '--no-gpg-sign'
  end

  command('commit', *arr_opts)
end
commit_data(sha) click to toggle source

returns useful array of raw commit object data

# File lib/git/lib.rb, line 240
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 = {}) click to toggle source
# File lib/git/lib.rb, line 1027
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 += Array(opts[:parents]).map { |p| ['-p', p] }.flatten if opts[:parents]
  command('commit-tree', *arr_opts, redirect: "< #{escape t.path}")
end
compare_version_to(*other_version) click to toggle source

Returns current_command_version <=> other_version

@example

lib.current_command_version #=> [2, 42, 0]

lib.compare_version_to(2, 41, 0) #=> 1
lib.compare_version_to(2, 42, 0) #=> 0
lib.compare_version_to(2, 43, 0) #=> -1

@param other_version [Array<Object>] the other version to compare to @return [Integer] -1 if this version is less than other_version, 0 if equal, or 1 if greater than

# File lib/git/lib.rb, line 1113
def compare_version_to(*other_version)
  current_command_version <=> other_version
end
config_get(name) click to toggle source
# File lib/git/lib.rb, line 585
def config_get(name)
  command('config', '--get', name, chdir: @git_dir)
end
config_list() click to toggle source
# File lib/git/lib.rb, line 593
def config_list
  parse_config_list command_lines('config', '--list', chdir: @git_dir)
end
config_remote(name) click to toggle source
# File lib/git/lib.rb, line 575
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, options = {}) click to toggle source

WRITE COMMANDS ##

# File lib/git/lib.rb, line 629
def config_set(name, value, options = {})
  if options[:file].to_s.empty?
    command('config', name, value)
  else
    command('config', '--file', options[:file], name, value)
  end
end
conflicts() { |file, your, their| ... } click to toggle source
# File lib/git/lib.rb, line 866
def conflicts # :yields: file, your, their
  self.unmerged.each do |f|
    your_tempfile = Tempfile.new("YOUR-#{File.basename(f)}")
    your = your_tempfile.path
    your_tempfile.close # free up file for git command process
    command('show', ":2:#{f}", redirect: "> #{escape your}")

    their_tempfile = Tempfile.new("THEIR-#{File.basename(f)}")
    their = their_tempfile.path
    their_tempfile.close # free up file for git command process
    command('show', ":3:#{f}", redirect: "> #{escape their}")
    yield(f, your, their)
  end
end
current_command_version() click to toggle source

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

# File lib/git/lib.rb, line 1094
def current_command_version
  output = command('version')
  version = output[/\d+(\.\d+)+/]
  version_parts = version.split('.').collect { |i| i.to_i }
  version_parts.fill(0, version_parts.length...3)
end
describe(committish=nil, opts={}) click to toggle source

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
# File lib/git/lib.rb, line 170
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() click to toggle source

compares the index and the working directory

# File lib/git/lib.rb, line 530
def diff_files
  diff_as_hash('diff-files')
end
diff_full(obj1 = 'HEAD', obj2 = nil, opts = {}) click to toggle source
# File lib/git/lib.rb, line 486
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) click to toggle source

compares the index and the repository

# File lib/git/lib.rb, line 535
def diff_index(treeish)
  diff_as_hash('diff-index', treeish)
end
diff_name_status(reference1 = nil, reference2 = nil, opts = {}) click to toggle source
# File lib/git/lib.rb, line 515
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 = {}) click to toggle source
# File lib/git/lib.rb, line 495
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
each_cat_file_header(data) { |key, join("\n")| ... } click to toggle source
# File lib/git/lib.rb, line 267
def each_cat_file_header(data)
  while (match = CAT_FILE_HEADER_LINE.match(data.shift))
    key = match[:key]
    value_lines = [match[:value]]

    while data.first.start_with?(' ')
      value_lines << data.shift.lstrip
    end

    yield key, value_lines.join("\n")
  end
end
fetch(remote, opts) click to toggle source
# File lib/git/lib.rb, line 937
def fetch(remote, opts)
  arr_opts = []
  arr_opts << '--all' if opts[:all]
  arr_opts << '--tags' if opts[:t] || opts[:tags]
  arr_opts << '--prune' if opts[:p] || opts[:prune]
  arr_opts << '--prune-tags' if opts[:P] || opts[:'prune-tags']
  arr_opts << '--force' if opts[:f] || opts[:force]
  arr_opts << '--update-head-ok' if opts[:u] || opts[:'update-head-ok']
  arr_opts << '--unshallow' if opts[:unshallow]
  arr_opts << '--depth' << opts[:depth] if opts[:depth]
  arr_opts << '--' if remote || opts[:ref]
  arr_opts << remote if remote
  arr_opts << opts[:ref] if opts[:ref]

  command('fetch', *arr_opts)
end
full_log_commits(opts={}) click to toggle source
# File lib/git/lib.rb, line 203
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)

  process_commit_log_data(full_log)
end
full_tree(sha) click to toggle source
# File lib/git/lib.rb, line 359
def full_tree(sha)
  command_lines('ls-tree', '-r', sha)
end
gc() click to toggle source
# File lib/git/lib.rb, line 1011
def gc
  command('gc', '--prune', '--aggressive', '--auto')
end
global_config_get(name) click to toggle source
# File lib/git/lib.rb, line 589
def global_config_get(name)
  command('config', '--global', '--get', name)
end
global_config_list() click to toggle source
# File lib/git/lib.rb, line 597
def global_config_list
  parse_config_list command_lines('config', '--global', '--list')
end
global_config_set(name, value) click to toggle source
# File lib/git/lib.rb, line 637
def global_config_set(name, value)
  command('config', '--global', name, value)
end
grep(string, opts = {}) click to toggle source

returns hash

tree-ish

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

tree-ish

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

# File lib/git/lib.rb, line 463
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' if opts[:extended_regexp]
  grep_opts << '-e'
  grep_opts << string
  grep_opts << opts[:object] if opts[:object].is_a?(String)
  grep_opts.push('--', opts[:path_limiter]) if opts[:path_limiter].is_a?(String)
  grep_opts.push('--', *opts[:path_limiter]) if opts[:path_limiter].is_a?(Array)

  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() click to toggle source
# File lib/git/lib.rb, line 570
def ignored_files
  command_lines('ls-files', '--others', '-i', '--exclude-standard')
end
init(opts={}) click to toggle source

creates or reinitializes the repository

options:

:bare
:working_directory
:initial_branch
# File lib/git/lib.rb, line 74
def init(opts={})
  arr_opts = []
  arr_opts << '--bare' if opts[:bare]
  arr_opts << "--initial-branch=#{opts[:initial_branch]}" if opts[:initial_branch]

  command('init', *arr_opts)
end
list_files(ref_dir) click to toggle source
# File lib/git/lib.rb, line 442
def list_files(ref_dir)
  dir = File.join(@git_dir, 'refs', ref_dir)
  files = []
  begin
    files = Dir.glob('**/*', base: dir).select { |f| File.file?(File.join(dir, f)) }
  rescue
  end
  files
end
log_commits(opts={}) click to toggle source
# File lib/git/lib.rb, line 193
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).map { |l| l.split.first }
end
ls_files(location=nil) click to toggle source
# File lib/git/lib.rb, line 539
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
    if file.start_with?('"') && file.end_with?('"')
      file = Git::EscapedPath.new(file[1..-2]).unescape
    end
    hsh[file] = {:path => file, :mode_index => mode, :sha_index => sha, :stage => stage}
  end
  hsh
end
ls_remote(location=nil, opts={}) click to toggle source
# File lib/git/lib.rb, line 553
def ls_remote(location=nil, opts={})
  arr_opts = []
  arr_opts << '--refs' if opts[:refs]
  arr_opts << (location || '.')

  Hash.new{ |h,k| h[k] = {} }.tap do |hsh|
    command_lines('ls-remote', *arr_opts).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) click to toggle source
# File lib/git/lib.rb, line 343
def ls_tree(sha)
  data = { 'blob' => {}, 'tree' => {}, 'commit' => {} }

  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?() click to toggle source
# File lib/git/lib.rb, line 1121
def meets_required_version?
  (self.current_command_version <=>  self.required_command_version) >= 0
end
merge(branch, message = nil, opts = {}) click to toggle source
# File lib/git/lib.rb, line 834
def merge(branch, message = nil, opts = {})
  arr_opts = []
  arr_opts << '--no-commit' if opts[:no_commit]
  arr_opts << '--no-ff' if opts[:no_ff]
  arr_opts << '-m' << message if message
  arr_opts += Array(branch)
  command('merge', *arr_opts)
end
merge_base(*args) click to toggle source
# File lib/git/lib.rb, line 843
def merge_base(*args)
  opts = args.last.is_a?(Hash) ? args.pop : {}

  arg_opts = []

  arg_opts << '--octopus' if opts[:octopus]
  arg_opts << '--independent' if opts[:independent]
  arg_opts << '--fork-point' if opts[:fork_point]
  arg_opts << '--all' if opts[:all]

  arg_opts += args

  command('merge-base', *arg_opts).lines.map(&:strip)
end
mv(file1, file2) click to toggle source
# File lib/git/lib.rb, line 355
def mv(file1, file2)
  command_lines('mv', '--', file1, file2)
end
namerev(string) click to toggle source
# File lib/git/lib.rb, line 227
def namerev(string)
  command('name-rev', string).split[1]
end
object_contents(sha, &block) click to toggle source
# File lib/git/lib.rb, line 339
def object_contents(sha, &block)
  command('cat-file', '-p', sha, &block)
end
object_size(sha) click to toggle source
# File lib/git/lib.rb, line 235
def object_size(sha)
  command('cat-file', '-s', sha).to_i
end
object_type(sha) click to toggle source
# File lib/git/lib.rb, line 231
def object_type(sha)
  command('cat-file', '-t', sha)
end
parse_config(file) click to toggle source
# File lib/git/lib.rb, line 610
def parse_config(file)
  parse_config_list command_lines('config', '--list', '--file', file)
end
parse_config_list(lines) click to toggle source
# File lib/git/lib.rb, line 601
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) click to toggle source
# File lib/git/lib.rb, line 246
def process_commit_data(data, sha)
  hsh = {
    'sha'    => sha,
    'parent' => []
  }

  each_cat_file_header(data) do |key, value|
    if key == 'parent'
      hsh['parent'] << value
    else
      hsh[key] = value
    end
  end

  hsh['message'] = data.join("\n") + "\n"

  return hsh
end
process_commit_log_data(data) click to toggle source
# File lib/git/lib.rb, line 298
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

    in_message = false if in_message && line[0..3] != "    "

    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) click to toggle source
# File lib/git/lib.rb, line 286
def process_tag_data(data, name)
  hsh = { 'name' => name }

  each_cat_file_header(data) do |key, value|
    hsh[key] = value
  end

  hsh['message'] = data.join("\n") + "\n"

  return hsh
end
pull(remote = nil, branch = nil) click to toggle source
# File lib/git/lib.rb, line 991
def pull(remote = nil, branch = nil)
  raise ArgumentError, "You must specify a remote if a branch is specified" if remote.nil? && !branch.nil?

  arr_opts = []
  arr_opts << remote if remote
  arr_opts << branch if branch
  command('pull', *arr_opts)
end
push(remote = nil, branch = nil, opts = nil) click to toggle source
# File lib/git/lib.rb, line 954
def push(remote = nil, branch = nil, opts = nil)
  if opts.nil? && branch.instance_of?(Hash)
    opts = branch
    branch = nil
  end

  if opts.nil? && remote.instance_of?(Hash)
    opts = remote
    remote = nil
  end

  opts ||= {}

  # Small hack to keep backwards compatibility with the 'push(remote, branch, tags)' method signature.
  opts = {:tags => opts} if [true, false].include?(opts)

  raise ArgumentError, "You must specify a remote if a branch is specified" if remote.nil? && !branch.nil?

  arr_opts = []
  arr_opts << '--mirror'  if opts[:mirror]
  arr_opts << '--delete'  if opts[:delete]
  arr_opts << '--force'   if opts[:force] || opts[:f]
  arr_opts << '--all'     if opts[:all] && remote

  Array(opts[:push_option]).each { |o| arr_opts << '--push-option' << o } if opts[:push_option]
  arr_opts << remote if remote
  arr_opts_with_branch = arr_opts.dup
  arr_opts_with_branch << branch if branch

  if opts[:mirror]
      command('push', *arr_opts_with_branch)
  else
      command('push', *arr_opts_with_branch)
      command('push', '--tags', *arr_opts) if opts[:tags]
  end
end
read_tree(treeish, opts = {}) click to toggle source

reads a tree into the current index file

# File lib/git/lib.rb, line 1016
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 = {}) click to toggle source
# File lib/git/lib.rb, line 881
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) click to toggle source
# File lib/git/lib.rb, line 900
def remote_remove(name)
  command('remote', 'rm', name)
end
remote_set_url(name, url) click to toggle source
# File lib/git/lib.rb, line 892
def remote_set_url(name, url)
  arr_opts = ['set-url']
  arr_opts << name
  arr_opts << url

  command('remote', *arr_opts)
end
remotes() click to toggle source
# File lib/git/lib.rb, line 904
def remotes
  command_lines('remote')
end
repack() click to toggle source
# File lib/git/lib.rb, line 1007
def repack
  command('repack', '-a', '-d')
end
repository_default_branch(repository) click to toggle source

Returns the name of the default branch of the given repository

@param repository [URI, Pathname, String] The (possibly remote) repository to clone from

@return [String] the name of the default branch

# File lib/git/lib.rb, line 136
def repository_default_branch(repository)
  output = command('ls-remote', '--symref', '--', repository, 'HEAD')

  match_data = output.match(%r{^ref: refs/remotes/origin/(?<default_branch>[^\t]+)\trefs/remotes/origin/HEAD$})
  return match_data[:default_branch] if match_data

  match_data = output.match(%r{^ref: refs/heads/(?<default_branch>[^\t]+)\tHEAD$})
  return match_data[:default_branch] if match_data

  raise 'Unable to determine the default branch'
end
required_command_version() click to toggle source
# File lib/git/lib.rb, line 1117
def required_command_version
  [1, 6]
end
reset(commit, opts = {}) click to toggle source
# File lib/git/lib.rb, line 720
def reset(commit, opts = {})
  arr_opts = []
  arr_opts << '--hard' if opts[:hard]
  arr_opts << commit if commit
  command('reset', *arr_opts)
end
return_base_opts_from_clone(clone_dir, opts) click to toggle source
# File lib/git/lib.rb, line 122
def return_base_opts_from_clone(clone_dir, opts)
  base_opts = {}
  base_opts[:repository] = clone_dir if (opts[:bare] || opts[:mirror])
  base_opts[:working_directory] = clone_dir unless (opts[:bare] || opts[:mirror])
  base_opts[:log] = opts[:log] if opts[:log]
  base_opts
end
revert(commitish, opts = {}) click to toggle source
# File lib/git/lib.rb, line 737
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) click to toggle source
# File lib/git/lib.rb, line 216
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
rm(path = '.', opts = {}) click to toggle source
# File lib/git/lib.rb, line 668
def rm(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 << '--'
  arr_opts += Array(path)

  command('rm', *arr_opts)
end
show(objectish=nil, path=nil) click to toggle source

Shows objects

@param [String|NilClass] objectish the target object reference (nil == HEAD) @param [String|NilClass] path the path of the file to be shown @return [String] the object information

# File lib/git/lib.rb, line 619
def show(objectish=nil, path=nil)
  arr_opts = []

  arr_opts << (path ? "#{objectish}:#{path}" : objectish)

  command('show', *arr_opts.compact, chomp: false)
end
stash_apply(id = nil) click to toggle source
# File lib/git/lib.rb, line 779
def stash_apply(id = nil)
  if id
    command('stash', 'apply', id)
  else
    command('stash', 'apply')
  end
end
stash_clear() click to toggle source
# File lib/git/lib.rb, line 787
def stash_clear
  command('stash', 'clear')
end
stash_list() click to toggle source
# File lib/git/lib.rb, line 791
def stash_list
  command('stash', 'list')
end
stash_save(message) click to toggle source
# File lib/git/lib.rb, line 774
def stash_save(message)
  output = command('stash', 'save', message)
  output =~ /HEAD is now at/
end
stashes_all() click to toggle source
# File lib/git/lib.rb, line 760
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) click to toggle source
# File lib/git/lib.rb, line 912
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) click to toggle source
# File lib/git/lib.rb, line 280
def tag_data(name)
  sha = sha.to_s
  tdata = command_lines('cat-file', 'tag', name)
  process_tag_data(tdata, name)
end
tag_sha(tag_name) click to toggle source
# File lib/git/lib.rb, line 1000
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() click to toggle source
# File lib/git/lib.rb, line 908
def tags
  command_lines('tag')
end
tree_depth(sha) click to toggle source
# File lib/git/lib.rb, line 363
def tree_depth(sha)
  full_tree(sha).size
end
unmerged() click to toggle source
# File lib/git/lib.rb, line 858
def unmerged
  unmerged = []
  command_lines('diff', "--cached").each do |line|
    unmerged << $1 if line =~ /^\* Unmerged path (.*)/
  end
  unmerged
end
update_ref(ref, commit) click to toggle source
# File lib/git/lib.rb, line 1040
def update_ref(ref, commit)
  command('update-ref', ref, commit)
end
worktree_add(dir, commitish = nil) click to toggle source
# File lib/git/lib.rb, line 429
def worktree_add(dir, commitish = nil)
  return command('worktree', 'add', dir, commitish) if !commitish.nil?
  command('worktree', 'add', dir)
end
worktree_prune() click to toggle source
# File lib/git/lib.rb, line 438
def worktree_prune
  command('worktree', 'prune')
end
worktree_remove(dir) click to toggle source
# File lib/git/lib.rb, line 434
def worktree_remove(dir)
  command('worktree', 'remove', dir)
end
worktrees_all() click to toggle source
# File lib/git/lib.rb, line 409
def worktrees_all
  arr = []
  directory = ''
  # Output example for `worktree list --porcelain`:
  # worktree /code/public/ruby-git
  # HEAD 4bef5abbba073c77b4d0ccc1ffcd0ed7d48be5d4
  # branch refs/heads/master
  #
  # worktree /tmp/worktree-1
  # HEAD b8c63206f8d10f57892060375a86ae911fad356e
  # detached
  #
  command_lines('worktree', 'list', '--porcelain').each do |w|
    s = w.split("\s")
    directory = s[1] if s[0] == 'worktree'
    arr << [directory, s[1]] if s[0] == 'HEAD'
  end
  arr
end
write_tree() click to toggle source
# File lib/git/lib.rb, line 1023
def write_tree
  command('write-tree')
end

Private Instance Methods

command(*cmd, redirect: '', chomp: true, chdir: nil, &block) click to toggle source
# File lib/git/lib.rb, line 1188
def command(*cmd, redirect: '', chomp: true, chdir: nil, &block)
  Git::Lib.warn_if_old_command(self)

  raise 'cmd can not include a nested array' if cmd.any? { |o| o.is_a? Array }

  global_opts = []
  global_opts << "--git-dir=#{@git_dir}" if !@git_dir.nil?
  global_opts << "--work-tree=#{@git_work_dir}" if !@git_work_dir.nil?
  global_opts << '-c' << 'core.quotePath=true'
  global_opts << '-c' << 'color.ui=false'

  escaped_cmd = cmd.map { |part| escape(part) }.join(' ')

  global_opts = global_opts.map { |s| escape(s) }.join(' ')

  git_cmd = "#{Git::Base.config.binary_path} #{global_opts} #{escaped_cmd} #{redirect} 2>&1"

  output = nil

  command_thread = nil;

  status = nil

  with_custom_env_variables do
    command_thread = Thread.new do
      output, status = run_command(git_cmd, chdir, &block)
    end
    command_thread.join
  end

  @logger.info(git_cmd)
  @logger.debug(output)

  if status.exitstatus > 1 || (status.exitstatus == 1 && output != '')
    result = Git::CommandLineResult.new(git_cmd, status, output, '')
    raise Git::FailedError.new(result)
  end

  output.chomp! if output && chomp && !block_given?

  output
end
command_lines(cmd, *opts, chdir: nil) click to toggle source
# File lib/git/lib.rb, line 1141
def command_lines(cmd, *opts, chdir: nil)
  cmd_op = command(cmd, *opts, chdir: chdir)
  if cmd_op.encoding.name != "UTF-8"
    op = cmd_op.encode("UTF-8", "binary", :invalid => :replace, :undef => :replace)
  else
    op = cmd_op
  end
  op.split("\n")
end
diff_as_hash(diff_command, opts=[]) click to toggle source

Takes the diff command line output (as Array) and parse it into a Hash

@param [String] diff_command the diff commadn to be used @param [Array] opts the diff options to be used @return [Hash] the diff as Hash

# File lib/git/lib.rb, line 1236
def diff_as_hash(diff_command, opts=[])
  # update index before diffing to avoid spurious diffs
  command('status')
  command_lines(diff_command, *opts).inject({}) do |memo, line|
    info, file = line.split("\t")
    mode_src, mode_dest, sha_src, sha_dest, type = info.split

    memo[file] = {
      :mode_index => mode_dest,
      :mode_repo => mode_src.to_s[1, 7],
      :path => file,
      :sha_repo => sha_src,
      :sha_index => sha_dest,
      :type => type
    }

    memo
  end
end
escape(s) click to toggle source
# File lib/git/lib.rb, line 1308
def escape(s)
  windows_platform? ? escape_for_windows(s) : escape_for_sh(s)
end
escape_for_sh(s) click to toggle source
# File lib/git/lib.rb, line 1312
def escape_for_sh(s)
  "'#{s && s.to_s.gsub('\'','\'"\'"\'')}'"
end
escape_for_windows(s) click to toggle source
# File lib/git/lib.rb, line 1316
def escape_for_windows(s)
  # Escape existing double quotes in s and then wrap the result with double quotes
  escaped_string = s.to_s.gsub('"','\\"')
  %Q{"#{escaped_string}"}
end
log_common_options(opts) click to toggle source

Returns an array holding the common options for the log commands

@param [Hash] opts the given options @return [Array] the set of common options that the log command will use

# File lib/git/lib.rb, line 1260
def log_common_options(opts)
  arr_opts = []

  if opts[:count] && !opts[:count].is_a?(Integer)
    raise ArgumentError, "The log count option must be an Integer but was #{opts[:count].inspect}"
  end

  arr_opts << "--max-count=#{opts[:count]}" if opts[:count]
  arr_opts << "--all" if opts[:all]
  arr_opts << "--no-color"
  arr_opts << "--cherry" if opts[:cherry]
  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
end
log_path_options(opts) click to toggle source

Retrurns an array holding path options for the log commands

@param [Hash] opts the given options @return [Array] the set of path options that the log command will use

# File lib/git/lib.rb, line 1284
def log_path_options(opts)
  arr_opts = []

  arr_opts << opts[:object] if opts[:object].is_a? String
  if opts[:path_limiter]
    arr_opts << '--'
    arr_opts += Array(opts[:path_limiter])
  end
  arr_opts
end
restore_git_system_env_variables() click to toggle source

Takes the previously stored git’s ENV variables and set them again on ENV.

# File lib/git/lib.rb, line 1160
def restore_git_system_env_variables
  ENV_VARIABLE_NAMES.each do |env_variable_name|
    ENV[env_variable_name] = @git_system_env_variables[env_variable_name]
  end
end
run_command(git_cmd, chdir=nil, &block) click to toggle source
# File lib/git/lib.rb, line 1295
def run_command(git_cmd, chdir=nil, &block)
  block ||= Proc.new do |io|
    io.readlines.map { |l| Git::EncodingUtils.normalize_encoding(l) }.join
  end

  opts = {}
  opts[:chdir] = File.expand_path(chdir) if chdir

  Open3.popen2(git_cmd, opts) do |stdin, stdout, wait_thr|
    [block.call(stdout), wait_thr.value]
  end
end
set_custom_git_env_variables() click to toggle source

Sets git’s ENV variables to the custom values for the current instance.

# File lib/git/lib.rb, line 1167
def set_custom_git_env_variables
  ENV['GIT_DIR'] = @git_dir
  ENV['GIT_WORK_TREE'] = @git_work_dir
  ENV['GIT_INDEX_FILE'] = @git_index_file
  ENV['GIT_SSH'] = Git::Base.config.git_ssh
end
store_git_system_env_variables() click to toggle source

Takes the current git’s system ENV variables and store them.

# File lib/git/lib.rb, line 1152
def store_git_system_env_variables
  @git_system_env_variables = {}
  ENV_VARIABLE_NAMES.each do |env_variable_name|
    @git_system_env_variables[env_variable_name] = ENV[env_variable_name]
  end
end
windows_platform?() click to toggle source
# File lib/git/lib.rb, line 1322
def windows_platform?
  # Check if on Windows via RUBY_PLATFORM (CRuby) and RUBY_DESCRIPTION (JRuby)
  win_platform_regex = /mingw|mswin/
  RUBY_PLATFORM =~ win_platform_regex || RUBY_DESCRIPTION =~ win_platform_regex
end
with_custom_env_variables(&block) click to toggle source

Runs a block inside an environment with customized ENV variables. It restores the ENV after execution.

@param [Proc] block block to be executed within the customized environment

# File lib/git/lib.rb, line 1178
def with_custom_env_variables(&block)
  @@semaphore.synchronize do
    store_git_system_env_variables()
    set_custom_git_env_variables()
    return block.call()
  end
ensure
  restore_git_system_env_variables()
end