Class: RuboCop::Cop::Layout::BlockAlignment
- Includes:
- ConfigurableEnforcedStyle, RangeHelp
- Defined in:
- lib/rubocop/cop/layout/block_alignment.rb
Overview
This cop checks whether the end keywords are aligned properly for do end blocks.
Three modes are supported through the ‘EnforcedStyleAlignWith` configuration parameter:
‘start_of_block` : the `end` shall be aligned with the start of the line where the `do` appeared.
‘start_of_line` : the `end` shall be aligned with the start of the line where the expression started.
‘either` (which is the default) : the `end` is allowed to be in either location. The autofixer will default to `start_of_line`.
Constant Summary collapse
- MSG =
'%<current>s is not aligned with %<prefer>s%<alt_prefer>s.'
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
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, #supported_styles, #unexpected_style_detected
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
87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/rubocop/cop/layout/block_alignment.rb', line 87 def autocorrect(node) ancestor_node = start_for_block_node(node) start_col = compute_start_col(ancestor_node, node) loc_end = node.loc.end delta = start_col - loc_end.column if delta.positive? add_space_before(loc_end, delta) elsif delta.negative? remove_space_before(loc_end.begin_pos, -delta) end end |
#on_block(node) ⇒ Object
79 80 81 |
# File 'lib/rubocop/cop/layout/block_alignment.rb', line 79 def on_block(node) check_block_alignment(start_for_block_node(node), node) end |
#style_parameter_name ⇒ Object
83 84 85 |
# File 'lib/rubocop/cop/layout/block_alignment.rb', line 83 def style_parameter_name 'EnforcedStyleAlignWith' end |