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 = {})

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