2018-01-29 22:25:36 +00:00
|
|
|
module Ameba
|
2018-01-31 17:46:44 +00:00
|
|
|
# A module that utilizes inline comments parsing and processing logic.
|
2018-01-29 22:25:36 +00:00
|
|
|
module InlineComments
|
|
|
|
COMMENT_DIRECTIVE_REGEX = Regex.new "# ameba : (\\w+) ([\\w, ]+)".gsub(" ", "\\s*")
|
|
|
|
|
|
|
|
# Returns true if current location is disabled for a particular rule,
|
|
|
|
# false otherwise.
|
|
|
|
#
|
|
|
|
# Location is disabled in two cases:
|
|
|
|
# 1. The line of the location ends with a comment directive.
|
|
|
|
# 2. The line above the location is a comment directive.
|
|
|
|
#
|
2018-01-30 13:46:11 +00:00
|
|
|
# For example, here are two examples of disabled location:
|
2018-01-29 22:25:36 +00:00
|
|
|
#
|
|
|
|
# ```
|
|
|
|
# # ameba:disable LargeNumbers
|
|
|
|
# Time.epoch(1483859302)
|
|
|
|
#
|
|
|
|
# Time.epoch(1483859302) # ameba:disable LargeNumbers
|
|
|
|
# ```
|
|
|
|
#
|
|
|
|
# But here are examples which are not considered as disabled location:
|
|
|
|
#
|
|
|
|
# ```
|
|
|
|
# # ameba:disable LargeNumbers
|
|
|
|
# #
|
|
|
|
# Time.epoch(1483859302)
|
|
|
|
#
|
|
|
|
# if use_epoch? # ameba:disable LargeNumbers
|
|
|
|
# Time.epoch(1483859302)
|
|
|
|
# end
|
|
|
|
# ```
|
|
|
|
#
|
|
|
|
def location_disabled?(location, rule)
|
|
|
|
return false unless line_number = location.try &.line_number.try &.- 1
|
|
|
|
return false unless line = lines[line_number]?
|
|
|
|
|
|
|
|
line_disabled?(line, rule) ||
|
|
|
|
(line_number > 0 &&
|
|
|
|
(prev_line = lines[line_number - 1]) &&
|
|
|
|
comment?(prev_line) &&
|
|
|
|
line_disabled?(prev_line, rule))
|
|
|
|
end
|
|
|
|
|
2018-01-31 17:46:44 +00:00
|
|
|
# Parses inline comment directive. Returns a tuple that consists of
|
|
|
|
# an action and parsed rules if directive found, nil otherwise.
|
|
|
|
#
|
|
|
|
# ```
|
|
|
|
# line = "# ameba:disable Rule1, Rule2"
|
|
|
|
# directive = parse_inline_directive(line)
|
|
|
|
# directive[:action] # => "disable"
|
|
|
|
# directive[:rules] # => ["Rule1", "Rule2"]
|
|
|
|
# ```
|
|
|
|
#
|
|
|
|
# It ignores the directive if it is commented out.
|
|
|
|
#
|
|
|
|
# ```
|
|
|
|
# line = "# # ameba:disable Rule1, Rule2"
|
|
|
|
# parse_inline_directive(line) # => nil
|
|
|
|
# ```
|
|
|
|
#
|
|
|
|
def parse_inline_directive(line)
|
|
|
|
if directive = COMMENT_DIRECTIVE_REGEX.match(line)
|
|
|
|
return if commented_out?(line.gsub directive[0], "")
|
|
|
|
{
|
|
|
|
action: directive[1],
|
|
|
|
rules: directive[2].split(/[\s,]/, remove_empty: true),
|
|
|
|
}
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-01-29 22:25:36 +00:00
|
|
|
private def comment?(line)
|
2018-01-31 17:46:44 +00:00
|
|
|
return true if line.lstrip.starts_with? '#'
|
2018-01-29 22:25:36 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
private def line_disabled?(line, rule)
|
2018-01-31 17:46:44 +00:00
|
|
|
return false unless directive = parse_inline_directive(line)
|
|
|
|
directive[:action] == "disable" && directive[:rules].includes?(rule)
|
2018-01-29 22:25:36 +00:00
|
|
|
end
|
|
|
|
|
2018-01-31 17:46:44 +00:00
|
|
|
private def commented_out?(line)
|
|
|
|
commented? = false
|
|
|
|
|
|
|
|
lexer = Crystal::Lexer.new(line).tap { |l| l.comments_enabled = true }
|
|
|
|
Tokenizer.new(lexer).run { |t| commented? = true if t.type == :COMMENT }
|
|
|
|
commented?
|
2018-01-29 22:25:36 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|