Allow annotating models and routes using sorbet's static checks

See https://sorbet.org/docs/static

Author: wteuber

.rubocop_todo.yml

@@ -768,6 +768,7 @@ Style/StderrPuts:
 Style/StringConcatenation:
   Exclude:
     - 'lib/annotate/annotate_models.rb'
+    - 'lib/annotate/annotate_routes/helpers.rb'
 
 # Offense count: 57
 # Cop supports --auto-correct.
@@ -817,4 +818,4 @@ Style/TrailingCommaInArrayLiteral:
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 264
+  Max: 245

lib/annotate/annotate_models.rb

@@ -39,7 +39,15 @@ module AnnotateModels
     }
   }.freeze
 
-  MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*(?:\n|r\n))|(^# coding:.*(?:\n|\r\n))|(^# -\*- coding:.*(?:\n|\r\n))|(^# -\*- encoding\s?:.*(?:\n|\r\n))|(^#\s*frozen_string_literal:.+(?:\n|\r\n))|(^# -\*- frozen_string_literal\s*:.+-\*-(?:\n|\r\n))/).freeze
+  MAGIC_COMMENT_MATCHER = Regexp.new(
+    '(^#\s*encoding:.*(?:\n|\r\n))' \
+    + '|(^# coding:.*(?:\n|\r\n))' \
+    + '|(^# -\*- coding:.*(?:\n|\r\n))' \
+    + '|(^# -\*- encoding\s?:.*(?:\n|\r\n))' \
+    + '|(^#\s*frozen_string_literal:.+(?:\n|\r\n))' \
+    + '|(^# -\*- frozen_string_literal\s*:.+-\*-(?:\n|\r\n))' \
+    + '|(^#\s*typed:.+(?:\n|\r\n))'
+  ).freeze
 
   class << self
     def annotate_pattern(options = {})
@@ -145,7 +153,9 @@ def get_schema_info(klass, header, options = {}) # rubocop:disable Metrics/Metho
       bare_type_allowance = 16
 
       if options[:format_markdown]
-        info << sprintf( "# %-#{max_size + md_names_overhead}.#{max_size + md_names_overhead}s | %-#{md_type_allowance}.#{md_type_allowance}s | %s\n", 'Name', 'Type', 'Attributes' )
+        info << sprintf(
+          "# %-#{max_size + md_names_overhead}.#{max_size + md_names_overhead}s | %-#{md_type_allowance}.#{md_type_allowance}s | %s\n", 'Name', 'Type', 'Attributes'
+        )
 
         info << "# #{ '-' * ( max_size + md_names_overhead ) } | #{'-' * md_type_allowance} | #{ '-' * 27 }\n"
       end
@@ -165,7 +175,9 @@ def get_schema_info(klass, header, options = {}) # rubocop:disable Metrics/Metho
                      col.name
                    end
         simple_formatted_attrs = attrs.join(", ")
-        [col.name, { col_type: col_type, attrs: attrs, col_name: col_name, simple_formatted_attrs: simple_formatted_attrs, col_comment: col_comment }]
+        [col.name,
+         { col_type: col_type, attrs: attrs, col_name: col_name, simple_formatted_attrs: simple_formatted_attrs,
+           col_comment: col_comment }]
       end.to_h
 
       # Output annotation
@@ -179,17 +191,21 @@ def get_schema_info(klass, header, options = {}) # rubocop:disable Metrics/Metho
         col_comment = cols_meta[col.name][:col_comment]
 
         if options[:format_rdoc]
-          info << sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col_name}*::", attrs.unshift(col_type).join(", ")).rstrip + "\n"
+          info << sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col_name}*::",
+                          attrs.unshift(col_type).join(", ")).rstrip + "\n"
         elsif options[:format_yard]
           info << sprintf("# @!attribute #{col_name}") + "\n"
           ruby_class = col.respond_to?(:array) && col.array ? "Array<#{map_col_type_to_ruby_classes(col_type)}>": map_col_type_to_ruby_classes(col_type)
           info << sprintf("#   @return [#{ruby_class}]") + "\n"
         elsif options[:format_markdown]
           name_remainder = max_size - col_name.length - non_ascii_length(col_name)
           type_remainder = (md_type_allowance - 2) - col_type.length
-          info << (sprintf("# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`", col_name, " ", col_type, " ", attrs.join(", ").rstrip)).gsub('``', '  ').rstrip + "\n"
+          info << (sprintf("# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`", col_name, " ", col_type, " ", attrs.join(", ").rstrip)).gsub(
+            '``', '  '
+          ).rstrip + "\n"
         elsif with_comments_column
-          info << format_default(col_name, max_size, col_type, bare_type_allowance, simple_formatted_attrs, bare_max_attrs_length, col_comment)
+          info << format_default(col_name, max_size, col_type, bare_type_allowance, simple_formatted_attrs,
+                                 bare_max_attrs_length, col_comment)
         else
           info << format_default(col_name, max_size, col_type, bare_type_allowance, simple_formatted_attrs)
         end
@@ -372,9 +388,11 @@ def get_foreign_key_info(klass, options = {})
         constraints_info.strip!
 
         fk_info << if options[:format_markdown]
-                     sprintf("# * `%s`%s:\n#     * **`%s`**\n", format_name.call(fk), constraints_info.blank? ? '' : " (_#{constraints_info}_)", ref_info)
+                     sprintf("# * `%s`%s:\n#     * **`%s`**\n", format_name.call(fk),
+                             constraints_info.blank? ? '' : " (_#{constraints_info}_)", ref_info)
                    else
-                     sprintf("#  %-#{max_size}.#{max_size}s %s %s", format_name.call(fk), "(#{ref_info})", constraints_info).rstrip + "\n"
+                     sprintf("#  %-#{max_size}.#{max_size}s %s %s", format_name.call(fk), "(#{ref_info})",
+                             constraints_info).rstrip + "\n"
                    end
       end
 
@@ -542,7 +560,8 @@ def annotate(klass, file, header, options = {})
         model_file_name = File.join(file)
         annotated = []
 
-        if annotate_one_file(model_file_name, info, :position_in_class, options_with_position(options, :position_in_class))
+        if annotate_one_file(model_file_name, info, :position_in_class,
+                             options_with_position(options, :position_in_class))
           annotated << model_file_name
         end
 
@@ -935,7 +954,8 @@ def ignored_translation_table_colums(klass)
     # a given column.
     def get_attributes(column, column_type, klass, options)
       attrs = []
-      attrs << "default(#{schema_default(klass, column)})" unless column.default.nil? || hide_default?(column_type, options)
+      attrs << "default(#{schema_default(klass, column)})" unless column.default.nil? || hide_default?(column_type,
+                                                                                                       options)
       attrs << 'unsigned' if column.respond_to?(:unsigned?) && column.unsigned?
       attrs << 'not null' unless column.null
       attrs << 'primary key' if klass.primary_key && (klass.primary_key.is_a?(Array) ? klass.primary_key.collect(&:to_sym).include?(column.name.to_sym) : column.name.to_sym == klass.primary_key.to_sym)

lib/annotate/annotate_routes/helpers.rb

@@ -1,6 +1,14 @@
 module AnnotateRoutes
   module Helpers
-    MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
+    MAGIC_COMMENT_MATCHER = Regexp.new(
+      '(^#\s*encoding:.*)' \
+      + '|(^# coding:.*)' \
+      + '|(^# -\*- coding:.*)' \
+      + '|(^# -\*- encoding\s?:.*)' \
+      + '|(^#\s*frozen_string_literal:.+)' \
+      + '|(^# -\*- frozen_string_literal\s*:.+-\*-)' \
+      + '|(^#\s*typed:.*)'
+    ).freeze
 
     class << self
       # TODO: write the method doc using ruby rdoc formats

spec/lib/annotate/annotate_models_spec.rb

@@ -18,7 +18,9 @@
     "# frozen_string_literal: true\n# encoding: utf-8",
     '# frozen_string_literal: true',
     '#frozen_string_literal: false',
-    '# -*- frozen_string_literal : true -*-'
+    '# -*- frozen_string_literal : true -*-',
+    '#typed: false',
+    '# typed: true'
   ].freeze unless const_defined?(:MAGIC_COMMENTS)
 
   def mock_index(name, params = {})

spec/lib/annotate/annotate_routes_spec.rb

@@ -20,7 +20,9 @@
     "# frozen_string_literal: true\n# encoding: utf-8",
     '# frozen_string_literal: true',
     '#frozen_string_literal: false',
-    '# -*- frozen_string_literal : true -*-'
+    '# -*- frozen_string_literal : true -*-',
+    '#typed: false',
+    '# typed: true'
   ].freeze unless const_defined?(:MAGIC_COMMENTS)
 
   let :stubs do