Class: RuboCop::Cop::Layout::MultilineAssignmentLayout
- Includes:
- CheckAssignment, ConfigurableEnforcedStyle, RangeHelp
- Defined in:
- lib/rubocop/cop/layout/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 `=`.'
- SAME_LINE_OFFENSE =
'Right hand side of multi-line assignment is not ' \ 'on the same line as the assignment operator `=`.'
Constants included from Util
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_by_enforced_style(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
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
75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 75 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
45 46 47 48 49 50 51 52 |
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 45 def check_assignment(node, rhs) return if node.send_type? return unless rhs return unless supported_types.include?(rhs.type) return if rhs.first_line == rhs.last_line check_by_enforced_style(node, rhs) end |
#check_by_enforced_style(node, rhs) ⇒ Object
54 55 56 57 58 59 60 61 |
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 54 def check_by_enforced_style(node, rhs) 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
63 64 65 66 67 |
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 63 def check_new_line_offense(node, rhs) return unless node.loc.operator.line == rhs.first_line add_offense(node, message: NEW_LINE_OFFENSE) end |
#check_same_line_offense(node, rhs) ⇒ Object
69 70 71 72 73 |
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 69 def check_same_line_offense(node, rhs) return unless node.loc.operator.line != rhs.first_line add_offense(node, message: SAME_LINE_OFFENSE) end |