moderate 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7604220d418947fa60f707ff40e41635b58f0e1dddb73b5e79d44ab4f37caf46
-  data.tar.gz: 48f55fa68865042efffe9c733f19ac031f89f8d1eaa1a91e03ef5f5dfaee6f48
+  metadata.gz: 855c6c868845a30cb2cc8ace230bb926b77b530eff47ee975b3137ceea0e6278
+  data.tar.gz: 87ba2fc546cadd8cdf0e0b53aca9936e2627f810c4ea685884c1742a09ea9565
 SHA512:
-  metadata.gz: cc7dca23c94332145107036a6fa411034f78aa17b8006341fc50ad5937ef6163cc147a02df68fd726806ca9eb5ad4b0bc922846fe1bb8c55a151a301a552d0bd
-  data.tar.gz: 6d0405cf47e6e8256e43bbf0b17d478ecb905451d1795a0e64dacccddf406ae2865d41e2e97ca574251be961f4b19890673bef53e94d9c40b499c8a3f0e503f2
+  metadata.gz: 416181ed2e12216dbd154511a5eec55d0f2e4ff9d6840c9f29a3b1b8e1ef126b241dbfa8f8d5145270a5af1cd97949bd1105ea41829da3f5a163ecaa89692885
+  data.tar.gz: fe0e4aadad27c758d72928ff95148a992b65e79eef3ba30946a8c76438b9e580536585baa03fa2ddafc363cf4741084291af25e3448de59b6d59298f5dffb09e

data/.rubocop.yml

@@ -101,3 +101,10 @@ Lint/UselessAccessModifier:
 # under a `raise`, or indented under a keyword); the code uses both.
 Layout/LineEndStringConcatenationIndentation:
   Enabled: false
+
+# The gem's own migrations are copied into host apps, many of them on Rails' omakase
+# style, which spaces array brackets (`[ :a, :b ]`); they follow that style, checked by
+# test/generators/omakase_style_test.rb.
+Layout/SpaceInsideArrayLiteralBrackets:
+  Exclude:
+    - "db/migrate/**/*"

data/CHANGELOG.md

