module RuboCop::PathUtil
Common methods and behaviors for dealing with paths.
Public Instance Methods
absolute?(path)
click to toggle source
Returns true for an absolute Unix or Windows path.
# File lib/rubocop/path_util.rb, line 42 def absolute?(path) path =~ %r{\A([A-Z]:)?/} end
match_path?(pattern, path)
click to toggle source
# File lib/rubocop/path_util.rb, line 27 def match_path?(pattern, path) case pattern when String File.fnmatch?(pattern, path, File::FNM_PATHNAME) when Regexp begin path =~ pattern rescue ArgumentError => e return false if e.message.start_with?('invalid byte sequence') raise e end end end
relative_path(path, base_dir = Dir.pwd)
click to toggle source
# File lib/rubocop/path_util.rb, line 7 def relative_path(path, base_dir = Dir.pwd) # Optimization for the common case where path begins with the base # dir. Just cut off the first part. return path[(base_dir.length + 1)..-1] if path.start_with?(base_dir) path_name = Pathname.new(File.expand_path(path)) path_name.relative_path_from(Pathname.new(base_dir)).to_s end
smart_path(path)
click to toggle source
# File lib/rubocop/path_util.rb, line 16 def smart_path(path) # 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