annotaterb 4.7.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f31e6cf08a5d57a35274e5964a5da9e4a01d006e0ddf3d4ac4467932901709ac
-  data.tar.gz: 020ad6bab20eb3c029173d5764050d7c62855785c2fa357750bc2fbff27cd02b
+  metadata.gz: 255fdc09fbc3848ba6d9306ec84d07c2471491ffbfde2440dc502bc35432a702
+  data.tar.gz: 004c6df59a13ec89bca83190fcb4de77c88435b0a091cd0385e1bc2a1c3f9ae8
 SHA512:
-  metadata.gz: 1a52c81202a634161721175021e8ee8742cad49f0eab0aab2e89319d856a8f81fe0e1e2ea3de1e78e3695f261a6d2ee5bd5b41ea1ac8c9b2d072a62bcec4b1cd
-  data.tar.gz: b01f86669748d083e52a0f3fef891632cff7fcf1c476ae1ce71e5e654cc028105435c4ceadcc73b23443dba28f3dd9c082ebbadeae541ad053a3cd93005d59cb
+  metadata.gz: ff01eaa95eda26cd5a14d30fb93bd2da5cabde3dc2da12cac718c40349a4228963e162162db017461942aa01cffba5ef59ca7c43344c01549a11ee2d6ba189b1
+  data.tar.gz: 4ee46c7c044938e98a883f72daa023ed89f3c2d13548d1986d2353b0f5f034a8eccab3cd8ea4032c80c3d7e3b3f8f093deccc92ef494c81f1c5631be5261d720

data/CHANGELOG.md

@@ -1,13 +1,41 @@
 # Changelog
 
+## [v4.7.1](https://github.com/drwl/annotaterb/tree/v4.7.1) (2024-05-09)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.7.0...v4.7.1)
+
+**Closed issues:**
+
+- Check constraint support [\#104](https://github.com/drwl/annotaterb/issues/104)
+
+**Merged pull requests:**
+
+- Bump version to v4.7.1 [\#113](https://github.com/drwl/annotaterb/pull/113) ([drwl](https://github.com/drwl))
+- Change AnnotationDecider to return false early [\#112](https://github.com/drwl/annotaterb/pull/112) ([drwl](https://github.com/drwl))
+- Memoize ActiveRecord migrator version calls [\#111](https://github.com/drwl/annotaterb/pull/111) ([drwl](https://github.com/drwl))
+- Fix misspelling in migration guide [\#109](https://github.com/drwl/annotaterb/pull/109) ([RobinDaugherty](https://github.com/RobinDaugherty))
+- Annotate model check constraints [\#105](https://github.com/drwl/annotaterb/pull/105) ([drwl](https://github.com/drwl))
+- Fix CHANGELOG.md [\#102](https://github.com/drwl/annotaterb/pull/102) ([drwl](https://github.com/drwl))
+- Generate changelog for v4.7.0 [\#101](https://github.com/drwl/annotaterb/pull/101) ([drwl](https://github.com/drwl))
+
+## [v4.7.0](https://github.com/drwl/annotaterb/tree/v4.7.0) (2024-03-27)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.6.0...v4.7.0)
+
+**Closed issues:**
+
+- Feature request: better custom type representation [\#97](https://github.com/drwl/annotaterb/issues/97)
+
+**Merged pull requests:**
+
+- Bump version to v4.7.0 [\#100](https://github.com/drwl/annotaterb/pull/100) ([drwl](https://github.com/drwl))
+- Add configurable classes list with `to_s` representation [\#98](https://github.com/drwl/annotaterb/pull/98) ([viralpraxis](https://github.com/viralpraxis))
+- Generate changelog for v4.6.0 [\#96](https://github.com/drwl/annotaterb/pull/96) ([drwl](https://github.com/drwl))
+
 ## [v4.6.0](https://github.com/drwl/annotaterb/tree/v4.6.0) (2024-02-27)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.5.0...v4.6.0)
 
-Adds two big changes: Fix annotations swallowing comments [\#72](https://github.com/drwl/annotaterb/pull/72) and 
-Add Zeitwerk support [\#85](https://github.com/drwl/annotaterb/pull/85).  
-Please report any issues you encounter. 
-
 **Closed issues:**
 
 - Add support for `data_migrate` gem [\#89](https://github.com/drwl/annotaterb/issues/89)

data/VERSION

@@ -1 +1 @@
-4.7.0
+4.8.0

data/lib/annotate_rb/model_annotator/annotated_file/generator.rb

@@ -5,7 +5,7 @@ module AnnotateRb
     module AnnotatedFile
       # Generates the file with fresh annotations
       class Generator
-        def initialize(file_content, new_annotations, annotation_position, options)
+        def initialize(file_content, new_annotations, annotation_position, parser_klass, parsed_file, options)
           @annotation_position = annotation_position
           @options = options
 
@@ -14,7 +14,8 @@ module AnnotateRb
           @new_annotations = new_annotations
           @file_content = file_content
 
-          @parsed_file = FileParser::ParsedFile.new(@file_content, @new_annotations, options).parse
+          @parser = parser_klass
+          @parsed_file = parsed_file
         end
 
         # @return [String] Returns the annotated file content to be written back to a file
@@ -32,7 +33,7 @@ module AnnotateRb
           end
 
           # We need to get class start and class end depending on the position
-          parsed = FileParser::CustomParser.new(content_without_annotations, "", 0).tap(&:parse)
+          parsed = @parser.parse(content_without_annotations)
 
           _content = if %w[after bottom].include?(annotation_write_position)
             content_annotated_after(parsed, content_without_annotations)

data/lib/annotate_rb/model_annotator/annotated_file/updater.rb

@@ -5,13 +5,13 @@ module AnnotateRb
     module AnnotatedFile
       # Updates existing annotations
       class Updater
-        def initialize(file_content, new_annotations, _annotation_position, options)
+        def initialize(file_content, new_annotations, _annotation_position, parsed_file, options)
           @options = options
 
           @new_annotations = new_annotations
           @file_content = file_content
 
-          @parsed_file = FileParser::ParsedFile.new(@file_content, @new_annotations, options).parse
+          @parsed_file = parsed_file
         end
 
         # @return [String] Returns the annotated file content to be written back to a file

data/lib/annotate_rb/model_annotator/annotation_builder.rb

@@ -44,6 +44,10 @@ module AnnotateRb
           @info += ForeignKeyAnnotation::AnnotationBuilder.new(@model, @options).build
         end
 
+        if @options[:show_check_constraints] && @model.table_exists?
+          @info += CheckConstraintAnnotation::AnnotationBuilder.new(@model, @options).build
+        end
+
         @info += schema_footer_text
 
         @info
@@ -52,12 +56,19 @@ module AnnotateRb
       def header
         header = @options[:format_markdown] ? PREFIX_MD.dup : PREFIX.dup
         header = "# #{header}"
-        version = begin
-          ActiveRecord::Migrator.current_version
-        rescue
-          0
+
+        if @options.get_state(:current_version).nil?
+          migration_version = begin
+            ActiveRecord::Migrator.current_version
+          rescue
+            0
+          end
+
+          @options.set_state(:current_version, migration_version)
         end
 
+        version = @options.get_state(:current_version)
+
         if @options[:include_version] && version > 0
           header += "\n# Schema version: #{version}"
         end

data/lib/annotate_rb/model_annotator/annotation_decider.rb

@@ -18,6 +18,10 @@ module AnnotateRb
           klass = ModelClassGetter.call(@file, @options)
 
           klass_is_a_class = klass.is_a?(Class)
+          # Methods such as #superclass only exist on a class. Because of how the code is structured, `klass` could be a
+          #  module that does not support the #superclass method, so we want to return early.
+          return false if !klass_is_a_class
+
           klass_inherits_active_record_base = klass < ActiveRecord::Base
           klass_is_not_abstract = klass.respond_to?(:abstract_class) && !klass.abstract_class?
           klass_table_exists = klass.respond_to?(:abstract_class) && klass.table_exists?

data/lib/annotate_rb/model_annotator/check_constraint_annotation/annotation_builder.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module CheckConstraintAnnotation
+      class AnnotationBuilder
+        def initialize(model, options)
+          @model = model
+          @options = options
+        end
+
+        def build
+          constraint_info = if @options[:format_markdown]
+            "#\n# ### Check Constraints\n#\n"
+          else
+            "#\n# Check Constraints\n#\n"
+          end
+
+          return "" unless @model.connection.respond_to?(:supports_check_constraints?) &&
+            @model.connection.supports_check_constraints? && @model.connection.respond_to?(:check_constraints)
+
+          check_constraints = @model.connection.check_constraints(@model.table_name)
+          return "" if check_constraints.empty?
+
+          max_size = check_constraints.map { |check_constraint| check_constraint.name.size }.max + 1
+          check_constraints.sort_by(&:name).each do |check_constraint|
+            expression = check_constraint.expression ? "(#{check_constraint.expression.squish})" : nil
+
+            constraint_info += if @options[:format_markdown]
+              cc_info_in_markdown(check_constraint.name, expression)
+            else
+              cc_info_string(check_constraint.name, expression, max_size)
+            end
+          end
+
+          constraint_info
+        end
+
+        private
+
+        def cc_info_in_markdown(name, expression)
+          cc_info_markdown = sprintf("# * `%s`", name)
+          cc_info_markdown += sprintf(": `%s`", expression) if expression
+          cc_info_markdown += "\n"
+
+          cc_info_markdown
+        end
+
+        def cc_info_string(name, expression, max_size)
+          # standard:disable Lint/FormatParameterMismatch
+          sprintf("#  %-#{max_size}.#{max_size}s %s", name, expression).rstrip + "\n"
+          # standard:enable Lint/FormatParameterMismatch
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/check_constraint_annotation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module CheckConstraintAnnotation
+      autoload :AnnotationBuilder, "annotate_rb/model_annotator/check_constraint_annotation/annotation_builder"
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/file_parser/annotation_finder.rb

@@ -19,19 +19,17 @@ module AnnotateRb
 
         attr_reader :parser
 
-        def initialize(content, wrapper_open, wrapper_close)
+        def initialize(content, wrapper_open, wrapper_close, parser)
           @content = content
           @wrapper_open = wrapper_open
           @wrapper_close = wrapper_close
           @annotation_start = nil
           @annotation_end = nil
-          @parser = nil
+          @parser = parser
         end
 
         # Find the annotation's line start and line end
         def run
-          # CustomParser returns line numbers as 0-indexed
-          @parser = FileParser::CustomParser.new(@content, "", 0).tap(&:parse)
           comments = @parser.comments
 
           start = comments.find_index { |comment, _| comment.include?(COMPAT_PREFIX) || comment.include?(COMPAT_PREFIX_MD) }

data/lib/annotate_rb/model_annotator/file_parser/parsed_file.rb

@@ -6,15 +6,17 @@ module AnnotateRb
       class ParsedFile
         SKIP_ANNOTATION_STRING = "# -*- SkipSchemaAnnotations"
 
-        def initialize(file_content, new_annotations, options)
+        def initialize(file_content, new_annotations, parser_klass, options)
           @file_content = file_content
           @file_lines = @file_content.lines
           @new_annotations = new_annotations
+          @parser_klass = parser_klass
           @options = options
         end
 
         def parse
-          @finder = AnnotationFinder.new(@file_content, @options[:wrapper_open], @options[:wrapper_close])
+          @file_parser = @parser_klass.parse(@file_content)
+          @finder = AnnotationFinder.new(@file_content, @options[:wrapper_open], @options[:wrapper_close], @file_parser)
           has_annotations = false
 
           begin
@@ -30,7 +32,6 @@ module AnnotateRb
           end
 
           @diff = AnnotationDiffGenerator.new(annotations, @new_annotations).generate
-          @file_parser = @finder.parser
 
           has_skip_string = @file_parser.comments.any? { |comment, _lineno| comment.include?(SKIP_ANNOTATION_STRING) }
           annotations_changed = @diff.changed?
@@ -85,7 +86,9 @@ module AnnotateRb
             annotations_with_whitespace: annotations_with_whitespace,
             has_leading_whitespace: has_leading_whitespace,
             has_trailing_whitespace: has_trailing_whitespace,
-            annotation_position: annotation_position
+            annotation_position: annotation_position,
+            starts: @file_parser.starts,
+            ends: @file_parser.ends
           )
         end
       end

data/lib/annotate_rb/model_annotator/file_parser/parsed_file_result.rb

@@ -12,7 +12,9 @@ module AnnotateRb
           annotations_with_whitespace:,
           has_leading_whitespace:,
           has_trailing_whitespace:,
-          annotation_position:
+          annotation_position:,
+          starts:,
+          ends:
         )
           @has_annotations = has_annotations
           @has_skip_string = has_skip_string
@@ -22,9 +24,11 @@ module AnnotateRb
           @has_leading_whitespace = has_leading_whitespace
           @has_trailing_whitespace = has_trailing_whitespace
           @annotation_position = annotation_position
+          @starts = starts
+          @ends = ends
         end
 
-        attr_reader :annotations, :annotation_position
+        attr_reader :annotations, :annotation_position, :starts, :ends
 
         # Returns annotations with new line before and after if they exist
         attr_reader :annotations_with_whitespace

data/lib/annotate_rb/model_annotator/file_parser/yml_parser.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "psych"
+
+module AnnotateRb
+  module ModelAnnotator
+    module FileParser
+      class YmlParser
+        class << self
+          def parse(string)
+            _parser = new(string).tap(&:parse)
+          end
+        end
+
+        attr_reader :comments, :starts, :ends
+
+        def initialize(input)
+          @input = input
+          @comments = []
+          @starts = []
+          @ends = []
+        end
+
+        def parse
+          parse_comments
+          parse_yml
+        end
+
+        private
+
+        def parse_comments
+          # Adds 0-indexed line numbers
+          @input.split($/).each_with_index do |line, line_no|
+            if line.strip.starts_with?("#")
+              @comments << [line, line_no]
+            end
+          end
+        end
+
+        def parse_yml
+          # https://docs.ruby-lang.org/en/master/Psych.html#module-Psych-label-Reading+to+Psych-3A-3ANodes-3A-3AStream+structure
+          parser = Psych.parser
+          parser.parse(@input)
+
+          stream = parser.handler.root
+
+          if stream.children.any?
+            doc = stream.children.first
+            @starts << [nil, doc.start_line]
+            @ends << [nil, doc.end_line]
+          else
+            # When parsing a yml file, streamer returns an instance of `Psych::Nodes::Stream` which is a subclass of
+            #   `Psych::Nodes::Node`. It along with children nodes, implement #start_line and #end_line.
+            #
+            # When parsing input that is only comments, the parser counts #start_line as the start of the file being
+            #   line 0.
+            #
+            # What we really want is where the "start" of the yml file would happen, which would be after comments.
+            # This is stream#end_line.
+            @starts << [nil, stream.end_line]
+            @ends << [nil, stream.end_line]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/file_parser.rb

@@ -7,6 +7,7 @@ module AnnotateRb
       autoload :CustomParser, "annotate_rb/model_annotator/file_parser/custom_parser"
       autoload :ParsedFile, "annotate_rb/model_annotator/file_parser/parsed_file"
       autoload :ParsedFileResult, "annotate_rb/model_annotator/file_parser/parsed_file_result"
+      autoload :YmlParser, "annotate_rb/model_annotator/file_parser/yml_parser"
     end
   end
 end

data/lib/annotate_rb/model_annotator/file_to_parser_mapper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    class FileToParserMapper
+      class UnsupportedFileTypeError < StandardError; end
+
+      MAP = {
+        ".rb" => FileParser::CustomParser,
+        ".yml" => FileParser::YmlParser
+      }.freeze
+
+      class << self
+        def map(file_name)
+          extension = File.extname(file_name).downcase
+          parser = MAP[extension]
+
+          raise UnsupportedFileTypeError, "File '#{file_name}' does not have a supported file type." if parser.nil?
+
+          parser
+        end
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/pattern_getter.rb

@@ -88,22 +88,51 @@ module AnnotateRb
         when "scaffold" then scaffold_files(root_directory)
         when "factory" then factory_files(root_directory)
         when "serializer" then serialize_files(root_directory)
-        when "additional_file_patterns"
-          [@options[:additional_file_patterns] || []].flatten
-        when "controller"
-          [File.join(root_directory, FilePatterns::CONTROLLER_DIR, "%PLURALIZED_MODEL_NAME%_controller.rb")]
-        when "admin"
-          [
-            File.join(root_directory, FilePatterns::ACTIVEADMIN_DIR, "%MODEL_NAME%.rb"),
-            File.join(root_directory, FilePatterns::ACTIVEADMIN_DIR, "%PLURALIZED_MODEL_NAME%.rb")
-          ]
-        when "helper"
-          [File.join(root_directory, FilePatterns::HELPER_DIR, "%PLURALIZED_MODEL_NAME%_helper.rb")]
+        when "serializer_test" then serializer_test_files(root_directory)
+        when "additional_file_patterns" then additional_file_patterns
+        when "controller" then controller_files(root_directory)
+        when "controller_test" then controller_test_files(root_directory)
+        when "admin" then active_admin_files(root_directory)
+        when "helper" then helper_files(root_directory)
+        when "request_spec" then request_spec_files(root_directory)
+        when "routing_spec" then routing_spec_files(root_directory)
         else
           []
         end
       end
 
+      def controller_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::CONTROLLER_DIR, "%PLURALIZED_MODEL_NAME%_controller.rb")
+        ]
+      end
+
+      def controller_test_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::CONTROLLER_TEST_DIR, "%PLURALIZED_MODEL_NAME%_controller_test.rb"),
+          File.join(root_directory, FilePatterns::CONTROLLER_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_controller_spec.rb")
+        ]
+      end
+
+      def additional_file_patterns
+        [
+          @options[:additional_file_patterns] || []
+        ].flatten
+      end
+
+      def active_admin_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::ACTIVEADMIN_DIR, "%MODEL_NAME%.rb"),
+          File.join(root_directory, FilePatterns::ACTIVEADMIN_DIR, "%PLURALIZED_MODEL_NAME%.rb")
+        ]
+      end
+
+      def helper_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::HELPER_DIR, "%PLURALIZED_MODEL_NAME%_helper.rb")
+        ]
+      end
+
       def test_files(root_directory)
         [
           File.join(root_directory, FilePatterns::UNIT_TEST_DIR, "%MODEL_NAME%_test.rb"),
@@ -122,10 +151,17 @@ module AnnotateRb
       end
 
       def scaffold_files(root_directory)
+        controller_test_files(root_directory) + request_spec_files(root_directory) + routing_spec_files(root_directory)
+      end
+
+      def request_spec_files(root_directory)
+        [
+          File.join(root_directory, FilePatterns::REQUEST_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_spec.rb")
+        ]
+      end
+
+      def routing_spec_files(root_directory)
         [
-          File.join(root_directory, FilePatterns::CONTROLLER_TEST_DIR, "%PLURALIZED_MODEL_NAME%_controller_test.rb"),
-          File.join(root_directory, FilePatterns::CONTROLLER_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_controller_spec.rb"),
-          File.join(root_directory, FilePatterns::REQUEST_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_spec.rb"),
           File.join(root_directory, FilePatterns::ROUTING_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_routing_spec.rb")
         ]
       end
@@ -151,7 +187,12 @@ module AnnotateRb
 
       def serialize_files(root_directory)
         [
-          File.join(root_directory, FilePatterns::SERIALIZERS_DIR, "%MODEL_NAME%_serializer.rb"),
+          File.join(root_directory, FilePatterns::SERIALIZERS_DIR, "%MODEL_NAME%_serializer.rb")
+        ]
+      end
+
+      def serializer_test_files(root_directory)
+        [
           File.join(root_directory, FilePatterns::SERIALIZERS_TEST_DIR, "%MODEL_NAME%_serializer_test.rb"),
           File.join(root_directory, FilePatterns::SERIALIZERS_SPEC_DIR, "%MODEL_NAME%_serializer_spec.rb")
         ]

data/lib/annotate_rb/model_annotator/related_files_list_builder.rb

@@ -7,6 +7,9 @@ module AnnotateRb
     class RelatedFilesListBuilder
       RELATED_TYPES = %w[test fixture factory serializer scaffold controller helper].freeze
 
+      # Valid options when `:exclude_tests` is an Array, note that symbols are expected
+      EXCLUDE_TEST_OPTIONS = %i[model controller serializer request routing].freeze
+
       def initialize(file, model_name, table_name, options)
         @file = file
         @model_name = model_name
@@ -17,11 +20,14 @@ module AnnotateRb
       def build
         @list = []
 
-        add_related_test_files if !@options[:exclude_tests]
+        add_related_test_files if !exclude_model_test_files?
         add_related_fixture_files if !@options[:exclude_fixtures]
         add_related_factory_files if !@options[:exclude_factories]
         add_related_serializer_files if !@options[:exclude_serializers]
-        add_related_scaffold_files if !@options[:exclude_scaffolds]
+        add_related_serializer_test_files if !exclude_serializer_tests?
+        add_related_controller_test_files if !exclude_controller_tests?
+        add_related_request_spec_files if !exclude_request_specs?
+        add_related_routing_spec_files if !exclude_routing_specs?
         add_related_controller_files if !@options[:exclude_controllers]
         add_related_helper_files if !@options[:exclude_helpers]
         add_related_admin_files if @options[:active_admin]
@@ -32,6 +38,51 @@ module AnnotateRb
 
       private
 
+      def exclude_model_test_files?
+        option = @options[:exclude_tests]
+
+        # If exclude_tests: [:model] then
+        # 1) we want to exclude model test files, and
+        # 2) we don't want to include model test files
+        if option.is_a?(Array)
+          option.include?(:model)
+        else
+          option
+        end
+      end
+
+      def exclude_serializer_tests?
+        if @options[:exclude_tests].is_a?(Array)
+          @options[:exclude_tests].include?(:serializer)
+        else
+          @options[:exclude_serializers]
+        end
+      end
+
+      def exclude_controller_tests?
+        if @options[:exclude_tests].is_a?(Array)
+          @options[:exclude_tests].include?(:controller)
+        else
+          @options[:exclude_scaffolds]
+        end
+      end
+
+      def exclude_routing_specs?
+        if @options[:exclude_tests].is_a?(Array)
+          @options[:exclude_tests].include?(:routing)
+        else
+          @options[:exclude_scaffolds]
+        end
+      end
+
+      def exclude_request_specs?
+        if @options[:exclude_tests].is_a?(Array)
+          @options[:exclude_tests].include?(:request)
+        else
+          @options[:exclude_scaffolds]
+        end
+      end
+
       def related_files_for_pattern(pattern_type)
         patterns = PatternGetter.call(@options, pattern_type)
 
@@ -81,9 +132,9 @@ module AnnotateRb
         @list.concat(files_with_position_key)
       end
 
-      def add_related_scaffold_files
-        position_key = :position_in_scaffold # Key does not exist
-        pattern_type = "scaffold"
+      def add_related_serializer_test_files
+        position_key = :position_in_serializer
+        pattern_type = "serializer_test"
 
         related_files = related_files_for_pattern(pattern_type)
         files_with_position_key = related_files.map { |f| [f, position_key] }
@@ -101,6 +152,36 @@ module AnnotateRb
         @list.concat(files_with_position_key)
       end
 
+      def add_related_controller_test_files
+        position_key = :position_in_scaffold # Key does not exist
+        pattern_type = "controller_test"
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_request_spec_files
+        position_key = :position_in_scaffold # Key does not exist
+        pattern_type = "request_spec"
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
+      def add_related_routing_spec_files
+        position_key = :position_in_scaffold # Key does not exist
+        pattern_type = "routing_spec"
+
+        related_files = related_files_for_pattern(pattern_type)
+        files_with_position_key = related_files.map { |f| [f, position_key] }
+
+        @list.concat(files_with_position_key)
+      end
+
       def add_related_helper_files
         position_key = :position_in_helper # Key does not exist
         pattern_type = "helper"

data/lib/annotate_rb/model_annotator/single_file_annotation_remover.rb

@@ -12,8 +12,10 @@ module AnnotateRb
           return false unless File.exist?(file_name)
           old_content = File.read(file_name)
 
+          parser_klass = FileToParserMapper.map(file_name)
+
           begin
-            parsed_file = FileParser::ParsedFile.new(old_content, "", options).parse
+            parsed_file = FileParser::ParsedFile.new(old_content, "", parser_klass, options).parse
           rescue FileParser::AnnotationFinder::MalformedAnnotation => e
             warn "Unable to process #{file_name}: #{e.message}"
             warn "\t" + e.backtrace.join("\n\t") if @options[:trace]

data/lib/annotate_rb/model_annotator/single_file_annotator.rb

@@ -25,8 +25,10 @@ module AnnotateRb
           return false unless File.exist?(file_name)
           old_content = File.read(file_name)
 
+          parser_klass = FileToParserMapper.map(file_name)
+
           begin
-            parsed_file = FileParser::ParsedFile.new(old_content, annotation, options).parse
+            parsed_file = FileParser::ParsedFile.new(old_content, annotation, parser_klass, options).parse
           rescue FileParser::AnnotationFinder::MalformedAnnotation => e
             warn "Unable to process #{file_name}: #{e.message}"
             warn "\t" + e.backtrace.join("\n\t") if @options[:trace]
@@ -39,11 +41,11 @@ module AnnotateRb
           abort "AnnotateRb error. #{file_name} needs to be updated, but annotaterb was run with `--frozen`." if options[:frozen]
 
           updated_file_content = if !parsed_file.has_annotations?
-            AnnotatedFile::Generator.new(old_content, annotation, annotation_position, options).generate
+            AnnotatedFile::Generator.new(old_content, annotation, annotation_position, parser_klass, parsed_file, options).generate
           elsif options[:force]
-            AnnotatedFile::Generator.new(old_content, annotation, annotation_position, options).generate
+            AnnotatedFile::Generator.new(old_content, annotation, annotation_position, parser_klass, parsed_file, options).generate
           else
-            AnnotatedFile::Updater.new(old_content, annotation, annotation_position, options).update
+            AnnotatedFile::Updater.new(old_content, annotation, annotation_position, parsed_file, options).update
           end
 
           File.open(file_name, "wb") { |f| f.puts updated_file_content }

data/lib/annotate_rb/model_annotator.rb

@@ -26,5 +26,7 @@ module AnnotateRb
     autoload :AnnotatedFile, "annotate_rb/model_annotator/annotated_file"
     autoload :FileParser, "annotate_rb/model_annotator/file_parser"
     autoload :ZeitwerkClassGetter, "annotate_rb/model_annotator/zeitwerk_class_getter"
+    autoload :CheckConstraintAnnotation, "annotate_rb/model_annotator/check_constraint_annotation"
+    autoload :FileToParserMapper, "annotate_rb/model_annotator/file_to_parser_mapper"
   end
 end

data/lib/annotate_rb/options.rb

@@ -45,6 +45,7 @@ module AnnotateRb
       ignore_unknown_models: false, # ModelAnnotator
       include_version: false, # ModelAnnotator
       show_complete_foreign_keys: false, # ModelAnnotator
+      show_check_constraints: false, # ModelAnnotator
       show_foreign_keys: true, # ModelAnnotator
       show_indexes: true, # ModelAnnotator
       simple_indexes: false, # ModelAnnotator
@@ -109,6 +110,7 @@ module AnnotateRb
       :ignore_model_sub_dir,
       :ignore_unknown_models,
       :include_version,
+      :show_check_constraints,
       :show_complete_foreign_keys,
       :show_foreign_keys,
       :show_indexes,
@@ -161,6 +163,8 @@ module AnnotateRb
 
       # For now, state is a hash to store state that we need but is not a configuration option
       @state = state
+
+      symbolize_exclude_tests
     end
 
     def to_h
@@ -216,5 +220,21 @@ module AnnotateRb
     def print
       # TODO: prints options and state
     end
+
+    private
+
+    # Guard against user inputting strings instead of symbols
+    def symbolize_exclude_tests
+      # `:exclude_tests` option is being expanded to function as a boolean OR an array of symbols
+      # https://github.com/drwl/annotaterb/issues/103
+
+      if @options[:exclude_tests].is_a?(Array)
+        @options[:exclude_tests].map! do |item|
+          item = item.strip if item.respond_to?(:strip)
+
+          item.to_sym
+        end
+      end
+    end
   end
 end

data/lib/annotate_rb/parser.rb

@@ -198,6 +198,12 @@ module AnnotateRb
         @options[:simple_indexes] = true
       end
 
+      option_parser.on("-c",
+        "--show-check-constraints",
+        "List the table's check constraints in the annotation") do
+        @options[:show_check_constraints] = true
+      end
+
       option_parser.on("--hide-limit-column-types VALUES",
         "don't show limit for given column types, separated by commas (i.e., `integer,boolean,text`)") do |values|
         @options[:hide_limit_column_types] = values.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -46,6 +46,8 @@ files:
 - lib/annotate_rb/model_annotator/annotation_diff_generator.rb
 - lib/annotate_rb/model_annotator/annotator.rb
 - lib/annotate_rb/model_annotator/bad_model_file_error.rb
+- lib/annotate_rb/model_annotator/check_constraint_annotation.rb
+- lib/annotate_rb/model_annotator/check_constraint_annotation/annotation_builder.rb
 - lib/annotate_rb/model_annotator/column_annotation.rb
 - lib/annotate_rb/model_annotator/column_annotation/annotation_builder.rb
 - lib/annotate_rb/model_annotator/column_annotation/attributes_builder.rb
@@ -58,6 +60,8 @@ files:
 - lib/annotate_rb/model_annotator/file_parser/custom_parser.rb
 - lib/annotate_rb/model_annotator/file_parser/parsed_file.rb
 - lib/annotate_rb/model_annotator/file_parser/parsed_file_result.rb
+- lib/annotate_rb/model_annotator/file_parser/yml_parser.rb
+- lib/annotate_rb/model_annotator/file_to_parser_mapper.rb
 - lib/annotate_rb/model_annotator/foreign_key_annotation.rb
 - lib/annotate_rb/model_annotator/foreign_key_annotation/annotation_builder.rb
 - lib/annotate_rb/model_annotator/index_annotation.rb