Class: RuboCop::Cop::Layout::EndAlignment
| 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/end_alignment.rb |
Overview
Checks whether the end keywords are aligned properly.
Three modes are supported through the EnforcedStyleAlignWith
configuration parameter:
If it’s set to keyword (which is the default), the end
shall be aligned with the start of the keyword (if, class, etc.).
If it’s set to variable the end shall be aligned with the
left-hand-side of the variable assignment, if there is one.
If it’s set to start_of_line, the end shall be aligned with the
start of the line where the matching keyword appears.
This Layout/EndAlignment cop aligns with keywords (e.g. if, while, case)
by default. On the other hand, Layout/BeginEndAlignment cop aligns with
EnforcedStyleAlignWith: start_of_line by default because ||= begin tends
to align with the start of the line. Layout/DefEndAlignment cop also aligns with
EnforcedStyleAlignWith: start_of_line by default.
These styles can be configured by each cop.
Constant Summary
::RuboCop::Cop::Base - Inherited
DEPARTMENT_SEVERITIES, EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::ConfigurableEnforcedStyle - Included
::RuboCop::Cop::RangeHelp - Included
::RuboCop::Cop::EndKeywordAlignment - 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 | Reserved for Commissioner. |
::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
| #active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #disabled_autocorrect?, | |
| #preview? | Whether the user opted in to unstable behavior, with |
| #processed_source, #project_index, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements? | |
::RuboCop::Cop::AutocorrectLogic - Included
| #autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?, | |
| #skipped_unsafe_correction_with_disable_uncorrectable? | Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while |
| #contextual_autocorrect_held_back? | When LSP is enabled or the |
Instance Method Summary
- #on_case(node) (also: #on_case_match)
-
#on_case_match(node)
Alias for #on_case.
-
#on_class(node)
Alias for #on_sclass.
- #on_csend
- #on_if(node)
-
#on_module(node)
Alias for #on_sclass.
- #on_sclass(node) (also: #on_class, #on_module)
- #on_until(node)
- #on_while(node)
- #alignment_node(node) private
- #alignment_node_for_variable_style(node) private
- #asgn_variable_align_with(outer_node, inner_node) private
- #assignment_or_method_call(node) private
- #autocorrect(corrector, node) private
- #check_asgn_alignment(outer_node, inner_node) private
- #check_assignment(node, rhs) private
- #check_other_alignment(node) private
- #leading_node(rhs) private
::RuboCop::Cop::EndKeywordAlignment - Included
| #add_offense_for_misalignment, #check_end_kw_alignment, #check_end_kw_in_node, #line_break_before_keyword?, #matching_ranges, #start_line_range, #style_parameter_name, #variable_alignment? |
::RuboCop::Cop::RangeHelp - Included
| #add_range, | |
| #arguments_range | A range containing the first to the last argument of a method call or method definition. |
| #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 | rubocop:disable-next Metrics/ParameterLists. |
| #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, | |
| #range_for_statement_removal | Returns the range to remove a statement: its whole lines, including a trailing comment and the final newline, when no other code shares them, and otherwise the range itself with the spaces after it. |
| #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range | |
::RuboCop::Cop::ConfigurableEnforcedStyle - Included
::RuboCop::Cop::CheckAssignment - Included
| #on_and_asgn | Alias for CheckAssignment#on_lvasgn. |
| #on_casgn | Alias for CheckAssignment#on_lvasgn. |
| #on_cvasgn | Alias for CheckAssignment#on_lvasgn. |
| #on_gvasgn | Alias for CheckAssignment#on_lvasgn. |
| #on_ivasgn | Alias for CheckAssignment#on_lvasgn. |
| #on_lvasgn, | |
| #on_masgn | Alias for CheckAssignment#on_lvasgn. |
| #on_op_asgn | Alias for CheckAssignment#on_lvasgn. |
| #on_or_asgn | Alias for CheckAssignment#on_lvasgn. |
| #on_send, #extract_rhs | |
::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 | — grouped under the Commissioner heading above. |
| #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_gem_version | Returns the version of a gem in the target, by default its locked version (i.e. from Gemfile.lock or gems.locked). |
| #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, #covering_disabled_range, #current_corrector, | |
| #current_offense_locations | Reserved for Commissioner: |
| #current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, | |
| #enabled_lines? | A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code. |
| #file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #new_offense, #range_for_original, #range_from_node_or_range, | |
| #reset_investigation | Actually private methods. |
| #suppression_reason | The |
| #use_corrector | |
::RuboCop::Cop::AutocorrectLogic - Included
::RuboCop::Cop::IgnoredNode - Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#alignment_node(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 171
def alignment_node(node) case style when :keyword node when :variable alignment_node_for_variable_style(node) else start_line_range(node) end end
#alignment_node_for_variable_style(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 182
def alignment_node_for_variable_style(node) if node.type?(:case, :case_match) && node.argument? && same_line?(node, node.parent) return node.parent end assignment = assignment_or_method_call(node) if assignment && !line_break_before_keyword?(assignment.source_range, node) assignment else # Fall back to 'keyword' style if this node is not on the RHS of an # assignment, or if it is but there's a line break between LHS and # RHS. node end end
#asgn_variable_align_with(outer_node, inner_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 152
def asgn_variable_align_with(outer_node, inner_node) expr = outer_node.source_range if line_break_before_keyword?(expr, inner_node) inner_node.loc.keyword else range_between(expr.begin_pos, inner_node.loc.keyword.end_pos) end end
#assignment_or_method_call(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 200
def assignment_or_method_call(node) node.ancestors.find do |ancestor| if ancestor.assignment_or_similar? leading_node(extract_rhs(ancestor)).equal?(node) elsif ancestor.call_type? leading_node(ancestor.last_argument).equal?(node) end end end
#autocorrect(corrector, node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 118
def autocorrect(corrector, node) AlignmentCorrector.align_end(corrector, processed_source, node, alignment_node(node)) end
#check_asgn_alignment(outer_node, inner_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 131
def check_asgn_alignment(outer_node, inner_node) align_with = { keyword: inner_node.loc.keyword, start_of_line: start_line_range(inner_node), variable: asgn_variable_align_with(outer_node, inner_node) } check_end_kw_alignment(inner_node, align_with) ignore_node(inner_node) end
#check_assignment(node, rhs) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 122
def check_assignment(node, rhs) rhs = leading_node(rhs) return unless rhs&.conditional? return if rhs.if_type? && rhs.ternary? check_asgn_alignment(node, rhs) end
#check_other_alignment(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 162
def check_other_alignment(node) align_with = { keyword: node.loc.keyword, variable: node.loc.keyword, start_of_line: start_line_range(node) } check_end_kw_alignment(node, align_with) end
#leading_node(rhs) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 142
def leading_node(rhs) # If there are method calls chained to the right hand side of the assignment, # we let rhs be the receiver of those method calls. rhs = first_part_of_call_chain(rhs) # If `rhs` is a `begin` node or a logical operator, unwrap to find the leading node. rhs = rhs.child_nodes.first while rhs&.type?(:begin, :or, :and) rhs end
#on_case(node) Also known as: #on_case_match
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 107
def on_case(node) if node.argument? check_asgn_alignment(node.parent, node) else check_other_alignment(node) end end
#on_case_match(node)
Alias for #on_case.
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 114
alias on_case_match on_case
#on_class(node)
Alias for #on_sclass.
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 92
alias on_class on_sclass
#on_csend
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 83
alias on_csend on_send
#on_if(node)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 95
def on_if(node) check_other_alignment(node) unless node.ternary? end
#on_module(node)
Alias for #on_sclass.
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 93
alias on_module on_sclass
#on_sclass(node) Also known as: #on_class, #on_module
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 85
def on_sclass(node) if node.parent&.assignment? check_asgn_alignment(node.parent, node) else check_other_alignment(node) end end
#on_until(node)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 103
def on_until(node) check_other_alignment(node) end
#on_while(node)
[ GitHub ]# File 'lib/rubocop/cop/layout/end_alignment.rb', line 99
def on_while(node) check_other_alignment(node) end