eager_eye 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 031e0f3547538856718932cd6121ac990ad8c11a43682ec076f68bb591943d55
-  data.tar.gz: 433563980a743704c361304dff56866fe4cc9795a1d6f927cd0b4a8fc0367c8f
+  metadata.gz: a8d34dc13a536c66ca82e9495ba5e53b81c31f1e2764dea3ba8d64c434da69ec
+  data.tar.gz: d63753e0d80c366cc9b87fe6bcc5bc2f2ee1ba537e7363c2b6aadafffd5a4a05
 SHA512:
-  metadata.gz: 5c9f874001fb0c71eb8c1858ef2739181482992b7455925afc696acfa1b7bebfa91888d305936ab6189f64ea1542afd7844b95c4ba453218d0c706d40d17304b
-  data.tar.gz: 93750c566392f234cb5009d30873130182a4e80722b9f29402b662caacc0c961a31a8c109937c378f9a04b3d0f6e134326a0edeb0d138255debc2c9fb4ceb9a3
+  metadata.gz: bf3ff2ba24314b8b6e22385c82685d8909729f12ffc9d48531bd7fe4c6a1683e2aadb5692934ec300430dfdbc0cde795489e9a68a98072658a9452cd8e6e338b
+  data.tar.gz: fd73786c8c983b2bcc3d3860bf1036dc1525523dcce8ef06767760dfce57b813ee415679fa42cc7631830e8c4780f0bbbdecc61ae4563b964a983ada5c2c0d42

data/CHANGELOG.md

@@ -7,6 +7,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2025-12-15
+
+### Added
+
+- **Auto-fix Suggestions (Experimental)** - Automatic fix capabilities for simple issues
+  - `--suggest-fixes` flag to show auto-fix suggestions in diff format
+  - `--fix` flag to apply auto-fixes interactively
+  - `--fix --force` to apply all fixes without confirmation
+  - Fixer for `.count` → `.size` transformation in iterations
+  - Fixer for inline `.pluck(:id)` → `.select(:id)` transformation
+
+### Note
+
+Auto-fix is experimental. Not all issues are auto-fixable. Always review changes and run your test suite after applying fixes.
+
+## [0.6.0] - 2025-12-15
+
+### Added
+
+- **Inline Suppression Comments** - RuboCop-style comment directives for suppressing false positives
+  - `# eager_eye:disable DetectorName` - Disable for single line (inline) or start block
+  - `# eager_eye:disable-next-line DetectorName` - Disable only the next line
+  - `# eager_eye:disable-file DetectorName` - Disable for entire file (must be in first 5 lines)
+  - `# eager_eye:enable DetectorName` - End a disable block
+  - Support for multiple detectors: `# eager_eye:disable LoopAssociation, CountInIteration`
+  - Support for reason comments: `# eager_eye:disable DetectorName -- reason here`
+  - `all` keyword to disable all detectors at once
+  - Both CamelCase (`LoopAssociation`) and snake_case (`loop_association`) detector names accepted
+
+### Changed
+
+- Updated README with inline suppression documentation
+- Added `CommentParser` module for parsing suppression directives
+
 ## [0.5.0] - 2025-12-15
 
 ### Added

data/README.md

@@ -272,6 +272,92 @@ Post.where(user_id: User.active.select(:id))
 | `pluck` + `where` | 2 | ~80KB for IDs | ~45ms |
 | `select` subquery | 1 | None | ~20ms |
 
