annotaterb 4.13.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7adb0604dd67e60d6658add880eeee01a0367c86f9f0088f557fcb6ab42605c6
-  data.tar.gz: faa6374c64ffb979d1690c896cc564c526a6641b2fd79adc8bc922fad2fb25c0
+  metadata.gz: a31463c338bd23299c7249e3c444d8c1b630157bf9905cfeb203dfafb1a4d16a
+  data.tar.gz: ad12fccdeeb0186d6627ba237c417c637b1b6136f354313e81f09de90cef4665
 SHA512:
-  metadata.gz: 6250eab94f83dd0c3a40d670ad6a151532199d0183f6d13893775094e5581f6bf2513205b04f29034f0c35c8a1e0c34911a964efcb2c3104cfde0c2d6af0c1d0
-  data.tar.gz: 39210bfcf75338adf0a0bc88b31720427ed28b2679abed39ee4aa7b2500b88a170665a330a4f709a6c08f1e9d8e628c553502a4143bf4ea5be5eb96e464ebb61
+  metadata.gz: af6ec6a16d36b65b00eb28f4736c46682aa0d47da4869503eaecb8a58a8ff34f783ac3986c09200f125279666a8b30658af1ba91a9ad5829d789846c1c9e82dd
+  data.tar.gz: ad7fbd08360072a24c2fbea2808c180806ae89da5775689d1f7cc2824fead770b771ac41667056e68da0921ae13948a6f3da48883ab2f0328506cbf7158a63c0

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## [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)
+
+**Closed issues:**
+
+- Bug: Bigint are reported as integer [\#157](https://github.com/drwl/annotaterb/issues/157)
+- Bug \(apparently\): :ignore\_columns does not work \(with any syntax I've tried\) [\#154](https://github.com/drwl/annotaterb/issues/154)
+
+**Merged pull requests:**
+
+- Bump version to v4.13.0 [\#159](https://github.com/drwl/annotaterb/pull/159) ([drwl](https://github.com/drwl))
+- Support parsing of dynamic fixture erb yml files [\#158](https://github.com/drwl/annotaterb/pull/158) ([drwl](https://github.com/drwl))
+- Fix updating of indexes containing escaped characters [\#156](https://github.com/drwl/annotaterb/pull/156) ([antonivanopoulos](https://github.com/antonivanopoulos))
+- Add model with association and foreign key to dummyapp [\#153](https://github.com/drwl/annotaterb/pull/153) ([drwl](https://github.com/drwl))
+- Generate changelog for v4.12.0 [\#152](https://github.com/drwl/annotaterb/pull/152) ([drwl](https://github.com/drwl))
+
 ## [v4.12.0](https://github.com/drwl/annotaterb/tree/v4.12.0) (2024-09-15)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.11.0...v4.12.0)
@@ -276,7 +319,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/VERSION

@@ -1 +1 @@
-4.13.0
+4.15.0

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/annotation_diff_generator.rb

@@ -5,7 +5,13 @@ module AnnotateRb
     # Compares the current file content and new annotation block and generates the column annotation differences
     class AnnotationDiffGenerator
       HEADER_PATTERN = /(^# Table name:.*?\n(#.*\r?\n)*\r?)/
-      COLUMN_PATTERN = /^#[\t ]+[\w*.`\[\]():]+[\t ]+.+$/
+      # Example matches:
+      #   - "#  id              :uuid             not null, primary key"
+      #   - "#  title(length 255) :string          not null"
+      #   - "#  status(a/b/c)    :string           not null"
+      #   - "#  created_at       :datetime         not null"
+      #   - "#  updated_at       :datetime         not null"
+      COLUMN_PATTERN = /^#[\t ]+[\w*.`\[\]():]+(?:\(.*?\))?[\t ]+.+$/
 
       class << self
         def call(file_content, annotation_block)

data/lib/annotate_rb/model_annotator/column_annotation/attributes_builder.rb

@@ -70,14 +70,26 @@ 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
 
+          # Check if the column is a virtual column and print the function
+          if @options[:show_virtual_columns] && @column.virtual?
+            # Any whitespace in the function gets reduced to a single space
+            attrs << @column.default_function.gsub(/\s+/, " ").strip
+          end
+
           attrs
         end
 

data/lib/annotate_rb/model_annotator/column_annotation/column_wrapper.rb

@@ -85,6 +85,14 @@ module AnnotateRb
           @column.name
         end
 
+        def virtual?
+          @column.respond_to?(:virtual?) && @column.virtual?
+        end
+
+        def default_function
+          @column.default_function
+        end
+
         private
 
         # Simple quoting for the default column value

data/lib/annotate_rb/model_annotator/column_annotation/type_builder.rb

@@ -25,6 +25,8 @@ module AnnotateRb
 
           if is_decimal_type
             formatted_column_type = "decimal(#{@column.precision}, #{@column.scale})"
+          elsif @options[:show_virtual_columns] && @column.virtual?
+            formatted_column_type = "virtual(#{column_type})"
           elsif is_special_type
             # Do nothing. Kept as a code fragment in case we need to do something here.
           elsif @column.limit && !@options[:format_yard]

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
@@ -162,21 +174,12 @@ module AnnotateRb
       # These are the columns that the globalize gem needs to work but
       # are not necessary for the models to be displayed as annotations.
       def ignored_translation_table_columns
-        # Construct the foreign column name in the translations table
-        # eg. Model: Car, foreign column name: car_id
-        foreign_column_name = [
-          @klass.translation_class.to_s
-            .gsub("::Translation", "").gsub("::", "_")
-            .downcase,
-          "_id"
-        ].join.to_sym
-
         [
           :id,
           :created_at,
           :updated_at,
           :locale,
-          foreign_column_name
+          @klass.name.foreign_key.to_sym
         ]
       end
     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

@@ -48,6 +48,7 @@ module AnnotateRb
       show_check_constraints: false, # ModelAnnotator
       show_foreign_keys: true, # ModelAnnotator
       show_indexes: true, # ModelAnnotator
+      show_virtual_columns: false, # ModelAnnotator
       simple_indexes: false, # ModelAnnotator
       sort: false, # ModelAnnotator
       timestamp: false, # RouteAnnotator
@@ -68,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
@@ -129,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

@@ -78,11 +78,12 @@ module AnnotateRb
         version: Commands::PrintVersion.new
       }
 
+      if @commands.size > 1
+        warn "Only one command can be run at a time"
+      end
+
       @options[:command] = if @commands.any?
         map[@commands.first]
-      elsif @commands.size > 1
-        # TODO: Should raise or alert user that multiple commands were selected but only 1 command will be ran
-        map[@commands.first]
       else # None
         map[:help]
       end

data/lib/annotaterb.rb

@@ -0,0 +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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.13.0
+  version: 4.15.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -104,6 +104,7 @@ files:
 - lib/annotate_rb/route_annotator/removal_processor.rb
 - lib/annotate_rb/runner.rb
 - lib/annotate_rb/tasks/annotate_models_migrate.rake
+- lib/annotaterb.rb
 - lib/generators/annotate_rb/config/USAGE
 - lib/generators/annotate_rb/config/config_generator.rb
 - lib/generators/annotate_rb/hook/USAGE
@@ -119,8 +120,9 @@ 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:
 rdoc_options: []
 require_paths:
@@ -136,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A gem for generating annotations for Rails projects.