public_code 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535f7f0cf97ddb8664e239bfb344ee344763f4f9992ae47a30bbdc23b7eb4c6a
-  data.tar.gz: f6b8b87729c7c566cb14b31f6579107f01880ea4e713649a6e8b2694ae4aca9a
+  metadata.gz: 85226caa9d5bbc68eedc7aecda5105a079c13733853522736aa1fb04f6d99477
+  data.tar.gz: 5bfe2a1075d98348dad53b5b569d86e21c16938908f91ef08ea97015076df351
 SHA512:
-  metadata.gz: 044c101dcebc4c309d96a7fbe9a21d4b00f95f3e72b9685a843e08e2ac6475aead151f78b585e51a7a3ae705971543f46c71af7fcc8f2711579fc5a8a617407f
-  data.tar.gz: 4ac279aef93d9311b5450261df822179fe743f0c3c2a4d9293f25cf95c3ca117d06d6313c77a7271cec0e2510fe999b8fc99ff5c0d4d61402fbf7170b3261a87
+  metadata.gz: 7b25139d8cc38a6ef010df8bd0167022f39e35469d89a80c026386603224d23128d21079c193981c074bd4ff0bedf4212c826668568f36792b81479be1519b25
+  data.tar.gz: 5909c90e24ef0e6dc33956b1454b20b7d0f37c47c327f3923649774da7a8a26a00712195359041436d9e7c06fbbcee5256d26cd1516c9308fa51e05cd3b96a57

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## [Unreleased]
 
+## [0.3.0] - 2026-10-12
+
+### Added
+
+- `bin/rails public_code:status` lists every model that declares a code and whether it is addressed by code or by id.
+- With `STRICT=1` the status task fails naming each model still addressed by id.
+
 ## [0.2.0] - 2026-10-12
 
 ### Added

data/README.md

@@ -89,6 +89,19 @@ column with the gem and name it in the gem's changelog.
 An app switches a gem's records to codes by copying and running that migration,
 then restarting so the new column is seen.
 
+## Seeing which models still use ids
+
+In a Rails app:
+
+```
+bin/rails public_code:status
+```
+
+It lists every model that declares a code and says whether it is addressed by
+code or by id. With `STRICT=1` it fails when any model is still addressed by
+id, and names each one, so a deploy or CI step can require every migration to
+have run.
+
 ## Checking pages for numbered links
 
 In an integration test:

data/lib/public_code/model.rb

@@ -4,6 +4,7 @@ module PublicCode
 
     class_methods do
       def has_public_code(column = :public_code)
+        PublicCode.models << self
         define_singleton_method(:public_code_column?) { table_exists? && column_names.include?(column.to_s) }
         define_method(:give_public_code) { self[column] ||= PublicCode.generate if self.class.public_code_column? }
         define_method(:"regenerate_#{column}") { update!(column => PublicCode.generate) }

data/lib/public_code/railtie.rb

@@ -0,0 +1,5 @@
+module PublicCode
+  class Railtie < Rails::Railtie
+    rake_tasks { load File.expand_path("../tasks/public_code.rake", __dir__) }
+  end
+end

data/lib/public_code/version.rb

@@ -1,3 +1,3 @@
 module PublicCode
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/public_code.rb

@@ -8,6 +8,10 @@ module PublicCode
   LENGTH = 24
 
   def self.generate = ActiveRecord::Base.generate_unique_secure_token(length: LENGTH)
+
+  def self.models = @models ||= []
 end
 
 ActiveSupport.on_load(:active_record) { include PublicCode::Model }
+
+require "public_code/railtie" if defined?(Rails::Railtie)

data/lib/tasks/public_code.rake

@@ -0,0 +1,11 @@
+namespace :public_code do
+  desc "List each model that declares a code and whether it is addressed by code or by id, failing on any by id when STRICT=1"
+  task status: :environment do
+    Rails.application.eager_load! if defined?(Rails.application) && Rails.application
+    models = PublicCode.models.sort_by(&:name)
+    models.each { |model| puts "#{model.name} addressed by #{model.public_code_column? ? "code" : "id"}" }
+
+    by_id = models.reject(&:public_code_column?)
+    abort "Still addressed by id: #{by_id.map(&:name).join(", ")}" if ENV["STRICT"] == "1" && by_id.any?
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_code
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tyler Schneider
@@ -50,8 +50,10 @@ files:
 - README.md
 - lib/public_code.rb
 - lib/public_code/model.rb
+- lib/public_code/railtie.rb
 - lib/public_code/test_help.rb
 - lib/public_code/version.rb
+- lib/tasks/public_code.rake
 homepage: https://github.com/DYB-Development/public_code
 licenses:
 - MIT