Class: Gitlab::Git::Tree

Inherits:
Object
  • Object
show all
Includes:
EncodingHelper
Defined in:
lib/gitlab_git/tree.rb

Constant Summary

Constants included from EncodingHelper

EncodingHelper::ENCODING_CONFIDENCE_THRESHOLD

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from EncodingHelper

#encode!, #encode_utf8

Constructor Details

#initialize(options) ⇒ Tree

Returns a new instance of Tree.



73
74
75
76
77
# File 'lib/gitlab_git/tree.rb', line 73

def initialize(options)
  %w(id root_id name path type mode commit_id).each do |key|
    self.send("#{key}=", options[key.to_sym])
  end
end

Instance Attribute Details

#commit_idObject

Returns the value of attribute commit_id.



6
7
8
# File 'lib/gitlab_git/tree.rb', line 6

def commit_id
  @commit_id
end

#idObject

Returns the value of attribute id.



6
7
8
# File 'lib/gitlab_git/tree.rb', line 6

def id
  @id
end

#modeObject

Returns the value of attribute mode.



6
7
8
# File 'lib/gitlab_git/tree.rb', line 6

def mode
  @mode
end

#nameObject

Returns the value of attribute name.



6
7
8
# File 'lib/gitlab_git/tree.rb', line 6

def name
  @name
end

#pathObject

Returns the value of attribute path.



6
7
8
# File 'lib/gitlab_git/tree.rb', line 6

def path
  @path
end

#root_idObject

Returns the value of attribute root_id.



6
7
8
# File 'lib/gitlab_git/tree.rb', line 6

def root_id
  @root_id
end

#submodule_urlObject

Returns the value of attribute submodule_url.



6
7
8
# File 'lib/gitlab_git/tree.rb', line 6

def submodule_url
  @submodule_url
end

#typeObject

Returns the value of attribute type.



6
7
8
# File 'lib/gitlab_git/tree.rb', line 6

def type
  @type
end

Class Method Details

.find_id_by_path(repository, root_id, path) ⇒ Object

Recursive search of tree id for path

Ex.

blog/            # oid: 1a
  app/           # oid: 2a
    models/      # oid: 3a
    views/       # oid: 4a

Tree.find_id_by_path(repo, ‘1a’, ‘app/models’) # => ‘3a’



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/gitlab_git/tree.rb', line 54

def find_id_by_path(repository, root_id, path)
  root_tree = repository.lookup(root_id)
  path_arr = path.split('/')

  entry = root_tree.find do |entry|
    entry[:name] == path_arr[0] && entry[:type] == :tree
  end

  return nil unless entry

  if path_arr.size > 1
    path_arr.shift
    find_id_by_path(repository, entry[:oid], path_arr.join('/'))
  else
    entry[:oid]
  end
end

.where(repository, sha, path = nil) ⇒ Object

Get list of tree objects for repository based on commit sha and path Uses rugged for raw objects



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/gitlab_git/tree.rb', line 13

def where(repository, sha, path = nil)
  path = nil if path == '' || path == '/'

  commit = repository.lookup(sha)
  root_tree = commit.tree

  tree = if path
           id = Tree.find_id_by_path(repository, root_tree.oid, path)
           if id
             repository.lookup(id)
           else
             []
           end
         else
           root_tree
         end

  tree.map do |entry|
    Tree.new(
      id: entry[:oid],
      root_id: root_tree.oid,
      name: entry[:name],
      type: entry[:type],
      mode: entry[:filemode],
      path: path ? File.join(path, entry[:name]) : entry[:name],
      commit_id: sha,
    )
  end
end

Instance Method Details

#contributing?Boolean

Returns:

  • (Boolean)


99
100
101
# File 'lib/gitlab_git/tree.rb', line 99

def contributing?
  name =~ /^contributing/i
end

#dir?Boolean

Returns:

  • (Boolean)


83
84
85
# File 'lib/gitlab_git/tree.rb', line 83

def dir?
  type == :tree
end

#file?Boolean

Returns:

  • (Boolean)


87
88
89
# File 'lib/gitlab_git/tree.rb', line 87

def file?
  type == :blob
end

#readme?Boolean

Returns:

  • (Boolean)


95
96
97
# File 'lib/gitlab_git/tree.rb', line 95

def readme?
  name =~ /^readme/i
end

#submodule?Boolean

Returns:

  • (Boolean)


91
92
93
# File 'lib/gitlab_git/tree.rb', line 91

def submodule?
  type == :commit
end