+## Inline Suppression
+
+Suppress false positives using inline comments (RuboCop-style):
+
+```ruby
+# Disable for single line
+user.posts.count  # eager_eye:disable CountInIteration
+
+# Disable for next line
+# eager_eye:disable-next-line LoopAssociation
+@users.each { |u| u.profile }
+
+# Disable block
+# eager_eye:disable LoopAssociation, SerializerNesting
+@users.each do |user|
+  user.posts.each { |p| p.author }
+end
+# eager_eye:enable LoopAssociation, SerializerNesting
+
+# Disable entire file (must be in first 5 lines)
+# eager_eye:disable-file CustomMethodQuery
+
+# With reason
+user.posts.count  # eager_eye:disable CountInIteration -- using counter_cache
+
+# Disable all detectors
+# eager_eye:disable all
+```
+
+### Available Detector Names
+
+Both CamelCase and snake_case formats are accepted:
+
+| Detector | CamelCase | snake_case |
+|----------|-----------|------------|
+| Loop Association | `LoopAssociation` | `loop_association` |
+| Serializer Nesting | `SerializerNesting` | `serializer_nesting` |
+| Missing Counter Cache | `MissingCounterCache` | `missing_counter_cache` |
+| Custom Method Query | `CustomMethodQuery` | `custom_method_query` |
+| Count in Iteration | `CountInIteration` | `count_in_iteration` |
+| Callback Query | `CallbackQuery` | `callback_query` |
+| Pluck to Array | `PluckToArray` | `pluck_to_array` |
+| All Detectors | `all` | `all` |
+
+## Auto-fix (Experimental)
+
+EagerEye can automatically fix some simple issues:
+
+```bash
+# Show fix suggestions
+eager_eye --suggest-fixes
+
+# Apply fixes interactively
+eager_eye --fix
+
+# Apply all fixes without confirmation
+eager_eye --fix --force
+```
+
+### Currently Supported Auto-fixes
+
+| Issue | Fix |
+|-------|-----|
+| `.count` in iteration | → `.size` |
+| `.pluck(:id)` inline | → `.select(:id)` |
+
+### Example
+
+```
+$ eager_eye --suggest-fixes
+
+app/controllers/posts_controller.rb:
+  Line 15:
+    - user.posts.count
+    + user.posts.size
+
+$ eager_eye --fix
+app/controllers/posts_controller.rb:15
+  - user.posts.count
+  + user.posts.size
+Apply this fix? [y/n/q] y
+  Applied
+```
+
+> **Warning:** Auto-fix is experimental. Always review changes and run your test suite after applying fixes.
+
 ## Configuration
 
 ### Config File (.eager_eye.yml)

data/lib/eager_eye/analyzer.rb

@@ -58,8 +58,16 @@ module EagerEye
       ast = parse_source(source)
       return unless ast
 
+      comment_parser = CommentParser.new(source)
+
       enabled_detectors.each do |detector|
         file_issues = detector.detect(ast, file_path)
+
+        # Filter suppressed issues
+        file_issues.reject! do |issue|
+          comment_parser.disabled_at?(issue.line_number, issue.detector)
+        end
+
         @issues.concat(file_issues)
       end
     rescue Errno::ENOENT, Errno::EACCES => e

data/lib/eager_eye/auto_fixer.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module EagerEye
+  class AutoFixer
+    def initialize(issues, interactive: true)
+      @issues = issues
+      @interactive = interactive
+      @files_cache = {}
+    end
+
+    def run
+      fixes = collect_fixes
+      return puts "No auto-fixable issues found." if fixes.empty?
+
+      if @interactive
+        apply_interactively(fixes)
+      else
+        apply_all(fixes)
+      end
+    end
+
+    def suggest
+      fixes = collect_fixes
+      return puts "No auto-fixable issues found." if fixes.empty?
+
+      fixes.group_by { |f| f[:file] }.each do |file, file_fixes|
+        puts "\n#{file}:"
+        file_fixes.each do |fix|
+          puts "  Line #{fix[:line]}:"
+          puts "    - #{fix[:original]}"
+          puts "    + #{fix[:fixed]}"
+        end
+      end
+    end
+
+    private
+
+    def collect_fixes
+      @issues.filter_map do |issue|
+        source = read_file(issue.file_path)
+        fixer = FixerRegistry.fixer_for(issue, source)
+        next unless fixer&.fixable?
+
+        fixer.diff
+      end.compact
+    end
+
+    def read_file(path)
+      @files_cache[path] ||= File.read(path)
+    end
+
+    def apply_interactively(fixes)
+      fixes.each do |fix|
+        puts "\n#{fix[:file]}:#{fix[:line]}"
+        puts "  - #{fix[:original]}"
+        puts "  + #{fix[:fixed]}"
+        print "Apply this fix? [y/n/q] "
+
+        response = $stdin.gets&.chomp&.downcase
+        case response
+        when "y"
+          apply_fix(fix)
+          puts "  Applied"
+        when "q"
+          puts "Aborted."
+          break
+        else
+          puts "  Skipped"
+        end
+      end
+    end
+
+    def apply_all(fixes)
+      # Group by file to minimize file operations
+      fixes.group_by { |f| f[:file] }.each do |file, file_fixes|
+        lines = File.readlines(file)
+
+        file_fixes.sort_by { |f| -f[:line] }.each do |fix|
+          lines[fix[:line] - 1] = "#{fix[:fixed]}\n"
+        end
+
+        File.write(file, lines.join)
+        puts "Fixed #{file_fixes.size} issue(s) in #{file}"
+      end
+    end
+
+    def apply_fix(fix)
+      lines = File.readlines(fix[:file])
+      lines[fix[:line] - 1] = "#{fix[:fixed]}\n"
+      File.write(fix[:file], lines.join)
+    end
+  end
+end

