sevencop 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b59b9e87fae854412dd7555c8e0afb4d6c8c5e2a4a629ceb0b5840d94bfbd25c
-  data.tar.gz: d2a7a9cf5eb6b2722e44bb1f29f84ff3557e8be03fab8ecfd7441fb5723b64ec
+  metadata.gz: 6671a53ba1051be4f4ea86dc41b3c4d4adfef282c8ca1078ea4271161e0e54ac
+  data.tar.gz: aea5e2be6ae30fe9ca7ba5237e3444cebe5e71ab7352b03f2929fef8c71fccd9
 SHA512:
-  metadata.gz: a8be2a642fcda52bb7b779032bb1714366ef300a44fc2b0d435333c0239d16b7aff7802e8a43206a65e105e328c6d42c400fbf132d2baa40eecadbf54e16b177
-  data.tar.gz: 8581bf84c297111f877db7d3e51eeddea2c1000af8ebaae49dbac164f229d9e73f7ef878a4cfe8520d8a40d1ec01954b04eaafe4370a3e7359e78f8573a45715
+  metadata.gz: 1ad6a03a60543e5171f8d41a0d8b257d7fe7b0141c1f2922556b89e8b1e068e3e68ea5db5ef1a941acdb4b2674898d25077e98c5f1c6e0abebb0d73b3aa7ffc2
+  data.tar.gz: af5b8df28c323361fe79082e26dc6d3910b1bc1d7bf8f1bb9d6d9321ba2a525615bc5fc65cbc24e47a5fccab2cd2a1271315c461cf32495b55a9494363c2b934

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.2.0 - 2022-06-07
+
+### Changed
+
+- Correct to enforced operation at `Sevencop/RedundantExistenceCheck`.
+
 ## 0.1.0 - 2022-06-07
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.1.0)
+    sevencop (0.2.0)
       rubocop (>= 1.27)
 
 GEM

data/lib/rubocop/cop/sevencop/redundant_existence_check.rb

@@ -6,8 +6,7 @@ module RuboCop
       # Identifies redundant existent check before file operation.
       #
       # @safety
-      #   This cop is unsafe because it can register a false positive
-      #   where the check is truly needed.
+      #   This cop is unsafe because it can register a false positive where the check is truly needed.
       #
       # @example
       #
@@ -15,13 +14,13 @@ module RuboCop
       #   FileUtils.mkdir(a) unless FileTest.exist?(a)
       #
       #   # good
-      #   FileUtils.mkdir(a)
+      #   FileUtils.mkdir_p(a)
       #
       #   # bad
-      #   FileUtils.rm(a) if FileTest.exist?(a)
+      #   FileUtils.rm(a) if File.exist?(a)
       #
       #   # good
-      #   FileUtils.rm(a)
+      #   FileUtils.rm_f(a)
       #
       class RedundantExistenceCheck < Base
         extend AutoCorrector
@@ -31,6 +30,11 @@ module RuboCop
           :FileTest,
         ]
 
+        CLASS_NAMES_FOR_OPERATION = ::Set[
+          :File,
+          :FileUtils,
+        ]
+
         METHOD_NAMES_FOR_MAKE = ::Set[
           :makedirs,
           :mkdir,
@@ -40,6 +44,7 @@ module RuboCop
         ]
 
         METHOD_NAMES_FOR_REMOVE = ::Set[
+          :delete,
           :remove,
           :remove_dir,
           :remove_entry,
@@ -52,6 +57,7 @@ module RuboCop
           :rmdir,
           :rmtree,
           :safe_unlink,
+          :unlink,
         ]
 
         METHOD_NAMES_FOR_EXIST = ::Set[
@@ -59,72 +65,120 @@ module RuboCop
           :exists?,
         ]
 
