class Quality::LinguistSourceFileGlobber

Uses the Linguist gem to find and classify source files.

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

Attributes

exclude_files[W]

Public Class Methods

new(repo: Rugged::Repository.new('.'), commit: repo.head, project: Linguist::Repository.new(repo, commit.target_id), file_blob: Linguist::FileBlob, file_class: File, pwd: Dir.pwd) click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 11
def initialize(repo: Rugged::Repository.new('.'),
               commit: repo.head,
               project: Linguist::Repository.new(repo, commit.target_id),
               file_blob: Linguist::FileBlob,
               file_class: File,
               pwd: Dir.pwd)
  @repo = repo
  @commit = commit
  @project = project
  @breakdown_by_file = @project.breakdown_by_file
  @file_blob = file_blob
  @file_class = file_class
  @exclude_files = nil
  @pwd = pwd
end

Public Instance Methods

all_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 44
def all_files
  @all_files ||= begin
    files = []
    tree = @commit.target.tree
    tree.walk(:preorder) do |root, file|
      filename = "#{root}#{file[:name]}"
      files << filename if ok_to_process?(filename, file)
    end
    files
  end
end
exclude_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 83
def exclude_files
  @exclude_files || []
end
js_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 79
def js_files
  language_files('JavaScript')
end
language_files(language) click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 56
def language_files(language)
  (@breakdown_by_file[language] || []) - exclude_files
end
markdown_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 123
def markdown_files
  @markdown_files ||= real_files_of_type('Markdown')
end
ok_to_process?(filename, file) click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 36
def ok_to_process?(filename, file)
  file[:type] == :blob &&
    !submodule_or_symlink?(file) &&
    @file_class.exist?(filename) &&
    !@file_class.symlink?(filename) &&
    @file_class.readable?(filename)
end
python_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 67
def python_files
  language_files('Python')
end
real_files_matching() { |blob, filename| ... } click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 87
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
real_files_of_type(file_type) click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 119
def real_files_of_type(file_type)
  real_files_matching { |blob, _filename| blob.language.to_s == file_type }
end
ruby_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 60
def ruby_files
  # Linguist treats Gemfile.lock as Ruby code.
  #
  # https://github.com/github/linguist/issues/1740
  language_files('Ruby') - ['Gemfile.lock']
end
scala_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 71
def scala_files
  language_files('Scala')
end
shell_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 75
def shell_files
  language_files('Shell')
end
source_and_doc_files() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 106
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() click to toggle source
# File lib/quality/linguist_source_file_globber.rb, line 98
def source_files
  @source_files ||= begin
    real_files_matching do |blob|
      !blob.language.nil? && !blob.documentation?
    end
  end
end