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



9
10
11
12
# File 'lib/rubocop/target_finder.rb', line 9

def initialize(config_store, options = {})
  @config_store = config_store
  @options = options
end

Instance Method Details

#all_cops_includeObject



139
140
141
# File 'lib/rubocop/target_finder.rb', line 139

def all_cops_include
  @config_store.for('.').for_all_cops['Include'].map(&:to_s)
end

#configured_include?(file) ⇒ Boolean

Returns:

  • (Boolean)


166
167
168
# File 'lib/rubocop/target_finder.rb', line 166

def configured_include?(file)
  @config_store.for('.').file_to_include?(file)
end

#debug?Boolean

Returns:

  • (Boolean)


18
19
20
# File 'lib/rubocop/target_finder.rb', line 18

def debug?
  @options[:debug]
end

#excluded_dirs(base_dir) ⇒ Object



109
110
111
112
113
114
115
# File 'lib/rubocop/target_finder.rb', line 109

def excluded_dirs(base_dir)
  all_cops_config = @config_store.for(base_dir).for_all_cops
  dir_tree_excludes = all_cops_config['Exclude'].select do |pattern|
    pattern.is_a?(String) && pattern.end_with?('/**/*')
  end
  dir_tree_excludes.map { |pattern| pattern.sub(%r{/\*\*/\*$}, '') }
end

#fail_fast?Boolean

Returns:

  • (Boolean)


22
23
24
# File 'lib/rubocop/target_finder.rb', line 22

def fail_fast?
  @options[:fail_fast]
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



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/rubocop/target_finder.rb', line 30

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

#find_files(base_dir, flags) ⇒ Object

Search for files recursively starting at the given base directory using the given flags that determine how the match is made. Excluded files will be removed later by the caller, but as an optimization find_files removes the top level directories that are excluded in configuration in the normal way (dir/*/).



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/rubocop/target_finder.rb', line 86

def find_files(base_dir, flags)
  wanted_toplevel_dirs = toplevel_dirs(base_dir, flags) -
                         excluded_dirs(base_dir)
  wanted_toplevel_dirs.map! { |dir| dir << '/**/*' }

  pattern = if wanted_toplevel_dirs.empty?
              # We need this special case to avoid creating the pattern
              # /**/* which searches the entire file system.
              ["#{base_dir}/**/*"]
            else
              # Search the non-excluded top directories, but also add files
              # on the top level, which would otherwise not be found.
              wanted_toplevel_dirs.unshift("#{base_dir}/*")
            end
  Dir.glob(pattern, flags).select { |path| FileTest.file?(path) }
end

#force_exclusion?Boolean

Returns:

  • (Boolean)


14
15
16
# File 'lib/rubocop/target_finder.rb', line 14

def force_exclusion?
  @options[:force_exclusion]
end

#included_file?(file) ⇒ Boolean

Returns:

  • (Boolean)


170
171
172
# File 'lib/rubocop/target_finder.rb', line 170

def included_file?(file)
  ruby_file?(file) || configured_include?(file)
end

#process_explicit_path(path) ⇒ Object



174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/rubocop/target_finder.rb', line 174

def process_explicit_path(path)
  files = path.include?('*') ? Dir[path] : [path]

  files.select! { |file| included_file?(file) }

  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)


143
144
145
146
147
148
149
150
151
# File 'lib/rubocop/target_finder.rb', line 143

def ruby_executable?(file)
  return false unless File.extname(file).empty? && File.exist?(file)

  first_line = File.open(file, &:readline)
  !(first_line =~ /#!.*(#{ruby_interpreters(file).join('|')})/).nil?
rescue EOFError, ArgumentError => e
  warn "Unprocessable file #{file}: #{e.class}, #{e.message}" if debug?
  false
end

#ruby_extension?(file) ⇒ Boolean

Returns:

  • (Boolean)


117
118
119
# File 'lib/rubocop/target_finder.rb', line 117

def ruby_extension?(file)
  ruby_extensions.include?(File.extname(file))
end

#ruby_extensionsObject



121
122
123
124
125
126
# File 'lib/rubocop/target_finder.rb', line 121

def ruby_extensions
  ext_patterns = all_cops_include.select do |pattern|
    pattern.start_with?('**/*.')
  end
  ext_patterns.map { |pattern| pattern.sub('**/*', '') }
end

#ruby_file?(file) ⇒ Boolean

Returns:

  • (Boolean)


161
162
163
164
# File 'lib/rubocop/target_finder.rb', line 161

def ruby_file?(file)
  stdin? || ruby_extension?(file) || ruby_filename?(file) ||
    ruby_executable?(file)
end

#ruby_filename?(file) ⇒ Boolean

Returns:

  • (Boolean)


128
129
130
# File 'lib/rubocop/target_finder.rb', line 128

def ruby_filename?(file)
  ruby_filenames.include?(File.basename(file))
end

#ruby_filenamesObject



132
133
134
135
136
137
# File 'lib/rubocop/target_finder.rb', line 132

def ruby_filenames
  file_patterns = all_cops_include.reject do |pattern|
    pattern.start_with?('**/*.')
  end
  file_patterns.map { |pattern| pattern.sub('**/', '') }
end

#ruby_interpreters(file) ⇒ Object



153
154
155
# File 'lib/rubocop/target_finder.rb', line 153

def ruby_interpreters(file)
  @config_store.for(file).for_all_cops['RubyInterpreters']
end

#stdin?Boolean

Returns:

  • (Boolean)


157
158
159
# File 'lib/rubocop/target_finder.rb', line 157

def stdin?
  @options.key?(:stdin)
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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/rubocop/target_finder.rb', line 55

def target_files_in_dir(base_dir = Dir.pwd)
  # Support Windows: Backslashes from command-line -> forward slashes
  if File::ALT_SEPARATOR
    base_dir = base_dir.gsub(File::ALT_SEPARATOR, File::SEPARATOR)
  end
  all_files = find_files(base_dir, File::FNM_DOTMATCH)
  hidden_files = Set.new(all_files - find_files(base_dir, 0))
  base_dir_config = @config_store.for(base_dir)

  target_files = all_files.select do |file|
    to_inspect?(file, hidden_files, base_dir_config)
  end

  # Most recently modified file first.
  target_files.sort_by! { |path| -Integer(File.mtime(path)) } if fail_fast?

  target_files
end

#to_inspect?(file, hidden_files, base_dir_config) ⇒ Boolean

Returns:

  • (Boolean)


74
75
76
77
78
79
# File 'lib/rubocop/target_finder.rb', line 74

def to_inspect?(file, hidden_files, base_dir_config)
  return false if base_dir_config.file_to_exclude?(file)
  return true if !hidden_files.include?(file) && ruby_file?(file)

  base_dir_config.file_to_include?(file)
end

#toplevel_dirs(base_dir, flags) ⇒ Object



103
104
105
106
107
# File 'lib/rubocop/target_finder.rb', line 103

def toplevel_dirs(base_dir, flags)
  Dir.glob(File.join(base_dir, '*'), flags).select do |dir|
    File.directory?(dir) && !dir.end_with?('/.', '/..')
  end
end