eager_eye 1.2.5 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fa0e6e3acb2c37751e7ab49a58826a016a68c7a33cc6305ddb6b82d6787c462
-  data.tar.gz: af81d8c0cfde13914b00a9f64b4b1bef6731b12902a1358c7f27473c2ab9a68d
+  metadata.gz: dd5177a12d64b54cc6cd426440f79018da9ccc7dd931db70c491c9154bb385a1
+  data.tar.gz: dec16deb3b55ab821225d5d0e06a6fa308c41fd472dad405bf125c7e5839f2e0
 SHA512:
-  metadata.gz: a0e233e5c53c6ee3c7a32239ca20625a58deb1b385af022cb582433d02070f7b861873f44cef5fe786ede0307caee4105202e49844902e8d75e14039623bdc74
-  data.tar.gz: 238ca3ba9a777686867752bc4abbf1d10081d73215e3c0f7ed0e9360f7c380298b4736177c703f1c921fb22b4296e7544379bef69021408f9e9ad86280a3716c
+  metadata.gz: 4336421ff71269732f594163dc3dbe29ca70d1b10c19dd333d972ea63bff9da36a4e83a041263fa6f61d758c8b0551912e075e00ce8f05978ab59c7db698af41
+  data.tar.gz: 51de528f0dca6b3279c0cb1fe6f21e5c35592dda81220419c209d8d43faf35b41375cbfffd33a463546f5e81e4807f8c48268f618d8383c82a570f81da823efa

data/CHANGELOG.md

@@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.7] - 2026-03-10
+
+### Added
+
+- **New Detector: `ScopeChainNPlusOne`** - Detects scope calls on associations inside iterations
+  - Catches `post.comments.recent`, `post.comments.approved.count` patterns
+  - Parses model files for `scope :name, -> { ... }` declarations
+  - Flags known scope names called on association chains inside loops
+  - Each scope call executes a new query per iteration — suggests preloading or joined queries
+- **New Parser: `ScopeParser`** - Collects scope definitions from model files for cross-file detection
+
+## [1.2.6] - 2026-02-25
+
+### Changed
+
+- Extract shared class-inspection logic into `ClassInspector` concern to reduce duplication across detectors
+- Refactor all detectors to use `ClassInspector` for parent class and naming convention checks
+- Simplify `Analyzer` by removing redundant delegation and streamlining detector orchestration
+- Clean up `DelegationParser` with leaner parsing logic
+- Improve `Base` detector with consolidated helper methods
+- Streamline reporter classes (`Base`, `Console`) for clarity and consistency
+
+### Removed
+
+- Remove duplicated class-matching code from `CallbackQuery`, `CountInIteration`, `CustomMethodQuery`, `DecoratorNPlusOne`, `DelegationNPlusOne`, `LoopAssociation`, and `SerializerNesting`
+
 ## [1.2.5] - 2026-02-21
 
 ### Added

data/README.md

@@ -10,7 +10,7 @@
 
 <p align="center">
   <a href="https://github.com/hamzagedikkaya/eager_eye/actions/workflows/main.yml"><img src="https://github.com/hamzagedikkaya/eager_eye/actions/workflows/main.yml/badge.svg" alt="CI"></a>
-  <a href="https://rubygems.org/gems/eager_eye"><img src="https://img.shields.io/badge/gem-v1.2.5-red.svg" alt="Gem Version"></a>
+  <a href="https://rubygems.org/gems/eager_eye"><img src="https://img.shields.io/badge/gem-v1.2.7-red.svg" alt="Gem Version"></a>
   <a href="https://github.com/hamzagedikkaya/eager_eye"><img src="https://img.shields.io/badge/coverage-95%25-brightgreen.svg" alt="Coverage"></a>
   <a href="https://www.ruby-lang.org/"><img src="https://img.shields.io/badge/ruby-%3E%3D%203.1-ruby.svg" alt="Ruby"></a>
   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
@@ -42,7 +42,7 @@
 
 ## Features
 
-✨ **Detects 9 types of N+1 problems:**
+✨ **Detects 10 types of N+1 problems:**
 - Loop associations (queries in iterations)
 - Serializer nesting issues
 - Missing counter caches
@@ -52,6 +52,7 @@
 - Pluck to array misuse
 - Delegation N+1s (hidden via `delegate :method, to: :association`)
 - Decorator N+1s (Draper, SimpleDelegator, Presenter, ViewObject)
+- Scope chain N+1s (named scopes on associations in loops)
 
 🔧 **Developer-friendly:**
 - Inline suppression (like RuboCop)
@@ -398,6 +399,33 @@ Supports the following object references inside decorators:
 - `__getobj__` — SimpleDelegator standard
 - `source`, `model` — alternative Draper aliases
 
+### 10. Scope Chain N+1
+
+Detects named scope calls on associations inside iterations. Unlike explicit query methods (`.where`, `.find_by`) caught by `CustomMethodQuery`, named scopes (`.recent`, `.active`, `.published`) are invisible query triggers.
+
+```ruby
+# Model
+class Comment < ApplicationRecord
+  scope :recent, -> { where("created_at > ?", 1.week.ago) }
+  scope :approved, -> { where(approved: true) }
+end
+
+# Bad - scope call per iteration
+posts.each do |post|
+  post.comments.recent          # Query for each post!
+  post.comments.approved.count  # Query for each post!
+end
+
+# Good - preload and filter in Ruby
+posts.includes(:comments).each do |post|
+  post.comments.select { |c| c.created_at > 1.week.ago }
+end
+```
+
+EagerEye detects these by:
+1. Scanning model files for `scope :name, -> { ... }` declarations
+2. Flagging known scope names called on association chains inside iteration blocks
+
 ## Inline Suppression
 
 Suppress false positives using inline comments (RuboCop-style):
@@ -442,6 +470,7 @@ Both CamelCase and snake_case formats are accepted:
 | Pluck to Array | `PluckToArray` | `pluck_to_array` |
 | Delegation N+1 | `DelegationNPlusOne` | `delegation_n_plus_one` |
 | Decorator N+1 | `DecoratorNPlusOne` | `decorator_n_plus_one` |
+| Scope Chain N+1 | `ScopeChainNPlusOne` | `scope_chain_n_plus_one` |
 | All Detectors | `all` | `all` |
 
 ## Auto-fix (Experimental)
@@ -546,18 +575,20 @@ enabled_detectors:
   - pluck_to_array
   - delegation_n_plus_one
   - decorator_n_plus_one
+  - scope_chain_n_plus_one
 
 # Severity levels per detector (error, warning, info)
 severity_levels:
-  loop_association: error        # Definite N+1
+  loop_association: error          # Definite N+1
   serializer_nesting: warning
   custom_method_query: warning
   count_in_iteration: warning
   callback_query: warning
-  pluck_to_array: warning        # Optimization
-  delegation_n_plus_one: warning # Hidden delegation N+1
-  decorator_n_plus_one: warning  # Decorator/Presenter N+1
-  missing_counter_cache: info    # Suggestion
+  pluck_to_array: warning          # Optimization
+  delegation_n_plus_one: warning   # Hidden delegation N+1
+  decorator_n_plus_one: warning    # Decorator/Presenter N+1
+  scope_chain_n_plus_one: warning  # Scope chain on association
+  missing_counter_cache: info      # Suggestion
 
 # Minimum severity to report (default: info)
 min_severity: warning

data/lib/eager_eye/analyzer.rb

@@ -13,52 +13,50 @@ module EagerEye
       callback_query: Detectors::CallbackQuery,
       pluck_to_array: Detectors::PluckToArray,
       delegation_n_plus_one: Detectors::DelegationNPlusOne,
-      decorator_n_plus_one: Detectors::DecoratorNPlusOne
+      decorator_n_plus_one: Detectors::DecoratorNPlusOne,
+      scope_chain_n_plus_one: Detectors::ScopeChainNPlusOne
     }.freeze
 
-    attr_reader :paths, :issues, :association_preloads, :delegation_maps
+    attr_reader :paths, :issues, :association_preloads, :delegation_maps, :scope_maps
 
     def initialize(paths: nil)
       @paths = Array(paths || EagerEye.configuration.app_path)
       @issues = []
       @association_preloads = {}
       @delegation_maps = {}
+      @scope_maps = {}
     end
 
     def run
       @issues = []
