eager_eye 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 251f5ec97df15b5f85cbea7b1be3b7c95961f6ed133f4a69b721d76ebd7ad40e
-  data.tar.gz: ce06033abc65e06113af34789bf17a97badcfe8076675a45bf5ee59f5e19af79
+  metadata.gz: a971d7fbafebc02b51a9767987541f67fdd216025ac04aa4bdf4f304cc3abad9
+  data.tar.gz: db6eeeb3e1f511856144c70031f63c5216c73b917c00a17a31dbcd44444757a8
 SHA512:
-  metadata.gz: 9f24578b9ec1a121b1698e3d53d78ec570b12b3f5092289ca42adc421c89cd1a94566e5de6ff45309803c0be2b8bafc76b1ea3e9f78599da32aef87503c51c38
-  data.tar.gz: 3f9dd3a3a3d4116840d8de2392e06afa78486ae049505f8706a7e5c9303d25e7efcf0ba7522b256bb9e504c1d8b709d93e06e92b1d0391cfd0e3bafdb7e00536
+  metadata.gz: b847b72aff2e758f0a32effdf68057c499503f97251802263d5a1109e5eac3afd8841044d5d144a48b351c4c0909789e5528574f911101f3949e8f78d015dd0a
+  data.tar.gz: 3938004802489b63234cc75ec7cfc79c580a0cf263c004762a63fb2d4d1a09350f49f158ab9f4e99cbe4a11b9a8772766be61531c1909d958bed5b82141b407c

data/CHANGELOG.md

@@ -7,6 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2025-12-15
+
+### Added
+
+- **New Detector: `CallbackQuery`** - Detects database queries and iterations inside ActiveRecord callbacks
+  - Identifies potential bulk operation performance issues
+  - Detects query methods (`.count`, `.sum`, `.update!`, etc.) in callbacks
+  - Detects iterations (`.each`, `.map`, etc.) in callbacks as errors
+  - Severity: `:error` for iterations in callbacks, `:warning` for query methods
+  - Suggests moving to background jobs or using conditional callbacks
+
+### Changed
+
+- Updated default `enabled_detectors` to include `:callback_query`
+- Updated README with new detector documentation
+
+## [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,76 @@ 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 |
+
+### 6. Callback Query Detection
+
+Detects database queries and iterations inside ActiveRecord callbacks. These become performance disasters during bulk operations.
+
+```ruby
+# Bad - Queries in callbacks
+class Article < ApplicationRecord
+  after_save :recalculate_stats
+
+  def recalculate_stats
+    author.articles.published.count  # Runs on EVERY save
+    category.update_article_count!   # Another query on EVERY save
+  end
+end
+
+# Disaster scenario
+Article.import(1000.times.map { |i| { title: "Post #{i}" } })
+# = 2000+ queries from callbacks!
+
+# Bad - N+1 in callback
+class Order < ApplicationRecord
+  after_create :notify_subscribers
+
+  def notify_subscribers
+    customer.followers.each do |follower|  # N+1!
+      NotificationMailer.new_order(follower).deliver_later
+    end
+  end
+end
+
+# Good - Use conditional callbacks
+after_save :recalculate_stats, if: :should_recalculate?
+
+# Good - Move to background job
+after_commit :schedule_stats_update, on: :create
+
+def schedule_stats_update
+  RecalculateStatsJob.perform_later(id)
+end
+```
+
 ## Configuration
 
 ### Config File (.eager_eye.yml)
@@ -192,6 +262,8 @@ enabled_detectors:
   - serializer_nesting
   - missing_counter_cache
   - custom_method_query
+  - count_in_iteration
+  - callback_query
 
 # Base path to analyze (default: app)
 app_path: app

data/lib/eager_eye/analyzer.rb

@@ -8,7 +8,9 @@ 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,
+      callback_query: Detectors::CallbackQuery
     }.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 callback_query
+    ].freeze
 
     def initialize
       @excluded_paths = []