data/lib/eager_eye/cli.rb

@@ -16,6 +16,19 @@ module EagerEye
       return 0 if options[:help] || options[:version]
 
       issues = analyze
+
+      if options[:suggest_fixes]
+        fixer = AutoFixer.new(issues)
+        fixer.suggest
+        return 0
+      end
+
+      if options[:fix]
+        fixer = AutoFixer.new(issues, interactive: !options[:force])
+        fixer.run
+        return 0
+      end
+
       output_report(issues)
       exit_code(issues)
     end
@@ -31,7 +44,10 @@ module EagerEye
         fail_on_issues: true,
         colorize: $stdout.tty?,
         help: false,
-        version: false
+        version: false,
+        suggest_fixes: false,
+        fix: false,
+        force: false
       }
     end
 
@@ -50,35 +66,66 @@ module EagerEye
         opts.separator ""
         opts.separator "Options:"
 
-        opts.on("-f", "--format FORMAT", %i[console json], "Output format (console, json)") do |format|
-          options[:format] = format
-        end
+        add_output_options(opts)
+        add_filter_options(opts)
+        add_behavior_options(opts)
+        add_info_options(opts)
+        add_fix_options(opts)
+      end
+    end
 
-        opts.on("-e", "--exclude PATTERN", "Exclude files matching pattern (can be used multiple times)") do |pattern|
-          options[:exclude] << pattern
-        end
+    def add_output_options(opts)
+      opts.on("-f", "--format FORMAT", %i[console json], "Output format (console, json)") do |format|
+        options[:format] = format
+      end
 
-        opts.on("-o", "--only DETECTORS", "Run only specified detectors (comma-separated)") do |detectors|
-          options[:only] = detectors.split(",").map(&:strip).map(&:to_sym)
-        end
+      opts.on("--no-color", "Disable colored output") do
+        options[:colorize] = false
+      end
+    end
 
-        opts.on("--no-fail", "Exit with 0 even if issues found") do
-          options[:fail_on_issues] = false
-        end
+    def add_filter_options(opts)
+      opts.on("-e", "--exclude PATTERN", "Exclude files matching pattern") do |pattern|
+        options[:exclude] << pattern
+      end
 
-        opts.on("--no-color", "Disable colored output") do
-          options[:colorize] = false
-        end
+      opts.on("-o", "--only DETECTORS", "Run only specified detectors (comma-separated)") do |detectors|
+        options[:only] = detectors.split(",").map(&:strip).map(&:to_sym)
+      end
+    end
 
-        opts.on("-v", "--version", "Show version") do
-          puts "EagerEye #{EagerEye::VERSION}"
-          options[:version] = true
-        end
+    def add_behavior_options(opts)
+      opts.on("--no-fail", "Exit with 0 even if issues found") do
+        options[:fail_on_issues] = false
+      end
+    end
+
+    def add_info_options(opts)
+      opts.on("-v", "--version", "Show version") do
+        puts "EagerEye #{EagerEye::VERSION}"
+        options[:version] = true
+      end
+
+      opts.on("-h", "--help", "Show this help message") do
+        puts opts
+        options[:help] = true
+      end
+    end
+
+    def add_fix_options(opts)
+      opts.separator ""
+      opts.separator "Auto-fix options (experimental):"
+
+      opts.on("--suggest-fixes", "Show auto-fix suggestions") do
+        options[:suggest_fixes] = true
+      end
+
+      opts.on("--fix", "Apply auto-fixes interactively") do
+        options[:fix] = true
+      end
 
