Module: RuboCop::PathUtil
- Included in:
- Config, Cop::Util, Formatter::DisabledConfigFormatter, Formatter::HTMLFormatter::ERBContext, Formatter::JSONFormatter, Formatter::MarkdownFormatter, Formatter::SimpleTextFormatter
- Defined in:
- lib/rubocop/path_util.rb
Overview
Common methods and behaviors for dealing with paths.
Constant Summary collapse
- HIDDEN_FILE_PATTERN =
"#{File::SEPARATOR}."
Class Attribute Summary collapse
-
.relative_paths_cache ⇒ Object
Returns the value of attribute relative_paths_cache.
Class Method Summary collapse
-
.absolute?(path) ⇒ Boolean
Returns true for an absolute Unix or Windows path.
-
.glob?(path) ⇒ Boolean
Returns true for a glob.
- .hidden_dir?(path) ⇒ Boolean
- .hidden_file?(path) ⇒ Boolean
- .hidden_file_in_not_hidden_dir?(pattern, path) ⇒ Boolean
-
.match_path?(pattern, path) ⇒ Boolean
rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity.
-
.maybe_hidden_file?(path) ⇒ Boolean
Loose check to reduce memory allocations.
- .relative_path(path, base_dir = Dir.pwd) ⇒ Object
- .smart_path(path) ⇒ Object
Class Attribute Details
.relative_paths_cache ⇒ Object
Returns the value of attribute relative_paths_cache.
7 8 9 |
# File 'lib/rubocop/path_util.rb', line 7 def relative_paths_cache @relative_paths_cache end |
Class Method Details
.absolute?(path) ⇒ Boolean
Returns true for an absolute Unix or Windows path.
72 73 74 |
# File 'lib/rubocop/path_util.rb', line 72 def absolute?(path) %r{\A([A-Z]:)?/}i.match?(path) end |
.glob?(path) ⇒ Boolean
Returns true for a glob
77 78 79 |
# File 'lib/rubocop/path_util.rb', line 77 def glob?(path) path.match?(/[*{\[?]/) end |
.hidden_dir?(path) ⇒ Boolean
107 108 109 |
# File 'lib/rubocop/path_util.rb', line 107 def hidden_dir?(path) File.dirname(path).split(File::SEPARATOR).any? { |dir| dir.start_with?('.') } end |
.hidden_file?(path) ⇒ Boolean
90 91 92 |
# File 'lib/rubocop/path_util.rb', line 90 def hidden_file?(path) maybe_hidden_file?(path) && File.basename(path).start_with?('.') end |
.hidden_file_in_not_hidden_dir?(pattern, path) ⇒ Boolean
81 82 83 84 85 86 87 88 |
# File 'lib/rubocop/path_util.rb', line 81 def hidden_file_in_not_hidden_dir?(pattern, path) hidden_file?(path) && File.fnmatch?( pattern, path, File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_DOTMATCH ) && !hidden_dir?(path) end |
.match_path?(pattern, path) ⇒ Boolean
rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/rubocop/path_util.rb', line 48 def match_path?(pattern, path) case pattern when String matches = if pattern == path true elsif glob?(pattern) File.fnmatch?(pattern, path, File::FNM_PATHNAME | File::FNM_EXTGLOB) end matches || hidden_file_in_not_hidden_dir?(pattern, path) when Regexp begin pattern.match?(path) rescue ArgumentError => e return false if e..start_with?('invalid byte sequence') raise e end end end |
.maybe_hidden_file?(path) ⇒ Boolean
Loose check to reduce memory allocations
97 98 99 100 101 102 103 104 105 |
# File 'lib/rubocop/path_util.rb', line 97 def maybe_hidden_file?(path) return false unless path.include?(HIDDEN_FILE_PATTERN) separator_index = path.rindex(File::SEPARATOR) return false unless separator_index dot_index = path.index('.', separator_index + 1) dot_index == separator_index + 1 end |
.relative_path(path, base_dir = Dir.pwd) ⇒ Object
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
# File 'lib/rubocop/path_util.rb', line 13 def relative_path(path, base_dir = Dir.pwd) PathUtil.relative_paths_cache[base_dir][path] ||= # Optimization for the common case where path begins with the base # dir. Just cut off the first part. if path.start_with?(base_dir) base_dir_length = base_dir.length result_length = path.length - base_dir_length - 1 path[base_dir_length + 1, result_length] else path_name = Pathname.new(File.(path)) begin path_name.relative_path_from(Pathname.new(base_dir)).to_s rescue ArgumentError path end end end |
.smart_path(path) ⇒ Object
34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/rubocop/path_util.rb', line 34 def smart_path(path) SMART_PATH_CACHE[path] ||= begin # Ideally, we calculate this relative to the project root. base_dir = Dir.pwd if path.start_with? base_dir relative_path(path, base_dir) else path end end end |