annotaterb 4.4.1 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a337f543f32142efaffbfd396196692d42a98438352b3bdd406c104c25a9958a
-  data.tar.gz: 27d091e7fed5953ccdd26c4b4874e45a0fcff541630595fa467e010629efb9ba
+  metadata.gz: ab5413ba1fb4c02274c37e7629b0553deed339067624ef96e1ad9a59ecf726d1
+  data.tar.gz: 6439540d1c152651735313e80839acddc79d202d8b0171edb6c424e932dde37a
 SHA512:
-  metadata.gz: 44125b3f65246ad1b5a0dd0d354487462ea6584c6147165650268244fd8d3c9826cf337873f24c31e008efa1c560b37bcb71e36af7fc05c9bc381d48e2b1e4b0
-  data.tar.gz: 7979e2309e3c09ee11fc090a424e7006a94634c7a970fe34b61028b3a90d495b684cc2a4a6fa78221b288dfe5e6682567835fb6839ada3903dfaa599a4f8cfdc
+  metadata.gz: 40353034b577b5a44a1204edbb02e25d01b4d99efcb8de1a50fd8698981767c4f5444079b851441db60d16c175237e63f80453370f38007613aae1da5b613f71
+  data.tar.gz: 5edb0a811149b9187fd0b2066cf1843a84fde281239e2628ba643fa1ce4c906e914b387d4f461e62c84d5323e21a51223f3d5e838f5f4da300743180d6dabb8e

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [v4.4.1](https://github.com/drwl/annotaterb/tree/v4.4.1) (2023-09-11)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.4.0...v4.4.1)
+
+**Merged pull requests:**
+
+- Bump version to v4.4.1 [\#62](https://github.com/drwl/annotaterb/pull/62) ([drwl](https://github.com/drwl))
+- Fix annotation for columns with `Date` and `DateTime` default values [\#61](https://github.com/drwl/annotaterb/pull/61) ([drwl](https://github.com/drwl))
+- Add integration tests [\#60](https://github.com/drwl/annotaterb/pull/60) ([drwl](https://github.com/drwl))
+- Fix the default array value from being escaped [\#58](https://github.com/drwl/annotaterb/pull/58) ([drwl](https://github.com/drwl))
+- Update dummyapp Rails version [\#56](https://github.com/drwl/annotaterb/pull/56) ([drwl](https://github.com/drwl))
+- Bump puma from 5.6.5 to 6.3.1 in /dummyapp [\#55](https://github.com/drwl/annotaterb/pull/55) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Generate changelog for v4.4.0 [\#53](https://github.com/drwl/annotaterb/pull/53) ([drwl](https://github.com/drwl))
+- Add CLI specs using `aruba` gem [\#43](https://github.com/drwl/annotaterb/pull/43) ([drwl](https://github.com/drwl))
+
 ## [v4.4.0](https://github.com/drwl/annotaterb/tree/v4.4.0) (2023-06-24)
 
 [Full Changelog](https://github.com/drwl/annotaterb/compare/v4.3.1...v4.4.0)

data/README.md

@@ -65,6 +65,35 @@ To skip the automatic annotation that happens after a db task, pass the environm
 $ ANNOTATERB_SKIP_ON_DB_TASKS=1 bin/rails db:migrate
 ```
 
+### Added Rails generators
+The following Rails generator commands get added.
+
+```sh
+$ bin/rails generator --help
+
+...
+
+AnnotateRb:
+  annotate_rb:config
+  annotate_rb:hook
+  annotate_rb:install
+  annotate_rb:update_config
+...
+
+```
+
+`bin/rails g annotate_rb:config`
+- Generates a new configuration file, `.annotaterb.yml`, using defaults from the gem.
+
+`bin/rails g annotate_rb:hook`
+- Installs the Rake file to automatically annotate Rails models on a database task (e.g. AnnotateRb will automatically run after running `bin/rails db:migrate`).
+
+`bin/rails g annotate_rb:install`
+- Runs the `config` and `hook` generator commands
+
+`bin/rails g annotate_rb:update_config`
+- Appends to `.annotaterb.yml` any configuration key-value pairs that are used by the Gem. This is useful when there's a drift between the config file values and the gem defaults (i.e. when new features get added).
+
 ## Migrating from the annotate gem
 Refer to the [migration guide](MIGRATION_GUIDE.md).
 

data/VERSION

@@ -1 +1 @@
-4.4.1
+4.5.0

data/lib/annotate_rb/config_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  class ConfigGenerator
+    class << self
+      # Returns unset configuration key-value pairs as yaml.
+      # Useful when a config file was generated an older version of gem and new
+      #   settings get added.
+      def unset_config_defaults
+        user_defaults = ConfigLoader.load_config
+        defaults = Options.from({}, {}).to_h
+
+        differences = defaults.keys - user_defaults.keys
+        result = defaults.slice(*differences)
+
+        # Generates proper YAML including the leading hyphens `---` header
+        yml_content = YAML.dump(result, StringIO.new).string
+        # Remove the header
+        yml_content.sub("---", "")
+      end
+
+      def default_config_yml
+        defaults_hash = Options.from({}, {}).to_h
+        _yml_content = YAML.dump(defaults_hash, StringIO.new).string
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module AnnotatedFile
+      # Generates the file with fresh annotations
+      class Generator
+        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
+          # 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
+
+        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
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module AnnotatedFile
+      # Updates existing annotations
+      class Updater
+        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 update
+          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
+end

data/lib/annotate_rb/model_annotator/annotated_file.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module AnnotatedFile
+      autoload :Generator, "annotate_rb/model_annotator/annotated_file/generator"
+      autoload :Updater, "annotate_rb/model_annotator/annotated_file/updater"
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/annotation_pattern_generator.rb

@@ -7,7 +7,7 @@ module AnnotateRb
       COMPAT_PREFIX_MD = "## Schema Info"
 
       class << self
-        def call(options = Options.from({}))
+        def call(options)
           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

data/lib/annotate_rb/model_annotator/annotator.rb

@@ -4,11 +4,11 @@ module AnnotateRb
   module ModelAnnotator
     class Annotator
       class << self
-        def do_annotations(options = {})
+        def do_annotations(options)
           new(options).do_annotations
         end
 
-        def remove_annotations(options = {})
+        def remove_annotations(options)
           new(options).remove_annotations
         end
       end

data/lib/annotate_rb/model_annotator/file_components.rb

@@ -43,7 +43,7 @@ module AnnotateRb
       def pure_file_content
         @pure_file_content ||=
           begin
-            content_without_magic_comments = @file_content.gsub(MagicCommentParser::MAGIC_COMMENTS_REGEX, "")
+            content_without_magic_comments = @file_content.gsub(FileParser::MagicCommentParser::MAGIC_COMMENTS_REGEX, "")
             content_without_annotations = content_without_magic_comments.sub(@annotation_pattern, "")
 
             content_without_annotations
@@ -51,7 +51,7 @@ module AnnotateRb
       end
 
       def magic_comments
-        @magic_comments ||= MagicCommentParser.call(@file_content)
+        @magic_comments ||= FileParser::MagicCommentParser.call(@file_content)
       end
 
       def has_skip_string?

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module FileParser
+      # 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
+end

data/lib/annotate_rb/model_annotator/file_parser.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    module FileParser
+      autoload :MagicCommentParser, "annotate_rb/model_annotator/file_parser/magic_comment_parser"
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/model_files_getter.rb

@@ -9,13 +9,9 @@ module AnnotateRb
         # of model files from root dir. Otherwise we take all the model files
         # in the model_dir directory.
         def call(options)
-          model_files = []
+          model_files = list_model_files_from_argument(options)
 
-          # Note: This is currently broken as we don't set `is_rake` anywhere.
-          # It's an artifact from the old Annotate gem and how it did control flow.
-          model_files = list_model_files_from_argument(options) if !options[:is_rake]
-
-          return model_files if !model_files.empty?
+          return model_files if model_files.any?
 
           options[:model_dir].each do |dir|
             Dir.chdir(dir) do
@@ -41,9 +37,9 @@ module AnnotateRb
         private
 
         def list_model_files_from_argument(options)
-          return [] if ARGV.empty?
+          return [] if options.get_state(:working_args).empty?
 
-          specified_files = ARGV.map { |file| File.expand_path(file) }
+          specified_files = options.get_state(:working_args).map { |file| File.expand_path(file) }
 
           model_files = options[:model_dir].flat_map do |dir|
             absolute_dir_path = File.expand_path(dir)

data/lib/annotate_rb/model_annotator/model_wrapper.rb

@@ -6,7 +6,7 @@ module AnnotateRb
       # Should be the wrapper for an ActiveRecord model that serves as the source of truth of the model
       # of the model that we're annotating
 
-      def initialize(klass, options = {})
+      def initialize(klass, options)
         @klass = klass
         @options = options
       end

data/lib/annotate_rb/model_annotator/pattern_getter.rb

@@ -142,6 +142,8 @@ module AnnotateRb
           File.join(root_directory, FilePatterns::FACTORY_BOT_SPEC_DIR, "%TABLE_NAME%.rb"), # (new style)
           File.join(root_directory, FilePatterns::FACTORY_BOT_TEST_DIR, "%PLURALIZED_MODEL_NAME%.rb"), # (new style)
           File.join(root_directory, FilePatterns::FACTORY_BOT_SPEC_DIR, "%PLURALIZED_MODEL_NAME%.rb"), # (new style)
+          File.join(root_directory, FilePatterns::FACTORY_BOT_TEST_DIR, "%PLURALIZED_MODEL_NAME%_factory.rb"), # (new style)
+          File.join(root_directory, FilePatterns::FACTORY_BOT_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_factory.rb"), # (new style)
           File.join(root_directory, FilePatterns::FABRICATORS_TEST_DIR, "%MODEL_NAME%_fabricator.rb"),
           File.join(root_directory, FilePatterns::FABRICATORS_SPEC_DIR, "%MODEL_NAME%_fabricator.rb")
         ]

data/lib/annotate_rb/model_annotator/single_file_annotator.rb

@@ -21,12 +21,11 @@ module AnnotateRb
         #  :position_in_*<Symbol>:: where to place the annotated section in fixture or model file,
         #                           :before, :top, :after or :bottom. Default is :before.
         #
-        def call(file_name, annotation, annotation_position, options = {})
+        def call(file_name, annotation, annotation_position, options)
           return false unless File.exist?(file_name)
           old_content = File.read(file_name)
 
           file_components = FileComponents.new(old_content, annotation, options)
-          builder = FileBuilder.new(file_components, annotation_position, options)
 
           return false if file_components.has_skip_string?
           return false if !file_components.annotations_changed? && !options[:force]
@@ -34,9 +33,9 @@ module AnnotateRb
           abort "AnnotateRb error. #{file_name} needs to be updated, but annotaterb was run with `--frozen`." if options[:frozen]
 
           updated_file_content = if !file_components.has_annotations? || options[:force]
-            builder.generate_content_with_new_annotations
+            AnnotatedFile::Generator.new(file_components, annotation_position, options).generate
           else
-            builder.update_existing_annotations
+            AnnotatedFile::Updater.new(file_components, annotation_position, options).update
           end
 
           File.open(file_name, "wb") { |f| f.puts updated_file_content }

data/lib/annotate_rb/model_annotator/single_file_annotator_instruction.rb

@@ -4,7 +4,7 @@ module AnnotateRb
   module ModelAnnotator
     # A plain old Ruby object (PORO) that contains all necessary information for SingleFileAnnotator
     class SingleFileAnnotatorInstruction
-      def initialize(file, annotation, position, options = {})
+      def initialize(file, annotation, position, options)
         @file = file # Path to file
         @annotation = annotation # Annotation string
         @position = position # Position in the file where to write the annotation to

data/lib/annotate_rb/model_annotator/single_file_remove_annotation_instruction.rb

@@ -4,7 +4,7 @@ module AnnotateRb
   module ModelAnnotator
     # A plain old Ruby object (PORO) that contains all necessary information for SingleFileAnnotationRemover
     class SingleFileRemoveAnnotationInstruction
-      def initialize(file, options = {})
+      def initialize(file, options)
         @file = file # Path to file
         @options = options
       end

data/lib/annotate_rb/model_annotator.rb

@@ -22,10 +22,10 @@ module AnnotateRb
     autoload :SingleFileRemoveAnnotationInstruction, "annotate_rb/model_annotator/single_file_remove_annotation_instruction"
     autoload :AnnotationDiffGenerator, "annotate_rb/model_annotator/annotation_diff_generator"
     autoload :AnnotationDiff, "annotate_rb/model_annotator/annotation_diff"
-    autoload :FileBuilder, "annotate_rb/model_annotator/file_builder"
-    autoload :MagicCommentParser, "annotate_rb/model_annotator/magic_comment_parser"
     autoload :FileComponents, "annotate_rb/model_annotator/file_components"
     autoload :ProjectAnnotator, "annotate_rb/model_annotator/project_annotator"
     autoload :ProjectAnnotationRemover, "annotate_rb/model_annotator/project_annotation_remover"
+    autoload :AnnotatedFile, "annotate_rb/model_annotator/annotated_file"
+    autoload :FileParser, "annotate_rb/model_annotator/file_parser"
   end
 end

data/lib/annotate_rb/options.rb

@@ -210,5 +210,9 @@ module AnnotateRb
     def get_state(key)
       @state[key]
     end
+
+    def print
+      # TODO: prints options and state
+    end
   end
 end

data/lib/annotate_rb/parser.rb

@@ -3,7 +3,7 @@ require "optparse"
 module AnnotateRb
   # Class for handling command line arguments
   class Parser # rubocop:disable Metrics/ClassLength
-    def self.parse(args, existing_options = {})
+    def self.parse(args, existing_options)
       new(args, existing_options).parse
     end
 
@@ -35,11 +35,11 @@ module AnnotateRb
     }.freeze
 
     def initialize(args, existing_options)
-      @args = args
+      @args = args.clone
       base_options = DEFAULT_OPTIONS.dup
       @options = base_options.merge(existing_options)
       @commands = []
-      @options[:original_args] = args.dup
+      @options[:original_args] = args.clone
     end
 
     def parse
@@ -52,6 +52,12 @@ module AnnotateRb
       @options
     end
 
+    def remaining_args
+      # `@args` gets modified throughout the lifecycle of this class.
+      # It starts as a shallow clone of ARGV, then arguments matching commands and options are removed in #parse
+      @args
+    end
+
     private
 
     def parse_command(args)

data/lib/annotate_rb/runner.rb

@@ -9,14 +9,15 @@ module AnnotateRb
     end
 
     def run(args)
-      _original_args = args.dup
-
       config_file_options = ConfigLoader.load_config
-      parsed_options = Parser.parse(args)
+      parser = Parser.new(args, {})
+
+      parsed_options = parser.parse
+      remaining_args = parser.remaining_args
 
       options = config_file_options.merge(parsed_options)
 
-      @options = Options.from(options, {})
+      @options = Options.from(options, {working_args: remaining_args})
       AnnotateRb::RakeBootstrapper.call(@options)
 
       if @options[:command]

data/lib/annotate_rb.rb

@@ -22,6 +22,7 @@ require_relative "annotate_rb/eager_loader"
 require_relative "annotate_rb/rake_bootstrapper"
 require_relative "annotate_rb/config_finder"
 require_relative "annotate_rb/config_loader"
+require_relative "annotate_rb/config_generator"
 
 module AnnotateRb
 end

data/lib/generators/annotate_rb/config/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generates a default configuration file, `.annotaterb.yml` in your
+    Rails app project root.
+
+Example:
+    `rails generate annotate_rb:config`

data/lib/generators/annotate_rb/config/config_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "annotate_rb"
+
+module AnnotateRb
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      def generate_config
+        create_file ::AnnotateRb::ConfigFinder::DOTFILE do
+          ::AnnotateRb::ConfigGenerator.default_config_yml
+        end
+      end
+    end
+  end
+end

data/lib/generators/annotate_rb/hook/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Adds a rake task into your Rails app's lib/tasks directory, that
+    automatically annotates models when you do a db:migrate in
+    development mode.
+
+Example:
+    `rails generate annotate_rb:hook`

data/lib/generators/annotate_rb/hook/hook_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "annotate_rb"
+
+module AnnotateRb
+  module Generators
+    class HookGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_hook_file
+        copy_file "annotate_rb.rake", "lib/tasks/annotate_rb.rake"
+      end
+    end
+  end
+end

data/lib/generators/annotate_rb/install/install_generator.rb

@@ -5,10 +5,9 @@ require "annotate_rb"
 module AnnotateRb
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path("templates", __dir__)
-
-      def copy_task
-        copy_file "annotate_rb.rake", "lib/tasks/annotate_rb.rake"
+      def install_hook_and_generate_defaults
+        generate "annotate_rb:hook"
+        generate "annotate_rb:config"
       end
     end
   end

data/lib/generators/annotate_rb/update_config/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Appends to .annotaterb.yml any missing default configuration
+    key-value pairs.
+
+Example:
+    `rails generate annotate_rb:update_config`

data/lib/generators/annotate_rb/update_config/update_config_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "annotate_rb"
+
+module AnnotateRb
+  module Generators
+    class UpdateConfigGenerator < ::Rails::Generators::Base
+      def generate_config
+        insert_into_file ::AnnotateRb::ConfigFinder::DOTFILE do
+          ::AnnotateRb::ConfigGenerator.unset_config_defaults
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.5.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -31,11 +31,15 @@ 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
@@ -49,14 +53,14 @@ 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/magic_comment_parser.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
@@ -80,9 +84,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

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/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