-        opts.on("-h", "--help", "Show this help message") do
-          puts opts
-          options[:help] = true
-        end
+      opts.on("--force", "Apply fixes without confirmation (use with --fix)") do
+        options[:force] = true
       end
     end
 

data/lib/eager_eye/comment_parser.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+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
+
+    def initialize(source_code)
+      @source_code = source_code
+      @lines = source_code.lines
+      @disabled_ranges = Hash.new { |h, k| h[k] = [] }
+      @file_disabled = Set.new
+      @current_disabled = Set.new
+      parse_comments
+    end
+
+    def disabled_at?(line_number, detector_name)
+      return true if @file_disabled.include?(detector_name.to_s)
+      return true if @file_disabled.include?("all")
+
+      detector = detector_name.to_s
+      @disabled_ranges[detector].any? { |range| range.cover?(line_number) } ||
+        @disabled_ranges["all"].any? { |range| range.cover?(line_number) }
+    end
+
+    private
+
+    def parse_comments
+      @lines.each_with_index do |line, index|
+        line_num = index + 1
+        process_line(line, line_num)
+      end
+
+      close_unclosed_blocks
+    end
+
+    def process_line(line, line_num)
+      directive = detect_directive(line, line_num)
+      apply_directive(directive, line_num) if directive
+    end
+
+    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)
+    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)) }
+    end
+
+    def detect_next_line_directive(line)
+      return unless line =~ NEXT_LINE_PATTERN
+
+      { type: :next_line, detectors: parse_detector_names(::Regexp.last_match(1)) }
+    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)
+      return unless line =~ ENABLE_PATTERN
+
+      { type: :block_end, detectors: parse_detector_names(::Regexp.last_match(1)) }
+    end
+
+    def detect_inline_directive(line)
+      return unless line =~ INLINE_DISABLE_PATTERN
+
+      { type: :inline, detectors: parse_detector_names(::Regexp.last_match(1)) }
+    end
+
+    def apply_directive(directive, line_num)
+      case directive[:type]
+      when :file then apply_file_disable(directive[:detectors])
+      when :next_line then apply_next_line_disable(directive[:detectors], line_num)
+      when :block_start then apply_block_start(directive[:detectors], line_num)
+      when :block_end then apply_block_end(directive[:detectors], line_num)
+      when :inline then apply_inline_disable(directive[:detectors], line_num)
+      end
+    end
+
+    def apply_file_disable(detectors)
+      @file_disabled.merge(detectors)
+    end
+
+    def apply_next_line_disable(detectors, line_num)
+      next_line = line_num + 1
+      detectors.each { |d| @disabled_ranges[d] << (next_line..next_line) }
+    end
+
+    def apply_block_start(detectors, line_num)
+      detectors.each { |d| @current_disabled << { detector: d, start: line_num } }
+    end
+
+    def apply_block_end(detectors, line_num)
+      detectors.each do |d|
+        entry = @current_disabled.find { |e| e[:detector] == d }
+        next unless entry
+
+        @disabled_ranges[d] << (entry[:start]..line_num)
+        @current_disabled.delete(entry)
+      end
+    end
+
+    def apply_inline_disable(detectors, line_num)
+      detectors.each { |d| @disabled_ranges[d] << (line_num..line_num) }
+    end
+
+    def close_unclosed_blocks
+      @current_disabled.each do |entry|
+        @disabled_ranges[entry[:detector]] << (entry[:start]..@lines.size)
+      end
+    end
+
+    def inline_disable?(line)
+      code_part = line.split("#").first
+      code_part && !code_part.strip.empty?
+    end
+
+    def parse_detector_names(str)
+      str.split(/[,\s]+/).map(&:strip).reject(&:empty?).map do |name|
+        normalize_detector_name(name)
+      end
+    end
+
+    def normalize_detector_name(name)
+      name.gsub(/([A-Z])/) { "_#{::Regexp.last_match(1).downcase}" }
+          .sub(/^_/, "")
+          .downcase
+    end
+  end
+end

