Class: RuboCop::Cop::Style::MultilineAssignmentLayout
- Includes:
- CheckAssignment, ConfigurableEnforcedStyle
- Defined in:
- lib/rubocop/cop/style/multiline_assignment_layout.rb
Overview
This cop checks whether the multiline assignments have a newline after the assignment operator.
Constant Summary collapse
- NEW_LINE_OFFENSE =
'Right hand side of multi-line assignment is on ' \ 'the same line as the assignment operator `=`.'.freeze
- SAME_LINE_OFFENSE =
'Right hand side of multi-line assignment is not ' \ 'on the same line as the assignment operator `=`.'.freeze
Constants included from Util
Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #autocorrect(node) ⇒ Object
- #check_assignment(node, rhs) ⇒ Object
- #check_new_line_offense(node, rhs) ⇒ Object
- #check_same_line_offense(node, rhs) ⇒ 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
Methods inherited from Cop
#add_offense, all, 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_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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?
Methods included from PathUtil
absolute?, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(node) ⇒ Object
68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/rubocop/cop/style/multiline_assignment_layout.rb', line 68 def autocorrect(node) case style when :new_line ->(corrector) { corrector.insert_after(node.loc.operator, "\n") } when :same_line range = range_between(node.loc.operator.end_pos, extract_rhs(node).source_range.begin_pos) ->(corrector) { corrector.replace(range, ' ') } end end |
#check_assignment(node, rhs) ⇒ Object
43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/rubocop/cop/style/multiline_assignment_layout.rb', line 43 def check_assignment(node, rhs) return unless rhs return unless supported_types.include?(rhs.type) return if rhs.loc.first_line == rhs.loc.last_line case style when :new_line check_new_line_offense(node, rhs) when :same_line check_same_line_offense(node, rhs) end end |
#check_new_line_offense(node, rhs) ⇒ Object
56 57 58 59 60 |
# File 'lib/rubocop/cop/style/multiline_assignment_layout.rb', line 56 def check_new_line_offense(node, rhs) return unless node.loc.operator.line == rhs.loc.line add_offense(node, :expression, NEW_LINE_OFFENSE) end |
#check_same_line_offense(node, rhs) ⇒ Object
62 63 64 65 66 |
# File 'lib/rubocop/cop/style/multiline_assignment_layout.rb', line 62 def check_same_line_offense(node, rhs) return unless node.loc.operator.line != rhs.loc.line add_offense(node, :expression, SAME_LINE_OFFENSE) end |