annotaterb 4.12.0 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acf04a7f1c6244fa950273cc78bb159e3f25e1e1f8f154ebb5a668152672f28d
-  data.tar.gz: 67466b09b7efa8ad90d2b674228c60b368c475b8809a5af7f0c9c48f1bfa3938
+  metadata.gz: 915a9aee6e9396080e4b115bc34466f422cc866aa31f64e8563a409f4ed53753
+  data.tar.gz: 30e4511ae77313d4d1f7348599286815a85e56f2c100f31ca73cc7a1feaa59d4
 SHA512:
-  metadata.gz: 76fcd6ffe70e014b15a4aab9b8e5f838432281cf7836eb83532a17f3f13c0e70381ea20bcec185efd91816df6eed64ae25d9541403c1aa0e3bb94b7970846f5b
-  data.tar.gz: 311ccf2c9013fe16ee0b70a693f9c1c478b4ab1543b6f8fdc3baf3fb0b4c9f8840e45d98236d2b634b80e3cadc1b33bb77f92a77f118828e92319292a85d8845
+  metadata.gz: 8e1c00298956404ba517a54b803f0cae4235da530a1f2dfe6db35e58c3747ba4bc7304759375ecf51237870f2e4701b965192b235e1c430b08bd4d0340bf6dc1
+  data.tar.gz: 63f51a4bbc1ebf2455aeeb8b3a7459a87787b309f5deae0a0e91df971bc28a36f77fa71f7b80a4fbe8f32d3660936fa41576f56569e72526fc2505a77c8fc6df

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## [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)
+
+**Merged pull requests:**
+
+- Bump version to v4.12.0 [\#151](https://github.com/drwl/annotaterb/pull/151) ([drwl](https://github.com/drwl))
+- Support postgres NULLS NOT DISTINCT clause in unique index [\#148](https://github.com/drwl/annotaterb/pull/148) ([ENewmeration](https://github.com/ENewmeration))
+- Generate changelog for v4.11.0 [\#147](https://github.com/drwl/annotaterb/pull/147) ([drwl](https://github.com/drwl))
+
 ## [v4.11.0](https://github.com/drwl/annotaterb/tree/v4.11.0) (2024-08-16)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.10.2...v4.11.0)

data/VERSION

@@ -1 +1 @@
-4.12.0
+4.14.0

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

@@ -20,7 +20,7 @@ module AnnotateRb
 
           new_annotation = wrapped_content(@new_annotations)
 
-          _content = @file_content.sub(@parsed_file.annotations, new_annotation)
+          _content = @file_content.sub(@parsed_file.annotations) { new_annotation }
         end
 
         private

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

@@ -78,6 +78,12 @@ module AnnotateRb
             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/file_parser/yml_parser.rb

@@ -40,7 +40,14 @@ module AnnotateRb
         def parse_yml
           # https://docs.ruby-lang.org/en/master/Psych.html#module-Psych-label-Reading+to+Psych-3A-3ANodes-3A-3AStream+structure
           parser = Psych.parser
-          parser.parse(@input)
+          begin
+            parser.parse(@input)
+          rescue Psych::SyntaxError => _e
+            # "Dynamic fixtures with ERB" exist in Rails, and will cause Psych.parser to error
+            # This is a hacky solution to get around this and still have it parse
+            erb_yml = ERB.new(@input).result
+            parser.parse(erb_yml)
+          end
 
           stream = parser.handler.root
 

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -162,21 +162,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/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

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.12.0
+  version: 4.14.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-15 00:00:00.000000000 Z
+date: 2025-02-17 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
@@ -121,6 +122,7 @@ metadata:
   source_code_uri: https://github.com/drwl/annotaterb
   changelog_uri: https://github.com/drwl/annotaterb/blob/master/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.