Class: Git::Base
- Inherits:
-
Object
- Object
- Git::Base
- Includes:
- Factory
- Defined in:
- lib/git/base.rb,
lib/git/base/factory.rb
Overview
Defined Under Namespace
Modules: Factory
Class Method Summary collapse
-
.bare(git_dir, options = {}) ⇒ Git::Base
Open a bare repository.
-
.clone(repository, name, options = {}) ⇒ Git::Base
Clone a repository into an empty or newly created directory.
-
.config ⇒ Git::Config
Returns (and initialize if needed) a Git::Config instance.
-
.init(directory = '.', options = {}) ⇒ Git::Base
Create an empty Git repository or reinitialize an existing Git repository.
-
.open(working_dir, options = {}) ⇒ Git::Base
Open a an existing Git working directory.
Instance Method Summary collapse
-
#add(paths = '.', **options)
updates the repository index using the working directory content.
-
#add_remote(name, url, opts = {})
adds a new remote to this repository url can be a git url or a Git::Base object if it's a local reference.
-
#add_tag(name, *options)
Creates a new git tag (Git::Tag).
- #apply(file)
- #apply_mail(file)
-
#archive(treeish, file = nil, opts = {})
creates an archive file of the given tree-ish.
- #cat_file(objectish)
-
#chdir
changes current working directory for a block to the git working directory.
-
#checkout(branch = 'master', opts = {})
checks out a branch as the new git working directory.
-
#checkout_file(version, file)
checks out an old version of a file.
- #checkout_index(opts = {})
-
#clean(opts = {})
cleans the working directory.
-
#commit(message, opts = {})
commits all pending changes in the index file to the git repository.
-
#commit_all(message, opts = {})
commits all pending changes in the index file to the git repository, but automatically adds all modified files without having to explicitly calling @git.add() on them.
-
#config(name = nil, value = nil, options = {})
g.config('user.name', 'Scott Chacon') # sets value g.config('user.email', '[email protected]') # sets value g.config('user.email', '[email protected]', file: 'path/to/custom/config) # sets value in file g.config('user.name') # returns 'Scott Chacon' g.config # returns whole config hash.
-
#current_branch
returns the name of the branch the working directory is currently on.
-
#delete_tag(name)
deletes a tag.
-
#describe(committish = nil, opts = {})
returns the most recent tag that is reachable from a commit.
-
#dir
returns a reference to the working directory @git.dir.path @git.dir.writeable?.
-
#each_conflict(&block)
iterates over the files which are unmerged.
-
#fetch(remote = 'origin', opts = {})
fetches changes from a remote branch - this does not modify the working directory, it just gets the changes from the remote if there are any.
- #gc
-
#grep(string, path_limiter = nil, opts = {}) ⇒ Hash<String, Array>
Run a grep for 'string' on the HEAD of the git repository.
-
#index
returns reference to the git index file.
-
#initialize(options = {}) ⇒ Git::Base
constructor
Create an object that executes Git commands in the context of a working copy or a bare repository.
-
#is_branch?(branch) ⇒ Boolean
returns +true+ if the branch exists.
-
#is_local_branch?(branch) ⇒ Boolean
returns +true+ if the branch exists locally.
-
#is_remote_branch?(branch) ⇒ Boolean
returns +true+ if the branch exists remotely.
-
#lib
this is a convenience method for accessing the class that wraps all the actual 'git' forked system calls.
- #ls_files(location = nil)
- #ls_tree(objectish)
-
#merge(branch, message = 'merge', opts = {})
merges one or more branches into the current working branch.
-
#pull(remote = 'origin', branch = 'master')
pulls the given branch from the given remote into the current branch.
-
#push(remote = 'origin', branch = 'master', opts = {})
pushes changes to a remote repository - easiest if this is a cloned repository, otherwise you may have to run something like this first to setup the push parameters:.
- #read_tree(treeish, opts = {})
-
#remotes
returns an array of Git:Remote objects.
-
#remove(path = '.', opts = {})
removes file(s) from the git repository.
-
#remove_remote(name)
removes a remote from this repository.
-
#repack
repacks the repository.
-
#repo
returns reference to the git repository directory @git.dir.path.
-
#repo_size
returns the repository size in bytes.
-
#reset(commitish = nil, opts = {})
resets the working directory to the provided commitish.
-
#reset_hard(commitish = nil, opts = {})
resets the working directory to the commitish with '--hard'.
-
#revert(commitish = nil, opts = {})
reverts the working directory to the provided commitish.
-
#revparse(objectish)
runs git rev-parse to convert the objectish to a full sha.
- #set_index(index_file, check = true)
-
#set_remote_url(name, url)
sets the url for a remote url can be a git url or a Git::Base object if it's a local reference.
- #set_working(work_dir, check = true)
-
#show(objectish = nil, path = nil) ⇒ String
Shows objects.
-
#tags
returns an array of all Git::Tag objects for this repository.
- #update_ref(branch, commit)
-
#with_index(new_index)
LOWER LEVEL INDEX OPERATIONS ##.
- #with_temp_index(&blk)
- #with_temp_working(&blk)
-
#with_working(work_dir)
:yields: the Git::WorkingDirectory.
- #write_and_commit_tree(opts = {})
- #write_tree
Methods included from Factory
#branch, #branches, #commit_tree, #diff, #gblob, #gcommit, #gtree, #log, #merge_base, #object, #remote, #status, #tag, #worktree, #worktrees
Constructor Details
#initialize(options = {}) ⇒ Git::Base
Create an object that executes Git commands in the context of a working copy or a bare repository.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/git/base.rb', line 88 def initialize( = {}) if working_dir = [:working_directory] [:repository] ||= File.join(working_dir, '.git') [:index] ||= File.join([:repository], 'index') end if [:log] @logger = [:log] @logger.info("Starting Git") else @logger = nil end @working_directory = [:working_directory] ? Git::WorkingDirectory.new([:working_directory]) : nil @repository = [:repository] ? Git::Repository.new([:repository]) : nil @index = [:index] ? Git::Index.new([:index], false) : nil end |
Class Method Details
.bare(git_dir, options = {}) ⇒ Git::Base
Open a bare repository
Opens a bare repository located in the git_dir
directory.
Since there is no working copy, you can not checkout or commit
but you can do most read operations.
14 15 16 17 |
# File 'lib/git/base.rb', line 14 def self.(git_dir, = {}) normalize_paths(, default_repository: git_dir, bare: true) self.new() end |
.clone(repository, name, options = {}) ⇒ Git::Base
Clone a repository into an empty or newly created directory
20 21 22 23 24 |
# File 'lib/git/base.rb', line 20 def self.clone(repository, name, = {}) = Git::Lib.new(nil, [:log]).clone(repository, name, ) normalize_paths(, bare: [:bare] || [:mirror]) self.new() end |
.config ⇒ Git::Config
Returns (and initialize if needed) a Git::Config instance
29 30 31 |
# File 'lib/git/base.rb', line 29 def self.config @@config ||= Config.new end |
.init(directory = '.', options = {}) ⇒ Git::Base
Create an empty Git repository or reinitialize an existing Git repository
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/git/base.rb', line 34 def self.init(directory = '.', = {}) normalize_paths(, default_working_directory: directory, default_repository: directory, bare: [:bare]) = { :bare => [:bare], :initial_branch => [:initial_branch] } directory = [:bare] ? [:repository] : [:working_directory] FileUtils.mkdir_p(directory) unless File.exist?(directory) # TODO: this dance seems awkward: this creates a Git::Lib so we can call # init so we can create a new Git::Base which in turn (ultimately) # creates another/different Git::Lib. # # TODO: maybe refactor so this Git::Bare.init does this: # self.new(opts).init(init_opts) and move all/some of this code into # Git::Bare#init. This way the init method can be called on any # repository you have a Git::Base instance for. This would not # change the existing interface (other than adding to it). # Git::Lib.new().init() self.new() end |
.open(working_dir, options = {}) ⇒ Git::Base
Open a an existing Git working directory
Git.open will most likely be the most common way to create a git reference, referring to an existing working directory.
If not provided in the options, the library will assume
the repository and index are in the default places (.git/
, .git/index
).
61 62 63 64 |
# File 'lib/git/base.rb', line 61 def self.open(working_dir, = {}) normalize_paths(, default_working_directory: working_dir) self.new() end |
Instance Method Details
#add(paths = '.', **options)
updates the repository index using the working directory content
options: :all => true
247 248 249 |
# File 'lib/git/base.rb', line 247 def add(paths = '.', **) self.lib.add(paths, ) end |
#add_remote(name, url, opts = {})
adds a new remote to this repository url can be a git url or a Git::Base object if it's a local reference
@git.add_remote('scotts_git', 'git://repo.or.cz/rubygit.git') @git.fetch('scotts_git') @git.merge('scotts_git/master')
Options:
:fetch => true
:track =>
392 393 394 395 396 |
# File 'lib/git/base.rb', line 392 def add_remote(name, url, opts = {}) url = url.repo.path if url.is_a?(Git::Base) self.lib.remote_add(name, url, opts) Git::Remote.new(self, name) end |
#add_tag(name, *options)
Creates a new git tag (Git::Tag)
439 440 441 442 |
# File 'lib/git/base.rb', line 439 def add_tag(name, *) self.lib.tag(name, *) self.tag(name) end |
#apply(file)
463 464 465 466 467 |
# File 'lib/git/base.rb', line 463 def apply(file) if File.exist?(file) self.lib.apply(file) end end |
#apply_mail(file)
469 470 471 |
# File 'lib/git/base.rb', line 469 def apply_mail(file) self.lib.apply_mail(file) if File.exist?(file) end |
#archive(treeish, file = nil, opts = {})
creates an archive file of the given tree-ish
450 451 452 |
# File 'lib/git/base.rb', line 450 def archive(treeish, file = nil, opts = {}) self.object(treeish).archive(file, opts) end |
#cat_file(objectish)
568 569 570 |
# File 'lib/git/base.rb', line 568 def cat_file(objectish) self.lib.object_contents(objectish) end |
#chdir
changes current working directory for a block to the git working directory
example @git.chdir do # write files @git.add @git.commit('message') end
114 115 116 117 118 |
# File 'lib/git/base.rb', line 114 def chdir # :yields: the Git::Path Dir.chdir(dir.path) do yield dir.path end end |
#checkout(branch = 'master', opts = {})
checks out a branch as the new git working directory
328 329 330 |
# File 'lib/git/base.rb', line 328 def checkout(branch = 'master', opts = {}) self.lib.checkout(branch, opts) end |
#checkout_file(version, file)
checks out an old version of a file
333 334 335 |
# File 'lib/git/base.rb', line 333 def checkout_file(version, file) self.lib.checkout_file(version,file) end |
#checkout_index(opts = {})
507 508 509 |
# File 'lib/git/base.rb', line 507 def checkout_index(opts = {}) self.lib.checkout_index(opts) end |
#clean(opts = {})
cleans the working directory
options: :force :d :ff
274 275 276 |
# File 'lib/git/base.rb', line 274 def clean(opts = {}) self.lib.clean(opts) end |
#commit(message, opts = {})
commits all pending changes in the index file to the git repository
options: :all :allow_empty :amend :author
315 316 317 |
# File 'lib/git/base.rb', line 315 def commit(, opts = {}) self.lib.commit(, opts) end |
#commit_all(message, opts = {})
commits all pending changes in the index file to the git repository, but automatically adds all modified files without having to explicitly calling @git.add() on them.
322 323 324 325 |
# File 'lib/git/base.rb', line 322 def commit_all(, opts = {}) opts = {:add_all => true}.merge(opts) self.lib.commit(, opts) end |
#config(name = nil, value = nil, options = {})
g.config('user.name', 'Scott Chacon') # sets value g.config('user.email', '[email protected]') # sets value g.config('user.email', '[email protected]', file: 'path/to/custom/config) # sets value in file g.config('user.name') # returns 'Scott Chacon' g.config # returns whole config hash
125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/git/base.rb', line 125 def config(name = nil, value = nil, = {}) 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 |
#current_branch
returns the name of the branch the working directory is currently on
573 574 575 |
# File 'lib/git/base.rb', line 573 def current_branch self.lib.branch_current end |
#delete_tag(name)
deletes a tag
445 446 447 |
# File 'lib/git/base.rb', line 445 def delete_tag(name) self.lib.tag(name, {:d => true}) end |
#describe(committish = nil, opts = {})
returns the most recent tag that is reachable from a commit
options: :all :tags :contains :debug :exact_match :dirty :abbrev :candidates :long :always :match
293 294 295 |
# File 'lib/git/base.rb', line 293 def describe(committish=nil, opts={}) self.lib.describe(committish, opts) end |
#dir
returns a reference to the working directory @git.dir.path @git.dir.writeable?
141 142 143 |
# File 'lib/git/base.rb', line 141 def dir @working_directory end |
#each_conflict(&block)
iterates over the files which are unmerged
363 364 365 |
# File 'lib/git/base.rb', line 363 def each_conflict(&block) # :yields: file, your_version, their_version self.lib.conflicts(&block) end |
#fetch(remote = 'origin', opts = {})
fetches changes from a remote branch - this does not modify the working directory, it just gets the changes from the remote if there are any
339 340 341 |
# File 'lib/git/base.rb', line 339 def fetch(remote = 'origin', opts={}) self.lib.fetch(remote, opts) end |
#gc
459 460 461 |
# File 'lib/git/base.rb', line 459 def gc self.lib.gc end |
#grep(string, path_limiter = nil, opts = {}) ⇒ Hash<String, Array>
Run a grep for 'string' on the HEAD of the git repository
224 225 226 |
# File 'lib/git/base.rb', line 224 def grep(string, path_limiter = nil, opts = {}) self.object('HEAD').grep(string, path_limiter, opts) end |
#index
returns reference to the git index file
146 147 148 |
# File 'lib/git/base.rb', line 146 def index @index end |
#is_branch?(branch) ⇒ Boolean
returns +true+ if the branch exists
190 191 192 193 |
# File 'lib/git/base.rb', line 190 def is_branch?(branch) branch_names = self.branches.map {|b| b.name} branch_names.include?(branch) end |
#is_local_branch?(branch) ⇒ Boolean
returns +true+ if the branch exists locally
178 179 180 181 |
# File 'lib/git/base.rb', line 178 def is_local_branch?(branch) branch_names = self.branches.local.map {|b| b.name} branch_names.include?(branch) end |
#is_remote_branch?(branch) ⇒ Boolean
returns +true+ if the branch exists remotely
184 185 186 187 |
# File 'lib/git/base.rb', line 184 def is_remote_branch?(branch) branch_names = self.branches.remote.map {|b| b.name} branch_names.include?(branch) end |
#lib
this is a convenience method for accessing the class that wraps all the actual 'git' forked system calls. At some point I hope to replace the Git::Lib class with one that uses native methods or libgit C bindings
198 199 200 |
# File 'lib/git/base.rb', line 198 def lib @lib ||= Git::Lib.new(self, @logger) end |
#ls_files(location = nil)
529 530 531 |
# File 'lib/git/base.rb', line 529 def ls_files(location=nil) self.lib.ls_files(location) end |
#ls_tree(objectish)
564 565 566 |
# File 'lib/git/base.rb', line 564 def ls_tree(objectish) self.lib.ls_tree(objectish) end |
#merge(branch, message = 'merge', opts = {})
merges one or more branches into the current working branch
you can specify more than one branch to merge by passing an array of branches
358 359 360 |
# File 'lib/git/base.rb', line 358 def merge(branch, = 'merge', opts = {}) self.lib.merge(branch, , opts) end |
#pull(remote = 'origin', branch = 'master')
pulls the given branch from the given remote into the current branch
@git.pull # pulls from origin/master @git.pull('upstream') # pulls from upstream/master @git.pull('upstream', 'develope') # pulls from upstream/develop
373 374 375 |
# File 'lib/git/base.rb', line 373 def pull(remote='origin', branch='master') self.lib.pull(remote, branch) end |
#push(remote = 'origin', branch = 'master', opts = {})
pushes changes to a remote repository - easiest if this is a cloned repository, otherwise you may have to run something like this first to setup the push parameters:
@git.config('remote.remote-name.push', 'refs/heads/master:refs/heads/master')
348 349 350 351 352 353 |
# File 'lib/git/base.rb', line 348 def push(remote = 'origin', 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) self.lib.push(remote, branch, opts) end |
#read_tree(treeish, opts = {})
511 512 513 |
# File 'lib/git/base.rb', line 511 def read_tree(treeish, opts = {}) self.lib.read_tree(treeish, opts) end |
#remotes
returns an array of Git:Remote objects
378 379 380 |
# File 'lib/git/base.rb', line 378 def remotes self.lib.remotes.map { |r| Git::Remote.new(self, r) } end |
#remove(path = '.', opts = {})
removes file(s) from the git repository
252 253 254 |
# File 'lib/git/base.rb', line 252 def remove(path = '.', opts = {}) self.lib.remove(path, opts) end |
#remove_remote(name)
removes a remote from this repository
@git.remove_remote('scott_git')
412 413 414 |
# File 'lib/git/base.rb', line 412 def remove_remote(name) self.lib.remote_remove(name) end |
#repack
repacks the repository
455 456 457 |
# File 'lib/git/base.rb', line 455 def repack self.lib.repack end |
#repo
returns reference to the git repository directory @git.dir.path
152 153 154 |
# File 'lib/git/base.rb', line 152 def repo @repository end |
#repo_size
returns the repository size in bytes
157 158 159 160 161 162 163 164 165 |
# File 'lib/git/base.rb', line 157 def repo_size Dir.glob(File.join(repo.path, '**', '*'), File::FNM_DOTMATCH).reject do |f| f.include?('..') end.map do |f| File.(f) end.uniq.map do |f| File.stat(f).size.to_i end.reduce(:+) end |
#reset(commitish = nil, opts = {})
resets the working directory to the provided commitish
257 258 259 |
# File 'lib/git/base.rb', line 257 def reset(commitish = nil, opts = {}) self.lib.reset(commitish, opts) end |
#reset_hard(commitish = nil, opts = {})
resets the working directory to the commitish with '--hard'
262 263 264 265 |
# File 'lib/git/base.rb', line 262 def reset_hard(commitish = nil, opts = {}) opts = {:hard => true}.merge(opts) self.lib.reset(commitish, opts) end |
#revert(commitish = nil, opts = {})
reverts the working directory to the provided commitish. Accepts a range, such as comittish..HEAD
options: :no_edit
303 304 305 |
# File 'lib/git/base.rb', line 303 def revert(commitish = nil, opts = {}) self.lib.revert(commitish, opts) end |
#revparse(objectish)
runs git rev-parse to convert the objectish to a full sha
560 561 562 |
# File 'lib/git/base.rb', line 560 def revparse(objectish) self.lib.revparse(objectish) end |
#set_index(index_file, check = true)
167 168 169 170 |
# File 'lib/git/base.rb', line 167 def set_index(index_file, check = true) @lib = nil @index = Git::Index.new(index_file.to_s, check) end |
#set_remote_url(name, url)
sets the url for a remote url can be a git url or a Git::Base object if it's a local reference
@git.set_remote_url('scotts_git', 'git://repo.or.cz/rubygit.git')
403 404 405 406 407 |
# File 'lib/git/base.rb', line 403 def set_remote_url(name, url) url = url.repo.path if url.is_a?(Git::Base) self.lib.remote_set_url(name, url) Git::Remote.new(self, name) end |
#set_working(work_dir, check = true)
172 173 174 175 |
# File 'lib/git/base.rb', line 172 def set_working(work_dir, check = true) @lib = nil @working_directory = Git::WorkingDirectory.new(work_dir.to_s, check) end |
#show(objectish = nil, path = nil) ⇒ String
Shows objects
478 479 480 |
# File 'lib/git/base.rb', line 478 def show(objectish=nil, path=nil) self.lib.show(objectish, path) end |
#tags
returns an array of all Git::Tag objects for this repository
417 418 419 |
# File 'lib/git/base.rb', line 417 def self.lib..map { |r| tag(r) } end |
#update_ref(branch, commit)
524 525 526 |
# File 'lib/git/base.rb', line 524 def update_ref(branch, commit) branch(branch).update_ref(commit) end |
#with_index(new_index)
LOWER LEVEL INDEX OPERATIONS ##
484 485 486 487 488 489 490 |
# File 'lib/git/base.rb', line 484 def with_index(new_index) # :yields: new_index old_index = @index set_index(new_index, false) return_value = yield @index set_index(old_index) return_value end |
#with_temp_index(&blk)
492 493 494 495 496 497 498 499 500 501 502 503 504 505 |
# File 'lib/git/base.rb', line 492 def with_temp_index &blk # Workaround for JRUBY, since they handle the TempFile path different. # MUST be improved to be safer and OS independent. if RUBY_PLATFORM == 'java' temp_path = "/tmp/temp-index-#{(0...15).map{ ('a'..'z').to_a[rand(26)] }.join}" else tempfile = Tempfile.new('temp-index') temp_path = tempfile.path tempfile.close tempfile.unlink end with_index(temp_path, &blk) end |
#with_temp_working(&blk)
544 545 546 547 548 549 550 551 |
# File 'lib/git/base.rb', line 544 def with_temp_working &blk tempfile = Tempfile.new("temp-workdir") temp_dir = tempfile.path tempfile.close tempfile.unlink Dir.mkdir(temp_dir, 0700) with_working(temp_dir, &blk) end |
#with_working(work_dir)
:yields: the Git::WorkingDirectory
533 534 535 536 537 538 539 540 541 542 |
# File 'lib/git/base.rb', line 533 def with_working(work_dir) # :yields: the Git::WorkingDirectory return_value = false old_working = @working_directory set_working(work_dir) Dir.chdir work_dir do return_value = yield @working_directory end set_working(old_working) return_value end |
#write_and_commit_tree(opts = {})
519 520 521 522 |
# File 'lib/git/base.rb', line 519 def write_and_commit_tree(opts = {}) tree = write_tree commit_tree(tree, opts) end |
#write_tree
515 516 517 |
# File 'lib/git/base.rb', line 515 def write_tree self.lib.write_tree end |