eager_eye 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8d34dc13a536c66ca82e9495ba5e53b81c31f1e2764dea3ba8d64c434da69ec
-  data.tar.gz: d63753e0d80c366cc9b87fe6bcc5bc2f2ee1ba537e7363c2b6aadafffd5a4a05
+  metadata.gz: 39f1ea38bf95b25a50a9dc854b1727811ffeadaeb5724e99f3e6160b2867dd79
+  data.tar.gz: db049f2205a44e3317d891d2c6c2dbda8f716562916bde05e151b97e532181af
 SHA512:
-  metadata.gz: bf3ff2ba24314b8b6e22385c82685d8909729f12ffc9d48531bd7fe4c6a1683e2aadb5692934ec300430dfdbc0cde795489e9a68a98072658a9452cd8e6e338b
-  data.tar.gz: fd73786c8c983b2bcc3d3860bf1036dc1525523dcce8ef06767760dfce57b813ee415679fa42cc7631830e8c4780f0bbbdecc61ae4563b964a983ada5c2c0d42
+  metadata.gz: bb4e89fa8d8206a556c9ca7d12d33ee0412091aba756abc0d0581b8ca20907898eb0ed74940f75c2afae727ed2825dd65472222edd566d9cfa8a8978969f0d3e
+  data.tar.gz: b34651d34df75eafa06175af3f715948995b9a2896910a4e4ec69f9c7464a1f4d7fdbf1efb844e34b50fa2fb9d5a4f55da8089fb0b1b50aef767bff70695e327

data/CHANGELOG.md

@@ -7,6 +7,18 @@ 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

data/README.md

@@ -358,6 +358,46 @@ Apply this fix? [y/n/q] y
 
 > **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/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.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eager_eye
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - hamzagedikkaya
@@ -80,6 +80,8 @@ files:
 - 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