+        METHOD_NAMES_FOR_FORCE_OPERATION = ::Set[
+          :makedirs,
+          :mkdir_p,
+          :mkpath,
+          :rm_f,
+          :rm_rf,
+          :rm_tree,
+          :safe_unlink,
+          :touch,
+        ]
+
+        METHOD_MAPPING_FOR_FORCE_REPLACEMENT = {
+          'FileUtils.mkdir' => 'FileUtils.mkdir_p',
+          'File.delete' => 'FileUtils.rm_f',
+          'File.unlink' => 'FileUtils.rm_f'
+        }.freeze
+
         MSG = 'Avoid redundant existent check before file operation.'
 
         def_node_matcher :make_unless_exist?, <<~PATTERN
           (if
             (send (const nil? CLASS_NAMES_FOR_EXIST) METHOD_NAMES_FOR_EXIST _)
             nil?
-            (send (const nil? :FileUtils) METHOD_NAMES_FOR_MAKE ...)
+            (send (const nil? CLASS_NAMES_FOR_OPERATION) METHOD_NAMES_FOR_MAKE ...)
           )
         PATTERN
 
         def_node_matcher :remove_if_exist?, <<~PATTERN
           (if
             (send (const nil? CLASS_NAMES_FOR_EXIST) METHOD_NAMES_FOR_EXIST _)
-            (send (const nil? :FileUtils) METHOD_NAMES_FOR_REMOVE ...)
+            (send (const nil? CLASS_NAMES_FOR_OPERATION) METHOD_NAMES_FOR_REMOVE ...)
             nil?
           )
         PATTERN
 
         def on_if(node)
-          if redundant_on_if(node)
-            add_offense(node) do |rewriter|
-              remove_if(
-                node: node,
-                rewriter: rewriter
-              )
-            end
-          elsif redundant_on_unless(node)
-            add_offense(node) do |rewriter|
-              remove_unless(
-                node: node,
-                rewriter: rewriter
-              )
-            end
+          return unless redundant_on_if(node) || redundant_on_unless(node)
+
+          add_offense(node) do |corrector|
+            corrector.replace(
+              node.location.expression,
+              enforce(node)
+            )
           end
         end
 
         private
 
-        def redundant_on_if(node)
-          remove_if_exist?(node) && same_argument_on_if(node)
+        def enforce(node)
+          if force_operation?(node)
+            node.if_branch.source
+          elsif force_replaceable_method?(node)
+            enforce_by_replacement(node)
+          else
+            enforce_by_force_option(node)
+          end
         end
 
-        def redundant_on_unless(node)
-          make_unless_exist?(node) && same_argument_on_unless(node)
+        def enforce_by_force_option(node)
+          arguments = node.if_branch.arguments.map(&:source)
+          arguments << 'force: true' unless force_operation?(node)
+          format(
+            '%<receiver>s.%<method_name>s(%<arguments>s)',
+            arguments: arguments.join(', '),
+            method_name: node.if_branch.method_name,
+            receiver: node.if_branch.receiver.source
+          )
         end
 
-        def remove_if(node:, rewriter:)
-          rewriter.replace(
-            node.location.expression,
-            node.children[1].source
+        def enforce_by_replacement(node)
+          format(
+            '%<signature>s(%<arguments>s)',
+            arguments: node.if_branch.arguments.map(&:source).join(', '),
+            signature: METHOD_MAPPING_FOR_FORCE_REPLACEMENT[operation_method_signature(node)]
           )
         end
 
-        def remove_unless(node:, rewriter:)
-          rewriter.replace(
-            node.location.expression,
-            node.children[2].source
-          )
+        def force_operation?(node)
+          force_operation_method_name?(node) || force_operation_argument?(node)
         end
 
-        def same_argument_on_if(node)
-          node.children[0].children[2] == node.children[1].children[2]
+        def force_operation_argument?(node)
+          node.if_branch.last_argument.hash_type? &&
+            node.if_branch.last_argument.pairs.any? do |pair|
+              pair.key.value == :force && pair.value.true_type?
+            end
+        end
+
+        def force_operation_method_name?(node)
+          METHOD_NAMES_FOR_FORCE_OPERATION.include?(node.if_branch.method_name)
+        end
+
+        def redundant_on_if(node)
+          remove_if_exist?(node) && same_argument?(node)
+        end
+
+        def redundant_on_unless(node)
+          make_unless_exist?(node) && same_argument?(node)
+        end
+
+        def force_replaceable_method?(node)
+          METHOD_MAPPING_FOR_FORCE_REPLACEMENT.key?(operation_method_signature(node))
+        end
+
+        def operation_method_signature(node)
+          format(
+            '%<receiver>s.%<method_name>s',
+            method_name: node.if_branch.method_name,
+            receiver: node.if_branch.receiver.source
+          )
         end
 
-        def same_argument_on_unless(node)
-          node.children[0].children[2] == node.children[2].children[2]
+        def same_argument?(node)
+          node.condition.first_argument == node.if_branch.first_argument
         end
       end
     end

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop