Class: RuboCop::Cop::Style::IfWithSemicolon
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
self,
::RuboCop::Cop::OnNormalIfUnless ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/if_with_semicolon.rb |
Overview
Checks for uses of semicolon in if statements.
Constant Summary
-
MSG_IF_ELSE =
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 20'Do not use `if %<expr>s;` - use `if/else` instead.'
-
MSG_NEWLINE =
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 21'Do not use `if %<expr>s;` - use a newline instead.'
-
MSG_TERNARY =
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 22'Do not use `if %<expr>s;` - use a ternary operator instead.'
::RuboCop::Cop::Base
- Inherited
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::RuboCop::Cop::Base
- Inherited
.gem_requirements, .lint?, | |
.support_autocorrect? | Returns if class supports autocorrect. |
.support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to |
Class Method Summary
::RuboCop::Cop::Base
- Inherited
.autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
.badge | Naming. |
.callbacks_needed, .cop_name, .department, | |
.documentation_url | Returns a url to view this cops documentation online. |
.exclude_from_registry | Call for abstract Cop classes. |
.inherited, | |
.joining_forces | Override and return the Force class(es) you need to join. |
.match? | Returns true if the cop name or the cop namespace matches any of the given names. |
.new, | |
.requires_gem | Register a version requirement for the given gem name. |
.restrict_on_send |
::RuboCop::ExcludeLimit
- Extended
exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
transform |
Instance Attribute Summary
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_normal_if_unless(node)
- #autocorrect(corrector, node) private
- #build_else_branch(second_condition) private
- #build_expression(expr) private
- #correct_elsif(node) private
- #message(node) private
- #replacement(node) private
- #require_argument_parentheses?(node) ⇒ Boolean private
- #require_newline?(node) ⇒ Boolean private
- #use_masgn_or_block_in_branches?(node) ⇒ Boolean private
- #use_return_with_argument?(node) ⇒ Boolean private
::RuboCop::Cop::OnNormalIfUnless
- Included
::RuboCop::Cop::Base
- Inherited
#add_global_offense | Adds an offense that has no particular location. |
#add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
#begin_investigation | Called before any investigation. |
#callbacks_needed, | |
#cop_config | Configuration Helpers. |
#cop_name, #excluded_file?, | |
#external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
#inspect, | |
#message | Gets called if no message is specified when calling |
#name | Alias for Base#cop_name. |
#offenses, | |
#on_investigation_end | Called after all on_… |
#on_new_investigation | Called before all on_… |
#on_other_file | Called instead of all on_… |
#parse | There should be very limited reasons for a Cop to do it’s own parsing. |
#parser_engine, | |
#ready | Called between investigations. |
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
#callback_argument | Reserved for Cop::Cop. |
#complete_investigation | Called to complete an investigation. |
#correct, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #max_line_length, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #string_continuation?, #surrounding_heredoc, #surrounding_percent_array |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#autocorrect(corrector, node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 55
def autocorrect(corrector, node) if require_newline?(node) || use_masgn_or_block_in_branches?(node) corrector.replace(node.loc.begin, "\n") else corrector.replace(node, replacement(node)) end end
#build_else_branch(second_condition) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 104
def build_else_branch(second_condition) result = <<~RUBY elsif #{second_condition.condition.source} #{second_condition.if_branch&.source} RUBY if second_condition.else_branch result += if second_condition.else_branch.if_type? build_else_branch(second_condition.else_branch) else <<~RUBY else #{second_condition.else_branch.source} RUBY end end result end
#build_expression(expr) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 95
def build_expression(expr) return expr.source unless require_argument_parentheses?(expr) method = expr.source_range.begin.join(expr.loc.selector.end) arguments = expr.first_argument.source_range.begin.join(expr.source_range.end) "#{method.source}(#{arguments.source})" end
#correct_elsif(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 86
def correct_elsif(node) <<~RUBY.chop if #{node.condition.source} #{node.if_branch&.source} #{build_else_branch(node.else_branch).chop} end RUBY end
#message(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 42
def (node) template = if require_newline?(node) MSG_NEWLINE elsif node.else_branch&.if_type? || node.else_branch&.begin_type? || use_masgn_or_block_in_branches?(node) MSG_IF_ELSE else MSG_TERNARY end format(template, expr: node.condition.source) end
#on_normal_if_unless(node)
[ GitHub ]# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 24
def on_normal_if_unless(node) return if node.parent&.if_type? return if part_of_ignored_node?(node) beginning = node.loc.begin return unless beginning&.is?(';') = (node) add_offense(node, message: ) do |corrector| autocorrect(corrector, node) end ignore_node(node) end
#replacement(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 77
def replacement(node) return correct_elsif(node) if node.else_branch&.if_type? then_code = node.if_branch ? build_expression(node.if_branch) : 'nil' else_code = node.else_branch ? build_expression(node.else_branch) : 'nil' "#{node.condition.source} ? #{then_code} : #{else_code}" end
#require_argument_parentheses?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 124
def require_argument_parentheses?(node) return false if !node.call_type? || node.arithmetic_operation? !node.parenthesized? && node.arguments.any? && !node.method?(:[]) && !node.method?(:[]=) end
#require_newline?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 63
def require_newline?(node) node.branches.compact.any?(&:begin_type?) || use_return_with_argument?(node) end
#use_masgn_or_block_in_branches?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 67
def use_masgn_or_block_in_branches?(node) node.branches.compact.any? do |branch| branch.masgn_type? || branch.block_type? || branch.numblock_type? end end
#use_return_with_argument?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/if_with_semicolon.rb', line 73
def use_return_with_argument?(node) node.if_branch&.return_type? && node.if_branch&.arguments&.any? end