Class: RuboCop::Cop::Lint::HeredocMethodCallPosition
- Includes:
- RangeHelp
- Defined in:
- lib/rubocop/cop/lint/heredoc_method_call_position.rb
Overview
This cop checks for the ordering of a method call where the receiver of the call is a HEREDOC.
Constant Summary collapse
- MSG =
'Put a method call with a HEREDOC receiver on the ' \ 'same line as the HEREDOC opening.'
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #autocorrect(node) ⇒ Object
- #on_send(node) ⇒ Object (also: #on_csend)
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
48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 48 def autocorrect(node) heredoc = heredoc_node_descendent_receiver(node) lambda do |corrector| call_range = call_range_to_safely_reposition(node, heredoc) return if call_range.nil? call_source = call_range.source.strip corrector.remove(call_range) corrector.insert_after(heredoc_begin_line_range(node), call_source) end end |
#on_send(node) ⇒ Object Also known as: on_csend
39 40 41 42 43 44 45 |
# File 'lib/rubocop/cop/lint/heredoc_method_call_position.rb', line 39 def on_send(node) heredoc = heredoc_node_descendent_receiver(node) return unless heredoc return if correctly_positioned?(node, heredoc) add_offense(node, location: call_after_heredoc_range(heredoc)) end |