annotaterb 4.1.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c77ca5a809b63c94e69b937732b8f8f531807cc332627791b649576e8ed583e
-  data.tar.gz: c2fb3ac84bad2e0cd108c801ca162a6a17b34ba800af8f5e885e03c8338d636d
+  metadata.gz: 8888511eb71e6d0c45eadf9f562767868adf7cb9f2c5c58d6eb3458a65dfdc31
+  data.tar.gz: 51d25d56e5068979a09d4562e7018b0272f8f73e952941a4f66faece7408cc11
 SHA512:
-  metadata.gz: fb88fa8b511e0ccbbadce0db7d0ae941234967eb7358fea1146e48309939b1b35e51f8db9f15d544a6af4b3827decb65e51f4546d73feb2ab2f404c67f3c0f05
-  data.tar.gz: 562cd430feba785e8f53ab90f79dfa1c3765f46a8e048bbe379955c8f696dd4e01ce167245cf17e31de4704dc0e22da859cba2f6f00c87d10782e637c2faad65
+  metadata.gz: 9b878bfc48836e52fe762c547870b67619427772e54efd28835e8699371dc60fdb5511649d9f2bf39431541a9b07f8e32188469526dd109553f71badedd6ec45
+  data.tar.gz: df69b71c4c10cc046ebd6cf0a21391262b90e0bcffe19556b59214d7658623fa323a7adbf24e711726bb685377e47596d9b95fed9c2425f22f4877264eed97d8

data/README.md

@@ -60,10 +60,7 @@ $ bin/rails g annotate_rb:install
 This will copy a rake task into your Rails project's `lib/tasks` directory that will hook into the Rails project rake tasks, automatically running AnnotateRb after database migration rake tasks.
 
 ## Migrating from the annotate gem
-The old [annotate gem](https://github.com/ctran/annotate_models) relied on environment variables and hardcoded values in rake files for configuration. AnnotateRb is different. It reads from an optional configuration yml file and options from the CLI to function.
-
-* Remove the following files `lib/tasks/annotate_models.rake`, `lib/tasks/annotate_models_migrate.rake`, `lib/tasks/annotate_routes.rake`.
-* Run the generator install command above.
+Refer to the [migration guide](MIGRATION_GUIDE.md).
 
 ## Usage
 
@@ -160,7 +157,9 @@ Previously in the [Annotate](https://github.com/ctran/annotate_models) you could
 position: after
 ```
 
-Annotaterb reads first from the configuration file, if it exists, then merges it with any options passed into the CLI.
+Annotaterb reads first from the configuration file, if it exists, then merges it with any options passed into the CLI. 
+
+For further details visit the [section in the migration guide](MIGRATION_GUIDE.md#automatic-annotations-after-running-database-migration-commands).
 
 ### How to skip annotating a particular model
 If you want to always skip annotations on a particular model, add this string

data/VERSION

@@ -1 +1 @@
-4.1.0
+4.1.1

data/lib/annotate_rb/model_annotator/annotation_diff.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    # Plain old Ruby object for holding the differences
+    class AnnotationDiff
+      attr_reader :current_columns, :new_columns
+
+      def initialize(current_columns, new_columns)
+        @current_columns = current_columns.dup.freeze
+        @new_columns = new_columns.dup.freeze
+      end
+
+      def changed?
+        @changed ||= @current_columns != @new_columns
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/annotation_diff_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module ModelAnnotator
+    # Compares the current file content and new annotation block and generates the column annotation differences
+    class AnnotationDiffGenerator
+      HEADER_PATTERN = /(^# Table name:.*?\n(#.*[\r]?\n)*[\r]?)/.freeze
+      COLUMN_PATTERN = /^#[\t ]+[\w\*\.`\[\]():]+[\t ]+.+$/.freeze
+
+      class << self
+        def call(file_content, annotation_block)
+          new(file_content, annotation_block).generate
+        end
+      end
+
+      # @param [String] file_content The current file content of the model file we intend to annotate
+      # @param [String] annotation_block The annotation block we intend to write to the model file
+      def initialize(file_content, annotation_block)
+        @file_content = file_content
+        @annotation_block = annotation_block
+      end
+
+      def generate
+        # Ignore the Schema version line because it changes with each migration
+        current_annotations = @file_content.match(HEADER_PATTERN).to_s
+        new_annotations = @annotation_block.match(HEADER_PATTERN).to_s
+
+        if current_annotations.present?
+          current_annotation_columns = current_annotations.scan(COLUMN_PATTERN).sort
+        else
+          current_annotation_columns = []
+        end
+
+        if new_annotations.present?
+          new_annotation_columns = new_annotations.scan(COLUMN_PATTERN).sort
+        else
+          new_annotation_columns = []
+        end
+
+        _result = AnnotationDiff.new(current_annotation_columns, new_annotation_columns)
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/file_annotator.rb

@@ -24,18 +24,12 @@ module AnnotateRb
         def call(file_name, info_block, position, options = {})
           return false unless File.exist?(file_name)
           old_content = File.read(file_name)
-          return false if old_content =~ /#{Constants::SKIP_ANNOTATION_PREFIX}.*\n/
 
-          # Ignore the Schema version line because it changes with each migration
-          header_pattern = /(^# Table name:.*?\n(#.*[\r]?\n)*[\r]?)/
-          old_header = old_content.match(header_pattern).to_s
-          new_header = info_block.match(header_pattern).to_s
+          return false if old_content =~ /#{Constants::SKIP_ANNOTATION_PREFIX}.*\n/
 
-          column_pattern = /^#[\t ]+[\w\*\.`]+[\t ]+.+$/
-          old_columns = old_header && old_header.scan(column_pattern).sort
-          new_columns = new_header && new_header.scan(column_pattern).sort
+          diff = AnnotationDiffGenerator.new(old_content, info_block).generate
 
-          return false if old_columns == new_columns && !options[:force]
+          return false if !diff.changed? && !options[:force]
 
           abort "AnnotateRb error. #{file_name} needs to be updated, but annotaterb was run with `--frozen`." if options[:frozen]
 

data/lib/annotate_rb/model_annotator.rb

@@ -26,5 +26,7 @@ module AnnotateRb
     autoload :RelatedFilesListBuilder, 'annotate_rb/model_annotator/related_files_list_builder'
     autoload :AnnotationDecider, 'annotate_rb/model_annotator/annotation_decider'
     autoload :FileAnnotatorInstruction, 'annotate_rb/model_annotator/file_annotator_instruction'
+    autoload :AnnotationDiffGenerator, 'annotate_rb/model_annotator/annotation_diff_generator'
+    autoload :AnnotationDiff, 'annotate_rb/model_annotator/annotation_diff'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -37,6 +37,8 @@ files:
 - lib/annotate_rb/eager_loader.rb
 - lib/annotate_rb/model_annotator.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_generator.rb
 - lib/annotate_rb/model_annotator/annotation_pattern_generator.rb
 - lib/annotate_rb/model_annotator/annotator.rb