annotaterb 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c77ca5a809b63c94e69b937732b8f8f531807cc332627791b649576e8ed583e
-  data.tar.gz: c2fb3ac84bad2e0cd108c801ca162a6a17b34ba800af8f5e885e03c8338d636d
+  metadata.gz: 5864a6030a7b4cfbf7751761c07136690ebafe15393d67147789f70319036205
+  data.tar.gz: a1dc2b99206b342bbd0dbc66795db4156abddfee307acecf6c2c383e8dbe89b1
 SHA512:
-  metadata.gz: fb88fa8b511e0ccbbadce0db7d0ae941234967eb7358fea1146e48309939b1b35e51f8db9f15d544a6af4b3827decb65e51f4546d73feb2ab2f404c67f3c0f05
-  data.tar.gz: 562cd430feba785e8f53ab90f79dfa1c3765f46a8e048bbe379955c8f696dd4e01ce167245cf17e31de4704dc0e22da859cba2f6f00c87d10782e637c2faad65
+  metadata.gz: b7cbd03e31fdc24f27d23d700773c157eca461078cddcd87739605980d6f5f07887b59f345ef41d91994547d8efbc2b82595e454f9e4619a5fe4e0fb506d29cd
+  data.tar.gz: f162544608cce0746a92250287ca4a5c7d25d151fe5bfe8bf4d18075834e98ce68939dc8b176dbe97d16f1f039a1a001cbb71066b26280f9fb5e83df763ba158

data/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+## [Unreleased](https://github.com/drwl/annotaterb/tree/HEAD)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.1.1...HEAD)
+
+**Merged pull requests:**
+
+- Specify `standard` gem version [\#39](https://github.com/drwl/annotaterb/pull/39) ([drwl](https://github.com/drwl))
+- Bump version to v4.2.0 [\#37](https://github.com/drwl/annotaterb/pull/37) ([drwl](https://github.com/drwl))
+- Generate changelog for 4.2 [\#36](https://github.com/drwl/annotaterb/pull/36) ([drwl](https://github.com/drwl))
+- Improve tests for `ColumnAnnotation::*` [\#35](https://github.com/drwl/annotaterb/pull/35) ([drwl](https://github.com/drwl))
+- Change instances of `Options.from` =\> `Options.new` in tests [\#34](https://github.com/drwl/annotaterb/pull/34) ([drwl](https://github.com/drwl))
+- Add `Standard` linter to project [\#33](https://github.com/drwl/annotaterb/pull/33) ([drwl](https://github.com/drwl))
+- Support Sorbet `typed` magic comment [\#32](https://github.com/drwl/annotaterb/pull/32) ([drwl](https://github.com/drwl))
+- Add `position_in_additional_file_patterns` to Options and Parser [\#31](https://github.com/drwl/annotaterb/pull/31) ([drwl](https://github.com/drwl))
+- Remove `Files` gem as a dependency [\#30](https://github.com/drwl/annotaterb/pull/30) ([drwl](https://github.com/drwl))
+- Refactor `ModelAnnotator` again [\#28](https://github.com/drwl/annotaterb/pull/28) ([drwl](https://github.com/drwl))
+- Add initial change log [\#27](https://github.com/drwl/annotaterb/pull/27) ([drwl](https://github.com/drwl))
+
+## [v4.1.1](https://github.com/drwl/annotaterb/tree/v4.1.1) (2023-05-20)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.1.0...v4.1.1)
+
+**Merged pull requests:**
+
+- Bump version to v4.1.1 [\#26](https://github.com/drwl/annotaterb/pull/26) ([drwl](https://github.com/drwl))
+- Tidy the github repo [\#25](https://github.com/drwl/annotaterb/pull/25) ([drwl](https://github.com/drwl))
+- Add guide for migrating from Annotate gem [\#24](https://github.com/drwl/annotaterb/pull/24) ([drwl](https://github.com/drwl))
+- Update column pattern regex to incorporate special column comments [\#23](https://github.com/drwl/annotaterb/pull/23) ([drwl](https://github.com/drwl))
+
+## [v4.1.0](https://github.com/drwl/annotaterb/tree/v4.1.0) (2023-05-17)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/v4.0.0...v4.1.0)
+
+**Merged pull requests:**
+
+- Bump version to 4.1.0 [\#22](https://github.com/drwl/annotaterb/pull/22) ([drwl](https://github.com/drwl))
+- Refactor ModelAnnotator; Fix instances of incorrect `exclude_*` keys [\#21](https://github.com/drwl/annotaterb/pull/21) ([drwl](https://github.com/drwl))
+- Fix the default behavior for model annotator [\#20](https://github.com/drwl/annotaterb/pull/20) ([drwl](https://github.com/drwl))
+- Refactor model annotator [\#19](https://github.com/drwl/annotaterb/pull/19) ([drwl](https://github.com/drwl))
+- Removed unused helper methods and `Env` class [\#18](https://github.com/drwl/annotaterb/pull/18) ([drwl](https://github.com/drwl))
+- Update dummy app depdencies [\#17](https://github.com/drwl/annotaterb/pull/17) ([drwl](https://github.com/drwl))
+
+## [v4.0.0](https://github.com/drwl/annotaterb/tree/v4.0.0) (2023-05-03)
+
+[Full Changelog](https://github.com/drwl/annotaterb/compare/1da0386bf9e1ca3fbd0d9d3ae69cdc7a8cdc26fa...v4.0.0)
+
+**Merged pull requests:**
+
+- Last project polish for 4.0.0 release [\#14](https://github.com/drwl/annotaterb/pull/14) ([drwl](https://github.com/drwl))
+- Add configuration instructions to README [\#13](https://github.com/drwl/annotaterb/pull/13) ([drwl](https://github.com/drwl))
+- Prepare gem for beta release [\#12](https://github.com/drwl/annotaterb/pull/12) ([drwl](https://github.com/drwl))
+- Make annotaterb usable [\#11](https://github.com/drwl/annotaterb/pull/11) ([drwl](https://github.com/drwl))
+- Move old annotate code into AnnotateRb namespace [\#10](https://github.com/drwl/annotaterb/pull/10) ([drwl](https://github.com/drwl))
+- Fix CodeQL action [\#9](https://github.com/drwl/annotaterb/pull/9) ([drwl](https://github.com/drwl))
+- Regularly run CI [\#8](https://github.com/drwl/annotaterb/pull/8) ([drwl](https://github.com/drwl))
+- Get CI consistently green [\#7](https://github.com/drwl/annotaterb/pull/7) ([drwl](https://github.com/drwl))
+- More work [\#6](https://github.com/drwl/annotaterb/pull/6) ([drwl](https://github.com/drwl))
+- Make CI green [\#5](https://github.com/drwl/annotaterb/pull/5) ([drwl](https://github.com/drwl))
+- Make it work for Rails 7 [\#4](https://github.com/drwl/annotaterb/pull/4) ([drwl](https://github.com/drwl))
+- Tidy up project [\#3](https://github.com/drwl/annotaterb/pull/3) ([drwl](https://github.com/drwl))
+- Set spec run order to random [\#2](https://github.com/drwl/annotaterb/pull/2) ([drwl](https://github.com/drwl))
+- Tidy rspec configuration [\#1](https://github.com/drwl/annotaterb/pull/1) ([drwl](https://github.com/drwl))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

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.2.0

data/exe/annotaterb

@@ -1,21 +1,21 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-unless File.exist?('./Rakefile') || File.exist?('./Gemfile')
-  abort 'Please run annotaterb from the root of the project.'
+unless File.exist?("./Rakefile") || File.exist?("./Gemfile")
+  abort "Please run annotaterb from the root of the project."
 end
 
 begin
-  require 'bundler'
+  require "bundler"
   Bundler.setup
-rescue StandardError
+rescue
 end
 
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 
-require 'annotate_rb'
+require "annotate_rb"
 
-exit_status = ::AnnotateRb::Runner.run(ARGV)
+_exit_status = ::AnnotateRb::Runner.run(ARGV)
 
 # TODO: Return exit status
-# exit exit_status
+# exit exit_status

data/lib/annotate_rb/active_record_patch.rb

@@ -1,5 +1,6 @@
 # monkey patches
 
+# standard:disable Style/MissingRespondToMissing
 module ::ActiveRecord
   class Base
     def self.method_missing(_name, *_args)
@@ -7,3 +8,4 @@ module ::ActiveRecord
     end
   end
 end
+# standard:enable Style/MissingRespondToMissing

data/lib/annotate_rb/commands/annotate_models.rb

@@ -19,4 +19,3 @@ module AnnotateRb
     end
   end
 end
-

data/lib/annotate_rb/commands/annotate_routes.rb

@@ -16,4 +16,3 @@ module AnnotateRb
     end
   end
 end
-

data/lib/annotate_rb/commands/print_help.rb

@@ -13,4 +13,3 @@ module AnnotateRb
     end
   end
 end
-

data/lib/annotate_rb/commands/print_version.rb

@@ -9,4 +9,3 @@ module AnnotateRb
     end
   end
 end
-

data/lib/annotate_rb/commands.rb

@@ -2,9 +2,9 @@
 
 module AnnotateRb
   module Commands
-    autoload :PrintVersion, 'annotate_rb/commands/print_version'
-    autoload :PrintHelp, 'annotate_rb/commands/print_help'
-    autoload :AnnotateModels, 'annotate_rb/commands/annotate_models'
-    autoload :AnnotateRoutes, 'annotate_rb/commands/annotate_routes'
+    autoload :PrintVersion, "annotate_rb/commands/print_version"
+    autoload :PrintHelp, "annotate_rb/commands/print_help"
+    autoload :AnnotateModels, "annotate_rb/commands/annotate_models"
+    autoload :AnnotateRoutes, "annotate_rb/commands/annotate_routes"
   end
 end

data/lib/annotate_rb/config_finder.rb

@@ -2,7 +2,7 @@
 
 module AnnotateRb
   class ConfigFinder
-    DOTFILE = '.annotaterb.yml'
+    DOTFILE = ".annotaterb.yml"
 
     class << self
       def find_project_root

data/lib/annotate_rb/config_loader.rb

@@ -44,9 +44,9 @@ module AnnotateRb
       # Method from Rubocop::ConfigLoader
       def yaml_safe_load(yaml_code, filename)
         yaml_safe_load!(yaml_code, filename)
-      rescue ::StandardError
+      rescue
         if defined?(::SafeYAML)
-          raise 'SafeYAML is unmaintained, no longer needed and should be removed'
+          raise "SafeYAML is unmaintained, no longer needed and should be removed"
         end
 
         raise

data/lib/annotate_rb/core.rb

@@ -4,13 +4,13 @@ module AnnotateRb
   module Core
     class << self
       def version
-        @version ||= File.read(File.expand_path('../../VERSION', __dir__)).strip
+        @version ||= File.read(File.expand_path("../../VERSION", __dir__)).strip
       end
 
       def load_rake_tasks
         return if @load_rake_tasks
 
-        rake_tasks = Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')]
+        rake_tasks = Dir[File.join(File.dirname(__FILE__), "tasks", "**/*.rake")]
 
         rake_tasks.each do |task|
           load task
@@ -20,4 +20,4 @@ module AnnotateRb
       end
     end
   end
-end
+end

data/lib/annotate_rb/helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AnnotateRb
+  module Helper
+    class << self
+      def width(string)
+        string.chars.inject(0) { |acc, elem| acc + ((elem.bytesize == 3) ? 2 : 1) }
+      end
+
+      # TODO: Find another implementation that doesn't depend on ActiveSupport
+      def fallback(*args)
+        args.compact.detect(&:present?)
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/{annotation_generator.rb → annotation_builder.rb}

@@ -2,12 +2,12 @@
 
 module AnnotateRb
   module ModelAnnotator
-    class AnnotationGenerator
+    class AnnotationBuilder
       # Annotate Models plugin use this header
-      PREFIX = '== Schema Information'.freeze
-      PREFIX_MD = '## Schema Information'.freeze
+      PREFIX = "== Schema Information"
+      PREFIX_MD = "## Schema Information"
 
-      END_MARK = '== Schema Information End'.freeze
+      END_MARK = "== Schema Information End"
 
       MD_NAMES_OVERHEAD = 6
       MD_TYPE_ALLOWANCE = 18
@@ -18,7 +18,7 @@ module AnnotateRb
         @info = "" # TODO: Make array and build string that way
       end
 
-      def generate
+      def build
         @info = "# #{header}\n"
         @info += schema_header_text
 
@@ -26,22 +26,22 @@ module AnnotateRb
 
         if @options[:format_markdown]
           @info += format("# %-#{max_size + MD_NAMES_OVERHEAD}.#{max_size + MD_NAMES_OVERHEAD}s | %-#{MD_TYPE_ALLOWANCE}.#{MD_TYPE_ALLOWANCE}s | %s\n",
-                          'Name',
-                          'Type',
-                          'Attributes')
-          @info += "# #{'-' * (max_size + MD_NAMES_OVERHEAD)} | #{'-' * MD_TYPE_ALLOWANCE} | #{'-' * 27}\n"
+            "Name",
+            "Type",
+            "Attributes")
+          @info += "# #{"-" * (max_size + MD_NAMES_OVERHEAD)} | #{"-" * MD_TYPE_ALLOWANCE} | #{"-" * 27}\n"
         end
 
         @info += @model.columns.map do |col|
-          ColumnAnnotationBuilder.new(col, @model, max_size, @options).build
+          ColumnAnnotation::AnnotationBuilder.new(col, @model, max_size, @options).build
         end.join
 
         if @options[:show_indexes] && @model.table_exists?
-          @info += IndexAnnotationBuilder.new(@model, @options).build
+          @info += IndexAnnotation::AnnotationBuilder.new(@model, @options).build
         end
 
         if @options[:show_foreign_keys] && @model.table_exists?
-          @info += ForeignKeyAnnotationBuilder.new(@model, @options).build
+          @info += ForeignKeyAnnotation::AnnotationBuilder.new(@model, @options).build
         end
 
         @info += schema_footer_text
@@ -51,7 +51,11 @@ module AnnotateRb
 
       def header
         header = @options[:format_markdown] ? PREFIX_MD.dup : PREFIX.dup
-        version = ActiveRecord::Migrator.current_version rescue 0
+        version = begin
+          ActiveRecord::Migrator.current_version
+        rescue
+          0
+        end
 
         if @options[:include_version] && version > 0
           header += "\n# Schema version: #{version}"
@@ -91,4 +95,4 @@ module AnnotateRb
       end
     end
   end
-end
+end

data/lib/annotate_rb/model_annotator/annotation_decider.rb

@@ -4,6 +4,8 @@ module AnnotateRb
   module ModelAnnotator
     # Class that encapsulates the logic to decide whether to annotate a model file and its related files or not.
     class AnnotationDecider
+      SKIP_ANNOTATION_PREFIX = '# -\*- SkipSchemaAnnotations'
+
       def initialize(file, options)
         @file = file
         @options = options
@@ -35,12 +37,12 @@ module AnnotateRb
           return to_annotate
         rescue BadModelFileError => e
           unless @options[:ignore_unknown_models]
-            $stderr.puts "Unable to annotate #{@file}: #{e.message}"
-            $stderr.puts "\t" + e.backtrace.join("\n\t") if @options[:trace]
+            warn "Unable to process #{@file}: #{e.message}"
+            warn "\t" + e.backtrace.join("\n\t") if @options[:trace]
           end
-        rescue StandardError => e
-          $stderr.puts "Unable to annotate #{@file}: #{e.message}"
-          $stderr.puts "\t" + e.backtrace.join("\n\t") if @options[:trace]
+        rescue => e
+          warn "Unable to process #{@file}: #{e.message}"
+          warn "\t" + e.backtrace.join("\n\t") if @options[:trace]
         end
 
         false
@@ -49,14 +51,10 @@ module AnnotateRb
       private
 
       def file_contains_skip_annotation
-        file_string = File.exist?(@file) ? File.read(@file) : ''
+        file_string = File.exist?(@file) ? File.read(@file) : ""
 
-        if /#{Constants::SKIP_ANNOTATION_PREFIX}.*/ =~ file_string
-          true
-        else
-          false
-        end
+        /#{SKIP_ANNOTATION_PREFIX}.*/o.match?(file_string)
       end
     end
   end
-end
+end

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?)/
+      COLUMN_PATTERN = /^#[\t ]+[\w*.`\[\]():]+[\t ]+.+$/
+
+      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
+
+        current_annotation_columns = if current_annotations.present?
+          current_annotations.scan(COLUMN_PATTERN).sort
+        else
+          []
+        end
+
+        new_annotation_columns = if new_annotations.present?
+          new_annotations.scan(COLUMN_PATTERN).sort
+        else
+          []
+        end
+
+        _result = AnnotationDiff.new(current_annotation_columns, new_annotation_columns)
+      end
+    end
+  end
+end

data/lib/annotate_rb/model_annotator/annotation_pattern_generator.rb

@@ -3,15 +3,15 @@
 module AnnotateRb
   module ModelAnnotator
     class AnnotationPatternGenerator
-      COMPAT_PREFIX = '== Schema Info'.freeze
-      COMPAT_PREFIX_MD = '## Schema Info'.freeze
+      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)*/
+          /^(\n|\r\n)?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?(\n|\r\n)(#.*(\n|\r\n))*(\n|\r\n)*/o
         end
       end
     end

data/lib/annotate_rb/model_annotator/annotator.rb

@@ -5,66 +5,25 @@ module AnnotateRb
     class Annotator
       class << self
         def do_annotations(options = {})
-          annotated = []
-
-          model_files_to_consider = ModelFilesGetter.call(options)
-
-          model_files_to_consider.each do |path, filename|
-            file = File.join(path, filename)
-
-            if AnnotationDecider.new(file, options).annotate?
-              ModelFileAnnotator.call(annotated, file, options)
-            end
-          end
-
-          if annotated.empty?
-            puts 'Model files unchanged.'
-          else
-            puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
-          end
+          new(options).do_annotations
         end
 
         def remove_annotations(options = {})
-          deannotated = []
-
-          model_files_to_consider = ModelFilesGetter.call(options)
-
-          model_files_to_consider.each do |path, filename|
-            deannotated_klass = false
-            file = File.join(path, filename)
-
-            begin
-              klass = ModelClassGetter.call(file, options)
-              if klass < ActiveRecord::Base && !klass.abstract_class?
-                model_name = klass.name.underscore
-                table_name = klass.table_name
-
-                if FileAnnotationRemover.call(file, options)
-                  deannotated_klass = true
-                end
-
-                related_files = RelatedFilesListBuilder.new(file, model_name, table_name, options).build
+          new(options).remove_annotations
+        end
+      end
 
-                related_files.each do |f, _position_key|
-                  if File.exist?(f)
-                    FileAnnotationRemover.call(f, options)
-                  end
-                end
-              end
+      def initialize(options)
+        @options = options
+      end
 
-              if deannotated_klass
-                deannotated << klass
-              end
-            rescue StandardError => e
-              $stderr.puts "Unable to deannotate #{File.join(file)}: #{e.message}"
-              $stderr.puts "\t" + e.backtrace.join("\n\t") if options[:trace]
-            end
-          end
+      def do_annotations
+        ProjectAnnotator.new(@options).annotate
+      end
 
-          puts "Removed annotations from: #{deannotated.join(', ')}"
-        end
+      def remove_annotations
+        ProjectAnnotationRemover.new(@options).remove_annotations
       end
     end
   end
 end
-