annotaterb 4.20.0 → 4.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9df7cea27e60968dc415cd65fc55696bfcb47444bdb0dc9964ce155bfbce4e40
-  data.tar.gz: 6883710db1dd58633c3a349adec97257df9c2d809a220fd19ba90c2a4a584cb7
+  metadata.gz: 2be17a236402d5406e2f4d1f68a567bf51de51f924f66591adf9460bfacabe18
+  data.tar.gz: 48743c136f9a195bb1dbaa564bd8047c16411394a991b4c86b57a70844d0e121
 SHA512:
-  metadata.gz: 2e164027db851243b7a1fccf9590c4a7515f47454ec785070e8e1dcd71bc0de7bec2caea30d919e6497dedfe78180681828cd6f1e24c6f0539c1d4e6b7895c33
-  data.tar.gz: 65629d818e0f3a92528deec50d5ba6adeb4a521058a174a7d463df1d565a8bf59eccd4ddb039ea68fe0dffed7329a994a5fbc1dae9cf19cb87cf9dcec7e308f2
+  metadata.gz: a203a269dbcf4c42a082a2088c6c38d8c4b97c3bbf9ab760762e3149294fb38dc31799aea2f3ece425504782cd2027187bd161ccf4a9c006aaa7a9a791094311
+  data.tar.gz: 8cc55f09f193f5f428db97afc1270386a06eb8185773cfd339830e1ee8e49631a1f203cced676fdb2f4d7d5c0b690f5aadc9108f63d3de588c019d7585c0011b

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 # Changelog
 
