From 3e44dca0b4d914886dbd4132d5eadd43c4be4304 Mon Sep 17 00:00:00 2001
From: "Andrew W. Lee" <wjldrew@gmail.com>
Date: Mon, 18 Nov 2024 06:40:02 -0800
Subject: [PATCH] Change dependency from annotate to annotaterb (#30232)

---
 .annotaterb.yml                     | 59 +++++++++++++++++++++++++++++
 Gemfile                             |  2 +-
 Gemfile.lock                        |  6 +--
 lib/tasks/annotate_rb.rake          | 10 +++++
 lib/tasks/auto_annotate_models.rake | 46 ----------------------
 5 files changed, 72 insertions(+), 51 deletions(-)
 create mode 100644 .annotaterb.yml
 create mode 100644 lib/tasks/annotate_rb.rake
 delete mode 100644 lib/tasks/auto_annotate_models.rake

diff --git a/.annotaterb.yml b/.annotaterb.yml
new file mode 100644
index 0000000000..df8e92b247
--- /dev/null
+++ b/.annotaterb.yml
@@ -0,0 +1,59 @@
+---
+:position: before
+:position_in_additional_file_patterns: before
+:position_in_class: before
+:position_in_factory: before
+:position_in_fixture: before
+:position_in_routes: before
+:position_in_serializer: before
+:position_in_test: before
+:classified_sort: true
+:exclude_controllers: true
+:exclude_factories: true
+:exclude_fixtures: true
+:exclude_helpers: true
+:exclude_scaffolds: true
+:exclude_serializers: true
+:exclude_sti_subclasses: true
+:exclude_tests: true
+:force: false
+:format_markdown: false
+:format_rdoc: false
+:format_yard: false
+:frozen: false
+:ignore_model_sub_dir: false
+:ignore_unknown_models: false
+:include_version: false
+:show_complete_foreign_keys: false
+:show_foreign_keys: false
+:show_indexes: false
+:simple_indexes: false
+:sort: false
+:timestamp: false
+:trace: false
+:with_comment: true
+:with_column_comments: true
+:with_table_comments: true
+:active_admin: false
+:command:
+:debug: false
+:hide_default_column_types: ''
+:hide_limit_column_types: 'integer,boolean'
+:ignore_columns:
+:ignore_routes:
+:models: true
+:routes: false
+:skip_on_db_migrate: false
+:target_action: :do_annotations
+:wrapper:
+:wrapper_close:
+:wrapper_open:
+:classes_default_to_s: []
+:additional_file_patterns: []
+:model_dir:
+  - app/models
+:require: []
+:root_dir:
+  - ''
+
+:show_check_constraints: false
diff --git a/Gemfile b/Gemfile
index 47506929b0..c8104d094e 100644
--- a/Gemfile
+++ b/Gemfile
@@ -172,7 +172,7 @@ group :development do
   gem 'rubocop-rspec_rails', require: false
 
   # Annotates modules with schema
-  gem 'annotate', '~> 3.2'
+  gem 'annotaterb', '~> 4.13'
 
   # Enhanced error message pages for development
   gem 'better_errors', '~> 2.9'
diff --git a/Gemfile.lock b/Gemfile.lock
index c7ab4e66fe..09017e3fa9 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -90,9 +90,7 @@ GEM
       public_suffix (>= 2.0.2, < 7.0)
     aes_key_wrap (1.1.0)
     android_key_attestation (0.3.0)
-    annotate (3.2.0)
-      activerecord (>= 3.2, < 8.0)
-      rake (>= 10.4, < 14.0)
+    annotaterb (4.13.0)
     ast (2.4.2)
     attr_required (1.0.2)
     awrence (1.2.1)
@@ -884,7 +882,7 @@ PLATFORMS
 DEPENDENCIES
   active_model_serializers (~> 0.10)
   addressable (~> 2.8)
-  annotate (~> 3.2)
+  annotaterb (~> 4.13)
   aws-sdk-s3 (~> 1.123)
   better_errors (~> 2.9)
   binding_of_caller (~> 1.0)
diff --git a/lib/tasks/annotate_rb.rake b/lib/tasks/annotate_rb.rake
new file mode 100644
index 0000000000..e8368b2e94
--- /dev/null
+++ b/lib/tasks/annotate_rb.rake
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# This rake task was added by annotate_rb gem.
+
+# Can set `ANNOTATERB_SKIP_ON_DB_TASKS` to be anything to skip this
+if Rails.env.development? && ENV['ANNOTATERB_SKIP_ON_DB_TASKS'].nil?
+  require 'annotate_rb'
+
+  AnnotateRb::Core.load_rake_tasks
+end
diff --git a/lib/tasks/auto_annotate_models.rake b/lib/tasks/auto_annotate_models.rake
deleted file mode 100644
index 4b5997920a..0000000000
--- a/lib/tasks/auto_annotate_models.rake
+++ /dev/null
@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-if Rails.env.development?
-  task :set_annotation_options do
-    Annotate.set_defaults(
-      'routes' => 'false',
-      'models' => 'true',
-      'position_in_routes' => 'before',
-      'position_in_class' => 'before',
-      'position_in_test' => 'before',
-      'position_in_fixture' => 'before',
-      'position_in_factory' => 'before',
-      'position_in_serializer' => 'before',
-      'show_foreign_keys' => 'false',
-      'show_indexes' => 'false',
-      'simple_indexes' => 'false',
-      'model_dir' => 'app/models',
-      'root_dir' => '',
-      'include_version' => 'false',
-      'require' => '',
-      'exclude_tests' => 'true',
-      'exclude_fixtures' => 'true',
-      'exclude_factories' => 'true',
-      'exclude_serializers' => 'true',
-      'exclude_scaffolds' => 'true',
-      'exclude_controllers' => 'true',
-      'exclude_helpers' => 'true',
-      'ignore_model_sub_dir' => 'false',
-      'ignore_columns' => nil,
-      'ignore_routes' => nil,
-      'ignore_unknown_models' => 'false',
-      'hide_limit_column_types' => 'integer,boolean',
-      'skip_on_db_migrate' => 'false',
-      'format_bare' => 'true',
-      'format_rdoc' => 'false',
-      'format_markdown' => 'false',
-      'sort' => 'false',
-      'force' => 'false',
-      'trace' => 'false',
-      'wrapper_open' => nil,
-      'wrapper_close' => nil
-    )
-  end
-
-  Annotate.load_tasks
-end