-      collect_association_preloads
-      collect_delegation_maps
-      analyze_files
+      collect_model_metadata
+      ruby_files.each { |file_path| analyze_file(file_path) }
       @issues
     end
 
     private
 
-    def collect_association_preloads
+    def collect_model_metadata
       model_files.each do |file_path|
         ast = parse_source(File.read(file_path))
         next unless ast
 
-        parser = AssociationParser.new
-        parser.parse_model(ast, extract_model_name(file_path))
-        @association_preloads.merge!(parser.preloaded_associations)
-      end
-    rescue StandardError
-      nil
-    end
+        model_name = extract_model_name(file_path)
 
-    def collect_delegation_maps
-      model_files.each do |file_path|
-        ast = parse_source(File.read(file_path))
-        next unless ast
+        assoc_parser = AssociationParser.new
+        assoc_parser.parse_model(ast, model_name)
+        @association_preloads.merge!(assoc_parser.preloaded_associations)
 
-        parser = DelegationParser.new
-        parser.parse_model(ast, extract_model_name(file_path))
-        @delegation_maps.merge!(parser.delegation_maps)
+        deleg_parser = DelegationParser.new
+        deleg_parser.parse_model(ast, model_name)
+        @delegation_maps.merge!(deleg_parser.delegation_maps)
+
+        scope_parser = ScopeParser.new
+        scope_parser.parse_model(ast, model_name)
+        @scope_maps.merge!(scope_parser.scope_maps)
+      rescue Errno::ENOENT, Errno::EACCES
+        next
       end
-    rescue StandardError
-      nil
     end
 
     def model_files
@@ -66,25 +64,19 @@ module EagerEye
     end
 
     def extract_model_name(file_path)
-      File.basename(file_path, ".rb").camelize
+      name = File.basename(file_path, ".rb")
+      name.respond_to?(:camelize) ? name.camelize : name.split("_").map(&:capitalize).join
     end
 
-    def analyze_files
-      ruby_files.each { |file_path| analyze_file(file_path) }
+    def ruby_files
+      paths.flat_map { |path| resolve_path(path) }.reject { |file| excluded?(file) }
     end
 
-    def ruby_files
-      all_files = paths.flat_map do |path|
-        if File.file?(path)
-          [path]
-        elsif File.directory?(path)
-          Dir.glob(File.join(path, "**", "*.rb"))
-        else
-          Dir.glob(path)
-        end
-      end
+    def resolve_path(path)
+      return [path] if File.file?(path)
+      return Dir.glob(File.join(path, "**", "*.rb")) if File.directory?(path)
 
-      all_files.reject { |file| excluded?(file) }
+      Dir.glob(path)
     end
 
     def excluded?(file_path)
@@ -103,9 +95,10 @@ module EagerEye
 
       enabled_detectors.each do |detector|
         file_issues = detector.detect(*detector_args(detector, ast, file_path))
-        file_issues.reject! { |issue| comment_parser.disabled_at?(issue.line_number, issue.detector) }
-        file_issues.select! { |issue| issue.meets_minimum_severity?(min_severity) }
-        @issues.concat(file_issues)
+        @issues.concat(file_issues.select do |issue|
+          !comment_parser.disabled_at?(issue.line_number, issue.detector) &&
+            issue.meets_minimum_severity?(min_severity)
+        end)
       end
     rescue Errno::ENOENT, Errno::EACCES => e
       warn "EagerEye: Could not read file #{file_path}: #{e.message}"
@@ -121,13 +114,13 @@ module EagerEye
       args = [ast, file_path]
       args << @association_preloads if detector.is_a?(Detectors::LoopAssociation)
       args << @delegation_maps if detector.is_a?(Detectors::DelegationNPlusOne)
+      args << @scope_maps if detector.is_a?(Detectors::ScopeChainNPlusOne)
       args
     end
 
     def enabled_detectors
       @enabled_detectors ||= EagerEye.configuration.enabled_detectors.filter_map do |name|
-        detector_class = DETECTOR_CLASSES[name]
-        detector_class&.new
+        DETECTOR_CLASSES[name]&.new
       end
     end
   end

data/lib/eager_eye/comment_parser.rb

@@ -5,7 +5,6 @@ module EagerEye
     FILE_DISABLE_PATTERN = /eager_eye:disable-file\s+(.+?)(?:\s+--|$)/i
     NEXT_LINE_PATTERN = /eager_eye:disable-next-line(?:\s+(.+?))?(?:\s+--|$)/i
     BLOCK_START_PATTERN = /eager_eye:disable-block(?:\s+(.+?))?(?:\s+--|$)/i
-    BLOCK_END_PATTERN = /eager_eye:enable-block(?:\s+(.+?))?(?:\s+--|$)/i
     INLINE_DISABLE_PATTERN = /eager_eye:disable\s+(.+?)(?:\s+--|$)/i
     ENABLE_PATTERN = /eager_eye:enable(?:\s+(.+?))?(?:\s+--|$)/i
 

data/lib/eager_eye/configuration.rb

@@ -9,6 +9,7 @@ module EagerEye
       loop_association serializer_nesting missing_counter_cache
       custom_method_query count_in_iteration callback_query
       pluck_to_array delegation_n_plus_one decorator_n_plus_one
+      scope_chain_n_plus_one
     ].freeze
 
     DEFAULT_SEVERITY_LEVELS = {
@@ -20,7 +21,8 @@ module EagerEye
       callback_query: :warning,
       pluck_to_array: :warning,
       delegation_n_plus_one: :warning,
-      decorator_n_plus_one: :warning
+      decorator_n_plus_one: :warning,
+      scope_chain_n_plus_one: :warning
     }.freeze
 
     VALID_SEVERITIES = %i[info warning error].freeze

data/lib/eager_eye/delegation_parser.rb

@@ -24,50 +24,42 @@ module EagerEye
     end
 
     def check_delegate(node, model_name)
-      return unless bare_delegate_call?(node)
+      return unless delegate_call?(node)
 
       args = node.children[2..]
-      methods = delegate_methods(args)
+      methods = extract_sym_args(args)
       return if methods.empty?
 
       to_target = extract_to_target(args)
       return unless to_target
 
-      register_delegates(model_name, methods, to_target)
+      @delegation_maps[model_name] ||= {}
+      methods.each { |m| @delegation_maps[model_name][m] = to_target }
     end
 
-    def bare_delegate_call?(node)
+    def delegate_call?(node)
       node.type == :send && node.children[0].nil? && node.children[1] == :delegate
     end
 
-    def delegate_methods(args)
+    def extract_sym_args(args)
       args.select { |a| a&.type == :sym }.map { |a| a.children[0] }
     end
 
-    def register_delegates(model_name, methods, to_target)
-      @delegation_maps[model_name] ||= {}
-      methods.each { |m| @delegation_maps[model_name][m] = to_target }
-    end
-
     def extract_to_target(args)
       hash_arg = args.find { |a| a&.type == :hash }
       return unless hash_arg
 
-      to_pair = hash_arg.children.find { |p| to_key_pair?(p) }
-      extract_sym_value(to_pair)
-    end
-
-    def extract_sym_value(node)
-      return unless node
+      to_pair = find_to_pair(hash_arg)
+      return unless to_pair
 
-      value = node.children[1]
+      value = to_pair.children[1]
       value.children[0] if value&.type == :sym
     end
 
-    def to_key_pair?(pair)
-      pair.type == :pair &&
-        pair.children[0]&.type == :sym &&
-        pair.children[0].children[0] == :to
+    def find_to_pair(hash_node)
+      hash_node.children.find do |p|
+        p.type == :pair && p.children[0]&.type == :sym && p.children[0].children[0] == :to
+      end
     end
   end
 end

data/lib/eager_eye/detectors/base.rb

@@ -22,13 +22,12 @@ module EagerEye
       protected
 
       def create_issue(file_path:, line_number:, message:, severity: nil, suggestion: nil)
-        resolved_severity = severity || configured_severity
         Issue.new(
           detector: self.class.detector_name,
           file_path: file_path,
           line_number: line_number,
           message: message,
-          severity: resolved_severity,
+          severity: severity || configured_severity,
           suggestion: suggestion
         )
       end
@@ -73,6 +72,34 @@ module EagerEye
           symbols.add(key.children[0]) if key&.type == :sym
         end
       end
