forked from rubocop/rubocop
/
target_finder.rb
209 lines (166 loc) · 6.32 KB
/
target_finder.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# frozen_string_literal: true
require 'set'
require 'open3'
module RuboCop
# This class finds target files to inspect by scanning the directory tree
# and picking ruby files.
class TargetFinder
def initialize(config_store, options = {})
@config_store = config_store
@options = options
end
def force_exclusion?
@options[:force_exclusion]
end
def debug?
@options[:debug]
end
def fail_fast?
@options[:fail_fast]
end
# 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
# @return [Array] array of file paths
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
# 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.
# @param base_dir Root directory under which to search for
# ruby source files
# @return [Array] Array of filenames
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))
git_files = ls_git_files(base_dir)
base_dir_config = @config_store.for(base_dir)
target_files = all_files.select do |file|
to_inspect?(file, git_files, 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
# 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/**/*).
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
private
def ls_git_files(base_dir)
return if `sh -c 'command -v git'`.empty?
output, _error, status = Open3.capture3(
'git', 'ls-files', '-z', base_dir,
'--exclude-standard', '--others', '--cached', '--modified'
)
return unless status.success?
output.split("\0").map { |git_file| "#{base_dir}/#{git_file}" }
end
def to_inspect?(file, git_files, hidden_files, base_dir_config)
return false if base_dir_config.file_to_exclude?(file)
if !hidden_files.include?(file) && ruby_file?(file)
return git_files.nil? || git_files.include?(file)
end
base_dir_config.file_to_include?(file)
end
def toplevel_dirs(base_dir, flags)
Dir.glob(File.join(base_dir, '*'), flags).select do |dir|
File.directory?(dir) && !dir.end_with?('/.', '/..')
end
end
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
def ruby_extension?(file)
ruby_extensions.include?(File.extname(file))
end
def ruby_extensions
ext_patterns = all_cops_include.select do |pattern|
pattern.start_with?('**/*.')
end
ext_patterns.map { |pattern| pattern.sub('**/*', '') }
end
def ruby_filename?(file)
ruby_filenames.include?(File.basename(file))
end
def ruby_filenames
file_patterns = all_cops_include.reject do |pattern|
pattern.start_with?('**/*.')
end
file_patterns.map { |pattern| pattern.sub('**/', '') }
end
def all_cops_include
@config_store.for('.').for_all_cops['Include'].map(&:to_s)
end
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
def ruby_interpreters(file)
@config_store.for(file).for_all_cops['RubyInterpreters']
end
def stdin?
@options.key?(:stdin)
end
def ruby_file?(file)
stdin? || ruby_extension?(file) || ruby_filename?(file) ||
ruby_executable?(file)
end
def configured_include?(file)
@config_store.for('.').file_to_include?(file)
end
def included_file?(file)
ruby_file?(file) || configured_include?(file)
end
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
end
end