annotaterb 4.18.0 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0276a5044aa1b444f73aac5612004ce9a8c05c6d47634fb2e8798c24a442fed5
-  data.tar.gz: 58cd27cb187989b06c459979ac0152db9dfdb54d671b9348980c244caa7981a6
+  metadata.gz: '0759110968217261a67bb8c519e55398ff9f43392e6cc4771bbebf5f97ce0395'
+  data.tar.gz: d179acc1d279901b547475d5ee87d46346d671e083ef233d2e65e1a7c8d3f277
 SHA512:
-  metadata.gz: ac0f491e7022299fc96029950c5edf2b0e05aa38e9f3198ec37acbd04275888be493f4202f31295e8db0ad7737cc03d2c6b52e5fbb51c24418ef92f40da77a13
-  data.tar.gz: 914216a38c137682acb6e2b58154c3af47dba3b0ebb424b69194a59c3939cfdd01c00d0f75a10bb51800f2ea6ce3f4dc97f3cdcd592ff7f77e7cafc906cd660f
+  metadata.gz: 8c0c8deaf4685925e3992f0adc33ecc2d92c49049eea38e44881d510b06128e031569ab242b80e160d534b369985a4eb9bb28612682d10c7a4e254f18030078e
+  data.tar.gz: 1f37df086f3c6afd475e684bdc8458fd3ffe70ff245f2dc6b14786cd889e3b2107269064344f79c27425f46e0f599b3a6d3d4e7662844523c7a22bd799c49fc5

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [v4.18.0](https://github.com/drwl/annotaterb/tree/v4.18.0) (2025-08-04)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.17.0...v4.18.0)
+
+**Implemented enhancements:**
+
+- Feature request: support for multi database [\#188](https://github.com/drwl/annotaterb/issues/188)
+
+**Closed issues:**
+
+- Does not run on rollback with multiple databases [\#244](https://github.com/drwl/annotaterb/issues/244)
+- classified\_sort and polymorphic associations [\#236](https://github.com/drwl/annotaterb/issues/236)
+- --show-migration also annotates the primary DB's schema version for models referencing the secondary DB [\#233](https://github.com/drwl/annotaterb/issues/233)
+- Annotations are not added on top of model files when columns'`comment:` contains Japanese characters in migrations [\#200](https://github.com/drwl/annotaterb/issues/200)
+- Feature: further customization to achieve more compact annotations [\#150](https://github.com/drwl/annotaterb/issues/150)
+- Version 5 change list [\#127](https://github.com/drwl/annotaterb/issues/127)
+- Reformat Column Comments [\#117](https://github.com/drwl/annotaterb/issues/117)
+
+**Merged pull requests:**
+
+- Bump version to v4.18.0 [\#246](https://github.com/drwl/annotaterb/pull/246) ([drwl](https://github.com/drwl))
+- Run on rollback in app with multiple databases [\#245](https://github.com/drwl/annotaterb/pull/245) ([z1lk](https://github.com/z1lk))
+- Speed up AnnotationDecider [\#243](https://github.com/drwl/annotaterb/pull/243) ([DRBragg](https://github.com/DRBragg))
+- Add AnnotateRb::Runner.running? method [\#242](https://github.com/drwl/annotaterb/pull/242) ([thewatts](https://github.com/thewatts))
+- fix: --show-migration to use per-model database connections [\#241](https://github.com/drwl/annotaterb/pull/241) ([OdenTakashi](https://github.com/OdenTakashi))
+- Fix: Support Japanese characters in column names [\#239](https://github.com/drwl/annotaterb/pull/239) ([tonystrawberry](https://github.com/tonystrawberry))
+- Fix classified\_sort to group polymorphic association columns together [\#238](https://github.com/drwl/annotaterb/pull/238) ([garriguv](https://github.com/garriguv))
+- Generate changelog for v4.17.0 [\#235](https://github.com/drwl/annotaterb/pull/235) ([drwl](https://github.com/drwl))
+
 ## [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)

data/VERSION

@@ -1 +1 @@
-4.18.0
+4.19.0

data/lib/annotate_rb/eager_loader.rb

@@ -7,17 +7,16 @@ module AnnotateRb
       def call(options)
         options[:require].count > 0 && options[:require].each { |path| require path }
 
-        if defined?(::Rails::Application)
-          if defined?(::Zeitwerk)
-            # Delegate to Zeitwerk to load stuff as needed
-          else
-            klass = ::Rails::Application.send(:subclasses).first
-            klass.eager_load!
-          end
+        if defined?(::Zeitwerk)
+          # Delegate to Zeitwerk to load stuff as needed
+          #   (Supports both Rails and non-Rails applications)
+        elsif defined?(::Rails::Application)
+          klass = ::Rails::Application.send(:subclasses).first
+          klass.eager_load!
         else
           model_files = ModelAnnotator::ModelFilesGetter.call(options)
           model_files&.each do |model_file|
-            require model_file
+            require File.join(*model_file)
           end
         end
       end

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

@@ -59,7 +59,7 @@ module AnnotateRb
         end
 
         def build
-          version = migration_version_for_model(@model)
+          version = @model.migration_version
           table_name = @model.table_name
           table_comment = @model.connection.try(:table_comment, @model.table_name)
           max_size = @model.max_schema_info_width
@@ -68,30 +68,6 @@ 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,17 +16,26 @@ 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?
 
-          return @options[:exclude_sti_subclasses] ? klass.base_class? : true
+          return false unless klass.respond_to?(:descends_from_active_record?)
+
+          # Skip annotating STI classes
+          if @options[:exclude_sti_subclasses] && !klass.descends_from_active_record?
+            return false
+          end
+
+          return false if klass.abstract_class?
+          return false unless klass.table_exists?
+
+          return true
         rescue BadModelFileError => e
           unless @options[:ignore_unknown_models]
             warn "Unable to process #{@file}: #{e.message}"
-            warn "\t" + e.backtrace.join("\n\t") if @options[:trace]
+            warn "\t#{e.backtrace.join("\n\t")}" if @options[:trace]
           end
         rescue => e
           warn "Unable to process #{@file}: #{e.message}"
-          warn "\t" + e.backtrace.join("\n\t") if @options[:trace]
+          warn "\t#{e.backtrace.join("\n\t")}" if @options[:trace]
         end
 
         false

data/lib/annotate_rb/model_annotator/model_files_getter.rb

@@ -32,9 +32,8 @@ module AnnotateRb
             warn "Either specify models on the command line, or use the --model-dir option."
             warn "Call 'annotaterb --help' for more info."
             # exit 1 # TODO: Return exit code back to caller. Right now it messes up RSpec being able to run
-          else
-            model_files
           end
+          model_files
         end
 
         private

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -221,6 +221,28 @@ module AnnotateRb
           @klass.name.foreign_key.to_sym
         ]
       end
+
+      def migration_version
+        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 = connection.pool.db_config.name
+        cache_key = "current_version_#{connection_pool_name}".to_sym
+
+        if @options.get_state(cache_key).nil?
+          migration_version = begin
+            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/parser.rb

@@ -423,9 +423,9 @@ module AnnotateRb
       end
 
       option_parser.on("-e",
-        "--exclude [tests,fixtures,factories,serializers]",
+        "--exclude [tests,fixtures,factories,serializers,sti_subclasses]",
         Array,
-        "Do not annotate fixtures, test files, factories, and/or serializers") do |exclusions|
+        "Do not annotate fixtures, test files, factories, serializers, and/or sti subclasses") do |exclusions|
         exclusions ||= EXCLUSION_LIST
         exclusions.each { |exclusion| @options["exclude_#{exclusion}".to_sym] = true }
       end

metadata

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