Module: RuboCop::Cop::ConfigurableEnforcedStyle
- Included in:
- ConfigurableFormatting, EndKeywordAlignment, Lint::BlockAlignment, Lint::InheritException, MultilineLiteralBraceLayout, Rails::ActionFilter, Rails::Date, Rails::Exit, Rails::RequestReferer, Rails::TimeZone, Rails::UniqBeforePluck, 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
- #alternative_style ⇒ Object
- #alternative_styles ⇒ Object
- #ambiguous_style_detected(*possibilities) ⇒ Object
- #correct_style_detected ⇒ Object
- #detected_style ⇒ Object
- #detected_style=(style) ⇒ Object
- #no_acceptable_style! ⇒ Object (also: #conflicting_styles_detected, #unrecognized_style_detected)
- #no_acceptable_style? ⇒ Boolean
- #opposite_style_detected ⇒ Object
- #style ⇒ Object
- #style_detected(detected) ⇒ Object
- #style_parameter_name ⇒ Object
- #supported_styles ⇒ Object
- #unexpected_style_detected(unexpected) ⇒ Object
Instance Method Details
#alternative_style ⇒ Object
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 alternative_styles.first end |
#alternative_styles ⇒ Object
82 83 84 |
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 82 def alternative_styles (supported_styles - [style]) 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_detected ⇒ Object
11 12 13 |
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 11 def correct_style_detected style_detected(style) end |
#detected_style ⇒ Object
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[style_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
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_detected ⇒ Object
7 8 9 |
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 7 def opposite_style_detected style_detected(alternative_style) end |
#style ⇒ Object
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[style_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 |
#style_parameter_name ⇒ Object
93 94 95 |
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 93 def style_parameter_name 'EnforcedStyle' end |
#supported_styles ⇒ Object
86 87 88 89 90 91 |
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 86 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) ⇒ Object
15 16 17 |
# File 'lib/rubocop/cop/mixin/configurable_enforced_style.rb', line 15 def unexpected_style_detected(unexpected) style_detected(unexpected) end |