1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
|
# frozen_string_literal: true
require_relative 'suggestor'
module Tooling
module Danger
# A basic suggestion.
#
# A subclass needs to define the following constants:
# * MATCH (Regexp) - A Regexp to match file lines
# * REPLACEMENT (String) - A suggestion replacement text
# * SUGGESTION (String) - A suggestion text
#
# @see Suggestor
class Suggestion
include ::Tooling::Danger::Suggestor
ONCE_PER_FILE = false
attr_reader :filename
def initialize(filename, context:)
@filename = filename
@context = context
end
def suggest
add_suggestion(
filename: filename,
regex: self.class::MATCH,
replacement: self.class::REPLACEMENT,
comment_text: self.class::SUGGESTION,
once_per_file: self.class::ONCE_PER_FILE
)
end
private
def helper(...)
# Previously, we were using `forwardable` but it emitted a mysterious warning:
# forwarding to private method Danger::Rubocop#helper
@context.helper(...)
end
def project_helper(...)
@context.project_helper(...)
end
def markdown(...)
@context.markdown(...)
end
end
end
end
|