Class: Gitlab::Git::Repository

Inherits:
Object
  • Object
show all
Includes:
Popen
Defined in:
lib/gitlab_git/repository.rb

Defined Under Namespace

Classes: InvalidBlobName, InvalidRef, NoRepository

Constant Summary collapse

SEARCH_CONTEXT_LINES = 
3
AUTOCRLF_VALUES = 
{
  "true" => true,
  "false" => false,
  "input" => :input
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Popen

#popen

Constructor Details

#initialize(path) ⇒ Repository

‘path’ must be the path to a bare git repository, e.g. /path/to/my-repo.git



32
33
34
35
36
 
# File 'lib/gitlab_git/repository.rb', line 32

def initialize(path)
  @path = path
  @name = path.split("/").last
  @root_ref = discover_default_branch
end

Instance Attribute Details

#name ⇒ Object (readonly)

Directory name of repo



25
26
27
 
# File 'lib/gitlab_git/repository.rb', line 25

def name
  @name
end

#path ⇒ Object (readonly)

Full path to repo



22
23
24
 
# File 'lib/gitlab_git/repository.rb', line 22

def path
  @path
end

#root_ref ⇒ Object

Default branch in the repository



19
20
21
 
# File 'lib/gitlab_git/repository.rb', line 19

def root_ref
  @root_ref
end

#rugged ⇒ Object (readonly)

Rugged repo object



28
29
30
 
# File 'lib/gitlab_git/repository.rb', line 28

def rugged
  @rugged
end

Instance Method Details

#add_tag(tag_name, ref_target, options = nil) ⇒ Object

Add a tag with tag_name+ name to the repository in corresponding ref_target+ supports passing a hash of options to create an annotated tag

Valid annotation options are:

:tagger ::
  same structure as a committer, the user that is creating the tag

:message ::
  the message to include in the tag annotation

Returns a Gitlab::Git::Tag



682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/gitlab_git/repository.rb', line 682

def add_tag(tag_name, ref_target, options = nil)
  tag = rugged.tags.create(tag_name, ref_target, options)
  if tag.annotated?
    Tag.new(tag_name, ref_target, tag.annotation.message)
  else
    Tag.new(tag_name, ref_target)
  end
rescue Rugged::TagError
  raise InvalidRef.new("Tag #{tag_name} already exists")
rescue Rugged::ReferenceError
  raise InvalidRef.new("Target #{ref_target} is invalid")
end

#archive_file_path(name, storage_path, format = "tar.gz") ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/gitlab_git/repository.rb', line 157

def archive_file_path(name, storage_path, format = "tar.gz")
  # Build file path
  return nil unless name

  extension =
    case format
    when "tar.bz2", "tbz", "tbz2", "tb2", "bz2"
      "tar.bz2"
    when "tar"
      "tar"
    when "zip"
      "zip"
    else
      # everything else should fall back to tar.gz
      "tar.gz"
    end

  file_name = "#{name}.#{extension}"
  File.join(storage_path, self.name, file_name)
end

#archive_metadata(ref, storage_path, format = "tar.gz") ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/gitlab_git/repository.rb', line 141

def archive_metadata(ref, storage_path, format = "tar.gz")
  ref ||= root_ref
  commit = Gitlab::Git::Commit.find(self, ref)
  return {} if commit.nil?

  project_name = self.name.chomp('.git')
  prefix = "#{project_name}-#{ref}-#{commit.id}"

  {
    'RepoPath' => path,
    'ArchivePrefix' => prefix,
    'ArchivePath' => archive_file_path(prefix, storage_path, format),
    'CommitId' => commit.id,
  }
end

#autocrlf ⇒ Object 



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

def autocrlf
  AUTOCRLF_VALUES[rugged.config['core.autocrlf']]
end

#autocrlf=(value) ⇒ Object 



791
792
793
 
# File 'lib/gitlab_git/repository.rb', line 791

def autocrlf=(value)
  rugged.config['core.autocrlf'] = AUTOCRLF_VALUES.invert[value]
end

#bare? ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/gitlab_git/repository.rb', line 108

def bare?
  rugged.bare?
end

#branch_names ⇒ Object

Returns an Array of branch names sorted by name ASC



51
52
53
 
# File 'lib/gitlab_git/repository.rb', line 51

def branch_names
  branches.map(&:name)
end

#branch_names_contains(commit) ⇒ Object

Returns branch names collection that contains the special commit(SHA1 or name)

Ex.

repo.branch_names_contains('master')



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

def branch_names_contains(commit)
  branches_contains(commit).map { |c| c.name }
end

#branches ⇒ Object

Returns an Array of Branches



56
57
58
59
60
61
62
63
64
 
# File 'lib/gitlab_git/repository.rb', line 56

def branches
  rugged.branches.map do |rugged_ref|
    begin
      Branch.new(rugged_ref.name, rugged_ref.target)
    rescue Rugged::ReferenceError
      # Omit invalid branch
    end
  end.compact.sort_by(&:name)
end

#branches_contains(commit) ⇒ Object

Returns branch collection that contains the special commit(SHA1 or name)

Ex.

repo.branch_names_contains('master')



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/gitlab_git/repository.rb', line 389

def branches_contains(commit)
  commit_obj = rugged.rev_parse(commit)
  parent = commit_obj.parents.first unless commit_obj.parents.empty?

  walker = Rugged::Walker.new(rugged)

  rugged.branches.select do |branch|
    walker.push(branch.target_id)
    walker.hide(parent) if parent
    result = walker.any? { |c| c.oid == commit_obj.oid }
    walker.reset

    result
  end
end

#checkout(ref, options = {}, start_point = "HEAD") ⇒ Object

Check out the specified ref. Valid options are:

:b - Create a new branch at +start_point+ and set HEAD to the new
     branch.

* These options are passed to the Rugged::Repository#checkout method:

:progress ::
  A callback that will be executed for checkout progress notifications.
  Up to 3 parameters are passed on each execution:

  - The path to the last updated file (or +nil+ on the very first
    invocation).
  - The number of completed checkout steps.
  - The number of total checkout steps to be performed.

:notify ::
  A callback that will be executed for each checkout notification
  types specified with +:notify_flags+. Up to 5 parameters are passed
  on each execution:

  - An array containing the +:notify_flags+ that caused the callback
    execution.
  - The path of the current file.
  - A hash describing the baseline blob (or +nil+ if it does not
    exist).
  - A hash describing the target blob (or +nil+ if it does not exist).
  - A hash describing the workdir blob (or +nil+ if it does not
    exist).

:strategy ::
  A single symbol or an array of symbols representing the strategies
  to use when performing the checkout. Possible values are:

  :none ::
    Perform a dry run (default).

  :safe ::
    Allow safe updates that cannot overwrite uncommitted data.

  :safe_create ::
    Allow safe updates plus creation of missing files.

  :force ::
    Allow all updates to force working directory to look like index.

  :allow_conflicts ::
    Allow checkout to make safe updates even if conflicts are found.

  :remove_untracked ::
    Remove untracked files not in index (that are not ignored).

  :remove_ignored ::
    Remove ignored files not in index.

  :update_only ::
    Only update existing files, don't create new ones.

  :dont_update_index ::
    Normally checkout updates index entries as it goes; this stops
    that.

  :no_refresh ::
    Don't refresh index/config/etc before doing checkout.

  :disable_pathspec_match ::
    Treat pathspec as simple list of exact match file paths.

  :skip_locked_directories ::
    Ignore directories in use, they will be left empty.

  :skip_unmerged ::
    Allow checkout to skip unmerged files (NOT IMPLEMENTED).

  :use_ours ::
    For unmerged files, checkout stage 2 from index (NOT IMPLEMENTED).

  :use_theirs ::
    For unmerged files, checkout stage 3 from index (NOT IMPLEMENTED).

  :update_submodules ::
    Recursively checkout submodules with same options (NOT
    IMPLEMENTED).

  :update_submodules_if_changed ::
    Recursively checkout submodules if HEAD moved in super repo (NOT
    IMPLEMENTED).

:disable_filters ::
  If +true+, filters like CRLF line conversion will be disabled.

:dir_mode ::
  Mode for newly created directories. Default: +0755+.

:file_mode ::
  Mode for newly created files. Default: +0755+ or +0644+.

:file_open_flags ::
  Mode for opening files. Default:
  <code>IO::CREAT | IO::TRUNC | IO::WRONLY</code>.

:notify_flags ::
  A single symbol or an array of symbols representing the cases in
  which the +:notify+ callback should be invoked. Possible values are:

  :none ::
    Do not invoke the +:notify+ callback (default).

  :conflict ::
    Invoke the callback for conflicting paths.

  :dirty ::
    Invoke the callback for "dirty" files, i.e. those that do not need
    an update but no longer match the baseline.

  :updated ::
    Invoke the callback for any file that was changed.

  :untracked ::
    Invoke the callback for untracked files.

  :ignored ::
    Invoke the callback for ignored files.

  :all ::
    Invoke the callback for all these cases.

:paths ::
  A glob string or an array of glob strings specifying which paths
  should be taken into account for the checkout operation. +nil+ will
  match all files.  Default: +nil+.

:baseline ::
  A Rugged::Tree that represents the current, expected contents of the
  workdir.  Default: +HEAD+.

:target_directory ::
  A path to an alternative workdir directory in which the checkout
  should be performed.



644
645
646
647
648
649
650
651
 
# File 'lib/gitlab_git/repository.rb', line 644

def checkout(ref, options = {}, start_point = "HEAD")
  if options[:b]
    rugged.branches.create(ref, start_point)
    options.delete(:b)
  end
  default_options = { strategy: [:recreate_missing, :safe] }
  rugged.checkout(ref, default_options.merge(options))
end

#clean(options = {}) ⇒ Object

Mimic the ‘git clean` command and recursively delete untracked files. Valid keys that can be passed in the options hash are:

:d - Remove untracked directories :f - Remove untracked directories that are managed by a different

repository

:x - Remove ignored files

The value in options must evaluate to true for an option to take effect.

Examples:

repo.clean(d: true, f: true) # Enable the -d and -f options

repo.clean(d: false, x: true) # -x is enabled, -d is not



497
498
499
500
501
502
503
 
# File 'lib/gitlab_git/repository.rb', line 497

def clean(options = {})
  strategies = [:remove_untracked]
  strategies.push(:force) if options[:f]
  strategies.push(:remove_ignored) if options[:x]

  # TODO: implement this method
end

#commit_count(ref) ⇒ Object

Return total commits count accessible from passed ref



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

def commit_count(ref)
  walker = Rugged::Walker.new(rugged)
  walker.sorting(Rugged::SORT_TOPO | Rugged::SORT_REVERSE)
  oid = rugged.rev_parse_oid(ref)
  walker.push(oid)
  walker.count
end

#commits_between(from, to) ⇒ Object

Return a collection of Rugged::Commits between the two SHA arguments.



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/gitlab_git/repository.rb', line 270

def commits_between(from, to)
  walker = Rugged::Walker.new(rugged)
  walker.sorting(Rugged::SORT_DATE | Rugged::SORT_REVERSE)

  walker.push(to)
  walker.hide(from)

  commits = walker.to_a
  walker.reset

  commits
end

#commits_since(from_date) ⇒ Object 



764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'lib/gitlab_git/repository.rb', line 764

def commits_since(from_date)
  walker = Rugged::Walker.new(rugged)
  walker.sorting(Rugged::SORT_DATE | Rugged::SORT_REVERSE)

  rugged.references.each("refs/heads/*") do |ref|
    walker.push(ref.target_id)
  end

  commits = []
  walker.each do |commit|
    break if commit.author[:time].to_date < from_date
    commits.push(commit)
  end

  commits
end

#create_branch(ref, start_point = "HEAD") ⇒ Object

Create a new branch named **ref+ based on **stat_point+, HEAD by default

Examples:

create_branch("feature")
create_branch("other-feature", "master")



663
664
665
666
667
668
669
 
# File 'lib/gitlab_git/repository.rb', line 663

def create_branch(ref, start_point = "HEAD")
  rugged_ref = rugged.branches.create(ref, start_point)
  Branch.new(rugged_ref.name, rugged_ref.target)
rescue Rugged::ReferenceError => e
  raise InvalidRef.new("Branch #{ref} already exists") if e.to_s =~ /'refs\/heads\/#{ref}'/
  raise InvalidRef.new("Invalid reference #{start_point}")
end

#delete_branch(branch_name) ⇒ Object

Delete the specified branch from the repository



654
655
656
 
# File 'lib/gitlab_git/repository.rb', line 654

def delete_branch(branch_name)
  rugged.branches.delete(branch_name)
end

#diff(from, to, options = {}, *paths) ⇒ Object

Return an array of Diff objects that represent the diff between from and to. See Diff::filter_diff_options for the allowed diff options. The options hash can also include :break_rewrites to split larger rewrites into delete/add pairs.



292
293
294
295
296
 
# File 'lib/gitlab_git/repository.rb', line 292

def diff(from, to, options = {}, *paths)
  diff_patches(from, to, options, *paths).map do |p|
    Gitlab::Git::Diff.new(p)
  end
end

#diff_text(from, to, options = {}, *paths) ⇒ Object

Return the diff between from and to in a single patch string. The options hash has the same allowed keys as #diff.



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

def diff_text(from, to, options = {}, *paths)
  # NOTE: It would be simpler to use the Rugged::Diff#patch method, but
  # that formats the diff text differently than Rugged::Patch#to_s for
  # changes to binary files.
  diff_patches(from, to, options, *paths).map do |p|
    p.to_s
  end.join("\n")
end

#discover_default_branch ⇒ Object

Discovers the default branch based on the repository’s available branches

  • If no branches are present, returns nil

  • If one branch is present, returns its name

  • If two or more branches are present, returns current HEAD or master or first branch



121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/gitlab_git/repository.rb', line 121

def discover_default_branch
  if branch_names.length == 0
    nil
  elsif branch_names.length == 1
    branch_names.first
  elsif rugged_head && branch_names.include?(Ref.extract_branch_name(rugged_head.name))
    Ref.extract_branch_name(rugged_head.name)
  elsif branch_names.include?("master")
    "master"
  else
    branch_names.first
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/gitlab_git/repository.rb', line 104

def empty?
  rugged.empty?
end

#fetch(remote_name) ⇒ Object

Fetch the specified remote



720
721
722
 
# File 'lib/gitlab_git/repository.rb', line 720

def fetch(remote_name)
  rugged.remotes[remote_name].fetch
end

#find_commits(options = {}) ⇒ Object

Returns commits collection

Ex.

repo.find_commits(
  ref: 'master',
  max_count: 10,
  skip: 5,
  order: :date
)

+options+ is a Hash of optional arguments to git
  :ref is the ref from which to begin (SHA1 or name)
  :contains is the commit contained by the refs from which to begin (SHA1 or name)
  :max_count is the maximum number of commits to fetch
  :skip is the number of commits to skip
  :order is the commits order and allowed value is :date(default) or :topo



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/gitlab_git/repository.rb', line 326

def find_commits(options = {})
  actual_options = options.dup

  allowed_options = [:ref, :max_count, :skip, :contains, :order]

  actual_options.keep_if do |key|
    allowed_options.include?(key)
  end

  default_options = { skip: 0 }
  actual_options = default_options.merge(actual_options)

  walker = Rugged::Walker.new(rugged)

  if actual_options[:ref]
    walker.push(rugged.rev_parse_oid(actual_options[:ref]))
  elsif actual_options[:contains]
    branches_contains(actual_options[:contains]).each do |branch|
      walker.push(branch.target_id)
    end
  else
    rugged.references.each("refs/heads/*") do |ref|
      walker.push(ref.target_id)
    end
  end

  if actual_options[:order] == :topo
    walker.sorting(Rugged::SORT_TOPO)
  else
    walker.sorting(Rugged::SORT_DATE)
  end


  commits = []
  offset = actual_options[:skip]
  limit = actual_options[:max_count]
  walker.each(offset: offset, limit: limit) do |commit|
    gitlab_commit = Gitlab::Git::Commit.decorate(commit)
    commits.push(gitlab_commit)
  end

  walker.reset

  commits
rescue Rugged::OdbError
  []
end

#format_patch(from, to, options = {}) ⇒ Object

Return a String containing the mbox-formatted diff between from and to. See #diff for the allowed keys in the options hash.



731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/gitlab_git/repository.rb', line 731

def format_patch(from, to, options = {})
  options ||= {}
  break_rewrites = options[:break_rewrites]
  actual_options = Diff.filter_diff_options(options)

  from_sha = rugged.rev_parse_oid(from)
  to_sha = rugged.rev_parse_oid(to)
  commits_between(from_sha, to_sha).map do |commit|
    commit.to_mbox(actual_options)
  end.join("\n")
end

#has_commits? ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
 
# File 'lib/gitlab_git/repository.rb', line 100

def has_commits?
  !empty?
end

#heads ⇒ Object

Deprecated. Will be removed in 5.2



94
95
96
97
98
 
# File 'lib/gitlab_git/repository.rb', line 94

def heads
  rugged.references.each("refs/heads/*").map do |head|
    Gitlab::Git::Ref.new(head.name, head.target)
  end.sort_by(&:name)
end

#log(options) ⇒ Object

Use the Rugged Walker API to build an array of commits.

Usage.

repo.log(
  ref: 'master',
  path: 'app/models',
  limit: 10,
  offset: 5,
)



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/gitlab_git/repository.rb', line 215

def log(options)
  default_options = {
    limit: 10,
    offset: 0,
    path: nil,
    ref: root_ref,
    follow: false,
    skip_merges: false
  }

  options = default_options.merge(options)
  options[:limit] ||= 0
  options[:offset] ||= 0
  actual_ref = options[:ref] || root_ref
  begin
    sha = sha_from_ref(actual_ref)
  rescue Rugged::OdbError, Rugged::InvalidError, Rugged::ReferenceError
    # Return an empty array if the ref wasn't found
    return []
  end

  repo = options[:repo]

  cmd = %W(git --git-dir=#{path} log)
  cmd += %W(-n #{options[:limit].to_i})
  cmd += %W(--format=%H)
  cmd += %W(--skip=#{options[:offset].to_i})
  cmd += %W(--follow) if options[:follow]
  cmd += %W(--no-merges) if options[:skip_merges]
  cmd += [sha]
  cmd += %W(-- #{options[:path]}) if options[:path].present?

  raw_output = IO.popen(cmd) {|io| io.read }

  log = raw_output.lines.map do |c|
    Rugged::Commit.new(rugged, c.strip)
  end

  log.is_a?(Array) ? log : []
end

#lookup(oid_or_ref_name) ⇒ Object

Lookup for rugged object by oid or ref name



425
426
427
 
# File 'lib/gitlab_git/repository.rb', line 425

def lookup(oid_or_ref_name)
  rugged.rev_parse(oid_or_ref_name)
end

#merge(source_name, target_name, options = {}) ⇒ Object

Merge the source_name branch into the target_name branch. This is equivalent to ‘git merge –no_ff source_name`, since a merge commit is always created.



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/gitlab_git/repository.rb', line 746

def merge(source_name, target_name, options = {})
  our_commit = rugged.branches[target_name].target
  their_commit = rugged.branches[source_name].target

  raise "Invalid merge target" if our_commit.nil?
  raise "Invalid merge source" if their_commit.nil?

  merge_index = rugged.merge_commits(our_commit, their_commit)
  return false if merge_index.conflicts?

  actual_options = options.merge(
    parents: [our_commit, their_commit],
    tree: merge_index.write_tree(rugged),
    update_ref: "refs/heads/#{target_name}"
  )
  Rugged::Commit.create(rugged, actual_options)
end

#merge_base_commit(from, to) ⇒ Object

Returns the SHA of the most recent common ancestor of from and to



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

def merge_base_commit(from, to)
  rugged.merge_base(from, to)
end

#mkdir(path, options = {}) ⇒ Object

Create a new directory with a .gitkeep file. Creates all required nested directories (i.e. mkdir -p behavior)

options should contain next structure:

author: {
  email: '[email protected]',
  name: 'Test User',
  time: Time.now
},
committer: {
  email: '[email protected]',
  name: 'Test User',
  time: Time.now
},
commit: {
  message: 'Wow such commit',
  branch: 'master'
}

Raises:



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/gitlab_git/repository.rb', line 813

def mkdir(path, options = {})
  # Check if this directory exists; if it does, then don't bother
  # adding .gitkeep file.
  ref = options[:commit][:branch]
  path = PathHelper.normalize_path(path).to_s
  rugged_ref = rugged.ref(ref)

  raise InvalidRef.new("Invalid ref") if rugged_ref.nil?
  target_commit = rugged_ref.target
  raise InvalidRef.new("Invalid target commit") if target_commit.nil?

  entry = tree_entry(target_commit, path)
  if entry
    if entry[:type] == :blob
      raise InvalidBlobName.new("Directory already exists as a file")
    else
      raise InvalidBlobName.new("Directory already exists")
    end
  end

  options[:file] = {
    content: '',
    path: "#{path}/.gitkeep",
    update: true
  }

  Blob.commit(self, options)
end

#push(remote_name, *refspecs) ⇒ Object

Push *refspecs to the remote identified by remote_name.



725
726
727
 
# File 'lib/gitlab_git/repository.rb', line 725

def push(remote_name, *refspecs)
  rugged.remotes[remote_name].push(refspecs)
end

#raw ⇒ Object

Alias to old method for compatibility



39
40
41
 
# File 'lib/gitlab_git/repository.rb', line 39

def raw
  rugged
end

#ref_names ⇒ Object

Returns an Array of branch and tag names



89
90
91
 
# File 'lib/gitlab_git/repository.rb', line 89

def ref_names
  branch_names + tag_names
end

#refs_hash ⇒ Object

Get refs hash which key is SHA1 and value is a Rugged::Reference



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/gitlab_git/repository.rb', line 407

def refs_hash
  # Initialize only when first call
  if @refs_hash.nil?
    @refs_hash = Hash.new { |h, k| h[k] = [] }

    rugged.references.each do |r|
      # Symbolic/remote references may not have an OID; skip over them
      target_oid = r.target.try(:oid)
      if target_oid
        sha = rev_parse_target(target_oid).oid
        @refs_hash[sha] << r
      end
    end
  end
  @refs_hash
end

#remote_add(remote_name, url) ⇒ Object

Add a new remote to this repository. Returns a Rugged::Remote object



706
707
708
 
# File 'lib/gitlab_git/repository.rb', line 706

def remote_add(remote_name, url)
  rugged.remotes.create(remote_name, url)
end

#remote_delete(remote_name) ⇒ Object

Delete the specified remote from this repository.



701
702
703
 
# File 'lib/gitlab_git/repository.rb', line 701

def remote_delete(remote_name)
  rugged.remotes.delete(remote_name)
end

#remote_names ⇒ Object

Return an array of this repository’s remote names



696
697
698
 
# File 'lib/gitlab_git/repository.rb', line 696

def remote_names
  rugged.remotes.each_name.to_a
end

#remote_update(remote_name, options = {}) ⇒ Object

Update the specified remote using the values in the options hash

Example repo.update_remote(“origin”, url: “path/to/repo”)



714
715
716
717
 
# File 'lib/gitlab_git/repository.rb', line 714

def remote_update(remote_name, options = {})
  # TODO: Implement other remote options
  rugged.remotes.set_url(remote_name, options[:url]) if options[:url]
end

#repo_exists? ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/gitlab_git/repository.rb', line 112

def repo_exists?
  !!rugged
end

#reset(ref, reset_type) ⇒ Object

Sets HEAD to the commit specified by ref; ref can be a branch or tag name or a commit SHA. Valid reset_type values are:

[:soft]
  the head will be moved to the commit.
[:mixed]
  will trigger a +:soft+ reset, plus the index will be replaced
  with the content of the commit tree.
[:hard]
  will trigger a +:mixed+ reset and the working directory will be
  replaced with the content of the index. (Untracked and ignored files
  will be left alone)



477
478
479
 
# File 'lib/gitlab_git/repository.rb', line 477

def reset(ref, reset_type)
  rugged.reset(ref, reset_type)
end

#rev_parse_target(revspec) ⇒ Object

Return the object that revspec points to. If revspec is an annotated tag, then return the tag’s target instead.



262
263
264
265
266
 
# File 'lib/gitlab_git/repository.rb', line 262

def rev_parse_target(revspec)
  obj = rugged.rev_parse(revspec)
  obj = obj.target while obj.is_a?(Rugged::Tag::Annotation)
  obj
end

#rugged_head ⇒ Object 



135
136
137
138
139
 
# File 'lib/gitlab_git/repository.rb', line 135

def rugged_head
  rugged.head
rescue Rugged::ReferenceError
  nil
end

#search_files(query, ref = nil) ⇒ Object

Returns an array of BlobSnippets for files at the specified ref that contain the query string.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/gitlab_git/repository.rb', line 186

def search_files(query, ref = nil)
  greps = []
  ref ||= root_ref

  populated_index(ref).each do |entry|
    # Discard submodules
    next if submodule?(entry)

    content = Blob.raw(self, entry[:oid]).data

    # Skip binary files
    next if content.encoding == Encoding::ASCII_8BIT

    greps += build_greps(content, query, ref, entry[:path])
  end

  greps
end

#sha_from_ref(ref) ⇒ Object 



256
257
258
 
# File 'lib/gitlab_git/repository.rb', line 256

def sha_from_ref(ref)
  rev_parse_target(ref).oid
end

#size ⇒ Object

Return repo size in megabytes



179
180
181
182
 
# File 'lib/gitlab_git/repository.rb', line 179

def size
  size = popen(%W(du -s), path).first.strip.to_i
  (size.to_f / 1024).round(2)
end

#submodules(ref) ⇒ Object

Return hash with submodules info for this repository

Ex.

{
  "rack"  => {
    "id" => "c67be4624545b4263184c4a0e8f887efd0a66320",
    "path" => "rack",
    "url" => "git://github.com/chneukirchen/rack.git"
  },
  "encoding" => {
    "id" => ....
  }
}



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

def submodules(ref)
  commit = rev_parse_target(ref)
  return {} unless commit

  begin
    content = blob_content(commit, ".gitmodules")
  rescue InvalidBlobName
    return {}
  end

  parse_gitmodules(commit, content)
end

#tag_names ⇒ Object

Returns an Array of tag names



67
68
69
 
# File 'lib/gitlab_git/repository.rb', line 67

def tag_names
  rugged.tags.map { |t| t.name }
end

#tags ⇒ Object

Returns an Array of Tags



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/gitlab_git/repository.rb', line 72

def tags
  rugged.references.each("refs/tags/*").map do |ref|
    message = nil

    if ref.target.is_a?(Rugged::Tag::Annotation)
      tag_message = ref.target.message

      if tag_message.respond_to?(:chomp)
        message = tag_message.chomp
      end
    end

    Tag.new(ref.name, ref.target, message)
  end.sort_by(&:name)
end