Module: Git

Defined in:
lib/git.rb,
lib/git/lib.rb,
lib/git/log.rb,
lib/git/base.rb,
lib/git/diff.rb,
lib/git/path.rb,
lib/git/stash.rb,
lib/git/index.rb,
lib/git/object.rb,
lib/git/status.rb,
lib/git/branch.rb,
lib/git/author.rb,
lib/git/remote.rb,
lib/git/stashes.rb,
lib/git/branches.rb,
lib/git/repository.rb,
lib/git/working_directory.rb

Overview

Git/Ruby Library

This provides bindings for working with git in complex interactions, including branching and merging, object inspection and manipulation, history, patch generation and more. You should be able to do most fundamental git operations with this library.

This module provides the basic functions to open a git reference to work with. You can open a working directory, open a bare repository, initialize a new repo or clone an existing remote repository.

Author

Scott Chacon (schacon@gmail.com)

License

MIT License

Defined Under Namespace

Classes: Author, Base, Branch, Branches, Diff, GitExecuteError, GitTagNameDoesNotExist, Index, Lib, Log, Object, Path, Remote, Repository, Stash, Stashes, Status, WorkingDirectory

Constant Summary

VERSION =
'1.0.4'

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) bare(git_dir, options = {})

open a bare repository

this takes the path to a bare git repo it expects not to be able to use a working directory so you can't checkout stuff, commit things, etc. but you can do most read operations



59
60
61
# File 'lib/git.rb', line 59

def self.bare(git_dir, options = {})
  Base.bare(git_dir, options)
end

+ (Object) clone(repository, name, options = {})

clones a remote repository

options

:bare => true (does a bare clone)
:repository => '/path/to/alt_git_dir'
:index => '/path/to/alt_index_file'

example

Git.clone('git://repo.or.cz/rubygit.git', 'clone.git', :bare => true)


96
97
98
# File 'lib/git.rb', line 96

def self.clone(repository, name, options = {})
  Base.clone(repository, name, options)
end

+ (Object) export(repository, name, options = {})

Export the current HEAD (or a branch, if options[:branch] is specified) into the name directory, then remove all traces of git from the directory.

See clone for options. Does not obey the :remote option, since the .git info will be deleted anyway; always uses the default remote, 'origin.'



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

def self.export(repository, name, options = {})
  options.delete(:remote)
  repo = clone(repository, name, {:depth => 1}.merge(options))
  repo.checkout("origin/#{options[:branch]}") if options[:branch]
  Dir.chdir(repo.dir.to_s) { FileUtils.rm_r '.git' }
end

+ (Object) global_config(name = nil, value = nil)

Same as g.config, but forces it to be at the global level

g.config('user.name', 'Scott Chacon') # sets value g.config('user.email', 'email@email.com') # sets value g.config('user.name') # returns 'Scott Chacon' g.config # returns whole config hash



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

def self.global_config(name = nil, value = nil)
  lib = Git::Lib.new(nil, nil)
  if(name && value)
    # set value
    lib.global_config_set(name, value)
  elsif (name)
    # return value
    lib.global_config_get(name)
  else
    # return hash
    lib.global_config_list
  end
end

+ (Object) init(working_dir = '.',, options = {})

initialize a new git repository, defaults to the current working directory

options

:repository => '/path/to/alt_git_dir'
:index => '/path/to/alt_index_file'


82
83
84
# File 'lib/git.rb', line 82

def self.init(working_dir = '.', options = {})
  Base.init(working_dir, options)
end

+ (Object) open(working_dir, options = {})

open an existing git working directory

this will most likely be the most common way to create a git reference, referring to a working directory. if not provided in the options, the library will assume your git_dir and index are in the default place (.git/, .git/index)

options

:repository => '/path/to/alt_git_dir'
:index => '/path/to/alt_index_file'


73
74
75
# File 'lib/git.rb', line 73

def self.open(working_dir, options = {})
  Base.open(working_dir, options)
end

Instance Method Details

- (Object) config(name = nil, value = nil)

g.config('user.name', 'Scott Chacon') # sets value g.config('user.email', 'email@email.com') # sets value g.config('user.name') # returns 'Scott Chacon' g.config # returns whole config hash



118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/git.rb', line 118

def config(name = nil, value = nil)
  lib = Git::Lib.new
  if(name && value)
    # set value
    lib.config_set(name, value)
  elsif (name)
    # return value
    lib.config_get(name)
  else
    # return hash
    lib.config_list
  end
end

- (Object) global_config(name = nil, value = nil)



152
153
154
# File 'lib/git.rb', line 152

def global_config(name = nil, value = nil)
  self.class.global_config(name, value)
end