Module: RuboCop::Cop::ConfigurableEnforcedStyle

Included in:
ConfigurableNaming, ConfigurableNumbering, EndKeywordAlignment, Lint::BlockAlignment, Lint::InheritException, MultilineLiteralBraceLayout, Rails::ActionFilter, Rails::Date, Rails::Exit, Rails::RequestReferer, Rails::TimeZone, Style::AccessModifierIndentation, Style::Alias, Style::AndOr, Style::BarePercentLiterals, Style::BlockDelimiters, Style::BracesAroundHashParameters, Style::CaseIndentation, Style::ClassAndModuleChildren, Style::ClassCheck, Style::CommandLiteral, Style::ConditionalAssignment, Style::DotPosition, Style::EmptyElse, Style::EmptyLinesAroundBody, Style::EmptyMethod, Style::Encoding, Style::FirstParameterIndentation, Style::For, Style::FormatString, Style::FrozenStringLiteralComment, Style::HashSyntax, Style::IndentArray, Style::IndentHash, Style::IndentationConsistency, Style::Lambda, Style::LambdaCall, Style::MethodDefParentheses, Style::MissingElse, Style::ModuleFunction, Style::MultilineAssignmentLayout, Style::MultilineMethodCallIndentation, Style::MultilineOperationIndentation, Style::Next, Style::NumericPredicate, Style::PercentQLiterals, Style::PreferredHashMethods, Style::RaiseArgs, Style::RegexpLiteral, Style::SignalException, Style::SpaceAroundBlockParameters, Style::SpaceAroundEqualsInParameterDefault, Style::SpaceBeforeBlockBraces, Style::SpaceInLambdaLiteral, Style::SpaceInsideBlockBraces, Style::SpaceInsideHashLiteralBraces, Style::SpaceInsideStringInterpolation, Style::SpecialGlobalVars, Style::StabbyLambdaParentheses, Style::StringLiterals, Style::StringLiteralsInInterpolation, Style::SymbolArray, Style::TernaryParentheses, Style::TrailingBlankLines, TrailingComma
Defined in:
lib/rubocop/cop/mixin/configurable_enforced_style.rb

Overview

Handles `EnforcedStyle` configuration parameters.

Instance Method Summary collapse

Instance Method Details

#alternative_styleObject


74
75
76
77
78
79
80
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 74

def alternative_style
  if supported_styles.size != 2
    raise 'alternative_style can only be used when there are exactly ' \
         '2 SupportedStyles'
  end
  (supported_styles - [style]).first
end

#ambiguous_style_detected(*possibilities) ⇒ Object


19
20
21
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 19

def ambiguous_style_detected(*possibilities)
  style_detected(possibilities)
end

#correct_style_detectedObject


11
12
13
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 11

def correct_style_detected
  style_detected(style)
end

#detected_styleObject


48
49
50
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 48

def detected_style
  Formatter::DisabledConfigFormatter.detected_styles[cop_name] ||= nil
end

#detected_style=(style) ⇒ Object


52
53
54
55
56
57
58
59
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 52

def detected_style=(style)
  Formatter::DisabledConfigFormatter.detected_styles[cop_name] = style

  return no_acceptable_style! if style.nil?
  return no_acceptable_style! if style.empty?

  config_to_allow_offenses[parameter_name] = style.first
end

#no_acceptable_style!Object Also known as: conflicting_styles_detected, unrecognized_style_detected


43
44
45
46
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 43

def no_acceptable_style!
  self.config_to_allow_offenses = { 'Enabled' => false }
  Formatter::DisabledConfigFormatter.detected_styles[cop_name] = []
end

#no_acceptable_style?Boolean

Returns:

  • (Boolean)

39
40
41
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 39

def no_acceptable_style?
  config_to_allow_offenses['Enabled'] == false
end

#opposite_style_detectedObject


7
8
9
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 7

def opposite_style_detected
  style_detected(alternative_style)
end

#parameter_nameObject


86
87
88
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 86

def parameter_name
  'EnforcedStyle'
end

#styleObject


64
65
66
67
68
69
70
71
72
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 64

def style
  @enforced_style ||= begin
    s = cop_config[parameter_name].to_sym
    unless supported_styles.include?(s)
      raise "Unknown style #{s} selected!"
    end
    s
  end
end

#style_detected(detected) ⇒ Object


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 23

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)

  if !detected_style # we haven't observed any specific style yet
    self.detected_style = detected_as_strings
  elsif detected_style.is_a?(Array)
    self.detected_style &= detected_as_strings
  elsif !detected.include?(detected_style)
    no_acceptable_style!
  end
end

#supported_stylesObject


82
83
84
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 82

def supported_styles
  @supported_styles ||= cop_config['SupportedStyles'].map(&:to_sym)
end

#unexpected_style_detected(unexpected) ⇒ Object


15
16
17
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 15

def unexpected_style_detected(unexpected)
  style_detected(unexpected)
end