Add Annotaterb (#1066)

.annotaterb.yml

@@ -0,0 +1,57 @@
+:active_admin: false
+:additional_file_patterns: []
+:classes_default_to_s: []
+:classified_sort: true
+:command:
+:debug: false
+:exclude_controllers: true
+:exclude_factories: false
+:exclude_fixtures: false
+:exclude_helpers: true
+:exclude_scaffolds: true
+:exclude_serializers: false
+:exclude_sti_subclasses: true
+:exclude_tests: true
+:force: false
+:format_markdown: false
+:format_rdoc: false
+:format_yard: false
+:frozen: false
+:hide_default_column_types: 'json,jsonb,hstore'
+:hide_limit_column_types: 'integer,bigint,boolean'
+:ignore_columns:
+:ignore_model_sub_dir: false
+:ignore_routes:
+:ignore_unknown_models: false
+:include_version: false
+:model_dir:
+  - app/models
+:models: true
+: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
+:require: []
+:root_dir:
+  - ''
+:routes: false
+:show_check_constraints: false
+:show_complete_foreign_keys: false
+:show_foreign_keys: true
+:show_indexes: true
+:simple_indexes: true
+:skip_on_db_migrate: false
+:sort: false
+:target_action: :do_annotations
+:timestamp: false
+:trace: false
+:with_column_comments: true
+:with_comment: true
+:with_table_comments: true
+:wrapper:
+:wrapper_close:
+:wrapper_open:

Gemfile

@@ -37,6 +37,7 @@ group :development, :test do
 end
 
 group :development do
+  gem 'annotaterb', require: false
   gem 'rack-mini-profiler'
   gem 'web-console'
 end

Gemfile.lock

@@ -74,6 +74,7 @@ GEM
       tzinfo (~> 2.0, >= 2.0.5)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    annotaterb (4.13.0)
     ast (2.4.2)
     base64 (0.2.0)
     benchmark (0.4.0)
@@ -377,6 +378,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  annotaterb
   bootsnap
   brakeman
   byebug

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