+
+      def extract_block_variable(block_node)
+        args = block_node&.children&.[](1)
+        first_arg = args&.children&.first
+        first_arg&.type == :arg ? first_arg.children[0] : nil
+      end
+
+      def receiver_chain_starts_with?(node, target_var)
+        return false unless node.is_a?(Parser::AST::Node)
+
+        case node.type
+        when :lvar then node.children[0] == target_var
+        when :send then receiver_chain_starts_with?(node.children[0], target_var)
+        else false
+        end
+      end
+
+      def reconstruct_chain(node)
+        return "" unless node.is_a?(Parser::AST::Node)
+
+        case node.type
+        when :lvar then node.children[0].to_s
+        when :send
+          receiver_str = reconstruct_chain(node.children[0])
+          receiver_str.empty? ? node.children[1].to_s : "#{receiver_str}.#{node.children[1]}"
+        else ""
+        end
+      end
     end
   end
 end

data/lib/eager_eye/detectors/callback_query.rb

@@ -41,7 +41,6 @@ module EagerEye
         @issues = []
         @file_path = file_path
         @callback_methods = {}
-
         return @issues unless ast
 
         find_callback_definitions(ast)
@@ -67,9 +66,7 @@ module EagerEye
         node.children[2..].each do |arg|
           next unless arg.is_a?(Parser::AST::Node) && arg.type == :sym
 
-          method_name = arg.children[0]
-          callback_type = node.children[1]
-          @callback_methods[method_name] = callback_type
+          @callback_methods[arg.children[0]] = node.children[1]
         end
       end
 
@@ -77,9 +74,8 @@ module EagerEye
         return unless node.is_a?(Parser::AST::Node)
 
         if node.type == :def && @callback_methods.key?(node.children[0])
-          method_name = node.children[0]
           body = node.children[2]
-          find_iterations_with_queries(body, method_name, @callback_methods[method_name]) if body
+          find_iterations_with_queries(body, node.children[0], @callback_methods[node.children[0]]) if body
         end
 
         node.children.each { |child| check_callback_methods(child) }
@@ -131,7 +127,6 @@ module EagerEye
       end
 
       def add_query_issue(node, method_name, callback_type)
-        query_method = node.children[1]
         suggestion = if transactional_callback?(callback_type)
                        "Callbacks run on every save/create/update. Move the query outside the iteration or preload data"
                      else
@@ -141,7 +136,7 @@ module EagerEye
         @issues << create_issue(
           file_path: @file_path,
           line_number: node.loc.line,
-          message: "Query method `.#{query_method}` found in `#{callback_type}` callback `:#{method_name}`",
+          message: "Query method `.#{node.children[1]}` found in `#{callback_type}` callback `:#{method_name}`",
           severity: :warning,
           suggestion: suggestion
         )
@@ -167,29 +162,6 @@ module EagerEye
         TRANSACTIONAL_CALLBACKS.include?(callback_type)
       end
 
-      def extract_block_variable(block_node)
-        args_node = block_node.children[1]
-        return nil unless args_node&.type == :args
-
-        first_arg = args_node.children[0]
-        return nil unless first_arg&.type == :arg
-
-        first_arg.children[0]
-      end
-
-      def receiver_chain_starts_with?(node, block_var)
-        return false unless node.is_a?(Parser::AST::Node)
-
-        case node.type
-        when :lvar
-          node.children[0] == block_var
-        when :send
-          receiver_chain_starts_with?(node.children[0], block_var)
-        else
-          false
-        end
-      end
-
       def non_ar_collection?(node)
         ns = root_namespace(node)
         ns && NON_AR_NAMESPACES.include?(ns)
@@ -199,10 +171,8 @@ module EagerEye
         return nil unless node.is_a?(Parser::AST::Node)
 
         case node.type
-        when :const
-          node.children[0].nil? ? node.children[1].to_s : root_namespace(node.children[0])
-        when :send, :block
-          root_namespace(node.children[0])
+        when :const then node.children[0].nil? ? node.children[1].to_s : root_namespace(node.children[0])
+        when :send, :block then root_namespace(node.children[0])
         end
       end
 

