eager_eye 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 251f5ec97df15b5f85cbea7b1be3b7c95961f6ed133f4a69b721d76ebd7ad40e
-  data.tar.gz: ce06033abc65e06113af34789bf17a97badcfe8076675a45bf5ee59f5e19af79
+  metadata.gz: 037dbef0e4dc82641ae8c56bb8110f822900dd7afe76ddac6051b375bb547208
+  data.tar.gz: 1d0878ea0046406e264ddfa92d68ac0c9f1748aea4803d9a638554bb13ea77c9
 SHA512:
-  metadata.gz: 9f24578b9ec1a121b1698e3d53d78ec570b12b3f5092289ca42adc421c89cd1a94566e5de6ff45309803c0be2b8bafc76b1ea3e9f78599da32aef87503c51c38
-  data.tar.gz: 3f9dd3a3a3d4116840d8de2392e06afa78486ae049505f8706a7e5c9303d25e7efcf0ba7522b256bb9e504c1d8b709d93e06e92b1d0391cfd0e3bafdb7e00536
+  metadata.gz: b97082ff4f9176c773a1007e9045305ad4c1d9ae46898bc1969eb66e6dd9bb42605bf567875ba7ba429693b1cd61385274587c51d6d0dc0397fc15f304d49af7
+  data.tar.gz: ca8e47200e8d140361dfb57f37fff56616d1c75c284b19de43afeb2c1f179cdf506731866ccaf4b531e867877fd2815de2e6082134b8f6754bfe861068647ff4

data/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2025-12-15
+
+### Added
+
+- **New Detector: `CountInIteration`** - Detects `.count` usage inside iterations
+  - `.count` always executes a COUNT query, even on preloaded associations
+  - Suggests using `.size` instead (uses loaded collection when available)
+  - Suggests `counter_cache: true` for frequently accessed counts
+  - Helps prevent unnecessary COUNT queries when associations are already loaded
+
+### Changed
+
+- Updated default `enabled_detectors` to include `:count_in_iteration`
+- Updated README with new detector documentation and comparison table
+
 ## [0.2.0] - 2025-12-15
 
 ### Added

data/README.md

@@ -176,6 +176,35 @@ end
 
 **Detected methods:** `where`, `find_by`, `find_by!`, `exists?`, `find`, `first`, `last`, `take`, `pluck`, `ids`, `count`, `sum`, `average`, `minimum`, `maximum`
 
+### 5. Count in Iteration
+
+Detects `.count` called on associations inside loops. Unlike `.size`, `.count` always executes a COUNT query even when the association is preloaded.
+
+```ruby
+# Bad - COUNT query for each user, even with includes!
+@users = User.includes(:posts)
+@users.each do |user|
+  user.posts.count  # Executes: SELECT COUNT(*) FROM posts WHERE user_id = ?
+end
+
+# Good - Use .size (checks if loaded first)
+@users.each do |user|
+  user.posts.size   # No query - counts the loaded array
+end
+
+# Best - Use counter_cache for frequent counts
+# In Post model: belongs_to :user, counter_cache: true
+user.posts_count  # Just reads the column
+```
+
+**Key differences:**
+
+| Method | Loaded Collection | Not Loaded |
+|--------|------------------|------------|
+| `.count` | COUNT query | COUNT query |
+| `.size` | Array#size | COUNT query |
+| `.length` | Array#length | Loads all, then counts |
+
 ## Configuration
 
 ### Config File (.eager_eye.yml)
@@ -192,6 +221,7 @@ enabled_detectors:
   - serializer_nesting
   - missing_counter_cache
   - custom_method_query
+  - count_in_iteration
 
 # Base path to analyze (default: app)
 app_path: app

data/lib/eager_eye/analyzer.rb

@@ -8,7 +8,8 @@ module EagerEye
       loop_association: Detectors::LoopAssociation,
       serializer_nesting: Detectors::SerializerNesting,
       missing_counter_cache: Detectors::MissingCounterCache,
-      custom_method_query: Detectors::CustomMethodQuery
+      custom_method_query: Detectors::CustomMethodQuery,
+      count_in_iteration: Detectors::CountInIteration
     }.freeze
 
     attr_reader :paths, :issues

data/lib/eager_eye/configuration.rb

@@ -4,7 +4,10 @@ module EagerEye
   class Configuration
     attr_accessor :excluded_paths, :enabled_detectors, :app_path, :fail_on_issues
 
