Release 1.10.0

Author: gregnavis

CHANGELOG.md

@@ -1,3 +1,38 @@
+# Version 1.10.0
+
+* New feature: incorrect_length_validation detector can identify text-column
+  length mismatches between tables and models (suggested by fatkodima).
+* New feature: each detector can be enabled or disabled globally via the
+  configuration file.
+* Enhancement: missing_non_null_constraints and missing_presence_validation
+  recognized NOT NULL check constraints (contributed by fatkodima).
+* Enhancement: missing_unique_index is aware of has_one associations and
+  recommends creating an index on the corresponding foreign key (contributed by
+  fatkodima).
+* Bug fix: missing_unique_indexes can be satisfied by creating an index on a
+  sublist of scope + column. Previously, it'd not accept such sublists even
+  though they're enough to guarantee uniqueness (contributed by fatkodima).
+* Bug fix: fix missing_unique_indexes crashes on function indexes (contributed
+  by fatkodima).
+* Bug fix: short_primary_key_type no longer complains about UUID primary keys
+  (contributed by fatkodima).
+* Bug fix: extraneous_indexes was made aware of non-standard primary key names
+  and partial indexes (contributed by fatkodima).
+* Bug fix: extraneous_indexes properly recognizes smaller indexes to be enough
+  to guarantee uniqueness. Previously, it'd skip some smaller indexes and ask
+  for a larger index to be created (contributed by fatkodima).
+* Bug fix: unindexed_deleted_at correctly works on partial indexes intended to
+  cover deleted columns. It no longer asks to create a contradictory condition
+  (IS NULL AND IS NOT NULL) in those cases (contributed by fatkodima).
+* Bug fix: incorrect_dependent_option works correctly on polymorphic
+  associations.
+* Bug fix: recognize the PostGIS adapter as PostgreSQL (contributed by
+  fatkodima).
+* Bug fix: index generators use index_name_length (defined by Active Record) to
+  ensure index names aren't too long (contributed by fatkodima).
+* Tested against Ruby 3.1 via CI (contributed by Peter Goldstein).
+* Documentation fixes (contributed by Alistair McKinnell and Kaleb Lape).
+
 # Version 1.9.0
 
 * New feature: support for project-specific configuration and Continuous

README.md

@@ -91,7 +91,8 @@ build steps -- it returns a non-zero exit status if any errors were reported.
 
 ### Obtaining Help
 
-If you'd like to obtain help on a specific detector then use the `help` sub-task:
+If you'd like to obtain help on a specific detector then use the `help`
+sub-task:
 
 ```
 bundle exec rake active_record_doctor:extraneous_indexes:help
@@ -176,7 +177,8 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_tables` - tables whose foreign keys should not be checked
-- `ignore_columns` - columns, written as table.column, that should not be checked.
+- `ignore_columns` - columns, written as table.column, that should not be
+  checked.
 
 ### Removing Extraneous Indexes
 
@@ -217,7 +219,11 @@ reported.
 Note that a unique index can _never be replaced by a non-unique one_. For
 example, if there's a unique index on `users.login` and a non-unique index on
 `users.login, users.domain` then the tool will _not_ suggest dropping
-`users.login` as it could violate the uniqueness assumption.
+`users.login` as it could violate the uniqueness assumption. However, a unique
+index on `users.login, user.domain` might be replaceable with `users.login` as
+the uniqueness of the latter implies the uniqueness of the former (if a given
+`login` can appear only once then it can be present in only one `login, domain`
+pair).
 
 Supported configuration options:
 
@@ -230,7 +236,8 @@ Supported configuration options:
 If you soft-delete some models (e.g. with `paranoia`) then you need to modify
 your indexes to include only non-deleted rows. Otherwise they will include
 logically non-existent rows. This will make them larger and slower to use. Most
-of the time they should only cover columns satisfying `deleted_at IS NULL`.
+of the time they should only cover columns satisfying `deleted_at IS NULL` (to
+cover existing records) or `deleted_at IS NOT NULL` (to cover deleted records).
 
 `active_record_doctor` can automatically detect indexes on tables with a
 `deleted_at` column. Just run:
@@ -247,8 +254,10 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_tables` - tables whose indexes should not be checked.
-- `ignore_columns` - specific columns, written as table.column, that should not be reported as unindexed.
-- `ignore_indexes` - specific indexes that should not be reported as excluding a timestamp column.
+- `ignore_columns` - specific columns, written as table.column, that should not
+  be reported as unindexed.
+- `ignore_indexes` - specific indexes that should not be reported as excluding a
+  timestamp column.
 - `column_names` - deletion timestamp column names.
 
 ### Detecting Missing Foreign Key Constraints
@@ -283,7 +292,8 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_tables` - tables whose columns should not be checked.
-- `ignore_columns` - columns, written as table.column, that should not be checked.
+- `ignore_columns` - columns, written as table.column, that should not be
+  checked.
 
 ### Detecting Models Referencing Undefined Tables
 
@@ -316,13 +326,14 @@ this check as part of your Continuous Integration pipeline.
 Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
-- `ignore_models` - models whose underlying tables should not be checked for existence.
+- `ignore_models` - models whose underlying tables should not be checked for
+  existence.
 
 ### Detecting Uniqueness Validations not Backed by an Index
 
-A model-level uniqueness validations should be backed by a database index in
-order to be robust. Otherwise you risk inserting duplicate values under heavy
-load.
+Model-level uniqueness validations and `has_one` associations should be backed
+by a database index in order to be robust. Otherwise you risk inserting
+duplicate values under heavy load.
 
 In order to detect such validations run:
 
@@ -342,12 +353,14 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_models` - models whose uniqueness validators should not be checked.
-- `ignore_columns` - specific validators, written as Model(column1, column2, ...), that should not be checked.
+- `ignore_columns` - specific validators, written as Model(column1, ...), that
+  should not be checked.
 
 ### Detecting Missing Non-`NULL` Constraints
 
 If there's an unconditional presence validation on a column then it should be
-marked as non-`NULL`-able at the database level.
+marked as non-`NULL`-able at the database level or should have a `IS NOT NULL`
+constraint.
 
 In order to detect columns whose presence is required but that are marked
 `null: true` in the database run the following command:
@@ -371,7 +384,8 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_tables` - tables whose columns should not be checked.
-- `ignore_columns` - columns, written as table.column, that should not be checked.
+- `ignore_columns` - columns, written as table.column, that should not be
+  checked.
 
 ### Detecting Missing Presence Validations
 
@@ -399,7 +413,8 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_models` - models whose underlying tables' columns should not be checked.
-- `ignore_attributes` - specific attributes, written as Model.attribute, that should not be checked.
+- `ignore_attributes` - specific attributes, written as Model.attribute, that
+  should not be checked.
 
 ### Detecting Incorrect Presence Validations on Boolean Columns
 
@@ -427,7 +442,8 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_models` - models whose validators should not be checked.
-- `ignore_columns` - attributes, written as Model.attribute, whose validators should not be checked.
+- `ignore_columns` - attributes, written as Model.attribute, whose validators
+  should not be checked.
 
 ### Detecting Incorrect Length Validations
 
@@ -459,7 +475,8 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_models` - models whose validators should not be checked.
-- `ignore_columns` - attributes, written as Model.attribute, whose validators should not be checked.
+- `ignore_columns` - attributes, written as Model.attribute, whose validators
+  should not be checked.
 
 ### Detecting Incorrect `dependent` Option on Associations
 
@@ -492,7 +509,8 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_models` - models whose associations should not be checked.
-- `ignore_columns` - associations, written as Model.association, that should not be checked.
+- `ignore_columns` - associations, written as Model.association, that should not
+  be checked.
 
 ### Detecting Primary Keys Having Short Integer Types
 
@@ -554,7 +572,8 @@ Supported configuration options:
 
 - `enabled` - set to `false` to disable the detector altogether
 - `ignore_tables` - tables whose foreign keys should not be checked.
-- `ignore_columns` - foreign keys, written as table.column, that should not be checked.
+- `ignore_columns` - foreign keys, written as table.column, that should not be
+  checked.
 
 ## Ruby and Rails Compatibility Policy
 

lib/active_record_doctor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordDoctor
-  VERSION = "1.9.0"
+  VERSION = "1.10.0"
 end