data/lib/eager_eye/detectors/concerns/class_inspector.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module EagerEye
+  module Detectors
+    module Concerns
+      module ClassInspector
+        HAS_MANY_ASSOCIATIONS = %w[
+          authors users owners creators admins members customers clients
+          posts articles comments categories tags children companies organizations
+          projects tasks items orders products accounts profiles settings
+          images avatars photos attachments documents
+        ].freeze
+
+        ACTIVE_STORAGE_METHODS = %i[
+          attached? attach attachment attachments blob blobs purge purge_later variant preview
+        ].freeze
+
+        private
+
+        def const_to_string(node)
+          return nil unless node&.type == :const
+
+          parts = []
+          current = node
+          while current&.type == :const
+            parts.unshift(current.children[1].to_s)
+            current = current.children[0]
+          end
+          parts.join("::")
+        end
+
+        def extract_class_name(class_node)
+          name_node = class_node.children[0]
+          name_node.children[1].to_s if name_node&.type == :const
+        end
+
+        def likely_association?(method_name)
+          HAS_MANY_ASSOCIATIONS.include?(method_name.to_s)
+        end
+
+        def collect_active_storage_lines(body)
+          lines = Set.new
+          traverse_ast(body) do |node|
+            lines << node.loc.line if node.type == :send && ACTIVE_STORAGE_METHODS.include?(node.children[1])
+          end
+          lines
+        end
+      end
+    end
+  end
+end

data/lib/eager_eye/detectors/count_in_iteration.rb

@@ -15,7 +15,6 @@ module EagerEye
       def detect(ast, file_path)
         @issues = []
         @file_path = file_path
-
         return @issues unless ast
 
         find_iteration_blocks(ast) do |block_body, block_var|
@@ -60,64 +59,23 @@ module EagerEye
       def array_returning_method?(node)
         return false unless node.is_a?(Parser::AST::Node) && node.type == :send
 
-        method_name = node.children[1].to_s
-        ARRAY_METHOD_SUFFIXES.any? { |suffix| method_name.end_with?(suffix) }
+        ARRAY_METHOD_SUFFIXES.any? { |suffix| node.children[1].to_s.end_with?(suffix) }
       end
 
       def association_call_on_block_var?(node, block_var)
-        return false unless node.is_a?(Parser::AST::Node) && node.type == :send
-
-        receiver = node.children[0]
-        return false unless receiver.is_a?(Parser::AST::Node)
-
-        return true if receiver.type == :lvar && receiver.children[0] == block_var
-
-        receiver.type == :send && chain_starts_with_block_var?(receiver, block_var)
-      end
-
-      def chain_starts_with_block_var?(node, block_var)
-        return false unless node.is_a?(Parser::AST::Node)
-
-        case node.type
-        when :lvar then node.children[0] == block_var
-        when :send then chain_starts_with_block_var?(node.children[0], block_var)
-        else false
-        end
-      end
-
-      def extract_block_variable(block_node)
-        args_node = block_node.children[1]
-        return nil unless args_node&.type == :args
-
-        first_arg = args_node.children[0]
-        first_arg&.type == :arg ? first_arg.children[0] : nil
+        node.is_a?(Parser::AST::Node) && node.type == :send &&
+          receiver_chain_starts_with?(node.children[0], block_var)
       end
 
       def add_issue(node)
-        receiver_chain = reconstruct_chain(node.children[0])
-
+        chain = reconstruct_chain(node.children[0])
         @issues << create_issue(
           file_path: @file_path,
           line_number: node.loc.line,
-          message: "`.count` called on `#{receiver_chain}` inside iteration always executes a COUNT query",
+          message: "`.count` called on `#{chain}` inside iteration always executes a COUNT query",
           suggestion: "Use `.size` instead (uses loaded collection) or add `counter_cache: true`"
         )
       end
-
-      def reconstruct_chain(node)
-        return "" unless node.is_a?(Parser::AST::Node)
-
-        case node.type
-        when :lvar
-          node.children[0].to_s
-        when :send
-          receiver_str = reconstruct_chain(node.children[0])
-          method = node.children[1]
-          receiver_str.empty? ? method.to_s : "#{receiver_str}.#{method}"
-        else
-          ""
-        end
-      end
     end
   end
 end