Class: RuboCop::Cop::Style::DirEmpty

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector, TargetRubyVersion
Defined in:
lib/rubocop/cop/style/dir_empty.rb

Overview

Prefer to use ‘Dir.empty?(’path/to/dir’)‘ when checking if a directory is empty.

Examples:

# bad
Dir.entries('path/to/dir').size == 2
Dir.children('path/to/dir').empty?
Dir.children('path/to/dir').size == 0
Dir.each_child('path/to/dir').none?

# good
Dir.empty?('path/to/dir')

Constant Summary collapse

MSG = 
'Use `%<replacement>s` instead.'
RESTRICT_ON_SEND = 
%i[== != > empty? none?].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from TargetRubyVersion

minimum_target_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #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

#offensive?(node) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/rubocop/cop/style/dir_empty.rb', line 28

def_node_matcher :offensive?, <<~PATTERN
  {
    (send (send (send $(const {nil? cbase} :Dir) :entries $_) :size) {:== :!= :>} (int 2))
    (send (send (send $(const {nil? cbase} :Dir) :children $_) :size) {:== :!= :>} (int 0))
    (send (send $(const {nil? cbase} :Dir) :children $_) :empty?)
    (send (send $(const {nil? cbase} :Dir) :each_child $_) :none?)
  }
PATTERN

#on_send(node) ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/rubocop/cop/style/dir_empty.rb', line 37

def on_send(node)
  offensive?(node) do |const_node, arg_node|
    replacement = "#{bang(node)}#{const_node.source}.empty?(#{arg_node.source})"
    add_offense(node, message: format(MSG, replacement: replacement)) do |corrector|
      corrector.replace(node, replacement)
    end
  end
end