-    DEFAULT_DETECTORS = %i[loop_association serializer_nesting missing_counter_cache custom_method_query].freeze
+    DEFAULT_DETECTORS = %i[
+      loop_association serializer_nesting missing_counter_cache
+      custom_method_query count_in_iteration
+    ].freeze
 
     def initialize
       @excluded_paths = []

data/lib/eager_eye/detectors/count_in_iteration.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module EagerEye
+  module Detectors
+    class CountInIteration < Base
+      # count always executes a COUNT query
+      # size and length use memory when collection is loaded
+      COUNT_METHODS = %i[count].freeze
+
+      ITERATION_METHODS = %i[
+        each map select find_all reject collect
+        each_with_index each_with_object flat_map
+      ].freeze
+
+      def self.detector_name
+        :count_in_iteration
+      end
+
+      def detect(ast, file_path)
+        @issues = []
+        @file_path = file_path
+
+        return @issues unless ast
+
+        find_iteration_blocks(ast) do |block_body, block_var|
+          check_for_count_calls(block_body, block_var)
+        end
+
+        @issues
+      end
+
+      private
+
+      def find_iteration_blocks(node, &block)
+        return unless node.is_a?(Parser::AST::Node)
+
+        if iteration_block?(node)
+          block_var = extract_block_variable(node)
+          block_body = extract_block_body(node)
+          yield(block_body, block_var) if block_var && block_body
+        end
+
+        node.children.each do |child|
+          find_iteration_blocks(child, &block)
+        end
+      end
+
+      def iteration_block?(node)
+        return false unless node.type == :block
+
+        send_node = node.children[0]
+        return false unless send_node&.type == :send
+
+        method_name = send_node.children[1]
+        ITERATION_METHODS.include?(method_name)
+      end
+
+      def check_for_count_calls(node, block_var)
+        return unless node.is_a?(Parser::AST::Node)
+
+        add_issue(node) if count_on_association?(node, block_var)
+
+        node.children.each do |child|
+          check_for_count_calls(child, block_var)
+        end
+      end
+
+      def count_on_association?(node, block_var)
+        return false unless node.type == :send
+
+        method_name = node.children[1]
+        return false unless COUNT_METHODS.include?(method_name)
+
+        receiver = node.children[0]
+        association_call_on_block_var?(receiver, block_var)
+      end
+
+      def association_call_on_block_var?(node, block_var)
+        return false unless node.is_a?(Parser::AST::Node)
+        return false unless node.type == :send
+
+        receiver = node.children[0]
+        return false unless receiver.is_a?(Parser::AST::Node)
+
+        # post.comments.count -> receiver is post.comments
+        # post.comments -> receiver is post (lvar)
+        if receiver.type == :lvar && receiver.children[0] == block_var
+          true
+        elsif receiver.type == :send
+          # Nested: post.author.posts.count
+          chain_starts_with_block_var?(receiver, block_var)
+        else
+          false
+        end
+      end
+
+      def chain_starts_with_block_var?(node, block_var)
+        return false unless node.is_a?(Parser::AST::Node)
+
+        case node.type
+        when :lvar
+          node.children[0] == block_var
+        when :send
+          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]
+        return nil unless first_arg&.type == :arg
+
+        first_arg.children[0]
+      end
+
+      def extract_block_body(block_node)
+        block_node.children[2]
+      end
+
+      def add_issue(node)
+        receiver_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",
+          severity: :warning,
+          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

data/lib/eager_eye/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EagerEye
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/eager_eye.rb

@@ -8,6 +8,7 @@ require_relative "eager_eye/detectors/loop_association"
 require_relative "eager_eye/detectors/serializer_nesting"
 require_relative "eager_eye/detectors/missing_counter_cache"
 require_relative "eager_eye/detectors/custom_method_query"
+require_relative "eager_eye/detectors/count_in_iteration"
 require_relative "eager_eye/analyzer"
 require_relative "eager_eye/reporters/base"
 require_relative "eager_eye/reporters/console"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eager_eye
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - hamzagedikkaya
@@ -61,6 +61,7 @@ files:
 - lib/eager_eye/cli.rb
 - lib/eager_eye/configuration.rb
 - lib/eager_eye/detectors/base.rb
+- lib/eager_eye/detectors/count_in_iteration.rb
 - lib/eager_eye/detectors/custom_method_query.rb
 - lib/eager_eye/detectors/loop_association.rb
 - lib/eager_eye/detectors/missing_counter_cache.rb