Class: RuboCop::Cop::Style::AutoResourceCleanup

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/auto_resource_cleanup.rb

Overview

This cop checks for cases when you could use a block accepting version of a method that does automatic resource cleanup.

Examples:


# bad
f = File.open('file')

# good
File.open('file') do |f|
  # ...
end

Constant Summary collapse

MSG =
'Use the block version of `%<class>s.%<method>s`.'.freeze
TARGET_METHODS =
{
  File: :open
}.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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 NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

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

Methods included from PathUtil

absolute?, 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

#on_send(node) ⇒ Object



26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/rubocop/cop/style/auto_resource_cleanup.rb', line 26

def on_send(node)
  TARGET_METHODS.each do |target_class, target_method|
    target_receiver = s(:const, nil, target_class)

    next if node.receiver != target_receiver
    next if node.method_name != target_method
    next if cleanup?(node)

    add_offense(node,
                message: format(MSG,
                                class: target_class,
                                method: target_method))
  end
end