eager_eye 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2e83de186394077d36507bd9c14dbb356777bddff49689c602b43dc8d74b80
-  data.tar.gz: 5ee79306b8bd9f602e9f09ed1c62bf5adb5920d57104c486d8799a757458eb6f
+  metadata.gz: 44b2f46a77bcc0bb742c6d169cebb7be6b9a8b722b64044b153397fcf7686872
+  data.tar.gz: 25a589c3401fe25248b6fe429e0255e5d2d9ada9b50bd7bbf467ada161e0ca95
 SHA512:
-  metadata.gz: 36d9dabec10f32dcf21c88efdd5125e5f7146cf61e0e500adc4f3c5b57608303cf0002d7ac48c32eb87b8f163fa6c3125d53bce4e052e9c1dd178f244b69e2a3
-  data.tar.gz: 6bc77a99dd29179c9179010ff1c6bb195048115b3b72e545ec51d1af1d286a430a35b223a138fc78e66dbb0172d9e2ff2f39c9f9639be9edc97a47eb928e3df6
+  metadata.gz: 2ea1baa8c98a5362527e991d3712c0a3c0d821307a99e1b8b1a9a0ac76fbff5d4adcf4f4cd512990971956fcc3bd61ef97fb8c047d0b44609e4bd55ca385bfb4
+  data.tar.gz: 8d1590b243420e3ea3534290f15725a0aa70f3ea537aa7da05cd4648521fe284718965d27e4b00ac77ea277d4ca400107e49a18a7759780dd532c560ef1b91b3

data/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.9] - 2025-12-26
+
+### Added
+
+- **Inline Suppression Comments** - Suppress specific warnings with RuboCop-style inline comments
+  - `# eager_eye:disable-next-line` - Suppress next line
+  - `# eager_eye:disable CallbackQuery` - Suppress specific detector inline
+  - `# eager_eye:disable-block` / `# eager_eye:enable-block` - Suppress block of code
+  - `# eager_eye:disable-file DetectorName` - Suppress entire file
+  - Supports both CamelCase and snake_case detector names
+  - Can disable all detectors with `all` keyword
+
+### Improved
+
+- Enhanced README with table of contents and better organization
+- Improved code readability and documentation structure
+- Updated version badge to v1.0.9
+
 ## [1.0.8] - 2025-12-25
 
 ### 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.0.8-red.svg" alt="Gem Version"></a>
+  <a href="https://rubygems.org/gems/eager_eye"><img src="https://img.shields.io/badge/gem-v1.0.9-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>
@@ -23,6 +23,24 @@
 
 ---
 