data/lib/eager_eye/detectors/callback_query.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module EagerEye
+  module Detectors
+    class CallbackQuery < Base
+      CALLBACK_METHODS = %i[
+        before_validation after_validation
+        before_save after_save around_save
+        before_create after_create around_create
+        before_update after_update around_update
+        before_destroy after_destroy around_destroy
+        after_commit after_rollback
+        after_create_commit after_update_commit after_destroy_commit
+        after_save_commit
+      ].freeze
+
+      QUERY_INDICATORS = %i[
+        where find find_by find_by! first last take
+        exists? any? none? many? one?
+        count sum average minimum maximum
+        pluck ids select
+        update update_all update! update_attribute update_column update_columns
+        destroy destroy_all destroy! delete delete_all
+        create create! save save! insert insert_all insert! upsert upsert_all
+        increment! decrement! toggle!
+        reload
+      ].freeze
+
+      ITERATION_METHODS = %i[each map select find_all reject collect].freeze
+
+      def self.detector_name
+        :callback_query
+      end
+
+      def detect(ast, file_path)
+        @issues = []
+        @file_path = file_path
+        @callback_methods = {}
+
+        return @issues unless ast
+
+        find_callback_definitions(ast)
+        check_callback_methods(ast)
+
+        @issues
+      end
+
+      private
+
+      def find_callback_definitions(node)
+        return unless node.is_a?(Parser::AST::Node)
+
+        extract_callback_method_name(node) if callback_definition?(node)
+
+        node.children.each do |child|
+          find_callback_definitions(child)
+        end
+      end
+
+      def callback_definition?(node)
+        return false unless node.type == :send
+        return false unless node.children[0].nil?
+
+        method_name = node.children[1]
+        CALLBACK_METHODS.include?(method_name)
+      end
+
+      def extract_callback_method_name(node)
+        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
+        end
+      end
+
+      def check_callback_methods(node)
+        return unless node.is_a?(Parser::AST::Node)
+
+        if method_definition?(node)
+          method_name = node.children[0]
+          if @callback_methods.key?(method_name)
+            callback_type = @callback_methods[method_name]
+            check_method_body_for_queries(node, method_name, callback_type)
+          end
+        end
+
+        node.children.each do |child|
+          check_callback_methods(child)
+        end
+      end
+
+      def method_definition?(node)
+        node.type == :def
+      end
+
+      def check_method_body_for_queries(method_node, method_name, callback_type)
+        method_body = method_node.children[2]
+        return unless method_body
+
+        find_query_calls(method_body, method_name, callback_type)
+        find_iteration_with_queries(method_body, method_name, callback_type)
+      end
+
+      def find_query_calls(node, method_name, callback_type)
+        return unless node.is_a?(Parser::AST::Node)
+
+        add_query_issue(node, method_name, callback_type) if query_call?(node)
+
+        node.children.each do |child|
+          find_query_calls(child, method_name, callback_type)
+        end
+      end
+
+      def find_iteration_with_queries(node, method_name, callback_type)
+        return unless node.is_a?(Parser::AST::Node)
+
+        add_iteration_issue(node, method_name, callback_type) if iteration_block?(node)
+
+        node.children.each do |child|
+          find_iteration_with_queries(child, method_name, callback_type)
+        end
+      end
+
+      def query_call?(node)
+        return false unless node.type == :send
+
+        method = node.children[1]
+        QUERY_INDICATORS.include?(method)
+      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 add_query_issue(node, method_name, callback_type)
+        query_method = node.children[1]
+
+        @issues << create_issue(
+          file_path: @file_path,
+          line_number: node.loc.line,
+          message: "Query method `.#{query_method}` found in `#{callback_type}` callback `:#{method_name}`",
+          severity: :warning,
+          suggestion: "Callbacks run on every save/create/update. Consider moving to a background job"
+        )
+      end
+
+      def add_iteration_issue(node, method_name, callback_type)
+        @issues << create_issue(
+          file_path: @file_path,
+          line_number: node.loc.line,
+          message: "Iteration found in `#{callback_type}` callback `:#{method_name}` - potential N+1",
+          severity: :error,
+          suggestion: "Avoid iterations in callbacks. Use background jobs for bulk operations"
+        )
+      end
+    end
+  end
+end

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.4.0"
 end

data/lib/eager_eye.rb

@@ -8,6 +8,8 @@ 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/detectors/callback_query"
 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.4.0
 platform: ruby
 authors:
 - hamzagedikkaya
@@ -61,6 +61,8 @@ files:
 - lib/eager_eye/cli.rb
 - lib/eager_eye/configuration.rb
 - lib/eager_eye/detectors/base.rb
+- lib/eager_eye/detectors/callback_query.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