officer_neetzsche 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 271ee4879a7e1972dfd96edbf5ed8db9ce1edcd6c642631f52d6aa77bba9f7c6
-  data.tar.gz: 4d6ce8fb83453d12b2bdbe4824974e776247fbbdb2a3f304d8f4fcf641fb9a5a
+  metadata.gz: 100c19f093b3f8972a0c73262ea4d1020057aea94a4835ac2a3e573d6b4d95c6
+  data.tar.gz: 7d267e9d2cd3c091223b63c65243aa9f369d3cc8356de4346772188edcfdd681
 SHA512:
-  metadata.gz: f2380fae302b365699c193d7b8721ca3ed35a56e18b039b9c335ac4bb79815db3c35afaad341512e737c06332dc35ac752d9233ed518dc92c77bb1f777610314
-  data.tar.gz: 702240bef2cf52c4fab6882271c737f0b5381d48917e3b3a10bdc43d4d36433dc1139eb6dc798db07495d9f6ca74608bc21283de9d690b8a8260a3e0490c2d62
+  metadata.gz: 8cf5f9105e71d0044dbbe8267db688767ea642f73ef6a00bc4272930e2bd8cecd3e42a6529b195e5b9ba905917345021447a701164372616e8c2fa214ae78b6c
+  data.tar.gz: b4fafbac860b255990358dfc15e95a4463358b3106a72fdb54627908f5484516722c0a616299e862c28241fef26e4a438d2cd1d3026d82c3d0e6b81bdb7c285d

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## 0.1.0 (unreleased)
+## 0.2.0 (unreleased)
+
+### Added
+
+- `NEETzsche/GeneratedMigrationTimestamp`: flags a migration file whose timestamp prefix is missing, impossible, in the future, or a round or patterned clock time that a hand or an LLM typed instead of `bin/rails generate migration`. Runs on `db/migrate/**/*.rb` and `db/*_migrate/**/*.rb`.
+
+## 0.1.0 (2026-09-09)
 
 - Add `NEETzsche/NoComments`, ported from hyperborea-news.
 - Disable `Style/Documentation` whenever the plugin is loaded, since it demands the comments `NEETzsche/NoComments` forbids.

data/README.md

@@ -1,11 +1,14 @@
 # OfficerNEETzsche
 
