annotaterb 4.14.0 → 4.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 915a9aee6e9396080e4b115bc34466f422cc866aa31f64e8563a409f4ed53753
-  data.tar.gz: 30e4511ae77313d4d1f7348599286815a85e56f2c100f31ca73cc7a1feaa59d4
+  metadata.gz: 91c5e0b20f8c7f5a3160bd2eac0f1e96f9b05e9fd72ddd08fc18422d63472510
+  data.tar.gz: e7bfda05d5943c0b2c978dc6863151aad9c1934b6ff5551ec88292ab96dfc57d
 SHA512:
-  metadata.gz: 8e1c00298956404ba517a54b803f0cae4235da530a1f2dfe6db35e58c3747ba4bc7304759375ecf51237870f2e4701b965192b235e1c430b08bd4d0340bf6dc1
-  data.tar.gz: 63f51a4bbc1ebf2455aeeb8b3a7459a87787b309f5deae0a0e91df971bc28a36f77fa71f7b80a4fbe8f32d3660936fa41576f56569e72526fc2505a77c8fc6df
+  metadata.gz: 42f9849dd393c04606dcbd7ada4749bfb617180fe3992d19adb16f17f00a9e4af4ecae34d2a9305b5a2ab5b359c4762a87c83cd43c395302e14387b43538ccb2
+  data.tar.gz: 5cc6acd44ac8ae6c4aeb5895e776adf3ac75044fc67e4c2682527256bda5a36915670dbae92e3a478f55d883907c5c480e28c769b7f40c219c5d4a06fc64750f

data/CHANGELOG.md

@@ -1,5 +1,61 @@
 # 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)
