Class: Rubocop::TargetFinder

Inherits:
Object
  • Object
show all
Defined in:
lib/rubocop/target_finder.rb

Overview

This class finds target files to inspect by scanning the directory tree and picking ruby files.

Instance Method Summary collapse

Constructor Details

#initialize(config_store, options = {}) ⇒ TargetFinder

Returns a new instance of TargetFinder.



7
8
9
10
 
# File 'lib/rubocop/target_finder.rb', line 7

def initialize(config_store, options = {})
  @config_store = config_store
  @options = { force_exclusion: false, debug: false }.merge(options)
end

Instance Method Details

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/rubocop/target_finder.rb', line 16

def debug?
  @options[:debug]
end

#find(args) ⇒ Array

Generate a list of target files by expanding globbing patterns (if any). If args is empty, recursively find all Ruby source files under the current directory

Returns:

  • (Array) —

    array of file paths



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/rubocop/target_finder.rb', line 24

def find(args)
  return target_files_in_dir if args.empty?

  files = []

  args.uniq.each do |arg|
    files += if File.directory?(arg)
               target_files_in_dir(arg.chomp(File::SEPARATOR))
             else
               process_explicit_path(arg)
             end
  end

  files.map { |f| File.expand_path(f) }.uniq
end

#force_exclusion? ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/rubocop/target_finder.rb', line 12

def force_exclusion?
  @options[:force_exclusion]
end

#process_explicit_path(path) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/rubocop/target_finder.rb', line 76

def process_explicit_path(path)
  files = if path.include?('*')
            Dir[path]
          else
            [path]
          end

  return files unless force_exclusion?

  files.reject do |file|
    config = @config_store.for(file)
    config.file_to_exclude?(file)
  end
end

#ruby_executable?(file) ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
70
71
72
73
74
 
# File 'lib/rubocop/target_finder.rb', line 67

def ruby_executable?(file)
  return false unless File.extname(file).empty?
  first_line = File.open(file) { |f| f.readline }
  first_line =~ /#!.*ruby/
rescue EOFError, ArgumentError => e
  warn "Unprocessable file #{file}: #{e.class}, #{e.message}" if debug?
  false
end

#target_files_in_dir(base_dir = Dir.pwd) ⇒ Array

Finds all Ruby source files under the current or other supplied directory. A Ruby source file is defined as a file with the .rb extension or a file with no extension that has a ruby shebang line as its first line. It is possible to specify includes and excludes using the config file, so you can include other Ruby files like Rakefiles and gemspecs.

Parameters:

  • base_dir (defaults to: Dir.pwd) —

    Root directory under which to search for ruby source files

Returns:

  • (Array) —

    Array of filenames



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/rubocop/target_finder.rb', line 49

def target_files_in_dir(base_dir = Dir.pwd)
  # Support Windows: Backslashes from command-line -> forward slashes
  if File::ALT_SEPARATOR
    base_dir.gsub!(File::ALT_SEPARATOR, File::SEPARATOR)
  end
  files = Dir["#{base_dir}/**/*"].select { |path| FileTest.file?(path) }
  base_dir_config = @config_store.for(base_dir)

  target_files = files.select do |file|
    next false if base_dir_config.file_to_exclude?(file)
    next true if File.extname(file) == '.rb'
    next true if ruby_executable?(file)
    @config_store.for(file).file_to_include?(file)
  end

  target_files
end