+[![Gem Version](https://badge.fury.io/rb/officer_neetzsche.svg)](https://rubygems.org/gems/officer_neetzsche)
+
 RuboCop cops that enforce NEETzsche-isms. Every cop ships enabled: register the plugin and the rules apply.
 
 ## Cops
 
 | Cop | Enforces | Autocorrect |
 | --- | --- | --- |
+| `NEETzsche/GeneratedMigrationTimestamp` | Migration timestamps come from `bin/rails generate migration`, not a keyboard. | No |
 | `NEETzsche/NoComments` | No comments. The code explains itself. | Yes |
 
 ## Requirements
@@ -23,15 +26,13 @@ group :development, :test do
 end
 ```
 
-Until the gem is published to RubyGems, point Bundler at the repository instead:
+Then run `bundle install`. Or install it directly:
 
-```ruby
-group :development, :test do
-  gem "officer_neetzsche", github: "TheStranjer/OfficerNEETzsche", require: false
-end
+```sh
+gem install officer_neetzsche
 ```
 
-Then run `bundle install`.
+The gem is published at [rubygems.org/gems/officer_neetzsche](https://rubygems.org/gems/officer_neetzsche).
 
 ## Usage
 
@@ -58,6 +59,54 @@ Autocorrect what they flag:
 bundle exec rubocop --autocorrect --only NEETzsche
 ```
 
+## NEETzsche/GeneratedMigrationTimestamp
+
+Flags a migration file whose 14-digit timestamp prefix looks typed rather than generated. `bin/rails generate migration` stamps the file with the current UTC second, and that second is almost never round. A person, or an LLM writing the file without running the generator, reaches for round numbers and patterns instead.
+
+```
+# bad
+db/migrate/20240101000000_create_users.rb
+db/migrate/20240101000001_create_posts.rb
+db/migrate/20240115120000_add_email_to_users.rb
+db/migrate/20240315143000_create_comments.rb
+db/migrate/20240601123456_add_index_to_comments.rb
+
+# good
+db/migrate/20260409074855_create_users.rb
+```
+
+The offense sits on the first line of the file and names the tell:
+
+- **No 14-digit timestamp.** `001_create_users.rb`, `20240101_create_users.rb`, `create_users.rb`.
+- **Not a real date or time.** `2023-02-29`, month `13`, hour `24`, minute or second `60`.
+- **In the future.** A date later than today in UTC.
+- **A round clock time.** Seconds `00` on a five-minute mark: `00:00:00`, `12:00:00`, `14:30:00`, `09:15:00`.
+- **A round hour plus a counter.** Up to nine seconds or nine minutes past any hour (`12:00:01`, `12:01:00`), or any whole minute or second past midnight (`00:00:23`, `00:37:00`). Incrementing the last digits of a copied timestamp produces these.
+- **One number repeated.** `11:11:11`, `12:12:12`.
+- **Consecutive numbers.** `01:02:03`, `10:11:12`.
+- **A placeholder time.** `12:34:56`, `01:23:45`, `10:20:30`, `11:22:33`, `15:30:45`, `23:59:59`.
+
+A time that only ends in `:00`, such as `14:17:00`, passes. The date is not judged beyond existing and having happened, so a migration generated on New Year's Day passes too.
+
+The cop runs on `db/migrate/**/*.rb` and on the `db/*_migrate/**/*.rb` directories that multiple-database setups use. About one generated timestamp in a hundred lands on a clock-time tell, so an established project may see a few legitimate migrations flagged. Never rename a migration that has run anywhere, since its version is recorded in `schema_migrations`. Exclude the file instead:
+
+```yaml
+NEETzsche/GeneratedMigrationTimestamp:
+  Exclude:
+    - "db/migrate/20230614140700_add_index_to_users.rb"
+```
+
+Or silence it from the first line with a directive, which `NEETzsche/NoComments` allows:
+
+```ruby
+# rubocop:disable NEETzsche/GeneratedMigrationTimestamp
+class AddIndexToUsers < ActiveRecord::Migration[8.0]
+```
+
+Projects that set `config.active_record.timestamped_migrations = false` number their migrations `001`, `002`, and so on. Every one of those trips the cop, so disable it there.
+
+There is no autocorrect. The fix is to delete the file and run `bin/rails generate migration` again.
+
 ## NEETzsche/NoComments
 
 Flags every comment. On autocorrect, a comment on its own line is deleted along with the line, and a trailing comment is deleted along with the whitespace before it.

data/config/default.yml

@@ -1,6 +1,14 @@
 NEETzsche:
   Enabled: true
 
+NEETzsche/GeneratedMigrationTimestamp:
+  Description: "Requires migration filenames to carry the timestamp `bin/rails generate migration` stamped, not a round or patterned one typed by hand."
+  Enabled: true
+  VersionAdded: "0.2.0"
+  Include:
+    - "**/db/migrate/**/*.rb"
+    - "**/db/*_migrate/**/*.rb"
+
 NEETzsche/NoComments:
   Description: "Forbids comments. Magic comments, shebangs, and rubocop directives are allowed."
   Enabled: true

data/lib/officer_neetzsche/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OfficerNEETzsche
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rubocop/cop/neetzsche/generated_migration_timestamp.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "date"
+
+module RuboCop
+  module Cop
+    module NEETzsche
+      class GeneratedMigrationTimestamp < Base
+        include RangeHelp
+
+        MSG = "Migration timestamp `%<timestamp>s` looks made up; %<tell>s. " \
+              "Let `bin/rails generate migration` name the file."
+        MSG_NO_TIMESTAMP = "Migration filename `%<basename>s` does not start with a 14-digit " \
+                           "`YYYYMMDDHHMMSS_` timestamp. Let `bin/rails generate migration` name the file."
+
+        VERSION_PREFIX = /\A\d+(?=_)/.freeze
+
+        def on_new_investigation
+          basename = File.basename(processed_source.file_path)
+          digits = basename[VERSION_PREFIX]
+          message = if digits&.length == 14
+                      made_up_message(digits)
+                    else
+                      format(MSG_NO_TIMESTAMP, basename: basename)
+                    end
+
+          add_offense(first_character, message: message) if message
+        end
+
+        private
+
+        def made_up_message(digits)
+          tell = Timestamp.new(digits).tell
+          format(MSG, timestamp: digits, tell: tell) if tell
+        end
+
+        def first_character
+          source_range(processed_source.buffer, 1, 0)
+        end
+
+        class Timestamp
+          PLACEHOLDERS = %w[123456 012345 102030 112233 153045 235959].freeze
+
+          def initialize(digits)
+            @digits = digits
+            @year, @month, @day, @hour, @minute, @second = digits.unpack("a4a2a2a2a2a2").map(&:to_i)
+          end
+
+          def tell
+            return "`#{date}` is not a real date" unless Date.valid_date?(@year, @month, @day)
+            return "`#{clock}` is not a real time" unless real_time?
+            return "`#{date}` is in the future" if Date.new(@year, @month, @day) > Time.now.utc.to_date
+
+            clock_tell
+          end
+
+          private
+
+          def clock_tell
+            if round? then "`#{clock}` is a round clock time"
+            elsif counter? then "`#{clock}` is a round hour plus a counter"
+            elsif repeated? then "`#{clock}` repeats one number"
+            elsif consecutive? then "`#{clock}` is three consecutive numbers"
+            elsif placeholder? then "`#{clock}` is a placeholder time"
+            end
+          end
+
+          def date
+            "#{@digits[0, 4]}-#{@digits[4, 2]}-#{@digits[6, 2]}"
+          end
+
+          def clock
+            "#{@digits[8, 2]}:#{@digits[10, 2]}:#{@digits[12, 2]}"
+          end
+
+          def real_time?
+            @hour < 24 && @minute < 60 && @second < 60
+          end
+
+          def round?
+            @second.zero? && (@minute % 5).zero?
+          end
+
+          def counter?
+            return @minute.zero? || @second.zero? if @hour.zero?
+
+            (@minute.zero? && @second < 10) || (@second.zero? && @minute < 10)
+          end
+
+          def repeated?
+            @hour == @minute && @minute == @second
+          end
+
+          def consecutive?
+            @minute == @hour + 1 && @second == @minute + 1
+          end
+
+          def placeholder?
+            PLACEHOLDERS.include?(@digits[8, 6])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/neetzsche_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative "neetzsche/generated_migration_timestamp"
 require_relative "neetzsche/no_comments"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: officer_neetzsche
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - TheStranjer
@@ -51,6 +51,7 @@ files:
 - lib/officer_neetzsche.rb
 - lib/officer_neetzsche/plugin.rb
 - lib/officer_neetzsche/version.rb
+- lib/rubocop/cop/neetzsche/generated_migration_timestamp.rb
 - lib/rubocop/cop/neetzsche/no_comments.rb
 - lib/rubocop/cop/neetzsche_cops.rb
 homepage: https://github.com/TheStranjer/OfficerNEETzsche