Class: Linguist::Repository
- Inherits:
-
Object
- Object
- Linguist::Repository
- 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
-
#repository ⇒ Object
readonly
Returns the value of attribute repository.
Class Method Summary collapse
-
.incremental(repo, commit_oid, old_commit_oid, old_stats) ⇒ Object
Public: Create a new Repository based on the stats of an existing one.
Instance Method Summary collapse
-
#breakdown_by_file ⇒ Object
Public: Return the language breakdown of this repository by file.
-
#cache ⇒ Object
Public: Return the cached results of the analysis.
- #current_tree ⇒ Object
-
#initialize(repo, commit_oid) ⇒ Repository
constructor
Public: Initialize a new Repository to be analyzed for language data.
-
#language ⇒ Object
Public: Get primary Language of repository.
-
#languages ⇒ Object
Public: Returns a breakdown of language stats.
-
#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.
- #read_index ⇒ Object
-
#size ⇒ Object
Public: Get the total size of the repository.
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
29 30 31 32 33 34 |
# File 'lib/linguist/repository.rb', line 29 def initialize(repo, commit_oid) @repository = repo @commit_oid = commit_oid raise TypeError, 'commit_oid must be a commit SHA1' unless commit_oid.is_a?(String) end |
Instance Attribute Details
#repository ⇒ Object (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_file ⇒ Object
Public: Return the language breakdown of this repository by file
Returns a map of language names => [filenames…]
92 93 94 95 96 97 98 99 100 |
# File 'lib/linguist/repository.rb', line 92 def breakdown_by_file @file_breakdown ||= begin breakdown = Hash.new { |h,k| h[k] = Array.new } cache.each do |filename, (language, _)| breakdown[language] << filename end breakdown end end |
#cache ⇒ Object
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]
108 109 110 111 112 113 114 115 116 |
# File 'lib/linguist/repository.rb', line 108 def cache @cache ||= begin if @old_commit_oid == @commit_oid @old_stats else compute_stats(@old_commit_oid, @old_stats) end end end |
#current_tree ⇒ Object
124 125 126 |
# File 'lib/linguist/repository.rb', line 124 def current_tree @tree ||= Rugged::Commit.lookup(repository, @commit_oid).tree end |
#language ⇒ Object
Public: Get primary Language of repository.
Returns a language name
75 76 77 78 79 80 |
# File 'lib/linguist/repository.rb', line 75 def language @language ||= begin primary = languages.max_by { |(_, size)| size } primary && primary[0] end end |
#languages ⇒ Object
Public: Returns a breakdown of language stats.
Examples
# => { 'Ruby' => 46319,
'JavaScript' => 258 }
Returns a Hash of language names and Integer size values.
62 63 64 65 66 67 68 69 70 |
# File 'lib/linguist/repository.rb', line 62 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
48 49 50 51 52 |
# File 'lib/linguist/repository.rb', line 48 def load_existing_stats(old_commit_oid, old_stats) @old_commit_oid = old_commit_oid @old_stats = old_stats nil end |
#read_index ⇒ Object
118 119 120 121 122 |
# File 'lib/linguist/repository.rb', line 118 def read_index attr_index = Rugged::Index.new attr_index.read_tree(current_tree) repository.index = attr_index end |
#size ⇒ Object
Public: Get the total size of the repository.
Returns a byte size Integer
85 86 87 |
# File 'lib/linguist/repository.rb', line 85 def size @size ||= languages.inject(0) { |s,(_,v)| s + v } end |