eager_eye 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e0c9e78e18d9d8c9a6cad8ee96a91c89ac469d9dc662e43a51f09d361a3200
-  data.tar.gz: 90554fbbe09380116398c8139c6d09ca5851d1e12d2eb52c32cf85f8c8fdc76a
+  metadata.gz: 39f1ea38bf95b25a50a9dc854b1727811ffeadaeb5724e99f3e6160b2867dd79
+  data.tar.gz: db049f2205a44e3317d891d2c6c2dbda8f716562916bde05e151b97e532181af
 SHA512:
-  metadata.gz: 86605c1632ed47aaae05e26d810c6611dac2f356503502b71a94a389b1d58148cbb5146e5e6cbc5e9f809f4b6bf2b78d983cbf8484c0bab6d1e9a046ab0a242b
-  data.tar.gz: bb3e07e2b8e799067aa475f6b8ffea6a303e797e3eac252f46f597eec751f42451f91fd97eacf024aae8a6129267ef2b425fdd26163a6b893714cb22c2d9ddfa
+  metadata.gz: bb4e89fa8d8206a556c9ca7d12d33ee0412091aba756abc0d0581b8ca20907898eb0ed74940f75c2afae727ed2825dd65472222edd566d9cfa8a8978969f0d3e
+  data.tar.gz: b34651d34df75eafa06175af3f715948995b9a2896910a4e4ec69f9c7464a1f4d7fdbf1efb844e34b50fa2fb9d5a4f55da8089fb0b1b50aef767bff70695e327

data/CHANGELOG.md

@@ -7,6 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2025-12-16
+
+### Added
+
+- **RSpec Integration** - RSpec matchers for testing your codebase
+  - `pass_eager_eye` matcher for testing files and directories
+  - `only` option to run specific detectors
+  - `exclude` option to exclude files by glob pattern
+  - `max_issues` option for gradual migration (allows up to N issues)
+  - `require "eager_eye/rspec"` for easy integration
+  - Helpful failure messages with issue details
+
+## [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

data/README.md

@@ -316,6 +316,88 @@ Both CamelCase and snake_case formats are accepted:
 | 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.
+
+## RSpec Integration
+
+EagerEye provides RSpec matchers for testing your codebase:
+
+```ruby
+# spec/rails_helper.rb
+require "eager_eye/rspec"
+
+# spec/eager_eye_spec.rb
+RSpec.describe "EagerEye Analysis" do
+  it "controllers have no N+1 issues" do
+    expect("app/controllers").to pass_eager_eye
+  end
+
+  it "serializers are clean" do
+    expect("app/serializers").to pass_eager_eye(only: [:serializer_nesting])
+  end
+
+  # Allow some issues during migration
+  it "legacy code is acceptable" do
+    expect("app/services/legacy").to pass_eager_eye(max_issues: 10)
+  end
+
+  it "models have no callback issues except legacy" do
+    expect("app/models").to pass_eager_eye(
+      only: [:callback_query],
+      exclude: ["app/models/legacy/**"]
+    )
+  end
+end
+```
+
+### Matcher Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `only` | `Array<Symbol>` | Run only specified detectors |
+| `exclude` | `Array<String>` | Glob patterns to exclude |
+| `max_issues` | `Integer` | Maximum allowed issues (default: 0) |
+
 ## Configuration
 
 ### Config File (.eager_eye.yml)

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/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/rspec/matchers.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module EagerEye
+  module RSpec
+    module Matchers
+      def pass_eager_eye(options = {})
+        PassEagerEyeMatcher.new(options)
+      end
+
+      class PassEagerEyeMatcher
+        def initialize(options = {})
+          @only = options[:only]
+          @exclude = options[:exclude] || []
+          @max_issues = options[:max_issues] || 0
+          @issues = []
+          @path = nil
+        end
+
+        def matches?(path)
+          @path = path
+          configure_eager_eye
+          analyzer = build_analyzer
+          @issues = analyzer.run
+          @issues.count <= @max_issues
+        end
+
+        def failure_message
+          message = "expected #{@path} to pass EagerEye analysis"
+          message += " (max #{@max_issues} issues)" if @max_issues.positive?
+          message += ", but found #{@issues.count} issue(s):\n\n"
+
+          @issues.group_by(&:file_path).each do |file, file_issues|
+            message += "#{file}:\n"
+            file_issues.each do |issue|
+              message += "  Line #{issue.line_number}: [#{issue.detector}] #{issue.message}\n"
+            end
+            message += "\n"
+          end
+
+          message
+        end
+
+        def failure_message_when_negated
+          "expected #{@path} to have EagerEye issues, but it passed"
+        end
+
+        def description
+          desc = "pass EagerEye analysis"
+          desc += " for #{@only.join(", ")}" if @only
+          desc += " (max #{@max_issues} issues)" if @max_issues.positive?
+          desc
+        end
+
+        private
+
+        def configure_eager_eye
+          EagerEye.reset_configuration!
+          EagerEye.configure do |config|
+            config.enabled_detectors = @only if @only
+            config.excluded_paths = @exclude unless @exclude.empty?
+            config.fail_on_issues = false
+          end
+        end
+
+        def build_analyzer
+          EagerEye::Analyzer.new(paths: [@path])
+        end
+      end
+    end
+  end
+end

data/lib/eager_eye/rspec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "eager_eye"
+require "eager_eye/rspec/matchers"
+
+RSpec.configure do |config|
+  config.include EagerEye::RSpec::Matchers
+end

data/lib/eager_eye/version.rb

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

data/lib/eager_eye.rb

@@ -13,6 +13,11 @@ 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.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - hamzagedikkaya
@@ -58,6 +58,7 @@ 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
@@ -69,12 +70,18 @@ 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
 - lib/eager_eye/reporters/base.rb
 - lib/eager_eye/reporters/console.rb
 - lib/eager_eye/reporters/json.rb
+- lib/eager_eye/rspec.rb
+- lib/eager_eye/rspec/matchers.rb
 - lib/eager_eye/version.rb
 - sig/eager_eye.rbs
 homepage: https://github.com/hamzagedikkaya/eager_eye