Class: RuboCop::Cop::Layout::EmptyLinesAroundExceptionHandlingKeywords
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:
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb |
Overview
Checks if empty lines exist around the bodies of begin
sections. This cop doesn’t check empty lines at begin
body
beginning/end and around method definition body.
Style/EmptyLinesAroundBeginBody
or Style/EmptyLinesAroundMethodBody
can be used for this purpose.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 65'Extra empty line detected %<location>s the `%<keyword>s`.'
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::RangeHelp
- Included
EmptyLinesAroundBody
- Included
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::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
-
#on_block(node)
Alias for #on_def.
- #on_def(node) (also: #on_defs, #on_block, #on_numblock)
-
#on_defs(node)
Alias for #on_def.
- #on_kwbegin(node)
-
#on_numblock(node)
Alias for #on_def.
- #check_body(body, line_of_def_or_kwbegin) private
- #keyword_locations(node) private
- #keyword_locations_in_ensure(node) private
- #keyword_locations_in_rescue(node) private
- #last_body_and_end_on_same_line?(body) ⇒ Boolean private
- #message(location, keyword) private
- #style private
EmptyLinesAroundBody
- Included
::RuboCop::Cop::RangeHelp
- Included
#add_range, #column_offset_between, | |
#contents_range | A range containing only the contents of a literal with delimiters (e.g. |
#directions, | |
#effective_column | Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. |
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range |
::RuboCop::Cop::ConfigurableEnforcedStyle
- 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
#check_body(body, line_of_def_or_kwbegin) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 80
def check_body(body, line_of_def_or_kwbegin) locations = keyword_locations(body) locations.each do |loc| line = loc.line next if line == line_of_def_or_kwbegin || last_body_and_end_on_same_line?(body) keyword = loc.source # below the keyword check_line(style, line, ('after', keyword), &:empty?) # above the keyword check_line(style, line - 2, ('before', keyword), &:empty?) end end
#keyword_locations(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 112
def keyword_locations(node) return [] unless node case node.type when :rescue keyword_locations_in_rescue(node) when :ensure keyword_locations_in_ensure(node) else [] end end
#keyword_locations_in_ensure(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 129
def keyword_locations_in_ensure(node) rescue_body_without_ensure = node.children.first [ node.loc.keyword, *keyword_locations(rescue_body_without_ensure) ] end
#keyword_locations_in_rescue(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 125
def keyword_locations_in_rescue(node) [node.loc.else, *node.resbody_branches.map { |body| body.loc.keyword }].compact end
#last_body_and_end_on_same_line?(body) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 95
def last_body_and_end_on_same_line?(body) end_keyword_line = body.parent.loc.end.line return body.loc.last_line == end_keyword_line unless body.rescue_type? last_body_line = body.else? ? body.loc.else.line : body.resbody_branches.last.loc.line last_body_line == end_keyword_line end
#message(location, keyword) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 104
def (location, keyword) format(MSG, location: location, keyword: keyword) end
#on_block(node)
Alias for #on_def.
# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 71
alias on_block on_def
#on_def(node) Also known as: #on_defs, #on_block, #on_numblock
[ GitHub ]# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 67
def on_def(node) check_body(node.body, node.loc.line) end
#on_defs(node)
Alias for #on_def.
# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 70
alias on_defs on_def
#on_kwbegin(node)
[ GitHub ]# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 74
def on_kwbegin(node) check_body(node.children.first, node.loc.line) end
#on_numblock(node)
Alias for #on_def.
# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 72
alias on_numblock on_def
#style (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 108
def style :no_empty_lines end