@@ -4,6 +4,39 @@ All notable changes to this project are documented here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2026-10-19
+
+### Upgrading from 1.0.0
+
+- **One migration: run `bin/rails moderate:install:migrations` (if your app holds copies of
+  the gem's migrations, `*.moderate.rb`; boot tells you if you forget), then
+  `bin/rails db:migrate`.** `db/migrate/20261019120000_change_moderate_classifications_record_id_to_string.rb`
+  makes `moderate_classifications.record_id` a string and caps it and `digest` at 64
+  characters (which keeps the table's unique index within MySQL's 3072-byte key limit).
+  Existing rows keep their ids, as strings. Polymorphic ids compare bytewise on every
+  database (on MySQL and Trilogy the column is `utf8mb4_bin`, as `pending_key` is). Guarded
+  (a no-op when the column is already a string) and reversible: `down` turns `record_id`
+  back into your primary-key type, and first refuses with `ActiveRecord::IrreversibleMigration`,
+  naming how many, while any row holds an id that type can't hold (for bigint: anything but
+  an integer within the signed 64-bit range, negatives included; for uuid: anything but the
+  canonical 8-4-4-4-12 form, in either case); delete those
+  classification rows (bookkeeping, re-created on the next classification) and run it
+  again.
+
+### Fixed
+
+- **Attachment classification works in apps that mix uuid and bigint primary keys.**
+  1.0.0 created `moderate_classifications.record_id` with the app's one primary-key type,
+  so records of the other kind couldn't be claimed or marked classified. It is a string
+  now (above).
+- **The migrations an app receives pass a Rails omakase app's RuboCop.** The gem's
+  migrations and the install template use omakase's array-bracket spacing, and the copies
+  `rails generate moderate:install` writes keep the blank line after the magic comment,
+  as `bin/rails moderate:install:migrations` (Rails' own copy) does. A test runs
+  rubocop-rails-omakase on both kinds of copies and on the generated initializer, so a host
+  needs no exclude for them. The README also explains the `.moderate` suffix Rails adds to
+  copied migrations' names in `db:migrate:status`.
+
 ## [1.0.0] - 2026-10-19
 
 The first stable release. The public API is frozen until 2.0: everything listed in the

data/README.md

@@ -527,6 +527,10 @@ Audit events (`Moderate::Event::AUDIT_NAMES`): `:report_received` · `:appeal_re
 
 Every hook receives one `Moderate::Event`: `#name` · `#subject` · `#actor` · `#recipients` · `#payload` (always with `:summary`) · `#occurred_at` · `#id` · `#summary` · `#to_h`. The contract for `config.notify`: it is called once per event, after the transaction that caused it commits (never for a rolled-back change); a truthy return means "handed off" (for a DSA notice the gem then treats the Art. 16(4) receipt as sent); a decision notice counts as delivered only when your notifier confirms it with `Moderate.delivered!(report, :decision | :affected_user)` from the mail's actual delivery, which stamps `decision_notified_at` / `affected_user_notified_at` once and starts the appeal window from then (DSA Art. 20(2)); an exception is swallowed, audited as `:notify_failed`, and never rolls back the decision. `config.audit` follows the same rules and its return value is ignored. Payload keys may be added in a minor release, never removed or renamed.
 
+## Upgrading within 1.0
+
+**1.0.1 adds a migration** (`moderate_classifications.record_id` becomes a string, so apps that mix uuid and bigint primary keys classify attachments on both): run `bin/rails moderate:install:migrations` if your app holds copies of the gem's migrations, then `bin/rails db:migrate`. The copies follow the RuboCop style of a new Rails app (rubocop-rails-omakase), so they need no exclude. In `bin/rails db:migrate:status` a copied migration's name ends in `.moderate` (`Add pending key to moderate flags.moderate`): that is Rails' own naming for migrations copied from an engine, not a broken copy.
+
 ## Upgrading from a 1.0 beta
 
 **1.0.0 adds a migration** (retention columns and `moderate_classifications`): run `bin/rails moderate:install:migrations` if your app holds copies of the gem's migrations (`*.moderate.rb`, as every app installed from 1.0.0.beta4 on does), then `bin/rails db:migrate`. An app without copies gets it through the engine, like beta4's. **A missed copy is no longer silent:** at boot, an app that holds copies but not one of this version's migrations raises `Moderate::ConfigurationError` naming it and the command that copies it (under a rake task, such as that command itself, it logs instead); `config.migration_copies_check = :log` or `:off` changes that.

data/db/migrate/20261018200000_add_pending_key_to_moderate_flags.rb

@@ -102,7 +102,7 @@ class AddPendingKeyToModerateFlags < ActiveRecord::Migration[7.1]
       newest[key] = flag if newest[key].nil? || flag.created_at > newest[key].created_at
     end
     taken = Flag.where.not(pending_key: nil).pluck(:pending_key).to_set
-    newest.except(*taken).to_h { |key, flag| [flag.id, key] }
+    newest.except(*taken).to_h { |key, flag| [ flag.id, key ] }
   end
 
   # The keys to write and the keys already written, in a temporary table whose key

data/db/migrate/20261018210000_add_retention_and_classifications_to_moderate_tables.rb

@@ -98,6 +98,6 @@ class AddRetentionAndClassificationsToModerateTables < ActiveRecord::Migration[8
   def key_types
     config = Rails.configuration.generators
     setting = config.options[config.orm][:primary_key_type]
-    [setting || :primary_key, setting || :bigint]
+    [ setting || :primary_key, setting || :bigint ]
   end
 end

data/db/migrate/20261019120000_change_moderate_classifications_record_id_to_string.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# 1.0.1: moderate_classifications.record_id becomes a string, so an app that mixes
+# uuid and bigint primary keys records classifications for every kind of record (1.0.0
+# created it with the app's one primary-key type). `digest` (always 16 hex characters)
+# and `record_id` (a uuid is 36, a bigint at most 20) are capped at 64 characters, so
+# the unique index on (record_type, record_id, field, digest) stays within MySQL's
+# 3072-byte key limit.
+#
+# On MySQL (and Trilogy) record_id is utf8mb4_bin, so ids compare bytewise, as they do
+# on PostgreSQL and SQLite: "abc" and "ABC" are two records.
+#
+# Ships with the gem: `rails generate moderate:install` copies it after the others,
+# an app holding copies gets it with `bin/rails moderate:install:migrations`, and an
+# app without copies gets it through the engine. Guarded, so it is a no-op when the
+# column is already a string, and reversible: `down` turns record_id back into the
+# app's primary-key type, and first refuses (naming how many) if any row holds an id
+# of the other key kind, which that type can't keep.
+class ChangeModerateClassificationsRecordIdToString < ActiveRecord::Migration[8.0]
+  # The table as it is, not the app's model: a migration must not depend on code.
+  class Classification < ActiveRecord::Base
+    self.table_name = "moderate_classifications"
+  end
+
+  # The canonical 8-4-4-4-12 form, either case: what Rails writes for a uuid key. (Other
+  # forms PostgreSQL accepts as uuid input, braces or no hyphens, aren't expected here.)
+  UUID = /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/i
+  BIGINT = /\A-?\d+\z/
+  BIGINT_RANGE = (-(2**63))..((2**63) - 1)
+
+  def up
+    return unless table_exists?(:moderate_classifications)
+    return if column_type(:record_id) == :string
+
+    change_column :moderate_classifications, :digest, :string, limit: 64, null: false
+    change_column :moderate_classifications, :record_id, :string, limit: 64, null: false, **binary, **cast("varchar")
+  end
+
+  def down
+    return unless table_exists?(:moderate_classifications)
+    return unless column_type(:record_id) == :string
+
+    key_type = key_type_setting || :bigint
+    refuse_unfit_ids!(key_type)
+    change_column :moderate_classifications, :record_id, key_type, null: false, **cast(key_type == :uuid ? "uuid" : "bigint")
+    change_column :moderate_classifications, :digest, :string, null: false
+  end
+
+  private
+
+  # Rows whose record_id the app's key type can't hold (a uuid in a bigint app, or the
+  # reverse): rolling back would fail midway on PostgreSQL and MySQL, or keep the text
+  # in an integer column on SQLite.
+  def refuse_unfit_ids!(key_type)
+    unfit = unfit_ids_count(key_type)
+    return if unfit.zero?
+
+    raise ActiveRecord::IrreversibleMigration,
+      "#{unfit} moderate_classifications row(s) hold a record_id that isn't a #{key_type} id, so record_id " \
+      "can't go back to #{key_type}. Delete those classification rows first; they are bookkeeping, " \
+      "re-created on the next classification."
+  end
+
+  def unfit_ids_count(key_type)
+    Classification.reset_column_information
+    unfit = 0
+    Classification.in_batches(of: 1000) do |batch|
+      unfit += batch.pluck(:record_id).count { |id| !fits?(id.to_s, key_type) }
+    end
+    unfit
+  end
+
+  # A uuid in the canonical form; a bigint: an optionally negative integer within the
+  # signed 64-bit range (a longer one would fail the conversion, not this refusal).
+  def fits?(id, key_type)
+    return UUID.match?(id) if key_type == :uuid
+
+    BIGINT.match?(id) && BIGINT_RANGE.cover?(id.to_i)
+  end
+
+  def mysql?
+    connection.adapter_name.downcase.match?(/mysql|trilogy/)
+  end
+
+  # Bytewise comparison on MySQL, whose default collation ignores case.
+  def binary
+    mysql? ? { collation: "utf8mb4_bin" } : {}
+  end
+
+  def column_type(name)
+    connection.columns(:moderate_classifications).find { |column| column.name == name.to_s }&.type
+  end
+
+  # PostgreSQL needs the conversion spelled out; MySQL and SQLite convert by themselves.
+  def cast(type)
+    connection.adapter_name.downcase.include?("postg") ? { using: "record_id::#{type}" } : {}
+  end
+
+  def key_type_setting
+    config = Rails.configuration.generators
+    config.options[config.orm][:primary_key_type]
+  end
+end

data/gemfiles/rails_8.0.gemfile

@@ -13,6 +13,7 @@ group :development do
   gem "rubocop", "~> 1.0"
   gem "rubocop-minitest", "~> 0.35"
   gem "rubocop-performance", "~> 1.0"
+  gem "rubocop-rails-omakase", require: false
   gem "standard"
 end
 

data/gemfiles/rails_8.1.gemfile

@@ -12,6 +12,7 @@ group :development do
   gem "rubocop", "~> 1.0"
   gem "rubocop-minitest", "~> 0.35"
   gem "rubocop-performance", "~> 1.0"
+  gem "rubocop-rails-omakase", require: false
   gem "standard"
 end
 

data/lib/generators/moderate/install_generator.rb

@@ -66,11 +66,15 @@ module Moderate
 
       private
 
-      # As Rails' engine copy writes it: magic comments first, then where it came from.
+      # As Rails' engine copy writes it: magic comments first (with the blank line after
+      # them that the source has, which RuboCop's omakase style asks for), then where it
+      # came from, then the rest.
       def copied_migration(source, version)
         body = File.read(source)
         magic = body[/\A(?:#.*\b(?:coding|frozen_string_literal):.*\n)+/].to_s
-        "#{magic}# This migration comes from moderate (originally #{version})\n#{body.delete_prefix(magic)}"
+        rest = body.delete_prefix(magic)
+        magic += "\n" if !magic.empty? && rest.start_with?("\n")
+        "#{magic}# This migration comes from moderate (originally #{version})\n#{rest.delete_prefix("\n")}"
       end
 
       def migration_version

data/lib/generators/moderate/templates/create_moderate_tables.rb.erb

@@ -70,12 +70,12 @@ class CreateModerateTables < ActiveRecord::Migration<%= migration_version %>
       t.timestamps
     end
 
-    add_index :moderate_reports, [:reportable_type, :reportable_id], name: "index_moderate_reports_on_reportable"
-    add_index :moderate_reports, [:reported_user_id, :status], name: "index_moderate_reports_on_reported_user_id_and_status"
-    add_index :moderate_reports, [:reporter_id, :created_at], name: "index_moderate_reports_on_reporter_id_and_created_at"
-    add_index :moderate_reports, [:status, :created_at], name: "index_moderate_reports_on_status_and_created_at"
-    add_index :moderate_reports, [:intake_kind, :created_at], name: "index_moderate_reports_on_intake_kind_and_created_at"
-    add_index :moderate_reports, [:legal_reason, :created_at], name: "index_moderate_reports_on_legal_reason_and_created_at"
+    add_index :moderate_reports, [ :reportable_type, :reportable_id ], name: "index_moderate_reports_on_reportable"
+    add_index :moderate_reports, [ :reported_user_id, :status ], name: "index_moderate_reports_on_reported_user_id_and_status"
+    add_index :moderate_reports, [ :reporter_id, :created_at ], name: "index_moderate_reports_on_reporter_id_and_created_at"
+    add_index :moderate_reports, [ :status, :created_at ], name: "index_moderate_reports_on_status_and_created_at"
+    add_index :moderate_reports, [ :intake_kind, :created_at ], name: "index_moderate_reports_on_intake_kind_and_created_at"
+    add_index :moderate_reports, [ :legal_reason, :created_at ], name: "index_moderate_reports_on_legal_reason_and_created_at"
     add_index :moderate_reports, :notifier_email, name: "index_moderate_reports_on_notifier_email"
     add_index :moderate_reports, :resolved_at, name: "index_moderate_reports_on_resolved_at"
     add_index :moderate_reports, :appeal_deadline_at, name: "index_moderate_reports_on_appeal_deadline_at"
@@ -106,7 +106,7 @@ class CreateModerateTables < ActiveRecord::Migration<%= migration_version %>
       t.timestamps
     end
 
-    add_index :moderate_blocks, [:blocker_id, :blocked_id], unique: true, name: "index_moderate_blocks_on_blocker_id_and_blocked_id"
+    add_index :moderate_blocks, [ :blocker_id, :blocked_id ], unique: true, name: "index_moderate_blocks_on_blocker_id_and_blocked_id"
     add_index :moderate_blocks, :created_at, name: "index_moderate_blocks_on_created_at"
 
     add_check_constraint :moderate_blocks,
@@ -147,9 +147,9 @@ class CreateModerateTables < ActiveRecord::Migration<%= migration_version %>
       t.timestamps
     end
 
-    add_index :moderate_flags, [:flaggable_type, :flaggable_id, :field], name: "index_moderate_flags_on_target_and_field"
-    add_index :moderate_flags, [:owner_id, :status], name: "index_moderate_flags_on_owner_id_and_status"
-    add_index :moderate_flags, [:status, :created_at], name: "index_moderate_flags_on_status_and_created_at"
+    add_index :moderate_flags, [ :flaggable_type, :flaggable_id, :field ], name: "index_moderate_flags_on_target_and_field"
+    add_index :moderate_flags, [ :owner_id, :status ], name: "index_moderate_flags_on_owner_id_and_status"
+    add_index :moderate_flags, [ :status, :created_at ], name: "index_moderate_flags_on_status_and_created_at"
 
     # moderate_flags.pending_key (at most one PENDING flag per content + field) is NOT
     # here: the gem's own AddPendingKeyToModerateFlags creates it, for a fresh install
@@ -188,8 +188,8 @@ class CreateModerateTables < ActiveRecord::Migration<%= migration_version %>
       t.timestamps
     end
 
-    add_index :moderate_appeals, [:report_id, :created_at], name: "index_moderate_appeals_on_report_id_and_created_at"
-    add_index :moderate_appeals, [:status, :created_at], name: "index_moderate_appeals_on_status_and_created_at"
+    add_index :moderate_appeals, [ :report_id, :created_at ], name: "index_moderate_appeals_on_report_id_and_created_at"
+    add_index :moderate_appeals, [ :status, :created_at ], name: "index_moderate_appeals_on_status_and_created_at"
     add_index :moderate_appeals, :appellant_email, name: "index_moderate_appeals_on_appellant_email"
 
     # The 1.0 retention columns (redacted_at, held_until) and moderate_classifications
@@ -209,7 +209,7 @@ class CreateModerateTables < ActiveRecord::Migration<%= migration_version %>
     setting = config.options[config.orm][:primary_key_type]
     primary_key_type = setting || :primary_key
     foreign_key_type = setting || :bigint
-    [primary_key_type, foreign_key_type]
+    [ primary_key_type, foreign_key_type ]
   end
 
   def json_column_type

data/lib/moderate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Moderate
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: moderate
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - rameerez
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -141,6 +141,7 @@ files:
 - context7.json
 - db/migrate/20261018200000_add_pending_key_to_moderate_flags.rb
 - db/migrate/20261018210000_add_retention_and_classifications_to_moderate_tables.rb
+- db/migrate/20261019120000_change_moderate_classifications_record_id_to_string.rb
 - docs/chats.md
 - docs/compliance.md
 - docs/configuration.md
@@ -216,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Let your Rails users report content and block each other (Trust & Safety)
 test_files: []