Class: RuboCop::Cop::Style::SingleLineDoEndBlock
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::CheckSingleLineSuitability ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/single_line_do_end_block.rb |
Overview
Checks for single-line do
…end
block.
In practice a single line do
…end
is autocorrected when EnforcedStyle: semantic
is configured for Style/BlockDelimiters
. The autocorrection maintains the
do
… end
syntax to preserve semantics and does not change it to {
…}
block.
Note
|
If InspectBlocks is set to true for Layout/RedundantLineBreak , blocks will
be autocorrected to be on a single line if possible. This cop respects that configuration
by not registering an offense if it would subsequently cause a
Layout/RedundantLineBreak offense.
|
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/style/single_line_do_end_block.rb', line 37'Prefer multiline `do`...`end` block.'
::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
- #single_line_blocks_preferred? ⇒ Boolean readonly private
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_block(node) (also: #on_numblock)
-
#on_numblock(node)
Alias for #on_block.
- #do_line(node) private
::RuboCop::Cop::CheckSingleLineSuitability
- Included
#suitable_as_single_line?, #comment_within?, #max_line_length, #safe_to_split?, #to_single_line, #too_long? |
::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 Attribute Details
#single_line_blocks_preferred? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/rubocop/cop/style/single_line_do_end_block.rb', line 70
def single_line_blocks_preferred? redundant_line_break_config = @config.for_cop('Layout/RedundantLineBreak') redundant_line_break_config['Enabled'] && redundant_line_break_config['InspectBlocks'] end
Instance Method Details
#do_line(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/single_line_do_end_block.rb', line 62
def do_line(node) if node.numblock_type? || node.arguments.children.empty? || node.send_node.lambda_literal? node.loc.begin else node.arguments end end
#on_block(node) Also known as: #on_numblock
[ GitHub ]# File 'lib/rubocop/cop/style/single_line_do_end_block.rb', line 40
def on_block(node) return if !node.single_line? || node.braces? return if single_line_blocks_preferred? && suitable_as_single_line?(node) add_offense(node) do |corrector| corrector.insert_after(do_line(node), "\n") node_body = node.body if node_body.respond_to?(:heredoc?) && node_body.heredoc? corrector.remove(node.loc.end) corrector.insert_after(node_body.loc.heredoc_end, "\nend") else corrector.insert_before(node.loc.end, "\n") end end end
#on_numblock(node)
Alias for #on_block.
# File 'lib/rubocop/cop/style/single_line_do_end_block.rb', line 58
alias on_numblock on_block