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

Inherits:
Base
  • 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`.'
TARGET_METHODS =
{
  File: :open
}.freeze
RESTRICT_ON_SEND =
TARGET_METHODS.values.freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_send(node) ⇒ Object


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

def on_send(node)
  TARGET_METHODS.each do |target_class, target_method|
    next if node.method_name != target_method

    target_receiver = s(:const, nil, target_class)
    next if node.receiver != target_receiver

    next if cleanup?(node)

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