+## [v4.21.0](https://github.com/drwl/annotaterb/tree/v4.21.0) (2026-01-30)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.20.0...v4.21.0)
+
+**Implemented enhancements:**
+
+- Displaying database name for multi-database rails projects [\#254](https://github.com/drwl/annotaterb/issues/254)
+
+**Fixed bugs:**
+
+- Yard format broken? [\#212](https://github.com/drwl/annotaterb/issues/212)
+
+**Closed issues:**
+
+- \[dotenv\] Loaded comment gets added to routes annotations [\#288](https://github.com/drwl/annotaterb/issues/288)
+
+**Merged pull requests:**
+
+- Bump version to v4.21.0 [\#306](https://github.com/drwl/annotaterb/pull/306) ([drwl](https://github.com/drwl))
+- Add integration test for ignore\_multi\_database\_name config option [\#305](https://github.com/drwl/annotaterb/pull/305) ([OdenTakashi](https://github.com/OdenTakashi))
+- Include ignore\_multi\_database\_name in generated config [\#304](https://github.com/drwl/annotaterb/pull/304) ([OdenTakashi](https://github.com/OdenTakashi))
+- Add to\_yard and to\_rdoc methods to Annotation classes [\#302](https://github.com/drwl/annotaterb/pull/302) ([k-duho](https://github.com/k-duho))
+- Support customising config path [\#301](https://github.com/drwl/annotaterb/pull/301) ([rience](https://github.com/rience))
+- Bump actions/checkout from 5 to 6 [\#299](https://github.com/drwl/annotaterb/pull/299) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update Rails generator command in README [\#296](https://github.com/drwl/annotaterb/pull/296) ([EstebanDalelR](https://github.com/EstebanDalelR))
+- chore: remove concurrent-ruby version lock from dummy app [\#284](https://github.com/drwl/annotaterb/pull/284) ([OdenTakashi](https://github.com/OdenTakashi))
+- feat: Add "ignore\_multi\_database\_name" option [\#283](https://github.com/drwl/annotaterb/pull/283) ([t27duck](https://github.com/t27duck))
+- refactor: use existing `database_name` method for cache key [\#282](https://github.com/drwl/annotaterb/pull/282) ([OdenTakashi](https://github.com/OdenTakashi))
+- Support .config directory convention [\#281](https://github.com/drwl/annotaterb/pull/281) ([ngan](https://github.com/ngan))
+- chore: add missing newlines [\#280](https://github.com/drwl/annotaterb/pull/280) ([OdenTakashi](https://github.com/OdenTakashi))
+- Generate changelog for v4.20.0 [\#279](https://github.com/drwl/annotaterb/pull/279) ([drwl](https://github.com/drwl))
+
+## [v4.20.0](https://github.com/drwl/annotaterb/tree/v4.20.0) (2025-10-20)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.19.0...v4.20.0)
+
+**Merged pull requests:**
+
+- Bump version to v4.20.0 [\#278](https://github.com/drwl/annotaterb/pull/278) ([drwl](https://github.com/drwl))
+- Bump github/codeql-action from 3 to 4 [\#277](https://github.com/drwl/annotaterb/pull/277) ([dependabot[bot]](https://github.com/apps/dependabot))
+- fix: position-of-column-comment option [\#275](https://github.com/drwl/annotaterb/pull/275) ([JohnnyKei](https://github.com/JohnnyKei))
+- feat: Add database name to annotations in multi-DB environments [\#272](https://github.com/drwl/annotaterb/pull/272) ([OdenTakashi](https://github.com/OdenTakashi))
+- fix: resolve YAML syntax error in update\_config generator [\#269](https://github.com/drwl/annotaterb/pull/269) ([ivy](https://github.com/ivy))
+- Update README.md [\#268](https://github.com/drwl/annotaterb/pull/268) ([torgoton](https://github.com/torgoton))
+- Honor --frozen option in routes [\#265](https://github.com/drwl/annotaterb/pull/265) ([garriguv](https://github.com/garriguv))
+- refactor\(test\): Default to single-DB environment for tests [\#264](https://github.com/drwl/annotaterb/pull/264) ([OdenTakashi](https://github.com/OdenTakashi))
+- Escape column comment newlines when using "rightmost" value for position\_of\_column\_comment option [\#263](https://github.com/drwl/annotaterb/pull/263) ([rowanhogan](https://github.com/rowanhogan))
+- chore: introduce switchable DB environment for specs [\#262](https://github.com/drwl/annotaterb/pull/262) ([OdenTakashi](https://github.com/OdenTakashi))
+- Generate changelog for v4.19.0 [\#260](https://github.com/drwl/annotaterb/pull/260) ([drwl](https://github.com/drwl))
+- Bump actions/checkout from 4 to 5 [\#257](https://github.com/drwl/annotaterb/pull/257) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [v4.19.0](https://github.com/drwl/annotaterb/tree/v4.19.0) (2025-08-28)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.18.0...v4.19.0)

data/README.md

@@ -75,7 +75,7 @@ $ ANNOTATERB_SKIP_ON_DB_TASKS=1 bin/rails db:migrate
 The following Rails generator commands get added.
 
 ```sh
-$ bin/rails generator --help
+$ bin/rails generate --help
 
 ...
 
@@ -183,6 +183,7 @@ Additional options that work for annotating models and routes
         --exclude                    Do not annotate fixtures, test files, factories, and/or serializers
     -f [bare|rdoc|yard|markdown],    Render Schema Information as plain/RDoc/Yard/Markdown
         --format
+        --config_path [path]         Path to configuration file (by default, .annotaterb.yml in the root of the project)
     -p [before|top|after|bottom],    Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)
         --position
         --pc, --position-in-class [before|top|after|bottom]
@@ -211,6 +212,14 @@ Additional options that work for annotating models and routes
 
 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.
 
+### Configuration file location
+
+AnnotateRb also supports other configuration file locations, and are searched for in the following locations (in order of precedence):
+- `.annotaterb.yml`
+- `config/annotaterb.yml`
+- `.config/.annotaterb.yml`
+- `.config/annotaterb/config.yml`
+
 ```yml
 # .annotaterb.yml
 

data/VERSION

@@ -1 +1 @@
-4.20.0
+4.22.0

data/lib/annotate_rb/config_finder.rb

@@ -1,20 +1,29 @@
 # frozen_string_literal: true
 
+require "pathname"
+
 module AnnotateRb
   class ConfigFinder
     DOTFILE = ".annotaterb.yml"
 
     class << self
+      attr_accessor :config_path
+
       def find_project_root
         # We should expect this method to be called from a Rails project root and returning it
         # e.g. "/Users/drwl/personal/annotaterb/dummyapp"
-        Dir.pwd
+        Pathname.pwd
       end
 
       def find_project_dotfile
-        file_path = File.expand_path(DOTFILE, find_project_root)
+        return @config_path if @config_path && File.exist?(@config_path)
 
-        return file_path if File.exist?(file_path)
+        [
+          find_project_root.join(DOTFILE),
+          find_project_root.join("config", DOTFILE.delete_prefix(".")),
+          find_project_root.join(".config", DOTFILE),
+          find_project_root.join(".config", "annotaterb", "config.yml")
+        ].find(&:exist?)
       end
     end
   end

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

@@ -66,7 +66,7 @@ module AnnotateRb
           # Handle empty files where no classes/modules are found
           return [nil, 0] if parsed.starts.empty?
 
-          return parsed.starts.first unless @options[:nested_position]
+          return parsed.starts.first unless @options[:nested_position] && parsed.respond_to?(:type_map)
 
           class_entries = parsed.starts.select { |name, _line| parsed.type_map[name] == :class }
           class_entries.last || parsed.starts.first

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

@@ -74,6 +74,8 @@ module AnnotateRb
         private
 
         def multi_db_environment?
+          return false if @options[:ignore_multi_database_name]
+
           if defined?(::Rails) && ::Rails.env
             ActiveRecord::Base.configurations.configs_for(env_name: ::Rails.env).size > 1
           else

data/lib/annotate_rb/model_annotator/annotation_diff_generator.rb

@@ -31,13 +31,13 @@ module AnnotateRb
         new_annotations = @annotation_block.match(HEADER_PATTERN).to_s
 
         current_annotation_columns = if current_annotations.present?
-          current_annotations.scan(COLUMN_PATTERN).sort
+          current_annotations.scan(COLUMN_PATTERN)
         else
           []
         end
 
         new_annotation_columns = if new_annotations.present?
-          new_annotations.scan(COLUMN_PATTERN).sort
+          new_annotations.scan(COLUMN_PATTERN)
         else
           []
         end

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

@@ -23,6 +23,14 @@ module AnnotateRb
           body.map(&:to_markdown).join("\n")
         end
 
+        def to_rdoc
+          body.map(&:to_rdoc).join("\n")
+        end
+
+        def to_yard
+          body.map(&:to_yard).join("\n")
+        end
+
         def to_default
           body.map(&:to_default).join("\n")
         end

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

@@ -23,6 +23,14 @@ module AnnotateRb
           body.map(&:to_markdown).join("\n")
         end
 
+        def to_rdoc
+          body.map(&:to_rdoc).join("\n")
+        end
+
+        def to_yard
+          body.map(&:to_yard).join("\n")
+        end
+
         def to_default
           body.map(&:to_default).join("\n")
         end

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

@@ -23,6 +23,14 @@ module AnnotateRb
           body.map(&:to_markdown).join("\n")
         end
 
+        def to_rdoc
+          body.map(&:to_rdoc).join("\n")
+        end
+
+        def to_yard
+          body.map(&:to_yard).join("\n")
+        end
+
         def to_default
           body.map(&:to_default).join("\n")
         end

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -35,7 +35,11 @@ module AnnotateRb
       end
 
       def connection
-        @klass.connection
+        if @klass.respond_to?(:lease_connection)
+          @klass.lease_connection
+        else
+          @klass.connection
+        end
       end
 
       def database_name
@@ -56,12 +60,12 @@ module AnnotateRb
       end
 
       def table_comments
-        @klass.connection.table_comment(@klass.table_name)
+        connection.table_comment(@klass.table_name)
       end
 
       def has_table_comments?
-        @klass.connection.respond_to?(:table_comment) &&
-          @klass.connection.table_comment(@klass.table_name).present?
+        connection.respond_to?(:table_comment) &&
+          connection.table_comment(@klass.table_name).present?
       end
 
       def column_defaults
@@ -113,21 +117,10 @@ 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
+        return false unless primary_key
 
-        false
+        Array(primary_key).map(&:to_sym).include?(column_name.to_sym)
       end
 
       def built_attributes
@@ -150,13 +143,13 @@ module AnnotateRb
         table_name = @klass.table_name
         return [] unless table_name
 
-        indexes = @klass.connection.indexes(table_name)
+        indexes = connection.indexes(table_name)
         return indexes if indexes.any? || !@klass.table_name_prefix
 
         # Try to search the table without prefix
         table_name_without_prefix = table_name.to_s.sub(@klass.table_name_prefix.to_s, "")
         begin
-          @klass.connection.indexes(table_name_without_prefix)
+          connection.indexes(table_name_without_prefix)
         rescue ActiveRecord::StatementInvalid => _e
           # Mysql2 adapter behaves differently than Sqlite3 and Postgres adapter.
           # If `table_name_without_prefix` does not exist, Mysql2 will raise,
@@ -232,8 +225,7 @@ module AnnotateRb
         # 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 = connection.pool.db_config.name
-        cache_key = "current_version_#{connection_pool_name}".to_sym
+        cache_key = "current_version_#{database_name}".to_sym
 
         if @options.get_state(cache_key).nil?
           migration_version = begin

data/lib/annotate_rb/options.rb

@@ -76,6 +76,7 @@ module AnnotateRb
       timestamp_columns: ModelAnnotator::ModelWrapper::DEFAULT_TIMESTAMP_COLUMNS,
 
       ignore_columns: nil, # ModelAnnotator
+      ignore_multi_database_name: false, # ModelAnnotator
       ignore_routes: nil, # RouteAnnotator
       ignore_unknown_models: false, # ModelAnnotator
       models: true, # Core
@@ -143,6 +144,7 @@ module AnnotateRb
       :ignore_columns,
       :ignore_routes,
       :ignore_unknown_models,
+      :ignore_multi_database_name,
       :models,
       :routes,
       :skip_on_db_migrate,

data/lib/annotate_rb/parser.rb

@@ -436,6 +436,11 @@ module AnnotateRb
         "Render Schema Information as plain/RDoc/Yard/Markdown") do |format_type|
         @options["format_#{format_type}".to_sym] = true
       end
+
+      option_parser.on("--config-path [path]",
+        "Path to configuration file (by default, .annotaterb.yml in the root of the project)") do |path|
+        @options[:config_path] = path
+      end
     end
   end
 end

data/lib/annotate_rb/rake_bootstrapper.rb

@@ -3,8 +3,9 @@
 module AnnotateRb
   class RakeBootstrapper
     class << self
-      def call(options)
+      def call
         require "rake"
+
         load "./Rakefile" if File.exist?("./Rakefile") && !Rake::Task.task_defined?(:environment)
 
         begin

data/lib/annotate_rb/runner.rb

@@ -23,23 +23,23 @@ module AnnotateRb
     end
 
     def run(args)
-      config_file_options = ConfigLoader.load_config
       parser = Parser.new(args, {})
 
       parsed_options = parser.parse
       remaining_args = parser.remaining_args
 
+      AnnotateRb::ConfigFinder.config_path = parsed_options[:config_path] if parsed_options[:config_path]
+      config_file_options = ConfigLoader.load_config
       options = config_file_options.merge(parsed_options)
 
       @options = Options.from(options, {working_args: remaining_args})
-      AnnotateRb::RakeBootstrapper.call(@options)
+      AnnotateRb::RakeBootstrapper.call
 
-      if @options[:command]
-        @options[:command].call(@options)
-      else
-        # TODO
-        raise "Didn't specify a command"
-      end
+      raise "Didn't specify a command" unless @options[:command]
+
+      @options[:command].call(@options)
+
+      # TODO
     end
   end
 end

data/lib/annotate_rb/tasks/annotate_models_migrate.rake

@@ -22,8 +22,11 @@ if defined?(Rails::Application) && Rails.version.split(".").first.to_i >= 6
   end
 end
 
+config = ::AnnotateRb::ConfigLoader.load_config
+
 migration_tasks.each do |task|
   next unless Rake::Task.task_defined?(task)
+  next if config[:skip_on_db_migrate]
 
   Rake::Task[task].enhance do # This block is ran after `task` completes
     task_name = Rake.application.top_level_tasks.last # The name of the task that was run, e.g. "db:migrate"

data/lib/annotate_rb.rb

@@ -2,14 +2,11 @@
 
 require "active_record"
 require "active_support"
-
-# Helper.fallback depends on this being required because it adds #present? to nil
-require "active_support/core_ext/object/blank"
-require "active_support/core_ext/class/subclasses"
-require "active_support/core_ext/string/inflections"
-
 require "rake"
 
+module AnnotateRb
+end
+
 require_relative "annotate_rb/helper"
 require_relative "annotate_rb/core"
 require_relative "annotate_rb/commands"
@@ -23,6 +20,3 @@ require_relative "annotate_rb/rake_bootstrapper"
 require_relative "annotate_rb/config_finder"
 require_relative "annotate_rb/config_loader"
 require_relative "annotate_rb/config_generator"
-
-module AnnotateRb
-end

data/lib/annotaterb.rb

@@ -1,4 +1,4 @@
 # Gem names that follow naming convention work seamlessly. However, this gem is "annotaterb" where in code it is
 # AnnotateRb. Because of this, we need this file so that the rest of the library automatically gets required.
 
-require "annotate_rb"
+require_relative "annotate_rb"

data/lib/generators/annotate_rb/hook/templates/annotate_rb.rake

@@ -4,5 +4,7 @@
 if Rails.env.development? && ENV["ANNOTATERB_SKIP_ON_DB_TASKS"].nil?
   require "annotate_rb"
 
+  # Can modify the config path here if needed - by default, it's .annotaterb.yml in the root of the project
+  # AnnotateRb::ConfigFinder.config_path = ""
   AnnotateRb::Core.load_rake_tasks
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.20.0
+  version: 4.22.0
 platform: ruby
 authors:
 - Andrew W. Lee
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -151,7 +150,6 @@ metadata:
   changelog_uri: https://github.com/drwl/annotaterb/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/drwl/annotaterb/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -166,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.4
 specification_version: 4
 summary: A gem for generating annotations for Rails projects.
 test_files: []