annotaterb 4.25.0 → 4.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e76c98c2c18b7021f7844189a076f4d5cb52b61777c5200bff9888497d3924d2
-  data.tar.gz: ddf7481ef3fdb08071855c9131a7dfca2426d29ad0c7dfdeff9f891d510a867b
+  metadata.gz: 128081f8778da0dda7fc1f5ea0a24544900e92ec1a2300a1baf1429dcc52946b
+  data.tar.gz: d093aba69c6949247182263968b2d9a63ee8be1c34dc2b473819c9e7cef73ef2
 SHA512:
-  metadata.gz: 38dd0ae99e1a1e21dd68963b5e6f85bb72d620955ab001df8136dc4d40122196d4bb88dd107bfe95fdd93bcb17befe907f4ebe001ad05f364067b17d40c839e3
-  data.tar.gz: be47e90cad90aefdd1ea96d494783731270b26c5a8f24843912eea6f418a1375bbbc7bdc3550181f763eef47eb46eb595d1e54fc2bc06ede1eb26abfbfeb917b
+  metadata.gz: 1581a93b0b0c29054b3ceb8d30a581834d809134a8ed8c546c2b285fb90f505c8c5dca99e7cb2449c3bd87dc60c3b756f033229672a721941c1d599b94d62adc
+  data.tar.gz: 8368a6349d5070d09aa9967a3474d92140fce7427c32b4273aad70aa2ca3e39486464bd6be4aff2560f7505b1aaf3de4980a533002aa5c82f0dcbeeeffff3555

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## [v4.25.0](https://github.com/drwl/annotaterb/tree/v4.25.0) (2026-09-17)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.24.0...v4.25.0)
+
+**Fixed bugs:**
+
+- Missing unique indexes in annotations [\#390](https://github.com/drwl/annotaterb/issues/390)
+- Related files are matched globally by unqualified model name, so models with the same basename in different packs overwrite   each other's annotations \(breaks --frozen\) [\#367](https://github.com/drwl/annotaterb/issues/367)
+- When `format_markdown: true`, annotations get written duplicated into models that already have annotations. [\#355](https://github.com/drwl/annotaterb/issues/355)
+
+**Closed issues:**
+
+- Foreign-key annotation crashes with ArgumentError when unnamed FKs mix with a composite FK [\#377](https://github.com/drwl/annotaterb/issues/377)
+- 4.24.0: enum-backed integer columns annotate raw default\(0\) instead of default\("label"\) [\#373](https://github.com/drwl/annotaterb/issues/373)
+
+**Merged pull requests:**
+
+- Release v4.25.0 [\#395](https://github.com/drwl/annotaterb/pull/395) ([drwl](https://github.com/drwl))
+- Bump github/codeql-action from 4.37.9 to 4.38.0 [\#394](https://github.com/drwl/annotaterb/pull/394) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Remove unused `routes` option [\#393](https://github.com/drwl/annotaterb/pull/393) ([OdenTakashi](https://github.com/OdenTakashi))
+- Bump github/codeql-action from 4.37.4 to 4.37.9 [\#389](https://github.com/drwl/annotaterb/pull/389) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Use native prefix predicate in YAML parser [\#387](https://github.com/drwl/annotaterb/pull/387) ([OskarEichler](https://github.com/OskarEichler))
+- Fix multi-database annotation removal fixture targeting [\#386](https://github.com/drwl/annotaterb/pull/386) ([OskarEichler](https://github.com/OskarEichler))
+- Update annotated model in README [\#385](https://github.com/drwl/annotaterb/pull/385) ([koeda-ta](https://github.com/koeda-ta))
+- Show index operator classes in annotations [\#382](https://github.com/drwl/annotaterb/pull/382) ([kamipo](https://github.com/kamipo))
+- Fix enum-backed integer columns annotations [\#380](https://github.com/drwl/annotaterb/pull/380) ([dmke](https://github.com/dmke))
+- Fix ArgumentError sorting unnamed foreign keys when one is composite [\#378](https://github.com/drwl/annotaterb/pull/378) ([6temes](https://github.com/6temes))
+- Bump github/codeql-action from 4 to 4.37.4 [\#376](https://github.com/drwl/annotaterb/pull/376) ([dependabot[bot]](https://github.com/apps/dependabot))
+- docs: fix mistake in changelog [\#375](https://github.com/drwl/annotaterb/pull/375) ([G-Rath](https://github.com/G-Rath))
+- Stop same-named models in different packs from annotating each others related files by matching on owning root\_dir. [\#374](https://github.com/drwl/annotaterb/pull/374) ([OdenTakashi](https://github.com/OdenTakashi))
+- Generate changelog for v4.24.0 [\#372](https://github.com/drwl/annotaterb/pull/372) ([drwl](https://github.com/drwl))
+
 ## [v4.24.0](https://github.com/drwl/annotaterb/tree/v4.24.0) (2026-07-24)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.23.0...v4.24.0)
@@ -7,7 +39,7 @@
 **Implemented enhancements:**
 
 - Annotate postgres enums [\#309](https://github.com/drwl/annotaterb/issues/309)
-- `--frozen` option returns a non-zero error code when database is inaccessible [\#240](https://github.com/drwl/annotaterb/issues/240)
+- `--frozen` option returns a zero error code when database is inaccessible [\#240](https://github.com/drwl/annotaterb/issues/240)
 - Add support for printing enum types [\#176](https://github.com/drwl/annotaterb/issues/176)
 
 **Fixed bugs:**

data/README.md

@@ -165,6 +165,7 @@ Annotate model options:
         --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.
+        --load-columns-from-schema   Load columns from schema to avoid ActiveRecord ignored/only column configuration
 
 Annotate routes options:
     Usage: annotaterb routes [options]

data/VERSION

@@ -1 +1 @@
-4.25.0
+4.26.0

data/lib/annotate_rb/model_annotator/file_name_resolver.rb

@@ -13,7 +13,7 @@ module AnnotateRb
             .gsub("%MODEL_NAME%", model_name)
             .gsub("%MODEL_NAME_WITHOUT_NS%", model_name_without_namespace)
             .gsub("%PLURALIZED_MODEL_NAME%", model_name.pluralize)
-            .gsub("%TABLE_NAME%", table_name || model_name.pluralize)
+            .gsub("%TABLE_NAME%", table_name&.to_s || model_name.pluralize)
         end
       end
     end

data/lib/annotate_rb/model_annotator/model_class_getter.rb

@@ -16,7 +16,9 @@ module AnnotateRb
           end
 
           model_path = file.gsub(/\.rb$/, "")
-          options[:model_dir].each { |dir| model_path = model_path.gsub(/^#{dir}/, "").gsub(/^\//, "") }
+          model_dirs = options[:model_dir].flat_map { |dir| Dir[dir] }
+          model_dirs.each { |dir| model_path = model_path.delete_prefix(File.join(dir, "")) }
+          model_path = model_path.delete_prefix(File::SEPARATOR)
 
           begin
             get_loaded_model(model_path, file) || raise(BadModelFileError.new)

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -48,7 +48,11 @@ module AnnotateRb
 
       # Returns the unmodified model columns
       def raw_columns
-        @raw_columns ||= @klass.columns
+        @raw_columns ||= if @options[:load_columns_from_schema]
+          connection.schema_cache.columns_hash(@klass.table_name).values.freeze
+        else
+          @klass.columns
+        end
       end
 
       def primary_key
@@ -80,7 +84,7 @@ module AnnotateRb
         @column_defaults ||= @klass.column_defaults.each_with_object({}) do |(name, value), result|
           column = @klass.columns_hash[name]
           result[name] = if attribute_default_overridden?(name, column)
-            schema_default_for(column)
+            schema_default_with_enum_label(name, column)
           else
             enum_default(name, column, value)
           end
@@ -296,9 +300,10 @@ module AnnotateRb
       # shown. `enum_default_format` picks between that label, the raw value,
       # and both.
       def enum_default(name, column, label)
-        return label unless @klass.defined_enums.key?(name)
+        return label unless enum_attribute?(name)
 
         raw = schema_default_for(column)
+        return raw if label.nil?
         return label if raw == label
 
         case @options[:enum_default_format]
@@ -308,6 +313,27 @@ module AnnotateRb
         end
       end
 
+      # `enum :status, {...}, default: :shipped` sets a Ruby-side default without
+      # changing the schema default, so it lands in the override path. Map the
+      # schema value back to its label so the column annotates like any other
+      # enum column.
+      def schema_default_with_enum_label(name, column)
+        raw = schema_default_for(column)
+        label = enum_label_for(name, raw)
+        return raw if label.nil?
+
+        enum_default(name, column, label)
+      end
+
+      def enum_label_for(name, raw)
+        @klass.defined_enums[name]&.key(raw)
+      end
+
+      def enum_attribute?(name)
+        @klass.defined_enums.key?(name) ||
+          (@klass.respond_to?(:enumerized_attributes) && @klass.enumerized_attributes[name])
+      end
+
       def schema_default_for(column)
         return nil if column.nil? || column.default.nil? || column.default_function
         cast_type_for(column).deserialize(column.default)

data/lib/annotate_rb/model_annotator/related_files_list_builder.rb

@@ -89,7 +89,17 @@ module AnnotateRb
         patterns
           .map { |f| FileNameResolver.call(f, @model_name, @table_name) }
           .flat_map { |f| Dir.glob(f) }
-          .select { |f| owning_root_dir(f) == model_root_dir }
+          .select { |f| related_file_owned_by_model_root?(f, pattern_type) }
+      end
+
+      # Additional file patterns are written by the user as explicit project paths, so a match outside
+      #   every `root_dir` (e.g. `app/serializers/%MODEL_NAME%.rb` for a model living in a pack) belongs
+      #   to the project and is still related. Matches inside another root directory remain excluded.
+      def related_file_owned_by_model_root?(file, pattern_type)
+        owner = owning_root_dir(file)
+        return true if owner == model_root_dir
+
+        owner.nil? && pattern_type.to_s == "additional_file_patterns"
       end
 
       def model_root_dir

data/lib/annotate_rb/model_annotator/single_file_annotator.rb

@@ -23,6 +23,8 @@ module AnnotateRb
         #
         def call(file_name, annotation, annotation_position, options, model_class_name: nil)
           return false unless File.exist?(file_name)
+
+          validate_annotation!(annotation)
           old_content = File.read(file_name)
 
           parser_klass = FileToParserMapper.map(file_name)
@@ -52,6 +54,16 @@ module AnnotateRb
 
           true
         end
+
+        private
+
+        def validate_annotation!(annotation)
+          comment_only = annotation.to_s.split(/\r\n?|\n/, -1).all? do |line|
+            line.match?(/\A[ \t]*(?:#.*)?\z/)
+          end
+
+          raise ArgumentError, "annotation contains non-comment content" unless comment_only
+        end
       end
     end
   end

data/lib/annotate_rb/options.rb

@@ -56,6 +56,7 @@ module AnnotateRb
       show_indexes_comments: false, # ModelAnnotator
       show_indexes_include: false, # ModelAnnotator
       show_virtual_columns: false, # ModelAnnotator
+      load_columns_from_schema: false, # ModelAnnotator
       simple_indexes: false, # ModelAnnotator
       sort: false, # ModelAnnotator
       timestamp: false, # RouteAnnotator
@@ -125,6 +126,7 @@ module AnnotateRb
       :ignore_model_sub_dir,
       :ignore_unknown_models,
       :include_version,
+      :load_columns_from_schema,
       :show_check_constraints,
       :show_unique_constraints,
       :show_exclusion_constraints,

data/lib/annotate_rb/parser.rb

@@ -296,6 +296,11 @@ module AnnotateRb
         "Place annotations directly above nested classes or modules instead of at the top of the file.") do
         @options[:nested_position] = true
       end
+
+      option_parser.on("--load-columns-from-schema",
+        "Load columns from schema to avoid ActiveRecord ignored/only column configuration") do
+        @options[:load_columns_from_schema] = true
+      end
     end
 
     def add_route_options_to_parser(option_parser)

data/lib/annotate_rb/rake_bootstrapper.rb

@@ -13,6 +13,12 @@ module AnnotateRb
         rescue
           nil
         end
+
+        # Tenanted models from activerecord-tenanted can't reach their database
+        # without a current tenant. The gem defines `db:tenant` to set its default
+        # tenant (ARTENANT, or the default tenant in local environments), the same
+        # way it does for the Rails console.
+        Rake::Task["db:tenant"].invoke if Rake::Task.task_defined?("db:tenant")
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.25.0
+  version: 4.26.0
 platform: ruby
 authors:
 - Andrew W. Lee