eager_eye 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0eccf7e9da999d8e273e9b41a11c96eb1284fdd944ce6af0e547f4201a3fbb9
-  data.tar.gz: 55b8ab8e753245bc5b638705bff5a0c10115c0f39f44d69f25f5b50dcb823ffa
+  metadata.gz: 0b2e83de186394077d36507bd9c14dbb356777bddff49689c602b43dc8d74b80
+  data.tar.gz: 5ee79306b8bd9f602e9f09ed1c62bf5adb5920d57104c486d8799a757458eb6f
 SHA512:
-  metadata.gz: 9f41668f38474f848cffe0e70473c689c27eb9a102a20cdc932f1039a2c4dce71cb91eda4fa2bb1012136d48b93976cb33ad8455a3e01db2a2c400037a75420e
-  data.tar.gz: 2d8f591ee31948302c8a14fe2deef868bc98e2d7fd23083c39a6ee8e9242296e25080938f4e00cef24757c2d2ec6df512d7e6ef144945420de593168e0d71e96
+  metadata.gz: 36d9dabec10f32dcf21c88efdd5125e5f7146cf61e0e500adc4f3c5b57608303cf0002d7ac48c32eb87b8f163fa6c3125d53bce4e052e9c1dd178f244b69e2a3
+  data.tar.gz: 6bc77a99dd29179c9179010ff1c6bb195048115b3b72e545ec51d1af1d286a430a35b223a138fc78e66dbb0172d9e2ff2f39c9f9639be9edc97a47eb928e3df6

data/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.8] - 2025-12-25
+
+### Added
+
+- **Severity Levels** - error/warning/info with `--min-severity` filtering
+  - Defaults: `loop_association`=error, `missing_counter_cache`=info, others=warning
+  - Configurable via `.eager_eye.yml` (`severity_levels`, `min_severity`)
+
+## [1.0.7] - 2025-12-24
+
+### Fixed
+
+- Fixed `invalid byte sequence in US-ASCII` error when parsing files containing non-ASCII characters (Turkish, Chinese, etc.)
+  - Now properly encodes source code to UTF-8 with replacement for invalid/undefined characters
+  - Fixes crash when analyzing files with special characters in comments or strings
+
 ## [1.0.6] - 2025-12-22
 
 ### Fixed

data/README.md

@@ -1,15 +1,27 @@
-# EagerEye
+<p align="center">
+  <img src="images/icon.png" alt="EagerEye Logo" width="140">
+</p>
 
-[![CI](https://github.com/hamzagedikkaya/eager_eye/actions/workflows/main.yml/badge.svg)](https://github.com/hamzagedikkaya/eager_eye/actions/workflows/main.yml)
-[![Gem Version](https://img.shields.io/badge/gem-v1.0.6-red.svg)](https://rubygems.org/gems/eager_eye)
-[![Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg)](https://github.com/hamzagedikkaya/eager_eye)
-[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.1-ruby.svg)](https://www.ruby-lang.org/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![VS Code Extension](https://img.shields.io/badge/VS%20Code-Extension-blue.svg)](https://marketplace.visualstudio.com/items?itemName=hamzagedikkaya.eager-eye)
+<h1 align="center">EagerEye</h1>
 
-**Static analysis tool for detecting N+1 queries in Rails applications.**
+<p align="center">
+  <strong>Static analysis tool for detecting N+1 queries in Rails applications.</strong>
+</p>
 
-EagerEye analyzes your Ruby code without running it, using AST (Abstract Syntax Tree) parsing to find potential N+1 query issues before they hit production.
+<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://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>
+  <a href="https://marketplace.visualstudio.com/items?itemName=hamzagedikkaya.eager-eye"><img src="https://img.shields.io/badge/VS%20Code-Extension-blue.svg" alt="VS Code Extension"></a>
+</p>
+
+<p align="center">
+  <em>Analyze your Ruby code without running it — find N+1 query issues before they hit production using AST parsing.</em>
+</p>
+
+---
 
 ## Why EagerEye?
 
@@ -445,6 +457,19 @@ enabled_detectors:
   - callback_query
   - pluck_to_array
 
+# Severity levels per detector (error, warning, info)
+severity_levels:
+  loop_association: error        # Definite N+1
+  serializer_nesting: warning
+  custom_method_query: warning
+  count_in_iteration: warning
+  callback_query: warning
+  pluck_to_array: warning        # Optimization
+  missing_counter_cache: info    # Suggestion
+
+# Minimum severity to report (default: info)
+min_severity: warning
+
 # Base path to analyze (default: app)
 app_path: app
 
@@ -458,6 +483,8 @@ fail_on_issues: true
 EagerEye.configure do |config|
   config.excluded_paths = ["app/legacy/**"]
   config.enabled_detectors = [:loop_association, :serializer_nesting]
+  config.severity_levels = { loop_association: :error, missing_counter_cache: :info }
+  config.min_severity = :warning
   config.app_path = "app"
   config.fail_on_issues = true
 end
@@ -500,6 +527,7 @@ Options:
     -f, --format FORMAT      Output format: console, json (default: console)
     -e, --exclude PATTERN    Exclude files matching pattern (can be used multiple times)
     -o, --only DETECTORS     Run only specified detectors (comma-separated)
+    -s, --min-severity LEVEL Minimum severity to report (info, warning, error)
         --no-fail            Exit with 0 even when issues are found
         --no-color           Disable colored output
     -v, --version            Show version

data/lib/eager_eye/analyzer.rb

@@ -68,6 +68,10 @@ module EagerEye
           comment_parser.disabled_at?(issue.line_number, issue.detector)
         end
 
+        # Filter by minimum severity
+        min_severity = EagerEye.configuration.min_severity
+        file_issues.select! { |issue| issue.meets_minimum_severity?(min_severity) }
+
         @issues.concat(file_issues)
       end
     rescue Errno::ENOENT, Errno::EACCES => e

data/lib/eager_eye/cli.rb

@@ -41,6 +41,7 @@ module EagerEye
         format: :console,
         exclude: [],
         only: [],
+        min_severity: nil,
         fail_on_issues: true,
         colorize: $stdout.tty?,
         help: false,
@@ -92,6 +93,11 @@ module EagerEye
       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("-s", "--min-severity LEVEL", %i[info warning error],
+              "Minimum severity to report (info, warning, error)") do |level|
+        options[:min_severity] = level
+      end
     end
 
     def add_behavior_options(opts)
@@ -140,6 +146,7 @@ module EagerEye
       EagerEye.configure do |config|
         config.excluded_paths += options[:exclude]
         config.enabled_detectors = options[:only] unless options[:only].empty?
+        config.min_severity = options[:min_severity] if options[:min_severity]
       end
     end
 

data/lib/eager_eye/comment_parser.rb

@@ -10,8 +10,8 @@ module EagerEye
     BLOCK_DISABLE_PATTERN = /eager_eye:disable\s+(.+?)(?:\s+--|$)/i
 
     def initialize(source_code)
-      @source_code = source_code
-      @lines = source_code.lines
+      @source_code = source_code.encode("UTF-8", invalid: :replace, undef: :replace)
+      @lines = @source_code.lines
       @disabled_ranges = Hash.new { |h, k| h[k] = [] }
       @file_disabled = Set.new
       @current_disabled = Set.new

data/lib/eager_eye/configuration.rb

@@ -2,7 +2,8 @@
 
 module EagerEye
   class Configuration
-    attr_accessor :excluded_paths, :enabled_detectors, :app_path, :fail_on_issues
+    attr_accessor :excluded_paths, :enabled_detectors, :app_path, :fail_on_issues,
+                  :severity_levels, :min_severity
 
     DEFAULT_DETECTORS = %i[
       loop_association serializer_nesting missing_counter_cache
@@ -10,11 +11,33 @@ module EagerEye
       pluck_to_array
     ].freeze
 
+    DEFAULT_SEVERITY_LEVELS = {
+      loop_association: :error,
+      serializer_nesting: :warning,
+      missing_counter_cache: :info,
+      custom_method_query: :warning,
+      count_in_iteration: :warning,
+      callback_query: :warning,
+      pluck_to_array: :warning
+    }.freeze
+
+    VALID_SEVERITIES = %i[info warning error].freeze
+
     def initialize
       @excluded_paths = []
       @enabled_detectors = DEFAULT_DETECTORS.dup
       @app_path = "app"
       @fail_on_issues = true
+      @severity_levels = DEFAULT_SEVERITY_LEVELS.dup
+      @min_severity = :info
+    end
+
+    def severity_for(detector_name)
+      severity_levels.fetch(detector_name.to_sym, :warning)
+    end
+
+    def valid_severity?(severity)
+      VALID_SEVERITIES.include?(severity.to_sym)
     end
   end
 end

data/lib/eager_eye/detectors/base.rb

@@ -9,6 +9,10 @@ module EagerEye
         def detector_name
           raise NotImplementedError, "Subclasses must implement .detector_name"
         end
+
+        def default_severity
+          :warning
+        end
       end
 
       def detect(_ast, _file_path)
@@ -17,17 +21,22 @@ module EagerEye
 
       protected
 
-      def create_issue(file_path:, line_number:, message:, severity: :warning, suggestion: nil)
+      def create_issue(file_path:, line_number:, message:, severity: nil, suggestion: nil)
+        resolved_severity = severity || configured_severity
         Issue.new(
           detector: self.class.detector_name,
           file_path: file_path,
           line_number: line_number,
           message: message,
-          severity: severity,
+          severity: resolved_severity,
           suggestion: suggestion
         )
       end
 
+      def configured_severity
+        EagerEye.configuration.severity_for(self.class.detector_name)
+      end
+
       def traverse_ast(node, &block)
         return unless node.is_a?(Parser::AST::Node)
 

data/lib/eager_eye/detectors/count_in_iteration.rb

@@ -128,7 +128,6 @@ module EagerEye
           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

data/lib/eager_eye/detectors/custom_method_query.rb

@@ -165,7 +165,6 @@ module EagerEye
           file_path: @file_path,
           line_number: node.loc.line,
           message: "Query method `.#{method_name}` called on `#{association_chain}` inside iteration",
-          severity: :warning,
           suggestion: "This query executes on each iteration. Consider preloading data or restructuring the query."
         )
       end

data/lib/eager_eye/detectors/pluck_to_array.rb

@@ -140,7 +140,6 @@ module EagerEye
           file_path: @file_path,
           line_number: node.loc.line,
           message: "Using plucked/mapped array in `where` causes two queries and holds IDs in memory",
-          severity: :warning,
           suggestion: "Use `.select(:id)` subquery: `Model.where(col: OtherModel.condition.select(:id))`"
         )
       end

data/lib/eager_eye/issue.rb

@@ -4,7 +4,8 @@ module EagerEye
   class Issue
     attr_reader :detector, :file_path, :line_number, :message, :severity, :suggestion
 
-    VALID_SEVERITIES = %i[warning error].freeze
+    VALID_SEVERITIES = %i[info warning error].freeze
+    SEVERITY_ORDER = { info: 0, warning: 1, error: 2 }.freeze
 
     def initialize(detector:, file_path:, line_number:, message:, severity: :warning, suggestion: nil)
       @detector = detector
@@ -15,6 +16,14 @@ module EagerEye
       @suggestion = suggestion
     end
 
+    def severity_level
+      SEVERITY_ORDER[severity]
+    end
+
+    def meets_minimum_severity?(min_severity)
+      severity_level >= SEVERITY_ORDER.fetch(min_severity, 0)
+    end
+
     def to_h
       {
         detector: detector,

data/lib/eager_eye/reporters/base.rb

@@ -19,6 +19,10 @@ module EagerEye
         issues.group_by(&:file_path)
       end
 
+      def info_count
+        issues.count { |i| i.severity == :info }
+      end
+
       def warning_count
         issues.count { |i| i.severity == :warning }
       end

data/lib/eager_eye/reporters/console.rb

@@ -61,7 +61,7 @@ module EagerEye
 
       def format_issue(issue)
         detector_label = format_detector(issue.detector)
-        severity_color = issue.severity == :error ? :red : :yellow
+        severity_color = severity_to_color(issue.severity)
 
         line = "  Line #{issue.line_number}: "
         line += colorize("[#{detector_label}]", severity_color)
@@ -72,18 +72,24 @@ module EagerEye
         line
       end
 
+      def severity_to_color(severity)
+        { error: :red, warning: :yellow, info: :cyan }.fetch(severity, :yellow)
+      end
+
       def format_detector(detector)
         detector.to_s.split("_").map(&:capitalize).join
       end
 
       def summary
         total = issues.size
-        warnings = warning_count
         errors = error_count
+        warnings = warning_count
+        infos = info_count
 
         "Total: #{total} issue#{"s" unless total == 1} " \
-          "(#{warnings} warning#{"s" unless warnings == 1}, " \
-          "#{errors} error#{"s" unless errors == 1})"
+          "(#{errors} error#{"s" unless errors == 1}, " \
+          "#{warnings} warning#{"s" unless warnings == 1}, " \
+          "#{infos} info)"
       end
 
       def colorize(text, color)

data/lib/eager_eye/reporters/json.rb

@@ -24,8 +24,9 @@ module EagerEye
       def summary_hash
         {
           total: issues.size,
-          warnings: warning_count,
           errors: error_count,
+          warnings: warning_count,
+          infos: info_count,
           files_affected: issues_by_file.keys.size
         }
       end

data/lib/eager_eye/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eager_eye
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.8
 platform: ruby
 authors:
 - hamzagedikkaya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-22 00:00:00.000000000 Z
+date: 2025-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -56,7 +56,6 @@ files:
 - README.md
 - Rakefile
 - SECURITY.md
-- examples/github_action.yml
 - exe/eager_eye
 - lib/eager_eye.rb
 - lib/eager_eye/analyzer.rb

data/examples/github_action.yml

@@ -1,75 +0,0 @@
-# Example GitHub Action workflow for using EagerEye in your Rails project
-# Copy this file to .github/workflows/eager_eye.yml in your repository
-
-name: EagerEye N+1 Analysis
-
-on:
-  pull_request:
-    paths:
-      - "app/**/*.rb"
-      - "lib/**/*.rb"
-
-jobs:
-  analyze:
-    runs-on: ubuntu-latest
-    name: N+1 Query Detection
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.3"
-
-      - name: Install EagerEye
-        run: gem install eager_eye
-
-      - name: Run EagerEye analysis
-        run: eager_eye app/ --format json > eager_eye_report.json
-        continue-on-error: true
-
-      - name: Upload report artifact
-        uses: actions/upload-artifact@v4
-        with:
-          name: eager-eye-report
-          path: eager_eye_report.json
-
-      - name: Check for N+1 issues
-        run: |
-          if [ -f eager_eye_report.json ]; then
-            issues=$(cat eager_eye_report.json | ruby -rjson -e 'puts JSON.parse(STDIN.read)["summary"]["total_issues"]')
-            if [ "$issues" -gt 0 ]; then
-              echo "::warning::EagerEye detected $issues potential N+1 query issue(s)"
-              cat eager_eye_report.json | ruby -rjson -e '
-                data = JSON.parse(STDIN.read)
-                data["issues"].each do |issue|
-                  puts "::warning file=#{issue["file_path"]},line=#{issue["line_number"]}::#{issue["message"]}"
-                end
-              '
-            else
-              echo "No N+1 query issues detected!"
-            fi
-          fi
-
-  # Alternative: Strict mode that fails the build on issues
-  analyze-strict:
-    runs-on: ubuntu-latest
-    name: N+1 Query Detection (Strict)
-    if: false  # Set to true to enable strict mode
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.3"
-
-      - name: Install EagerEye
-        run: gem install eager_eye
-
-      - name: Run EagerEye analysis (strict)
-        run: eager_eye app/ --no-color