eager_eye 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf21044e597735154b0b1acdcda9230749bf027e8b8acafe70c6aaa1da22b62
-  data.tar.gz: b7d6b716ff42f9e160c292a54ecf0344027c73e24eae29f6aecd34aae27d60ac
+  metadata.gz: 709b9faacf1729a719b9d6a2b5a76b6896433ceacaea4f155f0454256211cec4
+  data.tar.gz: 320a664b2d85dadbb97c04b073ad7ad6a6136077fad2b9c32479273f438287a7
 SHA512:
-  metadata.gz: 1849caab263614bdb85ed1ddcd15f63ae4199cd978ae56e2c8a690ca0e4c0e4616851f9a09f835d95e61adb457e35d5d07fbb3cb189c6394812f7064901cfaed
-  data.tar.gz: fe737b046298753a2fb9739f26307d46fbe4852a47f2a147fae56169259824dff4ced9f3f4cc3c6a37c58dbaea03785d2a1003d230d6b5c7cba56c4224ad011e
+  metadata.gz: a24335ee136add109f4484a07b4e45888308275965a0cb2213d348ca42fca6ac2395d0f09e99f3a3bc9e8109048a9cb69af35b2edc453f607562582ff3bbfddf
+  data.tar.gz: 4e2294859302a6afc52bf833e5aa5fcad684febf7bb73b7f2e8c6a68b6fdf250b909f9315020cc8ad09ba29dd665ce01f287af3b84ba7425709b22e67be0c8b7

data/CHANGELOG.md

