Class: Quality::LinguistSourceFileGlobber

Inherits:
Object
  • Object
show all
Defined in:
lib/quality/linguist_source_file_globber.rb

Overview

Uses the Linguist gem to find and classify source files.

Note: Requires files to be commited within a git repo.

Instance Method Summary collapse

Constructor Details

#initialize(repo: Rugged::Repository.new('.'), commit: repo.head, project: Linguist::Repository.new(repo, commit.target_id), file_blob: Linguist::FileBlob, pwd: Dir.pwd) ⇒ LinguistSourceFileGlobber

Returns a new instance of LinguistSourceFileGlobber.



10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/quality/linguist_source_file_globber.rb', line 10

def initialize(repo: Rugged::Repository.new('.'),
               commit: repo.head,
               project: Linguist::Repository.new(repo, commit.target_id),
               file_blob: Linguist::FileBlob,
               pwd: Dir.pwd)
  @repo = repo
  @commit = commit
  @project = project
  @breakdown_by_file = @project.breakdown_by_file
  @file_blob = file_blob
  @exclude_files = nil
  @pwd = pwd
end

Instance Method Details

#all_files ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/quality/linguist_source_file_globber.rb', line 33

def all_files
  @source_files ||= begin
    files = []
    tree = @commit.target.tree
    tree.walk(:preorder) do |root, file|
      unless file[:type] != :blob || submodule_or_symlink?(file)
        files << "#{root}#{file[:name]}"
      end
    end
    files
  end
end

#exclude_files ⇒ Object 



65
66
67
 
# File 'lib/quality/linguist_source_file_globber.rb', line 65

def exclude_files
  @exclude_files || []
end

#js_files ⇒ Object 



61
62
63
 
# File 'lib/quality/linguist_source_file_globber.rb', line 61

def js_files
  language_files('JavaScript')
end

#language_files(language) ⇒ Object 



46
47
48
 
# File 'lib/quality/linguist_source_file_globber.rb', line 46

def language_files(language)
  (@breakdown_by_file[language] || []) - exclude_files
end

#python_files ⇒ Object 



57
58
59
 
# File 'lib/quality/linguist_source_file_globber.rb', line 57

def python_files
  language_files('Python')
end

#real_files_matching ⇒ Object 



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/quality/linguist_source_file_globber.rb', line 69

def real_files_matching
  all_files.select do |filename|
    blob = @file_blob.new(filename, @pwd)
    if blob.generated? || blob.vendored?
      false
    else
      yield blob, filename
    end
  end
end

#ruby_files ⇒ Object 



50
51
52
53
54
55
 
# File 'lib/quality/linguist_source_file_globber.rb', line 50

def ruby_files
  # Linguist treats Gemfile.lock as Ruby code.
  #
  # https://github.com/github/linguist/issues/1740
  language_files('Ruby') - ['Gemfile.lock']
end

#source_and_doc_files ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/quality/linguist_source_file_globber.rb', line 88

def source_and_doc_files
  @source_and_doc_files ||= begin
    real_files_matching do |blob, _filename|
      if blob.documentation? || !blob.language.nil?
        true
      else
        # puts "Excluding #{filename} from source_and_doc_files"
        false
      end
    end
  end
end

#source_files ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/quality/linguist_source_file_globber.rb', line 80

def source_files
  @source_files ||= begin
    real_files_matching do |blob|
      !blob.language.nil?
    end
  end
end

#submodule_or_symlink?(file) ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
27
28
29
30
31
 
# File 'lib/quality/linguist_source_file_globber.rb', line 24

def submodule_or_symlink?(file)
  # Skip submodules and symlinks
  mode = file[:filemode]
  mode_format = (mode & 0o0170000)
  mode_format == 0o0120000 ||
    mode_format == 0o040000 ||
    mode_format == 0o0160000
end