Sha256: 1fb158c92cd92e1f26183d31cb86198f2bda4c8759e79739516dbf5922adb515
Contents?: true
Size: 1.02 KB
Versions: 13
Compression:
Stored size: 1.02 KB
Contents
# frozen_string_literal: true
require_relative 'base_detector'
module Reek
module SmellDetectors
#
# A Boolean parameter effectively permits a method's caller
# to decide which execution path to take. The
# offending parameter is a kind of Control Couple.
#
# Currently Reek can only detect a Boolean parameter when it has a
# default initializer.
#
# See {file:docs/Boolean-Parameter.md} for details.
class BooleanParameter < BaseDetector
BOOLEAN_VALUES = [:true, :false].freeze
#
# Checks whether the given method has any Boolean parameters.
#
# @return [Array<SmellWarning>]
#
def sniff
context.default_assignments.select do |_parameter, value|
BOOLEAN_VALUES.include?(value.type)
end.map do |parameter, _value|
smell_warning(
lines: [source_line],
message: "has boolean parameter '#{parameter}'",
parameters: { parameter: parameter.to_s })
end
end
end
end
end
Version data entries
13 entries across 13 versions & 1 rubygems