@@ -7,6 +7,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.3] - 2026-07-09
+
+### Fixed
+
+- **Repackage 1.3.2, which shipped without `lib/eager_eye/source_parser.rb`.**
+  The 1.3.2 gem was built from a tree where the new `source_parser.rb` had not
+  yet been committed, so `git ls-files` (which drives `spec.files`) omitted it
+  and every `require "eager_eye"` raised `LoadError: cannot load such file --
+  eager_eye/source_parser`. 1.3.3 contains the identical 1.3.2 changes with the
+  file included — no source changes beyond the version bump. The gemspec now
+  also fails the build if any `lib/**/*.rb` file is missing from the package,
+  so this cannot recur.
+
+## [1.3.2] - 2026-07-09
+
+
+### Fixed
+
+- **Unparseable files are reported once, by name — not as raw parser dumps.**
+  A file the parser gem cannot lex (e.g. a model holding a binary string
+  literal whose escapes are invalid UTF-8) used to trigger the default
+  diagnostic consumer, which dumped a three-line error block to stderr on
+  *every* analysis pass — three times per scan — labelled `(string):63` with
+  no hint of which file was affected, while the file itself was silently
+  dropped from analysis. All parsing now goes through the new
+  `EagerEye::SourceParser` (quiet diagnostics, buffers named after the real
+  file), and the analyzer emits a single clear line per file instead:
+  `EagerEye: Skipped unparseable file app/models/coupon.rb: literal contains
+  escape sequences incompatible with UTF-8`. Skipped files and their reasons
+  are also exposed programmatically via `Analyzer#skipped_files` (reset on
+  every `#run`). Unknown magic encoding comments (`# encoding: utf8` — a
+  `Parser::UnknownEncodingInMagicComment`, which is an ArgumentError rather
+  than a SyntaxError and previously crashed the whole run) are handled the
+  same way, and an unparseable `db/schema.rb` now warns explicitly that
+  schema-aware column checks are disabled instead of degrading precision in
+  silence.
+- **No more `parser/current` version-deviation warning.** EagerEye now
+  requires the grammar matching the running Ruby's *minor* version
+  (`parser/ruby33` on any 3.3.x) instead of `parser/current`, which insists
+  on an exact patch match and warned on every load ("parser/current is
+  loading parser/ruby33, which recognizes 3.3.4-compliant syntax, but you
+  are running 3.3.1"). Grammar only changes between minor versions, so
+  behaviour is identical; Rubies without a bundled grammar file fall back to
+  `parser/current` as before.
+
 ## [1.3.1] - 2026-06-12
 
 ### Changed — precision (fewer false positives)

data/lib/eager_eye/analyzer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "parser/current"
+require_relative "source_parser"
 
 module EagerEye
   class Analyzer
@@ -32,7 +32,7 @@ module EagerEye
 
     attr_reader :paths, :issues, :association_preloads, :association_names, :method_queries, :delegation_maps,
                 :scope_maps, :uniqueness_models, :associations_by_model, :all_columns, :columns_by_model,
-                :serializer_usage
+                :serializer_usage, :skipped_files
 
     def initialize(paths: nil)
       @paths = Array(paths || EagerEye.configuration.app_path)
@@ -47,10 +47,12 @@ module EagerEye
       @all_columns = Set.new
       @columns_by_model = {}
       @serializer_usage = SerializerUsageParser.new
+      @skipped_files = {}
     end
 
     def run
       @issues = []
+      @skipped_files = {}
       collect_schema
       collect_model_metadata
       collect_serializer_usage
@@ -73,7 +75,7 @@ module EagerEye
     # this to stay silent on associations preloaded at all render sites.
     def collect_serializer_usage
       ruby_files.each do |file_path|
-        ast = parse_source(File.read(file_path))
+        ast = parse_source(File.read(file_path), file_path)
         @serializer_usage.parse_file(ast) if ast
       rescue Errno::ENOENT, Errno::EACCES
         next
@@ -82,7 +84,7 @@ module EagerEye
 
     def collect_model_metadata
       model_files.each do |file_path|
-        ast = parse_source(File.read(file_path))
+        ast = parse_source(File.read(file_path), file_path)
         next unless ast
 
         model_name = extract_model_name(file_path)
@@ -143,7 +145,7 @@ module EagerEye
 
     def analyze_file(file_path)
       source = File.read(file_path)
-      ast = parse_source(source)
+      ast = parse_source(source, file_path)
       return unless ast
 
       comment_parser = CommentParser.new(source)
@@ -160,12 +162,24 @@ module EagerEye
       warn "EagerEye: Could not read file #{file_path}: #{e.message}"
     end
 
-    def parse_source(source)
-      Parser::CurrentRuby.parse(source)
-    rescue Parser::SyntaxError
+    # A file the parser cannot handle (syntax error, binary literal whose
+    # escapes are invalid UTF-8, ...) is skipped from analysis entirely. Each
+    # such file is recorded in #skipped_files and warned about exactly once,
+    # even though every file is parsed by multiple passes.
+    def parse_source(source, file_path)
+      SourceParser.parse(source, file_path)
+    rescue Parser::SyntaxError, Parser::UnknownEncodingInMagicComment, EncodingError => e
+      register_unparseable(file_path, e.message)
       nil
     end
 
+    def register_unparseable(file_path, message)
+      return if @skipped_files.key?(file_path)
+
+      @skipped_files[file_path] = message
+      warn "EagerEye: Skipped unparseable file #{file_path}: #{message}"
+    end
+
     def detector_args(detector, ast, file_path)
       extra = DETECTOR_EXTRA_ARGS.find { |klass, _| detector.is_a?(klass) }&.last || []
       [ast, file_path, *extra.map { |name| instance_variable_get(:"@#{name}") }]

data/lib/eager_eye/detectors/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "parser/current"
+require_relative "../source_parser"
 
 module EagerEye
   module Detectors
@@ -43,9 +43,12 @@ module EagerEye
         node.children.each { |child| traverse_ast(child, &block) }
       end
 
-      def parse_source(source)
-        Parser::CurrentRuby.parse(source)
-      rescue Parser::SyntaxError
+      # Convenience for detector subclasses; returns nil (without any stderr
+      # output) when the source cannot be parsed. Pass file_path so any
+      # diagnostics you inspect on the raised error name the real file.
+      def parse_source(source, file_path = "(string)")
+        SourceParser.parse(source, file_path)
+      rescue Parser::SyntaxError, Parser::UnknownEncodingInMagicComment, EncodingError
         nil
       end
 

data/lib/eager_eye/schema_parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "parser/current"
+require_relative "source_parser"
 
 module EagerEye
   # Parses db/schema.rb to learn the real column names of each table. Columns are
@@ -31,7 +31,7 @@ module EagerEye
       schema = locate_schema(start_path)
       return false unless schema
 
-      ast = parse(File.read(schema))
+      ast = parse(File.read(schema), schema)
       return false unless ast
 
       walk(ast)
@@ -62,9 +62,12 @@ module EagerEye
       nil
     end
 
-    def parse(source)
-      Parser::CurrentRuby.parse(source)
-    rescue Parser::SyntaxError
+    # An unparseable schema silently disables the column disambiguation that
+    # filters most false positives, so the failure must not be swallowed.
+    def parse(source, file_path)
+      SourceParser.parse(source, file_path)
+    rescue Parser::SyntaxError, Parser::UnknownEncodingInMagicComment, EncodingError => e
+      warn "EagerEye: Could not parse schema #{file_path}: #{e.message} (schema-aware column checks disabled)"
       nil
     end
 

data/lib/eager_eye/serializer_usage_parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "parser/current"
+require_relative "source_parser"
 
 module EagerEye
   # Serializers are the worst false-positive source because the detector sees the

data/lib/eager_eye/source_parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Require the grammar matching the running Ruby's minor version (parser/ruby33
+# for any 3.3.x) instead of parser/current, which insists on an exact *patch*
+# match and warns on every load otherwise ("parser/current is loading
+# parser/ruby33, which recognizes 3.3.4-compliant syntax, but you are running
+# 3.3.1"). Grammar only changes between minor versions, so the versioned
+# require is exactly as correct — and is the parser gem's documented way to
+# opt out of the warning. Unknown future Rubies fall back to parser/current.
+begin
+  require "parser/ruby#{RUBY_VERSION.split(".").first(2).join}"
+rescue LoadError
+  require "parser/current"
+end
+
+module EagerEye
+  # Single entry point for turning Ruby source into an AST. Differs from
+  # `Parser::CurrentRuby.parse` in two ways that matter for a CLI tool:
+  #
+  #   * No stderr side effects. The default parser prints every lexer/parser
+  #     diagnostic straight to $stderr — so one unparseable file (e.g. a model
+  #     holding a binary string literal whose escapes are invalid UTF-8) dumps
+  #     a raw three-line diagnostic once per analysis pass. Diagnostics stay
+  #     quiet here; failures surface only as the raised exception.
+  #   * The buffer is named after the real file, so callers can report
+  #     "app/models/coupon.rb", not "(string)".
+  #
+  # Raises like the original — Parser::SyntaxError, EncodingError, or
+  # Parser::UnknownEncodingInMagicComment (an ArgumentError, NOT a
+  # SyntaxError, raised for e.g. `# encoding: utf8` typos); callers decide
+  # whether and how to report.
+  module SourceParser
+    PARSER_CLASS =
+      begin
+        Parser.const_get(:"Ruby#{RUBY_VERSION.split(".").first(2).join}", false)
+      rescue NameError
+        Parser::CurrentRuby
+      end
+
+    def self.parse(source, file_path = "(string)")
+      parser = PARSER_CLASS.new
+      parser.diagnostics.all_errors_are_fatal = true
+      parser.diagnostics.ignore_warnings = true
+
+      buffer = Parser::Source::Buffer.new(file_path, 1)
+      buffer.source = source.dup.force_encoding(parser.default_encoding)
+      parser.parse(buffer)
+    end
+  end
+end

data/lib/eager_eye/version.rb

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

data/lib/eager_eye.rb

@@ -2,6 +2,7 @@
 
 require "set"
 require_relative "eager_eye/version"
+require_relative "eager_eye/source_parser"
 require_relative "eager_eye/configuration"
 require_relative "eager_eye/issue"
 require_relative "eager_eye/baseline"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eager_eye
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - hamzagedikkaya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-12 00:00:00.000000000 Z
+date: 2026-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -99,6 +99,7 @@ files:
 - lib/eager_eye/schema_parser.rb
 - lib/eager_eye/scope_parser.rb
 - lib/eager_eye/serializer_usage_parser.rb
+- lib/eager_eye/source_parser.rb
 - lib/eager_eye/validation_parser.rb
 - lib/eager_eye/version.rb
 - sig/eager_eye.rbs