-
-
Notifications
You must be signed in to change notification settings - Fork 263
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new
Rails/MigrationClassName
cop
This cop enforces that migration file names start with a valid timestamp.
- Loading branch information
1 parent
b040d84
commit 6c5a722
Showing
5 changed files
with
130 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* [#1044](https://github.com/rubocop/rubocop-rails/pull/1044): Add new `Rails/MigrationClassName` cop. ([@sambostock][]) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'time' | ||
|
||
module RuboCop | ||
module Cop | ||
module Rails | ||
# Checks that migration file names start with a valid timestamp. | ||
# | ||
# @example | ||
# # bad | ||
# # db/migrate/bad.rb | ||
|
||
# # bad | ||
# # db/migrate/123_bad.rb | ||
|
||
# # bad | ||
# # db/migrate/20171301000000_bad.rb | ||
# | ||
# # good | ||
# # db/migrate/20170101000000_good.rb | ||
# | ||
class MigrationTimestamp < Base | ||
include RangeHelp | ||
|
||
MSG = 'Migration file name must start with `YYYYmmddHHMMSS_` timestamp.' | ||
|
||
def on_new_investigation | ||
file_path = processed_source.file_path | ||
return unless file_path.include?('db/migrate') | ||
|
||
timestamp = File.basename(file_path)[/\A\d{14}(?=_)/] | ||
return if valid_timestamp?(timestamp) | ||
|
||
add_offense(source_range(processed_source.buffer, 1, 0)) | ||
end | ||
|
||
private | ||
|
||
def valid_timestamp?(timestamp, format: '%Y%m%d%H%M%S') | ||
timestamp && | ||
(time = Time.strptime(timestamp, format)) && | ||
# Time.strptime fuzzily accepts invalid dates around boundaries | ||
# | Wrong Days per Month | 24th Hour | 60th Minute | 60th Second | ||
# ---------+----------------------+----------------+----------------+---------------- | ||
# Actual | 20000231000000 | 20000101240000 | 20000101006000 | 20000101000060 | ||
# Expected | 20000302000000 | 20000102000000 | 20000101010000 | 20000101000100 | ||
# We want normalized values, so we can check if Time#strftime matches the original. | ||
time.strftime(format) == timestamp | ||
rescue ArgumentError | ||
false | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# frozen_string_literal: true | ||
|
||
RSpec.describe RuboCop::Cop::Rails::MigrationTimestamp, :config do | ||
it 'registers no offenses if timestamp is valid' do | ||
expect_no_offenses(<<~RUBY, 'db/migrate/20170101000000_good.rb') | ||
# ... | ||
RUBY | ||
end | ||
|
||
it 'registers an offense if timestamp is impossible' do | ||
expect_offense(<<~RUBY, 'db/migrate/20002222222222_bad.rb') | ||
# ... | ||
^ Migration file name must start with `YYYYmmddHHMMSS_` timestamp. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense if timestamp swaps month and day' do | ||
expect_offense(<<~RUBY, 'db/migrate/20003112000000_bad.rb') | ||
# ... | ||
^ Migration file name must start with `YYYYmmddHHMMSS_` timestamp. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense if timestamp day is wrong' do | ||
expect_offense(<<~RUBY, 'db/migrate/20000231000000_bad.rb') | ||
# ... | ||
^ Migration file name must start with `YYYYmmddHHMMSS_` timestamp. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense if timestamp hours are invalid' do | ||
expect_offense(<<~RUBY, 'db/migrate/20000101240000_bad.rb') | ||
# ... | ||
^ Migration file name must start with `YYYYmmddHHMMSS_` timestamp. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense if timestamp minutes are invalid' do | ||
expect_offense(<<~RUBY, 'db/migrate/20000101006000_bad.rb') | ||
# ... | ||
^ Migration file name must start with `YYYYmmddHHMMSS_` timestamp. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense if timestamp seconds are invalid' do | ||
expect_offense(<<~RUBY, 'db/migrate/20000101000060_bad.rb') | ||
# ... | ||
^ Migration file name must start with `YYYYmmddHHMMSS_` timestamp. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense if timestamp is invalid' do | ||
expect_offense(<<~RUBY, 'db/migrate/123_bad.rb') | ||
# ... | ||
^ Migration file name must start with `YYYYmmddHHMMSS_` timestamp. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense if no timestamp at all' do | ||
expect_offense(<<~RUBY, 'db/migrate/bad.rb') | ||
# ... | ||
^ Migration file name must start with `YYYYmmddHHMMSS_` timestamp. | ||
RUBY | ||
end | ||
end |