+
+**Closed issues:**
+
+- How do I annotate models but NOT routes? [\#178](https://github.com/drwl/annotaterb/issues/178)
+- Model Annotation Not Updated When Modifying Table Columns Using change\_table. [\#169](https://github.com/drwl/annotaterb/issues/169)
+- annotate\_rb:install failing on Rails 8 [\#168](https://github.com/drwl/annotaterb/issues/168)
+- Annotations with enums changing between db:create db:migrate and then db:migrate [\#167](https://github.com/drwl/annotaterb/issues/167)
+- JSON parse error [\#155](https://github.com/drwl/annotaterb/issues/155)
+- Feature: Add Support for dynamic fixtures with ERB [\#149](https://github.com/drwl/annotaterb/issues/149)
+
+**Merged pull requests:**
+
+- Bump version to v4.14.0 [\#190](https://github.com/drwl/annotaterb/pull/190) ([drwl](https://github.com/drwl))
+- Add expected file to automatically require [\#185](https://github.com/drwl/annotaterb/pull/185) ([drwl](https://github.com/drwl))
+- Fix translation foreign key exclusion bug [\#181](https://github.com/drwl/annotaterb/pull/181) ([galori](https://github.com/galori))
+- Lock `concurrent-ruby` gem to fix CI [\#180](https://github.com/drwl/annotaterb/pull/180) ([tagliala](https://github.com/tagliala))
+- Chore: alert when multiple conmmands were selected [\#179](https://github.com/drwl/annotaterb/pull/179) ([OdenTakashi](https://github.com/OdenTakashi))
+- Updated COLUMN\_PATTERN to handle optional metadata \(e.g., constraints or descriptions\) enclosed in parentheses. [\#170](https://github.com/drwl/annotaterb/pull/170) ([hatsu38](https://github.com/hatsu38))
+- Opt-in for MFA requirement [\#166](https://github.com/drwl/annotaterb/pull/166) ([tagliala](https://github.com/tagliala))
+- Fix typos [\#165](https://github.com/drwl/annotaterb/pull/165) ([tagliala](https://github.com/tagliala))
+- Add support for virtual columns [\#163](https://github.com/drwl/annotaterb/pull/163) ([robbevp](https://github.com/robbevp))
+- Generate changelog for v4.13.0 [\#160](https://github.com/drwl/annotaterb/pull/160) ([drwl](https://github.com/drwl))
+
 ## [v4.13.0](https://github.com/drwl/annotaterb/tree/v4.13.0) (2024-10-21)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.12.0...v4.13.0)
@@ -293,7 +349,7 @@
 - Fix the default behavior for model annotator [\#20](https://github.com/drwl/annotaterb/pull/20) ([drwl](https://github.com/drwl))
 - Refactor model annotator [\#19](https://github.com/drwl/annotaterb/pull/19) ([drwl](https://github.com/drwl))
 - Removed unused helper methods and `Env` class [\#18](https://github.com/drwl/annotaterb/pull/18) ([drwl](https://github.com/drwl))
-- Update dummy app depdencies [\#17](https://github.com/drwl/annotaterb/pull/17) ([drwl](https://github.com/drwl))
+- Update dummy app dependencies [\#17](https://github.com/drwl/annotaterb/pull/17) ([drwl](https://github.com/drwl))
 
 ## [v4.0.0](https://github.com/drwl/annotaterb/tree/v4.0.0) (2023-05-03)
 

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.14.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/eager_loader.rb

@@ -15,10 +15,9 @@ module AnnotateRb
             klass.eager_load!
           end
         else
-          options[:model_dir].each do |dir|
-            ::Rake::FileList["#{dir}/**/*.rb"].each do |fname|
-              require File.expand_path(fname)
-            end
+          model_files = ModelAnnotator::ModelFilesGetter.call(options)
+          model_files&.each do |model_file|
+            require model_file
           end
         end
       end

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/model_annotator/column_annotation/attributes_builder.rb

@@ -70,10 +70,16 @@ module AnnotateRb
             sorted_column_indices&.each do |index|
               indexed_columns = index.columns.reject { |i| i == @column.name }
 
-              attrs << if indexed_columns.empty?
+              index_text = if index.unique
+                "uniquely indexed"
+              else
                 "indexed"
+              end
+
+              attrs << if indexed_columns.empty?
+                index_text
               else
-                "indexed => [#{indexed_columns.join(", ")}]"
+                "#{index_text} => [#{indexed_columns.join(", ")}]"
               end
             end
           end

data/lib/annotate_rb/model_annotator/model_files_getter.rb

@@ -13,7 +13,8 @@ module AnnotateRb
 
           return model_files if model_files.any?
 
-          options[:model_dir].each do |dir|
+          model_dirs = options[:model_dir].flat_map { |model_dir| Dir[model_dir] }
+          model_dirs.each do |dir|
             Dir.chdir(dir) do
               list = if options[:ignore_model_sub_dir]
                 Dir["*.rb"].map { |f| [dir, f] }
@@ -26,12 +27,14 @@ module AnnotateRb
             end
           end
 
-          model_files
-        rescue SystemCallError
-          warn "No models found in directory '#{options[:model_dir].join("', '")}'."
-          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
+          if model_files.empty?
+            warn "No models found in directory '#{options[:model_dir].join("', '")}'."
+            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
         end
 
         private

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -6,6 +6,8 @@ module AnnotateRb
       # Should be the wrapper for an ActiveRecord model that serves as the source of truth of the model
       # of the model that we're annotating
 
+      DEFAULT_TIMESTAMP_COLUMNS = %w[created_at updated_at]
+
       def initialize(klass, options)
         @klass = klass
         @options = options
@@ -107,6 +109,10 @@ module AnnotateRb
       end
 
       def retrieve_indexes_from_table
+        @indexes_from_table ||= _retrieve_indexes_from_table
+      end
+
+      def _retrieve_indexes_from_table
         table_name = @klass.table_name
         return [] unless table_name
 
@@ -114,7 +120,7 @@ module AnnotateRb
         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, "")
+        table_name_without_prefix = table_name.to_s.sub(@klass.table_name_prefix.to_s, "")
         begin
           @klass.connection.indexes(table_name_without_prefix)
         rescue ActiveRecord::StatementInvalid => _e
@@ -143,10 +149,13 @@ module AnnotateRb
         associations = []
         id = nil
 
+        # specs don't load defaults, so ensure we have defaults here
+        timestamp_columns = @options[:timestamp_columns] || DEFAULT_TIMESTAMP_COLUMNS
+
         cols.each do |c|
           if c.name.eql?("id")
             id = c
-          elsif c.name.eql?("created_at") || c.name.eql?("updated_at")
+          elsif timestamp_columns.include?(c.name)
             timestamps << c
           elsif c.name[-3, 3].eql?("_id")
             associations << c
@@ -154,7 +163,10 @@ module AnnotateRb
             rest_cols << c
           end
         end
-        [rest_cols, timestamps, associations].each { |a| a.sort_by!(&:name) }
+
+        timestamp_order = timestamp_columns.each_with_index.to_h
+        timestamps.sort_by! { |col| timestamp_order[col.name] }
+        [rest_cols, associations].each { |a| a.sort_by!(&:name) }
 
         ([id] << rest_cols << timestamps << associations).flatten.compact
       end

data/lib/annotate_rb/model_annotator/pattern_getter.rb

@@ -64,7 +64,10 @@ module AnnotateRb
       def get
         current_patterns = []
 
-        @options[:root_dir].each do |root_directory|
+        root_dirs = @options[:root_dir].flat_map do |root_dir|
+          root_dir.empty? ? root_dir : Dir[root_dir]
+        end
+        root_dirs.each do |root_directory|
           Array(@pattern_types).each do |pattern_type|
             patterns = generate(root_directory, pattern_type)
 

data/lib/annotate_rb/model_annotator/project_annotator.rb

@@ -34,6 +34,7 @@ module AnnotateRb
       private
 
       def build_instructions_for_file(file)
+        start = Time.now
         klass = ModelClassGetter.call(file, @options)
 
         instructions = []
@@ -52,6 +53,10 @@ module AnnotateRb
         end
         instructions.concat(related_file_instructions)
 
+        if @options[:debug]
+          puts "Built instructions for #{file} in #{Time.now - start}s"
+        end
+
         instructions
       end
 

data/lib/annotate_rb/options.rb

@@ -69,6 +69,9 @@ module AnnotateRb
       # ModelAnnotator
       hide_limit_column_types: "",
 
+      # ModelAnnotator
+      timestamp_columns: ModelAnnotator::ModelWrapper::DEFAULT_TIMESTAMP_COLUMNS,
+
       ignore_columns: nil, # ModelAnnotator
       ignore_routes: nil, # RouteAnnotator
       ignore_unknown_models: false, # ModelAnnotator
@@ -130,6 +133,7 @@ module AnnotateRb
       :debug,
       :hide_default_column_types,
       :hide_limit_column_types,
+      :timestamp_columns,
       :ignore_columns,
       :ignore_routes,
       :ignore_unknown_models,

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.14.0
+  version: 4.16.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-17 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:
@@ -120,7 +148,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/drwl/annotaterb
   source_code_uri: https://github.com/drwl/annotaterb
-  changelog_uri: https://github.com/drwl/annotaterb/blob/master/CHANGELOG.md
+  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:
@@ -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:
   - - ">="