class RuboCop::Cop::Rails::FilePath
Rails.root.join(‘app/models/goober’)
# good
“#{Rails.root}/app/models/goober”
File.join(Rails.root, ‘app/models/goober’)
Rails.root.join(‘app’, ‘models’, ‘goober’)
# bad
@example EnforcedStyle: slashes
Rails.root.join(‘app’, ‘models’, ‘goober’)
# good
“#{Rails.root}/app/models/goober”
File.join(Rails.root, ‘app/models/goober’)
Rails.root.join(‘app/models/goober’)
# bad
@example EnforcedStyle: arguments (default)
joining paths.
to use ‘Rails.root.join` clause. It is used to add uniformity when
This cop is used to identify usages of file path joining process
def check_for_file_join_with_rails_root(node)
def check_for_file_join_with_rails_root(node) return unless file_join_nodes?(node) return unless node.arguments.any? { |e| rails_root_nodes?(e) } register_offense(node) end
def check_for_rails_root_join_with_slash_separated_path(node)
def check_for_rails_root_join_with_slash_separated_path(node) return unless style == :arguments return unless rails_root_nodes?(node) return unless rails_root_join_nodes?(node) return unless node.arguments.any? { |arg| string_with_slash?(arg) } register_offense(node) end
def check_for_rails_root_join_with_string_arguments(node)
def check_for_rails_root_join_with_string_arguments(node) return unless style == :slashes return unless rails_root_nodes?(node) return unless rails_root_join_nodes?(node) return unless node.arguments.size > 1 return unless node.arguments.all?(&:str_type?) register_offense(node) end
def message(_node)
def message(_node) format(style == :arguments ? MSG_ARGUMENTS : MSG_SLASHES) end
def on_dstr(node)
def on_dstr(node) return unless rails_root_nodes?(node) return unless node.children.last.source.start_with?('.') || node.children.last.source.include?(File::SEPARATOR) register_offense(node) end
def on_send(node)
def on_send(node) check_for_file_join_with_rails_root(node) check_for_rails_root_join_with_slash_separated_path(node) check_for_rails_root_join_with_string_arguments(node) end
def register_offense(node)
def register_offense(node) line_range = node.loc.column...node.loc.last_column source_range = source_range(processed_source.buffer, node.first_line, line_range) add_offense(node, location: source_range) end
def string_with_slash?(node)
def string_with_slash?(node) node.str_type? && node.source =~ %r{/} end