Sha256: 0d7e5c17dc7356534c2d0749df1ac2603dbd44d38d93b2e37463274abd85f024

Contents?: true

Size: 1.2 KB

Versions: 38

Compression:

Stored size: 1.2 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # This cop checks for cases when you could use a block
      # accepting version of a method that does automatic
      # resource cleanup.
      #
      # @example
      #
      #   # bad
      #   f = File.open('file')
      #
      #   # good
      #   File.open('file') do |f|
      #     # ...
      #   end
      class AutoResourceCleanup < Base
        MSG = 'Use the block version of `%<class>s.%<method>s`.'

        TARGET_METHODS = { File: :open }.freeze

        RESTRICT_ON_SEND = TARGET_METHODS.values.freeze

        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

        private

        def cleanup?(node)
          parent = node.parent
          node.block_argument? || (parent && (parent.block_type? || !parent.lvasgn_type?))
        end
      end
    end
  end
end

Version data entries

38 entries across 38 versions & 6 rubygems

Version Path
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/style/auto_resource_cleanup.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.29.1 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.29.0 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.28.2 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.28.1 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.28.0 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.27.0 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.26.1 lib/rubocop/cop/style/auto_resource_cleanup.rb
op_connect-0.1.2 vendor/bundle/ruby/3.1.0/gems/rubocop-1.26.0/lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.26.0 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.25.1 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.25.0 lib/rubocop/cop/style/auto_resource_cleanup.rb
phillipug-foodie-0.1.0 .vendor/ruby/3.0.0/gems/rubocop-1.24.0/lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.24.1 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.24.0 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.23.0 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.22.3 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.22.2 lib/rubocop/cop/style/auto_resource_cleanup.rb
rubocop-1.22.1 lib/rubocop/cop/style/auto_resource_cleanup.rb