Sha256: 7157b8e04b6e67fd3a0b31fea3e1e338fc01824b38de049d11127a8cb7d33729
Contents?: true
Size: 1.18 KB
Versions: 21
Compression:
Stored size: 1.18 KB
Contents
require 'reek/options'
module Reek
#
# Reports a warning that a smell has been found.
#
class SmellWarning
include Comparable
def initialize(smell, context, warning)
@smell = smell
@context = context
@warning = warning
end
def hash # :nodoc:
report.hash
end
def <=>(other)
report <=> other.report
end
alias eql? <=> # :nodoc:
#
# Returns +true+ only if this is a warning about an instance of
# +smell_class+ and its report string matches all of the +patterns+.
#
def matches?(smell_class, patterns)
return false unless smell_class.to_s == @smell.class.class_name
rpt = report
return patterns.all? {|exp| exp === rpt}
end
#
# Returns a copy of the current report format (see +Options+)
# in which the following magic tokens have been substituted:
#
# * %s <-- the name of the smell that was detected
# * %c <-- a description of the +CodeContext+ containing the smell
# * %w <-- the specific problem that was detected
#
def report
Options[:format].gsub(/\%s/, @smell.smell_name).gsub(/\%c/, @context.to_s).gsub(/\%w/, @warning)
end
end
end
Version data entries
21 entries across 21 versions & 3 rubygems