sidenotes 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24381f7028cc342a69f1b713f2604ae0a0bdc829d675f8f866241550e13b4440
-  data.tar.gz: 384a71a3b65bf767fd3634a84e03125329cb72fb5638dd29a9160a3f157e9bca
+  metadata.gz: 49cfca99965003c2f6fbff02ac2d9a930671bec5bb36f0cafecbb03e8c2e47f1
+  data.tar.gz: 505db15a10c3df2c3af8d3d3425d1cb3ea4580faf22a24fe0ba10a48dd0c432d
 SHA512:
-  metadata.gz: 23c955f99d8e8c4f46c221cc96332907ba20dd6492271eb176ce2ca07a40842a460720b17f8294acdc929980e59b014706acf4ac8363c405708df4864d07c368
-  data.tar.gz: 8a37de79dc70a7e941845485b2435bbabf9580fc07caaa6db9c86a4f55204fd3d84cbc01c23be1196c87715a83c52b6daae899e6c41061bd953ac6a8e6063ecb
+  metadata.gz: 042f58ab4161438219e6980cd8637bb07395e91bd4240e1c7bc729362c3a27d99b0d67cd2ff91c17103a58deb2fd6fa830de42749bdc1bceadc44fd7c7fb6334
+  data.tar.gz: 6e621545a5d90913fa388317bec1fc84bd75c7f0e2407be88f701eeff6d4d957a5f1b949379475b4ae4668edecf6af72dfd42db3adebb19b1b58fdde5f7ff808

data/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.1] - 2026-05-01
+
+### Added
+
+- `sidenotes:verify` now detects pending migrations and reports them as drift (exits 1). This catches the case where a migration file exists but hasn't been applied, where the sidecars and DB happen to match but the test suite would later fail with `ActiveRecord::PendingMigrationError`.
+- Verifier API: `Sidenotes::Verifier#pending_migrations`, `#pending_migrations?`
+
+### Changed
+
+- `Verifier#drift?` and `#issue_count` now include pending migrations.
+- Migration context lookup supports both pre-7.2 (`connection.migration_context`) and 7.2+ (`connection_pool.migration_context`) APIs.
+
 ## [0.2.0] - 2026-04-29
 
 ### Added

data/README.md

@@ -79,7 +79,7 @@ rake sidenotes:clean
 rake sidenotes:verify
 ```
 
-Compares each `.annotations/` sidecar file against the live database schema and reports drift (missing/extra columns, indexes, associations, foreign keys, or models without sidecars). Exits with status `1` if any drift is detected, making it suitable for CI:
+Compares each `.annotations/` sidecar file against the live database schema and reports drift (missing/extra columns, indexes, associations, foreign keys, or models without sidecars). It also surfaces **pending migrations** — if a migration file exists but hasn't been applied, sidenotes flags it before doing the schema comparison, since the test suite would fail later anyway. Exits with status `1` if any drift or pending migrations are detected, making it suitable for CI:
 
 ```yaml
 # .github/workflows/ci.yml

data/lib/sidenotes/railtie.rb

@@ -68,18 +68,37 @@ module Sidenotes
       puts "Checking #{verifier.checked_count} model annotations against database..."
       puts
 
+      print_pending_migrations(verifier) if verifier.pending_migrations?
+      print_drifts(verifier)
+      print_missing_sidecars(verifier)
+      print_summary(verifier)
+    end
+
+    def self.print_pending_migrations(verifier)
+      puts '  PENDING MIGRATIONS detected (run `rails db:migrate` first):'
+      verifier.pending_migrations.each do |m|
+        puts "    - #{m['version']} #{m['name']}"
+      end
+      puts
+    end
+
+    def self.print_drifts(verifier)
       verifier.drifts.each do |drift|
         puts "  #{File.basename(drift.sidecar_path)} - DRIFT:"
         drift.issues.each { |issue| puts "    #{issue}" }
         puts
       end
+    end
 
+    def self.print_missing_sidecars(verifier)
       verifier.missing_sidecars.each do |name|
         puts "  #{name} - MISSING (model exists, no sidecar file)"
       end
+    end
 
+    def self.print_summary(verifier)
       if verifier.drift?
-        puts "#{verifier.issue_count} issue(s) found. Run `rake sidenotes:generate` to update."
+        puts "#{verifier.issue_count} issue(s) found. Run `rake db:migrate && rake sidenotes:generate` to update."
       else
         puts 'All annotations are up to date.'
       end

data/lib/sidenotes/verifier.rb

@@ -7,20 +7,37 @@ module Sidenotes
   class Verifier
     Drift = Struct.new(:model_name, :sidecar_path, :issues, keyword_init: true)
 
-    attr_reader :drifts, :missing_sidecars, :checked_count
+    attr_reader :drifts, :missing_sidecars, :checked_count, :pending_migrations
 
     def initialize
       @drifts = []
       @missing_sidecars = []
       @checked_count = 0
+      @pending_migrations = []
     end
 
     def verify_all
+      check_pending_migrations
       generator = Generator.new
       generator.discover_models.each { |model| verify_model(model) }
       self
     end
 
+    def check_pending_migrations
+      context = migration_context
+      return unless context.respond_to?(:pending_migrations)
+
+      @pending_migrations = context.pending_migrations.map do |m|
+        { 'version' => m.version, 'name' => m.name }
+      end
+    rescue StandardError => e
+      warn "Sidenotes: could not check pending migrations: #{e.message}"
+    end
+
+    def pending_migrations?
+      pending_migrations.any?
+    end
+
     def verify_model(model)
       inspector = ModelInspector.new(model)
       return unless inspector.inspectable?
@@ -43,15 +60,29 @@ module Sidenotes
     end
 
     def drift?
-      drifts.any? || missing_sidecars.any?
+      drifts.any? || missing_sidecars.any? || pending_migrations?
     end
 
     def issue_count
-      drifts.sum { |d| d.issues.size } + missing_sidecars.size
+      drifts.sum { |d| d.issues.size } + missing_sidecars.size + pending_migrations.size
     end
 
     private
 
+    def migration_context
+      return nil unless defined?(ActiveRecord::Base)
+
+      pool = ActiveRecord::Base.connection_pool
+      return pool.migration_context if pool.respond_to?(:migration_context)
+
+      conn = ActiveRecord::Base.connection
+      return conn.migration_context if conn.respond_to?(:migration_context)
+
+      nil
+    rescue StandardError
+      nil
+    end
+
     def sidecar_path_for(model)
       config = Sidenotes.configuration
       File.join(config.output_directory, "#{model.name.underscore}.#{config.file_extension}")

data/lib/sidenotes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sidenotes
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidenotes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Wes Mason
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-29 00:00:00.000000000 Z
+date: 2026-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord