Class: RuboCop::Cop::Layout::EndAlignment
- Includes:
- CheckAssignment, EndKeywordAlignment, RangeHelp
- Defined in:
- lib/rubocop/cop/layout/end_alignment.rb
Overview
This cop 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.
Constant Summary
Constants included from EndKeywordAlignment
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #autocorrect(node) ⇒ Object
- #on_case(node) ⇒ Object
- #on_class(node) ⇒ Object
- #on_if(node) ⇒ Object
- #on_module(node) ⇒ Object
- #on_until(node) ⇒ Object
- #on_while(node) ⇒ Object
Methods included from ConfigurableEnforcedStyle
#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected
Methods included from CheckAssignment
extract_rhs, #on_lvasgn, #on_send
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first
Methods included from AutocorrectLogic
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?
Methods included from IgnoredNode
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(node) ⇒ Object
103 104 105 106 107 |
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 103 def autocorrect(node) AlignmentCorrector.align_end(processed_source, node, alignment_node(node)) end |
#on_case(node) ⇒ Object
95 96 97 98 99 100 101 |
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 95 def on_case(node) if node.argument? check_asgn_alignment(node.parent, node) else check_other_alignment(node) end end |
#on_class(node) ⇒ Object
75 76 77 |
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 75 def on_class(node) check_other_alignment(node) end |
#on_if(node) ⇒ Object
83 84 85 |
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 83 def on_if(node) check_other_alignment(node) unless node.ternary? end |
#on_module(node) ⇒ Object
79 80 81 |
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 79 def on_module(node) check_other_alignment(node) end |
#on_until(node) ⇒ Object
91 92 93 |
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 91 def on_until(node) check_other_alignment(node) end |
#on_while(node) ⇒ Object
87 88 89 |
# File 'lib/rubocop/cop/layout/end_alignment.rb', line 87 def on_while(node) check_other_alignment(node) end |