Switch to using annotate_rb (#2685)

Author: sethherr

.annotate_rb.yml

@@ -0,0 +1,58 @@
+---
+: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: false
+:exclude_helpers: true
+:exclude_scaffolds: true
+:exclude_serializers: true
+:exclude_sti_subclasses: false
+: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_check_constraints: false
+:show_complete_foreign_keys: false
+:show_foreign_keys: true
+:show_indexes: true
+: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: ''
+: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:
+- ''

Gemfile

@@ -151,8 +151,7 @@ group :development do
   gem "letter_opener"
   gem "rerun" # restart sidekiq processes in development on app change
   gem "terminal-notifier"
-  # Use community-maintained fork to support rails 8 - hopefully, eventually mainlined
-  gem "annotate", github: "bikeindex/annotate_models", branch: "develop" # Annotate models with schema info
+  gem 'annotate_rb', github: "sethherr/annotate_rb", branch: "rename-annotate_rb"
 end
 
 group :development, :test do

Gemfile.lock

@@ -1,12 +1,3 @@
-GIT
-  remote: https://github.com/bikeindex/annotate_models.git
-  revision: 8cf2eeaaeee39a00f6b9573485219910da77b9ff
-  branch: develop
-  specs:
-    annotate (3.2.0)
-      activerecord (>= 3.2)
-      rake (>= 10.4, < 14.0)
-
 GIT
   remote: https://github.com/bikeindex/carrierwave_backgrounder.git
   revision: 7b2b0e9bc43f2ec20f09db3fea7bbc5f167f52c7
@@ -42,6 +33,13 @@ GIT
       excon (~> 0.76.0)
       json (~> 2.1, >= 2.1.0)
 
+GIT
+  remote: https://github.com/sethherr/annotate_rb.git
+  revision: a947916dff1eab2c1b570a8b57020fb24337c797
+  branch: rename-annotate_rb
+  specs:
+    annotate_rb (5.0.0)
+
 GEM
   remote: https://rails-assets.org/
   specs:
@@ -841,7 +839,7 @@ PLATFORMS
 DEPENDENCIES
   MailchimpMarketing!
   active_model_serializers (~> 0.8.3)
-  annotate!
+  annotate_rb!
   api-pagination
   axlsx (~> 3.0.0.pre)
   bcrypt

app/models/logged_search.rb

@@ -28,6 +28,14 @@
 #  state_id          :bigint
 #  user_id           :bigint
 #
+# Indexes
+#
+#  index_logged_searches_on_country_id       (country_id)
+#  index_logged_searches_on_organization_id  (organization_id)
+#  index_logged_searches_on_request_id       (request_id)
+#  index_logged_searches_on_state_id         (state_id)
+#  index_logged_searches_on_user_id          (user_id)
+#
 class LoggedSearch < AnalyticsRecord
   include Geocodeable
 

app/models/organization_status.rb

@@ -12,6 +12,10 @@
 #  updated_at              :datetime         not null
 #  organization_id         :bigint
 #
+# Indexes
+#
+#  index_organization_statuses_on_organization_id  (organization_id)
+#
 class OrganizationStatus < AnalyticsRecord
   belongs_to :organization
 

lib/tasks/annotate_rb.rake

@@ -0,0 +1,8 @@
+# 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