module RuboCop::Cop::ConfigurableEnforcedStyle

Handles `EnforcedStyle` configuration parameters.

Public Instance Methods

alternative_style() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 72
def alternative_style
  if supported_styles.size != 2
    raise 'alternative_style can only be used when there are exactly ' \
         '2 SupportedStyles'
  end
  alternative_styles.first
end
alternative_styles() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 80
def alternative_styles
  (supported_styles - [style])
end
ambiguous_style_detected(*possibilities) click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 18
def ambiguous_style_detected(*possibilities)
  style_detected(possibilities)
end
conflicting_styles_detected()
correct_style_detected() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 10
def correct_style_detected
  style_detected(style)
end
detected_style() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 51
def detected_style
  Formatter::DisabledConfigFormatter.detected_styles[cop_name] ||= nil
end
detected_style=(style) click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 55
def detected_style=(style)
  Formatter::DisabledConfigFormatter.detected_styles[cop_name] = style
end
no_acceptable_style!() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 47
def no_acceptable_style!
  self.config_to_allow_offenses = { 'Enabled' => false }
end
no_acceptable_style?() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 43
def no_acceptable_style?
  config_to_allow_offenses['Enabled'] == false
end
opposite_style_detected() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 6
def opposite_style_detected
  style_detected(alternative_style)
end
style() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 62
def style
  @enforced_style ||= begin
    s = cop_config[style_parameter_name].to_sym
    unless supported_styles.include?(s)
      raise "Unknown style #{s} selected!"
    end
    s
  end
end
style_detected(detected) click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 22
def style_detected(detected)
  return if no_acceptable_style?

  # `detected` can be a single style, or an Array of possible styles
  # (if there is more than one which matches the observed code)
  detected_as_strings = Array(detected).map(&:to_s)

  updated_list = if detected_style
                   detected_style & detected_as_strings
                 else
                   # We haven't observed any specific style yet.
                   detected_as_strings
                 end
  if updated_list.empty?
    no_acceptable_style!
  else
    self.detected_style = updated_list
    config_to_allow_offenses[style_parameter_name] = updated_list.first
  end
end
style_parameter_name() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 91
def style_parameter_name
  'EnforcedStyle'
end
supported_styles() click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 84
def supported_styles
  @supported_styles ||= begin
    supported_styles = Util.to_supported_styles(style_parameter_name)
    cop_config[supported_styles].map(&:to_sym)
  end
end
unexpected_style_detected(unexpected) click to toggle source
# File lib/rubocop/cop/mixin/configurable_enforced_style.rb, line 14
def unexpected_style_detected(unexpected)
  style_detected(unexpected)
end
unrecognized_style_detected()