Sha256: 419d844e4edf6d5238c95b6188aaf67756c514f64999b6099fefb876e842cb1a
Contents?: true
Size: 1.6 KB
Versions: 58
Compression:
Stored size: 1.6 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Naming
# This cop checks that your heredocs are using the configured case.
# By default it is configured to enforce uppercase heredocs.
#
# @example EnforcedStyle: uppercase (default)
# # bad
# <<-sql
# SELECT * FROM foo
# sql
#
# # good
# <<-SQL
# SELECT * FROM foo
# SQL
#
# @example EnforcedStyle: lowercase
# # bad
# <<-SQL
# SELECT * FROM foo
# SQL
#
# # good
# <<-sql
# SELECT * FROM foo
# sql
class HeredocDelimiterCase < Base
include Heredoc
include ConfigurableEnforcedStyle
extend AutoCorrector
MSG = 'Use %<style>s heredoc delimiters.'
def on_heredoc(node)
return if correct_case_delimiters?(node)
add_offense(node.loc.heredoc_end) do |corrector|
expr = node.loc.expression
corrector.replace(expr, correct_delimiters(expr.source))
corrector.replace(node.loc.heredoc_end, correct_delimiters(delimiter_string(expr)))
end
end
private
def message(_node)
format(MSG, style: style)
end
def correct_case_delimiters?(node)
delimiter_string(node) == correct_delimiters(delimiter_string(node))
end
def correct_delimiters(source)
if style == :uppercase
source.upcase
else
source.downcase
end
end
end
end
end
end
Version data entries
58 entries across 58 versions & 6 rubygems