+## Table of Contents
+- [Why EagerEye?](#why-eagereye)
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Detected Issues](#detected-issues)
+- [Inline Suppression](#inline-suppression)
+- [Auto-fix](#auto-fix-experimental)
+- [RSpec Integration](#rspec-integration)
+- [Configuration](#configuration)
+- [CI Integration](#ci-integration)
+- [CLI Reference](#cli-reference)
+- [Output Formats](#output-formats)
+- [Limitations](#limitations)
+- [VS Code Extension](#vs-code-extension)
+- [Development](#development)
+- [Contributing](#contributing)
+
 ## Why EagerEye?
 
 Unlike runtime tools like Bullet, EagerEye:
@@ -41,6 +59,28 @@ Unlike runtime tools like Bullet, EagerEye:
 | CI integration | Native | Requires tests |
 | False positive rate | Higher | Lower |
 
+## Features
+
+✨ **Detects 7 types of N+1 problems:**
+- Loop associations (queries in iterations)
+- Serializer nesting issues
+- Missing counter caches
+- Custom method queries (invisible to Bullet)
+- Count in iteration patterns
+- Callback query N+1s
+- Pluck to array misuse
+
+🔧 **Developer-friendly:**
+- Inline suppression (like RuboCop)
+- Auto-fix support (experimental)
+- JSON/Console output formats
+- RSpec integration
+
+🚀 **CI-ready:**
+- No test suite required
+- GitHub Actions examples included
+- Severity levels and filtering
+
 ## Installation
 
 Add to your Gemfile:

data/lib/eager_eye/comment_parser.rb

@@ -2,12 +2,12 @@
 
 module EagerEye
   class CommentParser
-    DISABLE_PATTERN = /eager_eye:disable(?:-next-line|-file)?\s+(.+?)(?:\s+--|$)/i
-    ENABLE_PATTERN = /eager_eye:enable\s+(.+?)(?:\s+--|$)/i
-    INLINE_DISABLE_PATTERN = /eager_eye:disable\s+(.+?)(?:\s+--|$)/i
     FILE_DISABLE_PATTERN = /eager_eye:disable-file\s+(.+?)(?:\s+--|$)/i
-    NEXT_LINE_PATTERN = /eager_eye:disable-next-line\s+(.+?)(?:\s+--|$)/i
-    BLOCK_DISABLE_PATTERN = /eager_eye:disable\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
 
     def initialize(source_code)
       @source_code = source_code.encode("UTF-8", invalid: :replace, undef: :replace)
@@ -46,39 +46,50 @@ module EagerEye
     def detect_directive(line, line_num)
       detect_file_directive(line, line_num) ||
         detect_next_line_directive(line) ||
-        detect_block_directive(line) ||
-        detect_enable_directive(line) ||
-        detect_inline_directive(line)
+        detect_block_end_directive(line) ||
+        detect_block_or_inline_directive(line)
     end
 
     def detect_file_directive(line, line_num)
       return unless line_num <= 5 && line =~ FILE_DISABLE_PATTERN
 
-      { type: :file, detectors: parse_detector_names(::Regexp.last_match(1)) }
+      detectors = parse_detector_names(::Regexp.last_match(1) || "all")
+      { type: :file, detectors: detectors }
     end
 
     def detect_next_line_directive(line)
       return unless line =~ NEXT_LINE_PATTERN
 
-      { type: :next_line, detectors: parse_detector_names(::Regexp.last_match(1)) }
+      detectors = parse_detector_names(::Regexp.last_match(1) || "all")
+      { type: :next_line, detectors: detectors }
     end
 
-    def detect_block_directive(line)
-      return unless line =~ BLOCK_DISABLE_PATTERN && !inline_disable?(line)
-
-      { type: :block_start, detectors: parse_detector_names(::Regexp.last_match(1)) }
-    end
-
-    def detect_enable_directive(line)
+    def detect_block_end_directive(line)
       return unless line =~ ENABLE_PATTERN
 
-      { type: :block_end, detectors: parse_detector_names(::Regexp.last_match(1)) }
+      detectors = parse_detector_names(::Regexp.last_match(1) || "all")
+      { type: :block_end, detectors: detectors }
     end
 
-    def detect_inline_directive(line)
+    def detect_block_or_inline_directive(line)
+      # Check for eager_eye:disable-block explicitly
+      if line =~ BLOCK_START_PATTERN && !code_before_comment?(line)
+        detectors = parse_detector_names(::Regexp.last_match(1) || "all")
+        return { type: :block_start, detectors: detectors }
+      end
+
+      # Check for eager_eye:disable (either inline or block start)
       return unless line =~ INLINE_DISABLE_PATTERN
 
-      { type: :inline, detectors: parse_detector_names(::Regexp.last_match(1)) }
+      detectors = parse_detector_names(::Regexp.last_match(1) || "all")
+
+      # If there's code before the comment, it's inline (same line only)
+      if code_before_comment?(line)
+        { type: :inline, detectors: detectors }
+      else
+        # No code before comment, so it's a block start
+        { type: :block_start, detectors: detectors }
+      end
     end
 
     def apply_directive(directive, line_num)
@@ -129,7 +140,14 @@ module EagerEye
       code_part && !code_part.strip.empty?
     end
 
+    def code_before_comment?(line)
+      code_part = line.split("#").first
+      code_part && !code_part.strip.empty?
+    end
+
     def parse_detector_names(str)
+      return ["all"] if str.nil? || str.strip.empty?
+
       str.split(/[,\s]+/).map(&:strip).reject(&:empty?).map do |name|
         normalize_detector_name(name)
       end

data/lib/eager_eye/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eager_eye
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - hamzagedikkaya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-25 00:00:00.000000000 Z
+date: 2025-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast