annotaterb 4.16.0 → 4.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c5e0b20f8c7f5a3160bd2eac0f1e96f9b05e9fd72ddd08fc18422d63472510
-  data.tar.gz: e7bfda05d5943c0b2c978dc6863151aad9c1934b6ff5551ec88292ab96dfc57d
+  metadata.gz: 0276a5044aa1b444f73aac5612004ce9a8c05c6d47634fb2e8798c24a442fed5
+  data.tar.gz: 58cd27cb187989b06c459979ac0152db9dfdb54d671b9348980c244caa7981a6
 SHA512:
-  metadata.gz: 42f9849dd393c04606dcbd7ada4749bfb617180fe3992d19adb16f17f00a9e4af4ecae34d2a9305b5a2ab5b359c4762a87c83cd43c395302e14387b43538ccb2
-  data.tar.gz: 5cc6acd44ac8ae6c4aeb5895e776adf3ac75044fc67e4c2682527256bda5a36915670dbae92e3a478f55d883907c5c480e28c769b7f40c219c5d4a06fc64750f
+  metadata.gz: ac0f491e7022299fc96029950c5edf2b0e05aa38e9f3198ec37acbd04275888be493f4202f31295e8db0ad7737cc03d2c6b52e5fbb51c24418ef92f40da77a13
+  data.tar.gz: 914216a38c137682acb6e2b58154c3af47dba3b0ebb424b69194a59c3939cfdd01c00d0f75a10bb51800f2ea6ce3f4dc97f3cdcd592ff7f77e7cafc906cd660f

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## [v4.17.0](https://github.com/drwl/annotaterb/tree/v4.17.0) (2025-07-14)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.16.0...v4.17.0)
+
+**Implemented enhancements:**
+
+- Place column comments at the end of the line \(feature suggestion\) [\#164](https://github.com/drwl/annotaterb/issues/164)
+
+**Fixed bugs:**
+
+- Model annotation chokes on an empty file [\#182](https://github.com/drwl/annotaterb/issues/182)
+
+**Closed issues:**
+
+- uninitialized constant Zeitwerk::VERSION [\#216](https://github.com/drwl/annotaterb/issues/216)
+- Incorrect annotation of fixture files when different models share the same table name in different databases [\#206](https://github.com/drwl/annotaterb/issues/206)
+- Should active record and active support be in the gemspec? [\#197](https://github.com/drwl/annotaterb/issues/197)
+
+**Merged pull requests:**
+
+- Bump version to v4.17.0 [\#234](https://github.com/drwl/annotaterb/pull/234) ([drwl](https://github.com/drwl))
+- Fix NoMethodError when processing empty files [\#232](https://github.com/drwl/annotaterb/pull/232) ([tanukiti1987](https://github.com/tanukiti1987))
+- Refactor column ignore to use `match?` [\#231](https://github.com/drwl/annotaterb/pull/231) ([tagliala](https://github.com/tagliala))
+- Fix standard configuration [\#230](https://github.com/drwl/annotaterb/pull/230) ([tagliala](https://github.com/tagliala))
+- Generate changelog for v4.16.0 [\#229](https://github.com/drwl/annotaterb/pull/229) ([drwl](https://github.com/drwl))
+- show included columns in indexes [\#211](https://github.com/drwl/annotaterb/pull/211) ([pineman](https://github.com/pineman))
+- fix: use model name for file retrieval when not connected to the primary DB. [\#207](https://github.com/drwl/annotaterb/pull/207) ([OdenTakashi](https://github.com/OdenTakashi))
+- Place column comments at the end of the line [\#199](https://github.com/drwl/annotaterb/pull/199) ([Adeynack](https://github.com/Adeynack))
+
+## [v4.16.0](https://github.com/drwl/annotaterb/tree/v4.16.0) (2025-06-18)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.15.0...v4.16.0)
+
+**Implemented enhancements:**
+
+- Feature Request: Add Option to Place Annotations Above Nested Classes or Modules. [\#186](https://github.com/drwl/annotaterb/issues/186)
+
+**Closed issues:**
+
+- Misleading pattern examples in documentation for `additional_file_patterns` [\#221](https://github.com/drwl/annotaterb/issues/221)
+- Permission denied for table pg\_index [\#209](https://github.com/drwl/annotaterb/issues/209)
+- Performance regression relative to pre-fork? [\#205](https://github.com/drwl/annotaterb/issues/205)
+- Add back ruby configuration option? [\#203](https://github.com/drwl/annotaterb/issues/203)
+- Enable frozen mode when CI environment variable is set [\#171](https://github.com/drwl/annotaterb/issues/171)
+
+**Merged pull requests:**
+
+-  Bump version to v4.16.0 [\#228](https://github.com/drwl/annotaterb/pull/228) ([drwl](https://github.com/drwl))
+- chore: add --with-column-comments readme documentation [\#227](https://github.com/drwl/annotaterb/pull/227) ([jonmcelroy-appfolio](https://github.com/jonmcelroy-appfolio))
+- Drop Ruby 2.7 support and improve CI [\#226](https://github.com/drwl/annotaterb/pull/226) ([drwl](https://github.com/drwl))
+- Pass .annotaterb.yml through ERB [\#225](https://github.com/drwl/annotaterb/pull/225) ([fxn](https://github.com/fxn))
+- feat: Add `--nested-position` option for placing annotations above nested classes. [\#223](https://github.com/drwl/annotaterb/pull/223) ([yamat47](https://github.com/yamat47))
+- Fix for: Misleading pattern examples in documentation for additional\_file\_patterns [\#222](https://github.com/drwl/annotaterb/pull/222) ([skliarov](https://github.com/skliarov))
+- Move activerecord dependency into gemspec [\#220](https://github.com/drwl/annotaterb/pull/220) ([drwl](https://github.com/drwl))
+- Generate changelog for v4.15.0 [\#219](https://github.com/drwl/annotaterb/pull/219) ([drwl](https://github.com/drwl))
+- chore: add rake task to automatically deploy to rubygems [\#183](https://github.com/drwl/annotaterb/pull/183) ([OdenTakashi](https://github.com/OdenTakashi))
+
 ## [v4.15.0](https://github.com/drwl/annotaterb/tree/v4.15.0) (2025-05-30)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.14.1...v4.15.0)

data/README.md

@@ -1,9 +1,11 @@
 ## AnnotateRb
+
 ### forked from the [Annotate aka AnnotateModels gem](https://github.com/ctran/annotate_models)
 
 A Ruby Gem that adds annotations to your Rails models and route files.
 
-----------
+---
+
 [![CI](https://github.com/drwl/annotaterb/actions/workflows/ci.yml/badge.svg)](https://github.com/drwl/annotaterb/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/annotaterb.svg)](https://badge.fury.io/rb/annotaterb)
 
@@ -32,7 +34,9 @@ The schema comment looks like this:
 class Task < ApplicationRecord
   ...
 ```
-----------
+
+---
+
 ## Installation
 
 ```sh
@@ -46,11 +50,12 @@ group :development do
   ...
 
   gem "annotaterb"
-  
+
   ...
 ```
 
 ### Automatically annotate models
+
 For Rails projects, model files can get automatically annotated after migration tasks. To do this, run the following command:
 
 ```sh
@@ -66,6 +71,7 @@ $ ANNOTATERB_SKIP_ON_DB_TASKS=1 bin/rails db:migrate
 ```
 
 ### Added Rails generators
+
 The following Rails generator commands get added.
 
 ```sh
@@ -83,18 +89,23 @@ AnnotateRb:
 ```
 
 `bin/rails g annotate_rb:config`
+
 - Generates a new configuration file, `.annotaterb.yml`, using defaults from the gem.
 
 `bin/rails g annotate_rb:hook`
+
 - Installs the Rake file to automatically annotate Rails models on a database task (e.g. AnnotateRb will automatically run after running `bin/rails db:migrate`).
 
 `bin/rails g annotate_rb:install`
+
 - Runs the `config` and `hook` generator commands
 
 `bin/rails g annotate_rb:update_config`
+
 - Appends to `.annotaterb.yml` any configuration key-value pairs that are used by the Gem. This is useful when there's a drift between the config file values and the gem defaults (i.e. when new features get added).
 
 ## Migrating from the annotate gem
+
 Refer to the [migration guide](MIGRATION_GUIDE.md).
 
 ## Usage
@@ -103,7 +114,7 @@ AnnotateRb has a CLI that you can use to add or remove annotations.
 
 ```sh
 # To show the CLI options
-$ bundle exec annotaterb 
+$ bundle exec annotaterb
 
 Usage: annotaterb [command] [options]
 
@@ -127,6 +138,7 @@ Annotate model options:
                                      Complete foreign key names in the annotation
     -i, --show-indexes               List the table's database indexes in the annotation
     -s, --simple-indexes             Concat the column's related indexes in the annotation
+    -c, --show-check-constraints     List the table's check constraints in the annotation
         --hide-limit-column-types VALUES
                                      don't show limit for given column types, separated by commas (i.e., `integer,boolean,text`)
         --hide-default-column-types VALUES
@@ -134,7 +146,15 @@ Annotate model options:
         --ignore-unknown-models      don't display warnings for bad model files
     -I, --ignore-columns REGEX       don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`
         --with-comment               include database comments in model annotations
-        --with-column-comments       include column comments in model annotations 
+        --without-comment            include database comments in model annotations
+        --with-column-comments       include column comments in model annotations
+        --without-column-comments    exclude column comments in model annotations
+        --position-of-column-comments VALUE
+                                     set the position, in the annotation block, of the column comment
+        --with-table-comments        include table comments in model annotations
+        --without-table-comments     exclude table comments in model annotations
+        --classes-default-to-s class Custom classes to be represented with `to_s`, may be used multiple times
+        --nested-position            Place annotations directly above nested classes or modules instead of at the top of the file.
 
 Annotate routes options:
     Usage: annotaterb routes [options]
@@ -157,6 +177,7 @@ Additional options that work for annotating models and routes
         --ignore-model-subdirects    Ignore subdirectories of the models directory
         --sort                       Sort columns alphabetically, rather than in creation order
         --classified-sort            Sort columns alphabetically, but first goes id, then the rest columns, then the timestamp columns and then the association columns
+        --grouped-polymorphic        Group polymorphic associations together in the annotation when using --classified-sort
     -R, --require path               Additional file to require before loading models, may be used multiple times
     -e [tests,fixtures,factories,serializers],
         --exclude                    Do not annotate fixtures, test files, factories, and/or serializers
@@ -176,6 +197,8 @@ Additional options that work for annotating models and routes
                                      Place the annotations at the top (before) or the bottom (after) of the routes.rb file
         --ps, --position-in-serializer [before|top|after|bottom]
                                      Place the annotations at the top (before) or the bottom (after) of the serializer files
+        --pa, --position-in-additional-file-patterns [before|top|after|bottom]
+                                     Place the annotations at the top (before) or the bottom (after) of files captured in additional file patterns
         --force                      Force new annotations even if there are no changes.
         --debug                      Prints the options and outputs messages to make it easier to debug.
         --frozen                     Do not allow to change annotations. Exits non-zero if there are going to be changes to files.
@@ -185,6 +208,7 @@ Additional options that work for annotating models and routes
 ## Configuration
 
 ### Storing default options
+
 Previously in the [Annotate](https://github.com/ctran/annotate_models) you could pass options through the CLI or store them as environment variables. Annotaterb removes dependency on the environment variables and instead can read values from a `.annotaterb.yml` file stored in the Rails project root.
 
 ```yml
@@ -198,6 +222,7 @@ Annotaterb reads first the configuration file, if it exists, passes its content
 For further details visit the [section in the migration guide](MIGRATION_GUIDE.md#automatic-annotations-after-running-database-migration-commands).
 
 ### How to skip annotating a particular model
+
 If you want to always skip annotations on a particular model, add this string
 anywhere in the file:
 
@@ -211,6 +236,10 @@ migrations were run).
 If you prefer to sort alphabetically so that the results of annotation are
 consistent regardless of what order migrations are executed in, use `--sort`.
 
+You can also sort columns by type, then alphabetically using `--classified-sort`
+and `--grouped-polymorphic`: first goes id, then the rest columns, then the
+timestamp columns and then the association columns.
+
 ## License
 
 Released under the same license as Ruby. No Support. No Warranty.

data/VERSION

@@ -1 +1 @@
-4.16.0
+4.18.0

data/lib/annotate_rb/model_annotator/annotated_file/generator.rb

@@ -63,6 +63,9 @@ module AnnotateRb
         # When nested_position is enabled, finds the most deeply nested class declaration
         # to place annotations directly above nested classes instead of at the file top.
         def determine_annotation_position(parsed)
+          # Handle empty files where no classes/modules are found
+          return [nil, 0] if parsed.starts.empty?
+
           return parsed.starts.first unless @options[:nested_position]
 
           class_entries = parsed.starts.select { |name, _line| parsed.type_map[name] == :class }
@@ -90,6 +93,17 @@ module AnnotateRb
         def content_annotated_after(parsed, content_without_annotations)
           _constant_name, line_number_after = parsed.ends.last
 
+          # Handle empty files where no classes/modules are found
+          if line_number_after.nil?
+            content_lines = content_without_annotations.lines
+            # For empty files, append annotations at the end
+            content_with_annotations_written_after = []
+            content_with_annotations_written_after << content_lines
+            content_with_annotations_written_after << $/ unless content_lines.empty?
+            content_with_annotations_written_after << @new_wrapped_annotations.lines
+            return content_with_annotations_written_after.join
+          end
+
           content_with_annotations_written_after = []
           content_with_annotations_written_after << content_without_annotations.lines[0..line_number_after]
           content_with_annotations_written_after << $/

data/lib/annotate_rb/model_annotator/annotation/annotation_builder.rb

@@ -59,17 +59,7 @@ module AnnotateRb
         end
 
         def build
-          if @options.get_state(:current_version).nil?
-            migration_version = begin
-              ActiveRecord::Migrator.current_version
-            rescue
-              0
-            end
-
-            @options.set_state(:current_version, migration_version)
-          end
-
-          version = @options.get_state(:current_version)
+          version = migration_version_for_model(@model)
           table_name = @model.table_name
           table_comment = @model.connection.try(:table_comment, @model.table_name)
           max_size = @model.max_schema_info_width
@@ -78,6 +68,30 @@ module AnnotateRb
             version: version, table_name: table_name, table_comment: table_comment,
             max_size: max_size, model: @model).build
         end
+
+        private
+
+        def migration_version_for_model(model)
+          return 0 unless @options[:include_version]
+
+          # Multi-database support: Cache migration versions per database connection to handle
+          # different schema versions across primary/secondary databases correctly.
+          # Example: primary → "current_version_primary", secondary → "current_version_secondary"
+          connection_pool_name = model.connection.pool.db_config.name
+          cache_key = "current_version_#{connection_pool_name}".to_sym
+
+          if @options.get_state(cache_key).nil?
+            migration_version = begin
+              model.connection.migration_context.current_version
+            rescue
+              0
+            end
+
+            @options.set_state(cache_key, migration_version)
+          end
+
+          @options.get_state(cache_key)
+        end
       end
     end
   end

data/lib/annotate_rb/model_annotator/annotation_decider.rb

@@ -16,29 +16,9 @@ module AnnotateRb
 
         begin
           klass = ModelClassGetter.call(@file, @options)
+          return false unless klass.respond_to?(:descends_from_active_record?) && klass.descends_from_active_record? && klass.table_exists?
 
-          klass_is_a_class = klass.is_a?(Class)
-          # Methods such as #superclass only exist on a class. Because of how the code is structured, `klass` could be a
-          #  module that does not support the #superclass method, so we want to return early.
-          return false if !klass_is_a_class
-
-          klass_inherits_active_record_base = klass < ActiveRecord::Base
-          klass_is_not_abstract = klass.respond_to?(:abstract_class?) && !klass.abstract_class?
-          klass_table_exists = klass.respond_to?(:table_exists?) && klass.table_exists?
-
-          not_sure_this_conditional = (!@options[:exclude_sti_subclasses] || !(klass.superclass < ActiveRecord::Base && klass.table_name == klass.superclass.table_name))
-
-          annotate_conditions = [
-            klass_is_a_class,
-            klass_inherits_active_record_base,
-            not_sure_this_conditional,
-            klass_is_not_abstract,
-            klass_table_exists
-          ]
-
-          to_annotate = annotate_conditions.all?
-
-          return to_annotate
+          return @options[:exclude_sti_subclasses] ? klass.base_class? : true
         rescue BadModelFileError => e
           unless @options[:ignore_unknown_models]
             warn "Unable to process #{@file}: #{e.message}"
@@ -55,9 +35,9 @@ module AnnotateRb
       private
 
       def file_contains_skip_annotation
-        file_string = File.exist?(@file) ? File.read(@file) : ""
+        return false unless File.exist?(@file)
 
-        /#{SKIP_ANNOTATION_PREFIX}.*/o.match?(file_string)
+        /#{SKIP_ANNOTATION_PREFIX}.*/o.match?(File.read(@file))
       end
     end
   end

data/lib/annotate_rb/model_annotator/annotation_diff_generator.rb

@@ -11,8 +11,7 @@ module AnnotateRb
       #   - "#  status(a/b/c)    :string           not null"
       #   - "#  created_at       :datetime         not null"
       #   - "#  updated_at       :datetime         not null"
-      COLUMN_PATTERN = /^#[\t ]+[\w*.`\[\]():]+(?:\(.*?\))?[\t ]+.+$/
-
+      COLUMN_PATTERN = /^#[\t ]+[[\p{L}\p{N}_]*.`\[\]():]+(?:\(.*?\))?[\t ]+.+$/
       class << self
         def call(file_content, annotation_block)
           new(file_content, annotation_block).generate

data/lib/annotate_rb/model_annotator/column_annotation/annotation_builder.rb

@@ -12,42 +12,23 @@ module AnnotateRb
         end
 
         def build
-          is_primary_key = is_column_primary_key?(@model, @column.name)
-
-          table_indices = @model.retrieve_indexes_from_table
-          column_indices = table_indices.select { |ind| ind.columns.include?(@column.name) }
-          column_defaults = @model.column_defaults
-
-          column_attributes = AttributesBuilder.new(@column, @options, is_primary_key, column_indices, column_defaults).build
-          formatted_column_type = TypeBuilder.new(@column, @options, column_defaults).build
+          column_attributes = @model.built_attributes[@column.name]
+          formatted_column_type = TypeBuilder.new(@column, @options, @model.column_defaults).build
 
           display_column_comments = @options[:with_comment] && @options[:with_column_comments]
-          col_name = if display_column_comments && @model.with_comments? && @column.comment
-            "#{@column.name}(#{@column.comment.gsub(/\n/, '\\n')})"
-          else
-            @column.name
-          end
-
-          _component = ColumnComponent.new(col_name, @max_size, formatted_column_type, column_attributes)
-        end
-
-        private
-
-        # TODO: Simplify this conditional
-        def is_column_primary_key?(model, column_name)
-          if model.primary_key
-            if model.primary_key.is_a?(Array)
-              # If the model has multiple primary keys, check if this column is one of them
-              if model.primary_key.collect(&:to_sym).include?(column_name.to_sym)
-                return true
-              end
-            elsif column_name.to_sym == model.primary_key.to_sym
-              # If model has 1 primary key, check if this column is it
-              return true
-            end
-          end
-
-          false
+          display_column_comments &&= @model.with_comments? && @column.comment
+          position_of_column_comment = @options[:position_of_column_comment] || Options::FLAG_OPTIONS[:position_of_column_comment] if display_column_comments
+
+          max_attributes_size = @model.built_attributes.values.map { |v| v.join(", ").length }.max
+
+          _component = ColumnComponent.new(
+            column: @column,
+            max_name_size: @max_size,
+            type: formatted_column_type,
+            attributes: column_attributes,
+            position_of_column_comment: position_of_column_comment,
+            max_attributes_size: max_attributes_size
+          )
         end
       end
     end

data/lib/annotate_rb/model_annotator/column_annotation/column_component.rb

@@ -6,19 +6,31 @@ module AnnotateRb
       class ColumnComponent < Components::Base
         MD_TYPE_ALLOWANCE = 18
         BARE_TYPE_ALLOWANCE = 16
+        MIN_SPACES_BEFORE_COMMENT = 4
 
-        attr_reader :name, :max_size, :type, :attributes
+        attr_reader :column, :max_name_size, :type, :attributes, :position_of_column_comment, :max_attributes_size
 
-        def initialize(name, max_size, type, attributes)
-          @name = name
-          @max_size = max_size
+        def initialize(column:, max_name_size:, type:, attributes:, position_of_column_comment:, max_attributes_size:)
+          @column = column
+          @max_name_size = max_name_size
           @type = type
           @attributes = attributes
+          @position_of_column_comment = position_of_column_comment
+          @max_attributes_size = max_attributes_size
+        end
+
+        def name
+          case position_of_column_comment
+          when :with_name
+            "#{column.name}(#{column.comment.gsub(/\n/, '\\n')})"
+          else
+            column.name
+          end
         end
 
         def to_rdoc
           # standard:disable Lint/FormatParameterMismatch
-          format("# %-#{max_size}.#{max_size}s<tt>%s</tt>",
+          format("# %-#{max_name_size}.#{max_name_size}s<tt>%s</tt>",
             "*#{name}*::",
             attributes.unshift(type).join(", ")).rstrip
           # standard:enable Lint/FormatParameterMismatch
@@ -40,24 +52,35 @@ module AnnotateRb
         end
 
         def to_markdown
-          name_remainder = max_size - name.length - non_ascii_length(name)
+          joined_attributes = attributes.join(", ").rstrip
+          name_remainder = max_name_size - name.length - non_ascii_length(name)
           type_remainder = (MD_TYPE_ALLOWANCE - 2) - type.length
+          attributes_remainder = max_attributes_size + 1 - joined_attributes.length
+          comment_rightmost = (position_of_column_comment != :rightmost_column) ? "" : " | `#{@column.comment}`"
 
           # standard:disable Lint/FormatParameterMismatch
-          format("# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`",
+          format(
+            "# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`%#{attributes_remainder}s", # %s",
             name,
             " ",
             type,
             " ",
-            attributes.join(", ").rstrip).gsub("``", "  ").rstrip
+            joined_attributes,
+            comment_rightmost.to_s
+          ).gsub("``", "  ").rstrip
           # standard:enable Lint/FormatParameterMismatch
         end
 
         def to_default
-          format("#  %s:%s %s",
-            mb_chars_ljust(name, max_size),
+          comment_rightmost = (position_of_column_comment == :rightmost_column) ? @column.comment : ""
+          joined_attributes = attributes.join(", ")
+          format(
+            "#  %s:%s %s %s",
+            mb_chars_ljust(name, max_name_size),
             mb_chars_ljust(type, BARE_TYPE_ALLOWANCE),
-            attributes.join(", ")).rstrip
+            mb_chars_ljust(joined_attributes, max_attributes_size.to_i + MIN_SPACES_BEFORE_COMMENT),
+            comment_rightmost
+          ).rstrip
         end
 
         private

data/lib/annotate_rb/model_annotator/index_annotation/annotation_builder.rb

@@ -18,7 +18,7 @@ module AnnotateRb
           max_size = indexes.map { |index| index.name.size }.max + 1
 
           indexes = indexes.sort_by(&:name).map do |index|
-            IndexComponent.new(index, max_size)
+            IndexComponent.new(index, max_size, @options)
           end
 
           _annotation = Annotation.new(indexes)

data/lib/annotate_rb/model_annotator/index_annotation/index_component.rb

@@ -4,11 +4,12 @@ module AnnotateRb
   module ModelAnnotator
     module IndexAnnotation
       class IndexComponent < Components::Base
-        attr_reader :index, :max_size
+        attr_reader :index, :max_size, :options
 
-        def initialize(index, max_size)
+        def initialize(index, max_size, options)
           @index = index
           @max_size = max_size
+          @options = options
         end
 
         def to_default
@@ -34,11 +35,22 @@ module AnnotateRb
             ""
           end
 
+          include_info = ""
+          if options[:show_indexes_include]
+            value = index.try(:include)
+            include_info = if value.present? && value.any?
+              " INCLUDE (#{value.join(",")})"
+            else
+              ""
+            end
+          end
+
           # standard:disable Lint/FormatParameterMismatch
           sprintf(
-            "#  %-#{max_size}.#{max_size}s %s%s%s%s%s",
+            "#  %-#{max_size}.#{max_size}s %s%s%s%s%s%s",
             index.name,
             "(#{columns_info.join(",")})",
+            include_info,
             unique_info,
             nulls_not_distinct_info,
             where_info,
@@ -70,8 +82,19 @@ module AnnotateRb
             ""
           end
 
+          include_info = ""
+          if options[:show_indexes_include]
+            value = index.try(:include)
+            include_info = if value.present? && value.any?
+              " _include_ (#{value.join(",")})"
+            else
+              ""
+            end
+          end
+
           details = sprintf(
-            "%s%s%s%s",
+            "%s%s%s%s%s",
+            include_info,
             unique_info,
             nulls_not_distinct_info,
             where_info,

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -23,12 +23,12 @@ module AnnotateRb
             ignore_columns = @options[:ignore_columns]
             if ignore_columns
               cols = cols.reject do |col|
-                col.name.match(/#{ignore_columns}/)
+                col.name.match?(/#{ignore_columns}/)
               end
             end
 
             cols = cols.sort_by(&:name) if @options[:sort]
-            cols = classified_sort(cols) if @options[:classified_sort]
+            cols = classified_sort(cols, @options[:grouped_polymorphic]) if @options[:classified_sort]
 
             cols
           end
@@ -91,7 +91,8 @@ module AnnotateRb
           begin
             cols = columns
 
-            if with_comments?
+            position_of_column_comment = @options.with_default_fallback(:position_of_column_comment)
+            if with_comments? && position_of_column_comment == :with_name
               column_widths = cols.map do |column|
                 column.name.size + (column.comment ? Helper.width(column.comment) : 0)
               end
@@ -108,6 +109,35 @@ module AnnotateRb
           end
       end
 
+      # TODO: Simplify this conditional
+      def is_column_primary_key?(column_name)
+        if primary_key
+          if primary_key.is_a?(Array)
+            # If the model has multiple primary keys, check if this column is one of them
+            if primary_key.collect(&:to_sym).include?(column_name.to_sym)
+              return true
+            end
+          elsif column_name.to_sym == primary_key.to_sym
+            # If model has 1 primary key, check if this column is it
+            return true
+          end
+        end
+
+        false
+      end
+
+      def built_attributes
+        @built_attributes ||= begin
+          table_indices = retrieve_indexes_from_table
+          columns.map do |column|
+            is_primary_key = is_column_primary_key?(column.name)
+            column_indices = table_indices.select { |ind| ind.columns.include?(column.name) }
+            built = ColumnAnnotation::AttributesBuilder.new(column, @options, is_primary_key, column_indices, column_defaults).build
+            [column.name, built]
+          end.to_h
+        end
+      end
+
       def retrieve_indexes_from_table
         @indexes_from_table ||= _retrieve_indexes_from_table
       end
@@ -143,7 +173,11 @@ module AnnotateRb
           raw_columns.map(&:comment).any? { |comment| !comment.nil? }
       end
 
-      def classified_sort(cols)
+      def position_of_column_comment
+        @position_of_column_comment ||= @options[:position_of_column_comment]
+      end
+
+      def classified_sort(cols, grouped_polymorphic)
         rest_cols = []
         timestamps = []
         associations = []
@@ -152,6 +186,8 @@ module AnnotateRb
         # specs don't load defaults, so ensure we have defaults here
         timestamp_columns = @options[:timestamp_columns] || DEFAULT_TIMESTAMP_COLUMNS
 
+        col_names = cols.map(&:name)
+
         cols.each do |c|
           if c.name.eql?("id")
             id = c
@@ -159,6 +195,9 @@ module AnnotateRb
             timestamps << c
           elsif c.name[-3, 3].eql?("_id")
             associations << c
+          elsif c.name[-5, 5].eql?("_type") && col_names.include?(c.name.sub(/_type$/, "_id")) && grouped_polymorphic
+            # This is a polymorphic association's type column
+            associations << c
           else
             rest_cols << c
           end

data/lib/annotate_rb/model_annotator/project_annotator.rb

@@ -42,7 +42,11 @@ module AnnotateRb
         klass.reset_column_information
         annotation = Annotation::AnnotationBuilder.new(klass, @options).build
         model_name = klass.name.underscore
-        table_name = klass.table_name
+
+        # In multi-database configurations, it is possible for different models to have the same table name but live
+        #   in different databases. Here we are opting to use the table name to find related files only when the model
+        #   is using the primary connection.
+        table_name = klass.table_name if klass.connection_specification_name == ActiveRecord::Base.name
 
         model_instruction = SingleFileAnnotatorInstruction.new(file, annotation, :position_in_class, @options)
         instructions << model_instruction

data/lib/annotate_rb/options.rb

@@ -41,6 +41,7 @@ module AnnotateRb
       format_rdoc: false, # ModelAnnotator
       format_yard: false, # ModelAnnotator
       frozen: false, # ModelAnnotator, but should be used by both
+      grouped_polymorphic: false, # ModelAnnotator
       ignore_model_sub_dir: false, # ModelAnnotator
       ignore_unknown_models: false, # ModelAnnotator
       include_version: false, # ModelAnnotator
@@ -48,6 +49,7 @@ module AnnotateRb
       show_check_constraints: false, # ModelAnnotator
       show_foreign_keys: true, # ModelAnnotator
       show_indexes: true, # ModelAnnotator
+      show_indexes_include: false, # ModelAnnotator
       show_virtual_columns: false, # ModelAnnotator
       simple_indexes: false, # ModelAnnotator
       sort: false, # ModelAnnotator
@@ -55,7 +57,8 @@ module AnnotateRb
       trace: false, # ModelAnnotator, but is part of Core
       with_comment: true, # ModelAnnotator
       with_column_comments: nil, # ModelAnnotator
-      with_table_comments: nil # ModelAnnotator
+      with_table_comments: nil, # ModelAnnotator
+      position_of_column_comment: :with_name # ModelAnnotator
     }.freeze
 
     OTHER_OPTIONS = {
@@ -111,6 +114,7 @@ module AnnotateRb
       :format_rdoc,
       :format_yard,
       :frozen,
+      :grouped_polymorphic,
       :ignore_model_sub_dir,
       :ignore_unknown_models,
       :include_version,
@@ -118,13 +122,15 @@ module AnnotateRb
       :show_complete_foreign_keys,
       :show_foreign_keys,
       :show_indexes,
+      :show_indexes_include,
       :simple_indexes,
       :sort,
       :timestamp,
       :trace,
       :with_comment,
       :with_column_comments,
-      :with_table_comments
+      :with_table_comments,
+      :position_of_column_comment
     ].freeze
 
     OTHER_OPTION_KEYS = [
@@ -205,10 +211,15 @@ module AnnotateRb
       # Set column and table comments to default to :with_comment, if not set
       @options[:with_column_comments] = @options[:with_comment] if @options[:with_column_comments].nil?
       @options[:with_table_comments] = @options[:with_comment] if @options[:with_table_comments].nil?
+      @options[:position_of_column_comment] = @options[:position_of_column_comment].to_sym
 
       self
     end
 
+    def with_default_fallback(key)
+      @options[key] || DEFAULT_OPTIONS[key]
+    end
+
     def set_state(key, value, overwrite = false)
       if @state.key?(key) && !overwrite
         val = @state[key]

data/lib/annotate_rb/parser.rb

@@ -246,6 +246,11 @@ module AnnotateRb
         @options[:with_column_comments] = false
       end
 
+      option_parser.on("--position-of-column-comments VALUE",
+        "set the position, in the annotation block, of the column comment") do |value|
+        @options[:position_of_column_comments] = value.to_sym
+      end
+
       option_parser.on("--with-table-comments",
         "include table comments in model annotations") do
         @options[:with_table_comments] = true
@@ -402,6 +407,11 @@ module AnnotateRb
         @options[:classified_sort] = true
       end
 
+      option_parser.on("--grouped-polymorphic",
+        "Group polymorphic associations together in the annotation when using --classified-sort") do
+        @options[:grouped_polymorphic] = true
+      end
+
       option_parser.on("-R",
         "--require path",
         "Additional file to require before loading models, may be used multiple times") do |path|

data/lib/annotate_rb/route_annotator/helper.rb

@@ -3,7 +3,7 @@
 module AnnotateRb
   module RouteAnnotator
     module Helper
-      MAGIC_COMMENT_MATCHER = /(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/.freeze
+      MAGIC_COMMENT_MATCHER = /(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/
 
       class << self
         def routes_file_exist?

data/lib/annotate_rb/runner.rb

@@ -3,9 +3,23 @@
 module AnnotateRb
   class Runner
     class << self
+      attr_reader :runner
+
       def run(args)
-        new.run(args)
+        self.runner = new
+
+        runner.run(args)
+
+        self.runner = nil
       end
+
+      def running?
+        !!runner
+      end
+
+      private
+
+      attr_writer :runner
     end
 
     def run(args)

data/lib/annotate_rb/tasks/annotate_models_migrate.rake

@@ -18,7 +18,7 @@ if defined?(Rails::Application) && Rails.version.split(".").first.to_i >= 6
 
   # If there's multiple databases, this appends database specific rake tasks to `migration_tasks`
   ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |database_name|
-    migration_tasks.concat(%w[db:migrate db:migrate:up db:migrate:down].map { |task| "#{task}:#{database_name}" })
+    migration_tasks.concat(%w[db:migrate db:migrate:up db:migrate:down db:rollback].map { |task| "#{task}:#{database_name}" })
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.16.0
+  version: 4.18.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-18 00:00:00.000000000 Z
+date: 2025-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord