annotaterb 4.1.1 → 4.2.0

data/lib/annotate_rb/route_annotator/header_generator.rb

@@ -1,9 +1,9 @@
 module AnnotateRb
   module RouteAnnotator
     class HeaderGenerator
-      PREFIX = '== Route Map'.freeze
-      PREFIX_MD = '## Route Map'.freeze
-      HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
+      PREFIX = "== Route Map".freeze
+      PREFIX_MD = "## Route Map".freeze
+      HEADER_ROW = ["Prefix", "Verb", "URI Pattern", "Controller#Action"].freeze
 
       class << self
         def generate(options = {})
@@ -20,7 +20,7 @@ module AnnotateRb
           # In old versions of Rake, the first line of output was the cwd.  Not so
           # much in newer ones.  We ditch that line if it exists, and if not, we
           # keep the line around.
-          result.shift if result.first =~ %r{^\(in \/}
+          result.shift if %r{^\(in /}.match?(result.first)
 
           ignore_routes = options[:ignore_routes]
           regexp_for_ignoring_routes = ignore_routes ? /#{ignore_routes}/ : nil
@@ -48,7 +48,7 @@ module AnnotateRb
         magic_comments_map.each do |magic_comment|
           out << magic_comment
         end
-        out << '' if magic_comments_map.any?
+        out << "" if magic_comments_map.any?
 
         out << comment(options[:wrapper_open]) if options[:wrapper_open]
 
@@ -62,12 +62,12 @@ module AnnotateRb
           max = maxs.map(&:max).compact.max
 
           out << comment(content(HEADER_ROW, maxs))
-          out << comment(content(['-' * max, '-' * max, '-' * max, '-' * max], maxs))
+          out << comment(content(["-" * max, "-" * max, "-" * max, "-" * max], maxs))
         else
           out << comment(content(contents_without_magic_comments[0], maxs))
         end
 
-        out += contents_without_magic_comments[1..-1].map { |line| comment(content(markdown? ? line.split(' ') : line, maxs)) }
+        out += contents_without_magic_comments[1..-1].map { |line| comment(content(markdown? ? line.split(" ") : line, maxs)) }
         out << comment(options[:wrapper_close]) if options[:wrapper_close]
 
         out
@@ -77,9 +77,9 @@ module AnnotateRb
 
       attr_reader :options, :routes_map
 
-      def comment(row = '')
-        if row == ''
-          '#'
+      def comment(row = "")
+        if row == ""
+          "#"
         else
           "# #{row}"
         end
@@ -88,12 +88,12 @@ module AnnotateRb
       def content(line, maxs)
         return line.rstrip unless markdown?
 
-        line.each_with_index.map { |elem, index| format_line_element(elem, maxs, index) }.join(' | ')
+        line.each_with_index.map { |elem, index| format_line_element(elem, maxs, index) }.join(" | ")
       end
 
       def format_line_element(elem, maxs, index)
         min_length = maxs.map { |arr| arr[index] }.max || 0
-        format("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
+        format("%-#{min_length}.#{min_length}s", elem.tr("|", "-"))
       end
 
       def markdown?
@@ -102,12 +102,12 @@ module AnnotateRb
 
       def timestamp_if_required(time = Time.now)
         if options[:timestamp]
-          time_formatted = time.strftime('%Y-%m-%d %H:%M')
+          time_formatted = time.strftime("%Y-%m-%d %H:%M")
           " (Updated #{time_formatted})"
         else
-          ''
+          ""
         end
       end
     end
   end
-end
+end

data/lib/annotate_rb/route_annotator/helper.rb

@@ -3,7 +3,7 @@
 module AnnotateRb
   module RouteAnnotator
     module Helper
-      MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
+      MAGIC_COMMENT_MATCHER = /(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/.freeze
 
       class << self
         def routes_file_exist?
@@ -11,18 +11,18 @@ module AnnotateRb
         end
 
         def routes_file
-          @routes_rb ||= File.join('config', 'routes.rb')
+          @routes_rb ||= File.join("config", "routes.rb")
         end
 
         def strip_on_removal(content, header_position)
           if header_position == :before
-            content.shift while content.first == ''
+            content.shift while content.first == ""
           elsif header_position == :after
-            content.pop while content.last == ''
+            content.pop while content.last == ""
           end
 
           # Make sure we end on a trailing newline.
-          content << '' unless content.last == ''
+          content << "" unless content.last == ""
 
           # TODO: If the user buried it in the middle, we should probably see about
           # TODO: preserving a single line of space between the content above and
@@ -34,7 +34,7 @@ module AnnotateRb
           if existing_text == new_text
             false
           else
-            File.open(routes_file, 'wb') { |f| f.puts(new_text) }
+            File.open(routes_file, "wb") { |f| f.puts(new_text) }
             true
           end
         end
@@ -47,7 +47,7 @@ module AnnotateRb
           new_content = []
 
           content_array.each do |row|
-            if row =~ MAGIC_COMMENT_MATCHER
+            if MAGIC_COMMENT_MATCHER.match?(row)
               magic_comments << row.strip
             else
               new_content << row
@@ -74,7 +74,7 @@ module AnnotateRb
               mode = :content
               real_content << line unless line.blank?
             elsif mode == :content
-              if line =~ /^\s*#\s*== Route.*$/
+              if /^\s*#\s*== Route.*$/.match?(line)
                 header_position = line_number + 1 # index start's at 0
                 mode = :header
               else
@@ -96,7 +96,7 @@ module AnnotateRb
           return real_content, :after if header_position >= real_content.count
 
           # and the default
-          return real_content, header_position
+          [real_content, header_position]
         end
       end
     end

data/lib/annotate_rb/route_annotator/removal_processor.rb

@@ -22,13 +22,13 @@ module AnnotateRb
 
       def generate_new_content_array(content, header_position)
         if header_position == :before
-          content.shift while content.first == ''
+          content.shift while content.first == ""
         elsif header_position == :after
-          content.pop while content.last == ''
+          content.pop while content.last == ""
         end
 
         # Make sure we end on a trailing newline.
-        content << '' unless content.last == ''
+        content << "" unless content.last == ""
 
         # TODO: If the user buried it in the middle, we should probably see about
         # TODO: preserving a single line of space between the content above and
@@ -37,4 +37,4 @@ module AnnotateRb
       end
     end
   end
-end
+end

data/lib/annotate_rb/route_annotator.rb

@@ -2,11 +2,11 @@
 
 module AnnotateRb
   module RouteAnnotator
-    autoload :Annotator, 'annotate_rb/route_annotator/annotator'
-    autoload :Helper, 'annotate_rb/route_annotator/helper'
-    autoload :HeaderGenerator, 'annotate_rb/route_annotator/header_generator'
-    autoload :BaseProcessor, 'annotate_rb/route_annotator/base_processor'
-    autoload :AnnotationProcessor, 'annotate_rb/route_annotator/annotation_processor'
-    autoload :RemovalProcessor, 'annotate_rb/route_annotator/removal_processor'
+    autoload :Annotator, "annotate_rb/route_annotator/annotator"
+    autoload :Helper, "annotate_rb/route_annotator/helper"
+    autoload :HeaderGenerator, "annotate_rb/route_annotator/header_generator"
+    autoload :BaseProcessor, "annotate_rb/route_annotator/base_processor"
+    autoload :AnnotationProcessor, "annotate_rb/route_annotator/annotation_processor"
+    autoload :RemovalProcessor, "annotate_rb/route_annotator/removal_processor"
   end
 end

data/lib/annotate_rb/runner.rb

@@ -8,10 +8,6 @@ module AnnotateRb
       end
     end
 
-    def initialize
-
-    end
-
     def run(args)
       _original_args = args.dup
 

data/lib/annotate_rb/tasks/annotate_models_migrate.rake

@@ -5,15 +5,15 @@
 # run after doing db:migrate.
 
 # Migration tasks are tasks that we'll "hook" into
-migration_tasks = %w(db:migrate db:migrate:up db:migrate:down db:migrate:reset db:migrate:redo db:rollback)
-if defined?(Rails::Application) && Rails.version.split('.').first.to_i >= 6
-  require 'active_record'
+migration_tasks = %w[db:migrate db:migrate:up db:migrate:down db:migrate:reset db:migrate:redo db:rollback]
+if defined?(Rails::Application) && Rails.version.split(".").first.to_i >= 6
+  require "active_record"
 
   databases = ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml
 
   # If there's multiple databases, this appends database specific rake tasks to `migration_tasks`
   ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |database_name|
-    migration_tasks.concat(%w(db:migrate db:migrate:up db:migrate:down).map { |task| "#{task}:#{database_name}" })
+    migration_tasks.concat(%w[db:migrate db:migrate:up db:migrate:down].map { |task| "#{task}:#{database_name}" })
   end
 end
 
@@ -24,7 +24,7 @@ migration_tasks.each do |task|
     task_name = Rake.application.top_level_tasks.last # The name of the task that was run, e.g. "db:migrate"
 
     Rake::Task[task_name].enhance do
-      ::AnnotateRb::Runner.run(['models'])
+      ::AnnotateRb::Runner.run(["models"])
     end
   end
 end

data/lib/annotate_rb.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
-require 'active_record'
-require 'active_support'
+require "active_record"
+require "active_support"
 
 # Helper.fallback depends on this being required because it adds #present? to nil
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/class/subclasses'
-require 'active_support/core_ext/string/inflections'
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/class/subclasses"
+require "active_support/core_ext/string/inflections"
 
-require 'rake'
+require "rake"
 
-require 'annotate_rb/active_record_patch'
+require "annotate_rb/active_record_patch"
 
-require_relative 'annotate_rb/core'
-require_relative 'annotate_rb/commands'
-require_relative 'annotate_rb/parser'
-require_relative 'annotate_rb/runner'
-require_relative 'annotate_rb/route_annotator'
-require_relative 'annotate_rb/model_annotator'
-require_relative 'annotate_rb/options'
-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/helper"
+require_relative "annotate_rb/core"
+require_relative "annotate_rb/commands"
+require_relative "annotate_rb/parser"
+require_relative "annotate_rb/runner"
+require_relative "annotate_rb/route_annotator"
+require_relative "annotate_rb/model_annotator"
+require_relative "annotate_rb/options"
+require_relative "annotate_rb/eager_loader"
+require_relative "annotate_rb/rake_bootstrapper"
+require_relative "annotate_rb/config_finder"
+require_relative "annotate_rb/config_loader"
 
 module AnnotateRb
-
 end

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

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
-require 'annotate_rb'
+
+require "annotate_rb"
 
 module AnnotateRb
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def copy_task
         copy_file "annotate_rb.rake", "lib/tasks/annotate_rb.rake"

data/lib/generators/annotate_rb/install/templates/annotate_rb.rake

@@ -1,7 +1,7 @@
 # This rake task was added by annotate_rb gem.
 
 if Rails.env.development?
-  require 'annotate_rb'
+  require "annotate_rb"
 
   AnnotateRb::Core.load_rake_tasks
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotaterb
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Andrew W. Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-20 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies: []
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
@@ -35,33 +35,39 @@ files:
 - 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/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_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_builder.rb
-- lib/annotate_rb/model_annotator/column_attributes_builder.rb
-- lib/annotate_rb/model_annotator/column_type_builder.rb
-- lib/annotate_rb/model_annotator/column_wrapper.rb
-- lib/annotate_rb/model_annotator/constants.rb
-- lib/annotate_rb/model_annotator/file_annotation_remover.rb
-- lib/annotate_rb/model_annotator/file_annotator.rb
-- lib/annotate_rb/model_annotator/file_annotator_instruction.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
+- lib/annotate_rb/model_annotator/column_annotation/column_wrapper.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_patterns.rb
-- lib/annotate_rb/model_annotator/foreign_key_annotation_builder.rb
-- lib/annotate_rb/model_annotator/helper.rb
-- lib/annotate_rb/model_annotator/index_annotation_builder.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_file_annotator.rb
 - lib/annotate_rb/model_annotator/model_files_getter.rb
 - lib/annotate_rb/model_annotator/model_wrapper.rb
 - lib/annotate_rb/model_annotator/pattern_getter.rb
+- lib/annotate_rb/model_annotator/project_annotation_remover.rb
+- lib/annotate_rb/model_annotator/project_annotator.rb
 - lib/annotate_rb/model_annotator/related_files_list_builder.rb
+- lib/annotate_rb/model_annotator/single_file_annotation_remover.rb
+- 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/options.rb
 - lib/annotate_rb/parser.rb
 - lib/annotate_rb/rake_bootstrapper.rb

data/lib/annotate_rb/model_annotator/column_annotation_builder.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-module AnnotateRb
-  module ModelAnnotator
-    class ColumnAnnotationBuilder
-      BARE_TYPE_ALLOWANCE = 16
-      MD_TYPE_ALLOWANCE = 18
-
-      def initialize(column, model, max_size, options)
-        @column = column
-        @model = model
-        @max_size = max_size
-        @options = options
-      end
-
-      def build
-        result = ''
-
-        is_primary_key = is_column_primary_key?(@model, @column.name)
-
-        table_indices = @model.retrieve_indexes_from_table
-        column_indices = table_indices.select { |ind| ind.columns.include?(@column.name) }
-
-        column_attributes = ColumnAttributesBuilder.new(@column, @options, is_primary_key, column_indices).build
-        formatted_column_type = ColumnTypeBuilder.new(@column, @options).build
-
-        col_name = if @model.with_comments? && @column.comment
-                     "#{@column.name}(#{@column.comment.gsub(/\n/, '\\n')})"
-                   else
-                     @column.name
-                   end
-
-        if @options[:format_rdoc]
-          result += format("# %-#{@max_size}.#{@max_size}s<tt>%s</tt>",
-                           "*#{col_name}*::",
-                           column_attributes.unshift(formatted_column_type).join(', ')).rstrip + "\n"
-        elsif @options[:format_yard]
-          result += sprintf("# @!attribute #{col_name}") + "\n"
-
-          if @column.respond_to?(:array) && @column.array
-            ruby_class = "Array<#{Helper.map_col_type_to_ruby_classes(formatted_column_type)}>"
-          else
-            ruby_class = Helper.map_col_type_to_ruby_classes(formatted_column_type)
-          end
-
-          result += sprintf("#   @return [#{ruby_class}]") + "\n"
-        elsif @options[:format_markdown]
-          name_remainder = @max_size - col_name.length - Helper.non_ascii_length(col_name)
-          type_remainder = (MD_TYPE_ALLOWANCE - 2) - formatted_column_type.length
-          result += format("# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`",
-                           col_name,
-                           ' ',
-                           formatted_column_type,
-                           ' ',
-                           column_attributes.join(', ').rstrip).gsub('``', '  ').rstrip + "\n"
-        else
-          result += format_default(col_name, @max_size, formatted_column_type, column_attributes)
-        end
-
-        result
-      end
-
-      private
-
-      def format_default(col_name, max_size, col_type, attrs)
-        format('#  %s:%s %s',
-               Helper.mb_chars_ljust(col_name, max_size),
-               Helper.mb_chars_ljust(col_type, BARE_TYPE_ALLOWANCE),
-               attrs.join(', ')).rstrip + "\n"
-      end
-
-      # TODO: Simplify this conditional
-      def is_column_primary_key?(model, column_name)
-        if model.primary_key
-          if model.primary_key.is_a?(Array)
-            # If the model has multiple primary keys, check if this column is one of them
-            if model.primary_key.collect(&:to_sym).include?(column_name.to_sym)
-              return true
-            end
-          else
-            # If model has 1 primary key, check if this column is it
-            if column_name.to_sym == model.primary_key.to_sym
-              return true
-            end
-          end
-        end
-
-        false
-      end
-    end
-  end
-end

data/lib/annotate_rb/model_annotator/column_attributes_builder.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-module AnnotateRb
-  module ModelAnnotator
-    class ColumnAttributesBuilder
-      # Don't show default value for these column types
-      NO_DEFAULT_COL_TYPES = %w[json jsonb hstore].freeze
-
-      def initialize(column, options, is_primary_key, column_indices)
-        @column = ColumnWrapper.new(column)
-        @options = options
-        @is_primary_key = is_primary_key
-        @column_indices = column_indices
-      end
-
-      # Get the list of attributes that should be included in the annotation for
-      # a given column.
-      def build
-        column_type = @column.column_type_string
-        attrs = []
-
-        unless @column.default.nil? || hide_default?
-          schema_default = "default(#{@column.default_string})"
-
-          attrs << schema_default
-        end
-
-        if @column.unsigned?
-          attrs << 'unsigned'
-        end
-
-        if !@column.null
-          attrs << 'not null'
-        end
-
-        if @is_primary_key
-          attrs << 'primary key'
-        end
-
-        is_special_type = %w[spatial geometry geography].include?(column_type)
-        is_decimal_type = column_type == 'decimal'
-
-        if !is_decimal_type && !is_special_type
-          if @column.limit && !@options[:format_yard]
-            if @column.limit.is_a?(Array)
-              attrs << "(#{@column.limit.join(', ')})"
-            end
-          end
-        end
-
-        # Check out if we got an array column
-        if @column.array?
-          attrs << 'is an Array'
-        end
-
-        # Check out if we got a geometric column
-        # and print the type and SRID
-        if @column.geometry_type?
-          attrs << "#{@column.geometry_type}, #{@column.srid}"
-        elsif @column.geometric_type? && @column.geometric_type.present?
-          attrs << "#{@column.geometric_type.to_s.downcase}, #{@column.srid}"
-        end
-
-        # Check if the column has indices and print "indexed" if true
-        # If the index includes another column, print it too.
-        if @options[:simple_indexes]
-          # Note: there used to be a klass.table_exists? call here, but removed it as it seemed unnecessary.
-
-          sorted_column_indices&.each do |index|
-            indexed_columns = index.columns.reject { |i| i == @column.name }
-
-            if indexed_columns.empty?
-              attrs << 'indexed'
-            else
-              attrs << "indexed => [#{indexed_columns.join(', ')}]"
-            end
-          end
-        end
-
-        attrs
-      end
-
-      def sorted_column_indices
-        # Not sure why there were & safe accessors here, but keeping in for time being.
-        sorted_indices = @column_indices&.sort_by(&:name)
-
-        _sorted_indices = sorted_indices.reject { |ind| ind.columns.is_a?(String) }
-      end
-
-      def hide_default?
-        excludes =
-          if @options[:hide_default_column_types].blank?
-            NO_DEFAULT_COL_TYPES
-          else
-            @options[:hide_default_column_types].split(',')
-          end
-
-        excludes.include?(@column.column_type_string)
-      end
-    end
-  end
-end

data/lib/annotate_rb/model_annotator/column_type_builder.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module AnnotateRb
-  module ModelAnnotator
-    class ColumnTypeBuilder
-      # Don't show limit (#) on these column types
-      # Example: show "integer" instead of "integer(4)"
-      NO_LIMIT_COL_TYPES = %w[integer bigint boolean].freeze
-
-      def initialize(column, options)
-        @column = ColumnWrapper.new(column)
-        @options = options
-      end
-
-      # Returns the formatted column type as a string.
-      def build
-        column_type = @column.column_type_string
-
-        formatted_column_type = column_type
-
-        is_special_type = %w[spatial geometry geography].include?(column_type)
-        is_decimal_type = column_type == 'decimal'
-
-        if is_decimal_type
-          formatted_column_type = "decimal(#{@column.precision}, #{@column.scale})"
-        elsif is_special_type
-          # Do nothing. Kept as a code fragment in case we need to do something here.
-        else
-          if @column.limit && !@options[:format_yard]
-            if !@column.limit.is_a?(Array) && !hide_limit?
-              formatted_column_type = column_type + "(#{@column.limit})"
-            end
-          end
-        end
-
-        formatted_column_type
-      end
-
-      def hide_limit?
-        excludes =
-          if @options[:hide_limit_column_types].blank?
-            NO_LIMIT_COL_TYPES
-          else
-            @options[:hide_limit_column_types].split(',')
-          end
-
-        excludes.include?(@column.column_type_string)
-      end
-    end
-  end
-end