data/lib/eager_eye/fixer_registry.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module EagerEye
+  class FixerRegistry
+    FIXERS = {
+      count_in_iteration: Fixers::CountToSize,
+      pluck_to_array: Fixers::PluckToSelect
+    }.freeze
+
+    def self.fixer_for(issue, source_code)
+      fixer_class = FIXERS[issue.detector]
+      return nil unless fixer_class
+
+      fixer_class.new(issue, source_code)
+    end
+
+    def self.fixable?(issue, source_code)
+      fixer = fixer_for(issue, source_code)
+      fixer&.fixable? || false
+    end
+  end
+end

data/lib/eager_eye/fixers/base.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module EagerEye
+  module Fixers
+    class Base
+      attr_reader :issue, :source_lines
+
+      def initialize(issue, source_code)
+        @issue = issue
+        @source_code = source_code
+        @source_lines = source_code.lines
+      end
+
+      def fixable?
+        false
+      end
+
+      def fix
+        raise NotImplementedError
+      end
+
+      def diff
+        return nil unless fixable?
+
+        original_line = @source_lines[issue.line_number - 1]
+        fixed_line = fixed_content
+        return nil if original_line == fixed_line
+
+        {
+          file: issue.file_path,
+          line: issue.line_number,
+          original: original_line.chomp,
+          fixed: fixed_line.chomp
+        }
+      end
+
+      protected
+
+      def fixed_content
+        raise NotImplementedError
+      end
+
+      def line_content
+        @source_lines[issue.line_number - 1]
+      end
+    end
+  end
+end

data/lib/eager_eye/fixers/count_to_size.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module EagerEye
+  module Fixers
+    class CountToSize < Base
+      def fixable?
+        issue.detector == :count_in_iteration &&
+          line_content&.include?(".count")
+      end
+
+      protected
+
+      def fixed_content
+        line_content.gsub(/\.count\b/, ".size")
+      end
+    end
+  end
+end

data/lib/eager_eye/fixers/pluck_to_select.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EagerEye
+  module Fixers
+    class PluckToSelect < Base
+      # This fixer only works for single-line pluck + where patterns
+      # Two-line patterns are too complex to fix automatically
+
+      def fixable?
+        issue.detector == :pluck_to_array &&
+          single_line_pattern?
+      end
+
+      protected
+
+      def fixed_content
+        # Model.where(col: OtherModel.pluck(:id)) -> Model.where(col: OtherModel.select(:id))
+        line_content.gsub(/\.pluck\((:\w+)\)/, '.select(\1)')
+      end
+
+      private
+
+      def single_line_pattern?
+        return false unless line_content
+
+        line_content.include?(".pluck(") && line_content.include?(".where(")
+      end
+    end
+  end
+end

data/lib/eager_eye/version.rb

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

data/lib/eager_eye.rb

@@ -11,7 +11,13 @@ 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/detectors/pluck_to_array"
+require_relative "eager_eye/comment_parser"
 require_relative "eager_eye/analyzer"
+require_relative "eager_eye/fixers/base"
+require_relative "eager_eye/fixers/count_to_size"
+require_relative "eager_eye/fixers/pluck_to_select"
+require_relative "eager_eye/fixer_registry"
+require_relative "eager_eye/auto_fixer"
 require_relative "eager_eye/reporters/base"
 require_relative "eager_eye/reporters/console"
 require_relative "eager_eye/reporters/json"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eager_eye
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - hamzagedikkaya
@@ -58,7 +58,9 @@ files:
 - exe/eager_eye
 - lib/eager_eye.rb
 - lib/eager_eye/analyzer.rb
+- lib/eager_eye/auto_fixer.rb
 - lib/eager_eye/cli.rb
+- lib/eager_eye/comment_parser.rb
 - lib/eager_eye/configuration.rb
 - lib/eager_eye/detectors/base.rb
 - lib/eager_eye/detectors/callback_query.rb
@@ -68,6 +70,10 @@ files:
 - lib/eager_eye/detectors/missing_counter_cache.rb
 - lib/eager_eye/detectors/pluck_to_array.rb
 - lib/eager_eye/detectors/serializer_nesting.rb
+- lib/eager_eye/fixer_registry.rb
+- lib/eager_eye/fixers/base.rb
+- lib/eager_eye/fixers/count_to_size.rb
+- lib/eager_eye/fixers/pluck_to_select.rb
 - lib/eager_eye/generators/install_generator.rb
 - lib/eager_eye/issue.rb
 - lib/eager_eye/railtie.rb