rubocop-require_tools 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92a502fba8cea8224ca73240fca61774a3a3c7dd9a572ba902da7cd5cdce804a
-  data.tar.gz: 7dcd0456375b56dfeaff84693ee49988e0b59efcb228622fbab249704645b99c
+  metadata.gz: 904921f72984631692f9d38ce8f6e6ba4ebc99383c871bb09bb518c419336f60
+  data.tar.gz: d6838acd03ecd1c02de7baa0c62ff2ed66944d3d82b8f4127c594e2215682534
 SHA512:
-  metadata.gz: abcd24dd207443eeba31b9a7ab62444dea88c2df9bf619980136622570bc1eaa6aa935f5aa0cf1a220519f6fa105e21ced27f6510dd78521ce2edfad020444b5
-  data.tar.gz: 1c5570d3ff8bc845f313d9825a4d6b63f03b1fdfccd3b6cca0ee7a16b7cb9cea4a4f4882c2f65a7841348841f377c93c0fc76cd8ae4a42bd169770ea68f7effa
+  metadata.gz: ac6e57ced1eda99834806160ff201a5dc2c5beaf0f139143ed5ac8db628efe7f66e2d6adafeb70b79be827f8217690edda25d96f49f8afee6c4223e84abbd0c7
+  data.tar.gz: 24b98cecaa56dd3992a09be447a686291f65960caa1a88a6d0736c03c29dd7224e04442e2a688bea5776326d967d8b02f9270a56abdac33b33fd57f2c730f1ff

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rubocop-require_tools (0.2.0)
-      rubocop (>= 0.49.1)
+    rubocop-require_tools (0.3.0)
+      rubocop (>= 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -11,7 +11,7 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.6.2)
     io-console (0.8.2)
-    json (2.19.5)
+    json (2.19.9)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     method_source (1.1.0)
@@ -78,7 +78,7 @@ CHECKSUMS
   coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
   io-console (0.8.2) sha256=d6e3ae7a7cc7574f4b8893b4fca2162e57a825b223a177b7afa236c5ef9814cc
-  json (2.19.5) sha256=218a18553e4801d579ca7e0f5bc72bafd776d7397238a1fb4e74db5b0a812c59
+  json (2.19.9) sha256=9b9025b7cdddafa38d316eca0b2358488e42d417045c1b90d216a9fefe46b79a
   language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
   method_source (1.1.0) sha256=181301c9c45b731b4769bc81e8860e72f9161ad7d66dd99103c9ab84f560f5c5
@@ -98,7 +98,7 @@ CHECKSUMS
   rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
   rubocop (1.86.2) sha256=bb2e97f635eda42c448f2588f4a6ff78f221b8bdfdf65b1e9b07fbd57521b45d
   rubocop-ast (1.49.1) sha256=4412f3ee70f6fe4546cc489548e0f6fcf76cafcfa80fa03af67098ffed755035
-  rubocop-require_tools (0.2.0)
+  rubocop-require_tools (0.3.0)
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
   unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
   unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f

data/lib/rubocop/cop/require/missing_require_statement.rb

@@ -16,7 +16,7 @@ module RuboCop
       #   require 'faraday'
       #
       #   Faraday.new
-      class MissingRequireStatement < Cop
+      class MissingRequireStatement < Base
         MSG = '`%<constant>s` not found, you\'re probably missing a require statement or there is a cycle in your dependencies.'.freeze
 
         attr_writer :timeline
@@ -26,7 +26,7 @@ module RuboCop
         end
 
         # Builds
-        def investigate(processed_source)
+        def on_new_investigation
           processing_methods = self.methods.select { |m| m.to_s.start_with? 'process_' }
 
           stack = [processed_source.ast]
@@ -63,19 +63,6 @@ module RuboCop
           end
         end
 
-        def add_offense(node, location: nil, message:)
-          # Work around breaking API changes between rubocop 0.49.1 and later (...)
-          signature_old = %i[node loc message severity]
-          param_info = RuboCop::Cop::Cop.instance_method(:add_offense).parameters
-          if param_info.map(&:last) == signature_old
-            super(node, location || :expression, message)
-          elsif location
-            super(node, location: location, message: message)
-          else
-            super(node, message: message)
-          end
-        end
-
         def_node_matcher :extract_inner_const, <<-PATTERN
           (const $!nil? _)
         PATTERN
@@ -102,11 +89,47 @@ module RuboCop
           return unless consts
           const_name = consts.join('::')
 
-          self.timeline << { event: :const_access, name: const_name, node: node }
+          self.timeline << { event: :const_access, name: const_name, node: node } unless guarded?(node, const_name)
 
           { skip: node.children }
         end
 
