Class: Linguist::Repository

Inherits:
Object
  • Object
show all
Defined in:
lib/linguist/repository.rb

Overview

A Repository is an abstraction of a Grit::Repo or a basic file system tree. It holds a list of paths pointing to Blobish objects.

Its primary purpose is for gathering language statistics across the entire project.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(repo, commit_oid) ⇒ Repository

Public: Initialize a new Repository to be analyzed for language data

repo - a Rugged::Repository object commit_oid - the sha1 of the commit that will be analyzed;

this is usually the master branch

Returns a Repository

Raises:

  • (TypeError)

29
30
31
32
33
34
35
36
37
# File 'lib/linguist/repository.rb', line 29

def initialize(repo, commit_oid)
  @repository = repo
  @commit_oid = commit_oid

  @old_commit_oid = nil
  @old_stats = nil

  raise TypeError, 'commit_oid must be a commit SHA1' unless commit_oid.is_a?(String)
end

Instance Attribute Details

#repositoryObject (readonly)

Returns the value of attribute repository


11
12
13
# File 'lib/linguist/repository.rb', line 11

def repository
  @repository
end

Class Method Details

.incremental(repo, commit_oid, old_commit_oid, old_stats) ⇒ Object

Public: Create a new Repository based on the stats of an existing one


15
16
17
18
19
# File 'lib/linguist/repository.rb', line 15

def self.incremental(repo, commit_oid, old_commit_oid, old_stats)
  repo = self.new(repo, commit_oid)
  repo.load_existing_stats(old_commit_oid, old_stats)
  repo
end

Instance Method Details

#breakdown_by_fileObject

Public: Return the language breakdown of this repository by file

Returns a map of language names => [filenames…]


95
96
97
98
99
100
101
102
103
# File 'lib/linguist/repository.rb', line 95

def breakdown_by_file
  @file_breakdown ||= begin
    breakdown = Hash.new { |h,k| h[k] = Array.new }
    cache.each do |filename, (language, _)|
      breakdown[language] << filename.dup.force_encoding("UTF-8").scrub
    end
    breakdown
  end
end

#cacheObject

Public: Return the cached results of the analysis

This is a per-file breakdown that can be passed to other instances of Linguist::Repository to perform incremental scans

Returns a map of filename => [language, size]


111
112
113
114
115
116
117
118
119
# File 'lib/linguist/repository.rb', line 111

def cache
  @cache ||= begin
    if @old_commit_oid == @commit_oid
      @old_stats
    else
      compute_stats(@old_commit_oid, @old_stats)
    end
  end
end

#current_treeObject


127
128
129
# File 'lib/linguist/repository.rb', line 127

def current_tree
  @tree ||= Rugged::Commit.lookup(repository, @commit_oid).tree
end

#languageObject

Public: Get primary Language of repository.

Returns a language name


78
79
80
81
82
83
# File 'lib/linguist/repository.rb', line 78

def language
  @language ||= begin
    primary = languages.max_by { |(_, size)| size }
    primary && primary[0]
  end
end

#languagesObject

Public: Returns a breakdown of language stats.

Examples

# => { 'Ruby' => 46319,
       'JavaScript' => 258 }

Returns a Hash of language names and Integer size values.


65
66
67
68
69
70
71
72
73
# File 'lib/linguist/repository.rb', line 65

def languages
  @sizes ||= begin
    sizes = Hash.new { 0 }
    cache.each do |_, (language, size)|
      sizes[language] += size
    end
    sizes
  end
end

#load_existing_stats(old_commit_oid, old_stats) ⇒ Object

Public: Load the results of a previous analysis on this repository to speed up the new scan.

The new analysis will be performed incrementally as to only take into account the file changes since the last time the repository was scanned

old_commit_oid - the sha1 of the commit that was previously analyzed old_stats - the result of the previous analysis, obtained by calling

Repository#cache on the old repository

Returns nothing


51
52
53
54
55
# File 'lib/linguist/repository.rb', line 51

def load_existing_stats(old_commit_oid, old_stats)
  @old_commit_oid = old_commit_oid
  @old_stats = old_stats
  nil
end

#read_indexObject


121
122
123
124
125
# File 'lib/linguist/repository.rb', line 121

def read_index
  attr_index = Rugged::Index.new
  attr_index.read_tree(current_tree)
  repository.index = attr_index
end

#sizeObject

Public: Get the total size of the repository.

Returns a byte size Integer


88
89
90
# File 'lib/linguist/repository.rb', line 88

def size
  @size ||= languages.inject(0) { |s,(_,v)| s + v }
end