Class: RuboCop::Cop::Lint::BlockAlignment

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/lint/block_alignment.rb

Overview

This cop checks whether the end keywords are aligned properly for do end blocks.

Three modes are supported through the ‘AlignWith` 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`.

Examples:


# either
variable = lambda do |i|
  i
end

# start_of_block
foo.bar
  .each do
     baz
   end

# start_of_line
foo.bar
  .each do
     baz
end

Constant Summary collapse

MSG = 
'%s is not aligned with %s%s.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #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, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#on_block(node) ⇒ Object 



54
55
56
 
# File 'lib/rubocop/cop/lint/block_alignment.rb', line 54

def on_block(node)
  check_block_alignment(start_for_block_node(node), node)
end

#parameter_name ⇒ Object 



58
59
60
 
# File 'lib/rubocop/cop/lint/block_alignment.rb', line 58

def parameter_name
  'AlignWith'
end