+        def_node_matcher :const_defined_check, <<-PATTERN
+          (send $_ :const_defined? ({str sym} $_) ...)
+        PATTERN
+
+        # True where a check that this very constant is defined has just passed: in the true branch of
+        # an `if`, or on the right of an `&&`. Code that tests for an optional dependency is not missing a
+        # require. A check on Foo does not cover Foo::Bar, which may still not be loaded.
+        def guarded?(node, const_name)
+          child = node
+          node.each_ancestor do |ancestor|
+            return true if ancestor.type == :defined? # defined?(Foo) is itself the check, and never raises
+
+            condition = ancestor.children[0] if (ancestor.if_type? || ancestor.and_type?) && child.equal?(ancestor.children[1])
+            return true if condition && checked_constants(condition).include?(const_name)
+
+            child = ancestor
+          end
+          false
+        end
+
+        def checked_constants(condition)
+          return condition.children.flat_map { |c| checked_constants(c) } if condition.and_type?
+
+          if (checked = const_defined_check(condition))
+            receiver, name = checked
+            return [] unless receiver&.const_type?
+
+            path = find_consts(receiver).join('::')
+            return [path == 'Object' ? name.to_s : "#{path}::#{name}"]
+          end
+
+          # `defined?` cannot be written as a node pattern: the pattern language reads it as a predicate
+          checked = condition.children.first if condition.type == :defined?
+          checked&.const_type? ? [find_consts(checked).join('::')] : []
+        end
+
         def_node_matcher :extract_const_assignment, <<-PATTERN
           (casgn nil? $_ ...)
         PATTERN
@@ -164,6 +187,20 @@ module RuboCop
           { skip: skip_list, push: push_list }
         end
 
+        def_node_matcher :extract_include, <<-PATTERN
+          (send nil? :include $(const ...))
+        PATTERN
+
+        # `include Foo` makes Foo's constants reachable unqualified in the enclosing class or module.
+        def process_include(node, _source)
+          return unless node.kind_of? RuboCop::AST::Node
+          included = extract_include(node)
+          return unless included
+
+          self.timeline << { event: :include, name: find_consts(included).join('::') }
+          nil
+        end
+
         def_node_matcher :extract_require, <<-PATTERN
           (send nil? ${:require :require_relative} (str $_))
         PATTERN
@@ -205,6 +242,8 @@ module RuboCop
                 err_indices = err_indices.reject { |e| outdated.include?(timeline[e]) }
               when :const_undef
                 state.undefine_const(const_name: event[:name])
+              when :include
+                state.include_module(name: event[:name])
               when :const_assign
                 state.const_assigned(const_name: event[:name], alias_target: event[:alias_target])
 

data/lib/rubocop/helper/state.rb

@@ -5,11 +5,13 @@ module RuboCop
       attr_accessor :defined_constants
       attr_accessor :const_stack
       attr_accessor :aliases
+      attr_accessor :included_modules
 
       def initialize
         self.defined_constants = []
         self.const_stack = []
         self.aliases = {}
+        self.included_modules = [] # [nesting depth, module name]
       end
 
       def require(file: nil)
@@ -56,6 +58,13 @@ module RuboCop
 
       def undefine_const(const_name: nil) # rubocop:disable Lint/UnusedMethodArgument
         self.const_stack.pop
+        self.included_modules.reject! { |depth, _| depth > self.const_stack.length }
+      end
+
+      def include_module(name: nil)
+        prefixes = self.const_stack.reduce([]) { |a, c| a << [a.last, c].compact.join('::') }
+        full_name = ([name] + prefixes.reverse.map { |prefix| "#{prefix}::#{name}" }).find { |n| Object.const_get(n) rescue nil }
+        self.included_modules << [self.const_stack.length, full_name || name]
       end
 
       def const_assigned(const_name: nil, alias_target: nil)
@@ -81,6 +90,7 @@ module RuboCop
         unless local_only
           result = Object.const_get(name) rescue nil                                                   # Defined elsewhere, top-level
           result ||= self.defined_constants.find { |c| Object.const_get("#{c}::#{name}") rescue nil }  # Defined elsewhere, nested
+          result ||= self.included_modules.map(&:last).find { |m| Object.const_get("#{m}::#{name}") rescue nil } # From an included module
         end
 
         result ||= self.defined_constants.find { |c| name == c }                                       # Defined in this file, other module/class

data/lib/rubocop/require_tools/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module RequireTools
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/rubocop-require_tools.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop', '>= 0.49.1'
+  spec.add_runtime_dependency 'rubocop', '>= 1.0'
 
   spec.add_development_dependency 'pry'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-require_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Manu Wallner
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement