annotaterb 4.4.1 → 4.6.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.6.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -31,16 +31,19 @@ files:
 - lib/annotate_rb/commands/print_help.rb
 - lib/annotate_rb/commands/print_version.rb
 - lib/annotate_rb/config_finder.rb
+- lib/annotate_rb/config_generator.rb
 - lib/annotate_rb/config_loader.rb
 - lib/annotate_rb/core.rb
 - lib/annotate_rb/eager_loader.rb
 - lib/annotate_rb/helper.rb
 - lib/annotate_rb/model_annotator.rb
+- lib/annotate_rb/model_annotator/annotated_file.rb
+- lib/annotate_rb/model_annotator/annotated_file/generator.rb
+- lib/annotate_rb/model_annotator/annotated_file/updater.rb
 - lib/annotate_rb/model_annotator/annotation_builder.rb
 - lib/annotate_rb/model_annotator/annotation_decider.rb
 - lib/annotate_rb/model_annotator/annotation_diff.rb
 - lib/annotate_rb/model_annotator/annotation_diff_generator.rb
-- lib/annotate_rb/model_annotator/annotation_pattern_generator.rb
 - lib/annotate_rb/model_annotator/annotator.rb
 - lib/annotate_rb/model_annotator/bad_model_file_error.rb
 - lib/annotate_rb/model_annotator/column_annotation.rb
@@ -49,14 +52,16 @@ files:
 - lib/annotate_rb/model_annotator/column_annotation/column_wrapper.rb
 - lib/annotate_rb/model_annotator/column_annotation/default_value_builder.rb
 - lib/annotate_rb/model_annotator/column_annotation/type_builder.rb
-- lib/annotate_rb/model_annotator/file_builder.rb
-- lib/annotate_rb/model_annotator/file_components.rb
 - lib/annotate_rb/model_annotator/file_name_resolver.rb
+- lib/annotate_rb/model_annotator/file_parser.rb
+- lib/annotate_rb/model_annotator/file_parser/annotation_finder.rb
+- 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/foreign_key_annotation.rb
 - lib/annotate_rb/model_annotator/foreign_key_annotation/annotation_builder.rb
 - lib/annotate_rb/model_annotator/index_annotation.rb
 - lib/annotate_rb/model_annotator/index_annotation/annotation_builder.rb
-- lib/annotate_rb/model_annotator/magic_comment_parser.rb
 - lib/annotate_rb/model_annotator/model_class_getter.rb
 - lib/annotate_rb/model_annotator/model_files_getter.rb
 - lib/annotate_rb/model_annotator/model_wrapper.rb
@@ -68,6 +73,7 @@ files:
 - lib/annotate_rb/model_annotator/single_file_annotator.rb
 - lib/annotate_rb/model_annotator/single_file_annotator_instruction.rb
 - lib/annotate_rb/model_annotator/single_file_remove_annotation_instruction.rb
+- lib/annotate_rb/model_annotator/zeitwerk_class_getter.rb
 - lib/annotate_rb/options.rb
 - lib/annotate_rb/parser.rb
 - lib/annotate_rb/rake_bootstrapper.rb
@@ -80,9 +86,15 @@ files:
 - lib/annotate_rb/route_annotator/removal_processor.rb
 - lib/annotate_rb/runner.rb
 - lib/annotate_rb/tasks/annotate_models_migrate.rake
+- lib/generators/annotate_rb/config/USAGE
+- lib/generators/annotate_rb/config/config_generator.rb
+- lib/generators/annotate_rb/hook/USAGE
+- lib/generators/annotate_rb/hook/hook_generator.rb
+- lib/generators/annotate_rb/hook/templates/annotate_rb.rake
 - lib/generators/annotate_rb/install/USAGE
 - lib/generators/annotate_rb/install/install_generator.rb
-- lib/generators/annotate_rb/install/templates/annotate_rb.rake
+- lib/generators/annotate_rb/update_config/USAGE
+- lib/generators/annotate_rb/update_config/update_config_generator.rb
 homepage: https://github.com/drwl/annotaterb
 licenses:
 - BSD-2-Clause
@@ -106,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: A gem for generating annotations for Rails projects.

data/lib/annotate_rb/model_annotator/annotation_pattern_generator.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module AnnotateRb
-  module ModelAnnotator
-    class AnnotationPatternGenerator
-      COMPAT_PREFIX = "== Schema Info"
-      COMPAT_PREFIX_MD = "## Schema Info"
-
-      class << self
-        def call(options = Options.from({}))
-          if options[:wrapper_open]
-            return /(?:^(\n|\r\n)?# (?:#{options[:wrapper_open]}).*(\n|\r\n)?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?(\n|\r\n)(#.*(\n|\r\n))*(\n|\r\n)*)|^(\n|\r\n)?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?(\n|\r\n)(#.*(\n|\r\n))*(\n|\r\n)*/
-          end
-          /^(\n|\r\n)?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?(\n|\r\n)(#.*(\n|\r\n))*(\n|\r\n)*/o
-        end
-      end
-    end
-  end
-end

data/lib/annotate_rb/model_annotator/file_builder.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module AnnotateRb
-  module ModelAnnotator
-    # Generates the text file content with annotations, these are then to be written to filesystem.
-    class FileBuilder
-      def initialize(file_components, annotation_position, options)
-        @file_components = file_components
-        @annotation_position = annotation_position
-        @options = options
-
-        @new_wrapped_annotations = wrapped_content(@file_components.new_annotations)
-      end
-
-      def generate_content_with_new_annotations
-        # Need to keep `.to_s` for now since the it can be either a String or Symbol
-        annotation_write_position = @options[@annotation_position].to_s
-
-        _content = if %w[after bottom].include?(annotation_write_position)
-          @file_components.magic_comments + (@file_components.pure_file_content.rstrip + "\n\n" + @new_wrapped_annotations)
-        elsif @file_components.magic_comments.empty?
-          @file_components.magic_comments + @new_wrapped_annotations + @file_components.pure_file_content.lstrip
-        else
-          @file_components.magic_comments + "\n" + @new_wrapped_annotations + @file_components.pure_file_content.lstrip
-        end
-      end
-
-      def update_existing_annotations
-        return "" if !@file_components.has_annotations?
-
-        annotation_pattern = AnnotationPatternGenerator.call(@options)
-
-        new_annotation = @file_components.space_before_annotation + @new_wrapped_annotations + @file_components.space_after_annotation
-
-        _content = @file_components.current_file_content.sub(annotation_pattern, new_annotation)
-      end
-
-      private
-
-      def wrapped_content(content)
-        wrapper_open = if @options[:wrapper_open]
-          "# #{@options[:wrapper_open]}\n"
-        else
-          ""
-        end
-
-        wrapper_close = if @options[:wrapper_close]
-          "# #{@options[:wrapper_close]}\n"
-        else
-          ""
-        end
-
-        _wrapped_info_block = "#{wrapper_open}#{content}#{wrapper_close}"
-      end
-    end
-  end
-end

data/lib/annotate_rb/model_annotator/file_components.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module AnnotateRb
-  module ModelAnnotator
-    class FileComponents
-      SKIP_ANNOTATION_STRING = "# -*- SkipSchemaAnnotations"
-      SOME_PATTERN = /\A(?<start>\s*).*?\n(?<end>\s*)\z/m # Unsure what this pattern is
-
-      attr_reader :new_annotations
-
-      def initialize(file_content, new_annotations, options)
-        @file_content = file_content
-        @diff = AnnotationDiffGenerator.new(file_content, new_annotations).generate
-        @options = options
-        @annotation_pattern = AnnotationPatternGenerator.call(options)
-        @new_annotations = new_annotations
-      end
-
-      def current_file_content
-        @file_content
-      end
-
-      # TODO: Rename method once it's clear what this actually does
-      def space_before_annotation
-        return @space_before_annotation if defined?(@space_before_annotation)
-
-        match = current_annotations.match(SOME_PATTERN)
-        @space_before_annotation = if match
-          match[:start]
-        end
-      end
-
-      # TODO: Rename method once it's clear what this actually does
-      def space_after_annotation
-        return @space_after_annotation if defined?(@space_after_annotation)
-
-        match = current_annotations.match(SOME_PATTERN)
-        @space_after_annotation = if match
-          match[:end]
-        end
-      end
-
-      def pure_file_content
-        @pure_file_content ||=
-          begin
-            content_without_magic_comments = @file_content.gsub(MagicCommentParser::MAGIC_COMMENTS_REGEX, "")
-            content_without_annotations = content_without_magic_comments.sub(@annotation_pattern, "")
-
-            content_without_annotations
-          end
-      end
-
-      def magic_comments
-        @magic_comments ||= MagicCommentParser.call(@file_content)
-      end
-
-      def has_skip_string?
-        @has_skip_string ||= @file_content.include?(SKIP_ANNOTATION_STRING)
-      end
-
-      def has_annotations?
-        @has_annotations ||= @diff.current_columns.present?
-      end
-
-      def annotations_changed?
-        @has_annotations_changed ||= @diff.changed?
-      end
-
-      def current_annotations
-        @current_annotations ||=
-          if has_annotations?
-            # `#has_annotations?` uses a different regex pattern than the one in `@annotation_pattern`,
-            # this could lead to unexpected behavior
-            @file_content.match(@annotation_pattern).to_s
-          else
-            ""
-          end
-      end
-    end
-  end
-end

data/lib/annotate_rb/model_annotator/magic_comment_parser.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module AnnotateRb
-  module ModelAnnotator
-    # Extracts magic comments strings and returns them
-    class MagicCommentParser
-      MAGIC_COMMENTS = [
-        HASH_ENCODING = /(^#\s*encoding:.*(?:\n|r\n))/,
-        HASH_CODING = /(^# coding:.*(?:\n|\r\n))/,
-        HASH_FROZEN_STRING = /(^#\s*frozen_string_literal:.+(?:\n|\r\n))/,
-        STAR_ENCODING = /(^# -\*- encoding\s?:.*(?:\n|\r\n))/,
-        STAR_CODING = /(^# -\*- coding:.*(?:\n|\r\n))/,
-        STAR_FROZEN_STRING = /(^# -\*- frozen_string_literal\s*:.+-\*-(?:\n|\r\n))/,
-        SORBET_TYPED_STRING = /(^#\s*typed:.*(?:\n|r\n))/.freeze
-      ].freeze
-
-      MAGIC_COMMENTS_REGEX = Regexp.union(*MAGIC_COMMENTS).freeze
-
-      class << self
-        def call(content)
-          magic_comments = content.scan(MAGIC_COMMENTS_REGEX).flatten.compact
-
-          if magic_comments.any?
-            magic_comments.join
-          else
-            ""
-          end
-        end
-      end
-    end
-  end
-end