annotaterb 4.15.0 → 4.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a31463c338bd23299c7249e3c444d8c1b630157bf9905cfeb203dfafb1a4d16a
-  data.tar.gz: ad12fccdeeb0186d6627ba237c417c637b1b6136f354313e81f09de90cef4665
+  metadata.gz: 91c5e0b20f8c7f5a3160bd2eac0f1e96f9b05e9fd72ddd08fc18422d63472510
+  data.tar.gz: e7bfda05d5943c0b2c978dc6863151aad9c1934b6ff5551ec88292ab96dfc57d
 SHA512:
-  metadata.gz: af6ec6a16d36b65b00eb28f4736c46682aa0d47da4869503eaecb8a58a8ff34f783ac3986c09200f125279666a8b30658af1ba91a9ad5829d789846c1c9e82dd
-  data.tar.gz: ad7fbd08360072a24c2fbea2808c180806ae89da5775689d1f7cc2824fead770b771ac41667056e68da0921ae13948a6f3da48883ab2f0328506cbf7158a63c0
+  metadata.gz: 42f9849dd393c04606dcbd7ada4749bfb617180fe3992d19adb16f17f00a9e4af4ecae34d2a9305b5a2ab5b359c4762a87c83cd43c395302e14387b43538ccb2
+  data.tar.gz: 5cc6acd44ac8ae6c4aeb5895e776adf3ac75044fc67e4c2682527256bda5a36915670dbae92e3a478f55d883907c5c480e28c769b7f40c219c5d4a06fc64750f

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## [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)
+
+**Closed issues:**
+
+- Feature request: packs-rails support [\#99](https://github.com/drwl/annotaterb/issues/99)
+- Annotate models using Zeitwerk namespaces [\#82](https://github.com/drwl/annotaterb/issues/82)
+
+**Merged pull requests:**
+
+- Bump version to v4.15.0 [\#218](https://github.com/drwl/annotaterb/pull/218) ([drwl](https://github.com/drwl))
+- Add debug logs for model annotation [\#217](https://github.com/drwl/annotaterb/pull/217) ([jarredhawkins](https://github.com/jarredhawkins))
+- Cache retrieved indexes in ModelWrapper [\#215](https://github.com/drwl/annotaterb/pull/215) ([tr4b4nt](https://github.com/tr4b4nt))
+- feat: identify unique indexes in simple\_indexes option [\#214](https://github.com/drwl/annotaterb/pull/214) ([amerritt14](https://github.com/amerritt14))
+- fix: Handle case when table\_name\_prefix specified as symbol [\#208](https://github.com/drwl/annotaterb/pull/208) ([gururuby](https://github.com/gururuby))
+- Support the glob pattern in `root_dir` and `model_dir` [\#198](https://github.com/drwl/annotaterb/pull/198) ([sinsoku](https://github.com/sinsoku))
+- Fix `changelog_uri` in gemspec [\#192](https://github.com/drwl/annotaterb/pull/192) ([y-yagi](https://github.com/y-yagi))
+- Generate changelog for v4.14.0 [\#191](https://github.com/drwl/annotaterb/pull/191) ([drwl](https://github.com/drwl))
+- feat: add `timestamp_columns` config option [\#173](https://github.com/drwl/annotaterb/pull/173) ([pbernays](https://github.com/pbernays))
+
+## [v4.14.1](https://github.com/drwl/annotaterb/tree/v4.14.1) (2025-03-31)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.14.0...v4.14.1)
+
+**Closed issues:**
+
+- Sort by database order [\#194](https://github.com/drwl/annotaterb/issues/194)
+- “wrong number of arguments \(given 0, expected 1..2\)” when using enum in a Rails 8 model [\#184](https://github.com/drwl/annotaterb/issues/184)
+
 ## [v4.14.0](https://github.com/drwl/annotaterb/tree/v4.14.0) (2025-02-17)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.13.0...v4.14.0)

data/README.md

@@ -134,6 +134,7 @@ 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 
 
 Annotate routes options:
     Usage: annotaterb routes [options]
@@ -149,7 +150,7 @@ Command options:
 Additional options that work for annotating models and routes
 
         --additional-file-patterns path1,path2,path3
-                                     Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
+                                     Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%MODEL_NAME%/*.rb,/baz/%MODEL_NAME%.rb`)
     -d, --delete                     Remove annotations from all model files or the routes.rb file
         --model-dir dir              Annotate model files stored in dir rather than app/models, separate multiple dirs with commas
         --root-dir dir               Annotate files stored within root dir projects, separate multiple dirs with commas
@@ -192,7 +193,7 @@ Previously in the [Annotate](https://github.com/ctran/annotate_models) you could
 position: after
 ```
 
-Annotaterb reads first from the configuration file, if it exists, then merges it with any options passed into the CLI. 
+Annotaterb reads first the configuration file, if it exists, passes its content through ERB, and merges the result with any options passed into the CLI.
 
 For further details visit the [section in the migration guide](MIGRATION_GUIDE.md#automatic-annotations-after-running-database-migration-commands).
 

data/VERSION

@@ -1 +1 @@
-4.15.0
+4.16.0

data/lib/annotate_rb/config_loader.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "erb"
+
 module AnnotateRb
   # Raised when a configuration file is not found.
   class ConfigNotFoundError < StandardError
@@ -20,8 +22,9 @@ module AnnotateRb
       # Method from Rubocop::ConfigLoader
       def load_yaml_configuration(absolute_path)
         file_contents = read_file(absolute_path)
+        yaml_code = ERB.new(file_contents).result
 
-        hash = yaml_safe_load(file_contents, absolute_path) || {}
+        hash = yaml_safe_load(yaml_code, absolute_path) || {}
 
         # TODO: Print config if debug flag/option is set
 

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

@@ -47,19 +47,46 @@ module AnnotateRb
         def content_annotated_before(parsed, content_without_annotations, write_position)
           same_write_position = @parsed_file.has_annotations? && @parsed_file.annotation_position.to_s == write_position
 
-          # Could error if there's no class or module declaration
-          _constant_name, line_number_before = parsed.starts.first
+          _constant_name, line_number_before = determine_annotation_position(parsed)
 
           content_with_annotations_written_before = []
           content_with_annotations_written_before << content_without_annotations.lines[0...line_number_before]
           content_with_annotations_written_before << $/ if @parsed_file.has_leading_whitespace? && same_write_position
-          content_with_annotations_written_before << @new_wrapped_annotations.lines
+          content_with_annotations_written_before << formatted_annotations(content_without_annotations, line_number_before)
           content_with_annotations_written_before << $/ if @parsed_file.has_trailing_whitespace? && same_write_position
           content_with_annotations_written_before << content_without_annotations.lines[line_number_before..]
 
           content_with_annotations_written_before.join
         end
 
+        # Determines where to place the annotation based on the nested_position option.
+        # 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)
+          return parsed.starts.first unless @options[:nested_position]
+
+          class_entries = parsed.starts.select { |name, _line| parsed.type_map[name] == :class }
+          class_entries.last || parsed.starts.first
+        end
+
+        # Formats annotations with appropriate indentation for consistent code structure.
+        # Applies the same indentation level as the target line to maintain proper
+        # code alignment when using nested positioning.
+        def formatted_annotations(content_without_annotations, line_number_before)
+          indentation = determine_indentation(content_without_annotations, line_number_before)
+          @new_wrapped_annotations.lines.map { |line| "#{indentation}#{line}" }
+        end
+
+        # Calculates the indentation string to apply to annotations for nested positioning.
+        # Extracts leading whitespace from the target line to preserve visual hierarchy
+        # and readability of nested code structures.
+        def determine_indentation(content_without_annotations, line_number_before)
+          return "" unless @options[:nested_position] && line_number_before > 0
+
+          target_line = content_without_annotations.lines[line_number_before]
+          target_line&.match(/^(\s*)/)&.[](1) || ""
+        end
+
         def content_annotated_after(parsed, content_without_annotations)
           _constant_name, line_number_after = parsed.ends.last
 

data/lib/annotate_rb/parser.rb

@@ -264,6 +264,11 @@ module AnnotateRb
           [klass]
         end
       end
+
+      option_parser.on("--nested-position",
+        "Place annotations directly above nested classes or modules instead of at the top of the file.") do
+        @options[:nested_position] = true
+      end
     end
 
     def add_route_options_to_parser(option_parser)
@@ -362,7 +367,7 @@ module AnnotateRb
 
       option_parser.on("--additional-file-patterns path1,path2,path3",
         Array,
-        "Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)") do |additional_file_patterns|
+        "Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%MODEL_NAME%/*.rb,/baz/%MODEL_NAME%.rb`)") do |additional_file_patterns|
         @options[:additional_file_patterns] = additional_file_patterns
       end
 

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.15.0
+  version: 4.16.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-30 00:00:00.000000000 Z
-dependencies: []
+date: 2025-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
 email:
@@ -131,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="