annotate 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14932a4a189792b68c9d85c63313d0d60322ca22fed18a7a4a00edd47348743a
-  data.tar.gz: 351b61b7b3eac94f1ce6d8a86e1630bbbf6c0920cacfe46319163a86bc189887
+  metadata.gz: a49c914d3c2486e109b4a499b71fe905c8534e21b1d44cee15056a3066468e2e
+  data.tar.gz: 383445b9f5c13d02da7190a009ed974b5f88b41fe88f156814e743b4f7ec99d2
 SHA512:
-  metadata.gz: a717f48aff793ea4566fca6919eb4fe85b1545fe93b0bece91c5a9507cbb87fe14aa35ac520e618e98f8db92fe11010a8fe8653802b25b83b24590467e5d64f1
-  data.tar.gz: d13aab072e5e3901788f4aff809e08f3d28ac24cf0eed4187b0e5c0f98008f3c95a7553b58c4f50705f2f42729e96a05a57631356715953bb7d29531e4365fbd
+  metadata.gz: 70b926aba8e1ba91ccf506cfdabb94016efaaf788beaf6bdc0691fb6ad30edf57b794842f93f9860e1f82fa38c2934530e6fc0940f88ce4b47a909da8456ddd0
+  data.tar.gz: bf94c7d38b3a11ddc658947a7c1f2164854070a5707f56c148bcbdd5495b88c270ee0f0e587b07c0c421724b40059f110c808a8f3af90e68a86c5e249dfb1fa1

data/README.md

@@ -104,8 +104,8 @@ Into environment gems from Github checkout:
 
     git clone https://github.com/ctran/annotate_models.git annotate_models
     cd annotate_models
-    rake build
-    gem install pkg/annotate-*.gem
+    rake gem
+    gem install dist/annotate-*.gem
 
 ## Usage
 

data/annotate.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.executables = ['annotate']
   s.extra_rdoc_files = ['README.md', 'CHANGELOG.md']
   s.files = `git ls-files -z LICENSE.txt *.md *.gemspec bin lib`.split("\x0")
-  s.homepage = 'http://github.com/ctran/annotate_models'
+  s.homepage = 'https://github.com/ctran/annotate_models'
   s.licenses = ['Ruby']
   s.require_paths = ['lib']
   s.rubygems_version = '2.1.11'
@@ -23,7 +23,10 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4 if s.respond_to? :specification_version
   s.add_runtime_dependency(%q<rake>, '>= 10.4', '< 14.0')
-  s.add_runtime_dependency(%q<activerecord>, ['>= 3.2', '< 7.0'])
+  s.add_runtime_dependency(%q<activerecord>, ['>= 3.2', '< 8.0'])
 
-  s.metadata = { "github_repo" => "ssh://github.com/ctran/annotate_models" }
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/ctran/annotate_models/issues/",
+    "source_code_uri" => "https://github.com/ctran/annotate_models.git"
+  }
 end

data/lib/annotate/annotate_models/file_patterns.rb

@@ -0,0 +1,127 @@
+module AnnotateModels
+  # This module provides module method to get file paths.
+  module FilePatterns
+    # Controller files
+    CONTROLLER_DIR       = File.join('app', 'controllers')
+
+    # Active admin registry files
+    ACTIVEADMIN_DIR      = File.join('app', 'admin')
+
+    # Helper files
+    HELPER_DIR           = File.join('app', 'helpers')
+
+    # File.join for windows reverse bar compat?
+    # I dont use windows, can`t test
+    UNIT_TEST_DIR        = File.join('test', 'unit')
+    MODEL_TEST_DIR       = File.join('test', 'models') # since rails 4.0
+    SPEC_MODEL_DIR       = File.join('spec', 'models')
+
+    FIXTURE_TEST_DIR     = File.join('test', 'fixtures')
+    FIXTURE_SPEC_DIR     = File.join('spec', 'fixtures')
+
+    # Other test files
+    CONTROLLER_TEST_DIR  = File.join('test', 'controllers')
+    CONTROLLER_SPEC_DIR  = File.join('spec', 'controllers')
+    REQUEST_SPEC_DIR     = File.join('spec', 'requests')
+    ROUTING_SPEC_DIR     = File.join('spec', 'routing')
+
+    # Object Daddy http://github.com/flogic/object_daddy/tree/master
+    EXEMPLARS_TEST_DIR   = File.join('test', 'exemplars')
+    EXEMPLARS_SPEC_DIR   = File.join('spec', 'exemplars')
+
+    # Machinist http://github.com/notahat/machinist
+    BLUEPRINTS_TEST_DIR  = File.join('test', 'blueprints')
+    BLUEPRINTS_SPEC_DIR  = File.join('spec', 'blueprints')
+
+    # Factory Bot https://github.com/thoughtbot/factory_bot
+    FACTORY_BOT_TEST_DIR = File.join('test', 'factories')
+    FACTORY_BOT_SPEC_DIR = File.join('spec', 'factories')
+
+    # Fabrication https://github.com/paulelliott/fabrication.git
+    FABRICATORS_TEST_DIR = File.join('test', 'fabricators')
+    FABRICATORS_SPEC_DIR = File.join('spec', 'fabricators')
+
+    # Serializers https://github.com/rails-api/active_model_serializers
+    SERIALIZERS_DIR      = File.join('app',  'serializers')
+    SERIALIZERS_TEST_DIR = File.join('test', 'serializers')
+    SERIALIZERS_SPEC_DIR = File.join('spec', 'serializers')
+
+    class << self
+      def generate(root_directory, pattern_type, options)
+        case pattern_type
+        when 'test'       then test_files(root_directory)
+        when 'fixture'    then fixture_files(root_directory)
+        when 'scaffold'   then scaffold_files(root_directory)
+        when 'factory'    then factory_files(root_directory)
+        when 'serializer' then serialize_files(root_directory)
+        when 'additional_file_patterns'
+          [options[:additional_file_patterns] || []].flatten
+        when 'controller'
+          [File.join(root_directory, CONTROLLER_DIR, '%PLURALIZED_MODEL_NAME%_controller.rb')]
+        when 'admin'
+          [
+            File.join(root_directory, ACTIVEADMIN_DIR, '%MODEL_NAME%.rb'),
+            File.join(root_directory, ACTIVEADMIN_DIR, '%PLURALIZED_MODEL_NAME%.rb')
+          ]
+        when 'helper'
+          [File.join(root_directory, HELPER_DIR, '%PLURALIZED_MODEL_NAME%_helper.rb')]
+        else
+          []
+        end
+      end
+
+      private
+
+      def test_files(root_directory)
+        [
+          File.join(root_directory, UNIT_TEST_DIR,  '%MODEL_NAME%_test.rb'),
+          File.join(root_directory, MODEL_TEST_DIR, '%MODEL_NAME%_test.rb'),
+          File.join(root_directory, SPEC_MODEL_DIR, '%MODEL_NAME%_spec.rb')
+        ]
+      end
+
+      def fixture_files(root_directory)
+        [
+          File.join(root_directory, FIXTURE_TEST_DIR, '%TABLE_NAME%.yml'),
+          File.join(root_directory, FIXTURE_SPEC_DIR, '%TABLE_NAME%.yml'),
+          File.join(root_directory, FIXTURE_TEST_DIR, '%PLURALIZED_MODEL_NAME%.yml'),
+          File.join(root_directory, FIXTURE_SPEC_DIR, '%PLURALIZED_MODEL_NAME%.yml')
+        ]
+      end
+
+      def scaffold_files(root_directory)
+        [
+          File.join(root_directory, CONTROLLER_TEST_DIR, '%PLURALIZED_MODEL_NAME%_controller_test.rb'),
+          File.join(root_directory, CONTROLLER_SPEC_DIR, '%PLURALIZED_MODEL_NAME%_controller_spec.rb'),
+          File.join(root_directory, REQUEST_SPEC_DIR,    '%PLURALIZED_MODEL_NAME%_spec.rb'),
+          File.join(root_directory, ROUTING_SPEC_DIR,    '%PLURALIZED_MODEL_NAME%_routing_spec.rb')
+        ]
+      end
+
+      def factory_files(root_directory)
+        [
+          File.join(root_directory, EXEMPLARS_TEST_DIR,   '%MODEL_NAME%_exemplar.rb'),
+          File.join(root_directory, EXEMPLARS_SPEC_DIR,   '%MODEL_NAME%_exemplar.rb'),
+          File.join(root_directory, BLUEPRINTS_TEST_DIR,  '%MODEL_NAME%_blueprint.rb'),
+          File.join(root_directory, BLUEPRINTS_SPEC_DIR,  '%MODEL_NAME%_blueprint.rb'),
+          File.join(root_directory, FACTORY_BOT_TEST_DIR, '%MODEL_NAME%_factory.rb'),    # (old style)
+          File.join(root_directory, FACTORY_BOT_SPEC_DIR, '%MODEL_NAME%_factory.rb'),    # (old style)
+          File.join(root_directory, FACTORY_BOT_TEST_DIR, '%TABLE_NAME%.rb'),            # (new style)
+          File.join(root_directory, FACTORY_BOT_SPEC_DIR, '%TABLE_NAME%.rb'),            # (new style)
+          File.join(root_directory, FACTORY_BOT_TEST_DIR, '%PLURALIZED_MODEL_NAME%.rb'), # (new style)
+          File.join(root_directory, FACTORY_BOT_SPEC_DIR, '%PLURALIZED_MODEL_NAME%.rb'), # (new style)
+          File.join(root_directory, FABRICATORS_TEST_DIR, '%MODEL_NAME%_fabricator.rb'),
+          File.join(root_directory, FABRICATORS_SPEC_DIR, '%MODEL_NAME%_fabricator.rb')
+        ]
+      end
+
+      def serialize_files(root_directory)
+        [
+          File.join(root_directory, SERIALIZERS_DIR,      '%MODEL_NAME%_serializer.rb'),
+          File.join(root_directory, SERIALIZERS_TEST_DIR, '%MODEL_NAME%_serializer_test.rb'),
+          File.join(root_directory, SERIALIZERS_SPEC_DIR, '%MODEL_NAME%_serializer_spec.rb')
+        ]
+      end
+    end
+  end
+end

data/lib/annotate/annotate_models.rb

@@ -3,6 +3,7 @@
 require 'bigdecimal'
 
 require 'annotate/constants'
+require_relative 'annotate_models/file_patterns'
 
 module AnnotateModels
   # Annotate Models plugin use this header
@@ -16,50 +17,6 @@ module AnnotateModels
 
   MATCHED_TYPES = %w(test fixture factory serializer scaffold controller helper).freeze
 
-  # File.join for windows reverse bar compat?
-  # I dont use windows, can`t test
-  UNIT_TEST_DIR         = File.join('test', "unit")
-  MODEL_TEST_DIR        = File.join('test', "models") # since rails 4.0
-  SPEC_MODEL_DIR        = File.join('spec', "models")
-  FIXTURE_TEST_DIR      = File.join('test', "fixtures")
-  FIXTURE_SPEC_DIR      = File.join('spec', "fixtures")
-
-  # Other test files
-  CONTROLLER_TEST_DIR   = File.join('test', "controllers")
-  CONTROLLER_SPEC_DIR   = File.join('spec', "controllers")
-  REQUEST_SPEC_DIR      = File.join('spec', "requests")
-  ROUTING_SPEC_DIR      = File.join('spec', "routing")
-
-  # Object Daddy http://github.com/flogic/object_daddy/tree/master
-  EXEMPLARS_TEST_DIR    = File.join('test', "exemplars")
-  EXEMPLARS_SPEC_DIR    = File.join('spec', "exemplars")
-
-  # Machinist http://github.com/notahat/machinist
-  BLUEPRINTS_TEST_DIR   = File.join('test', "blueprints")
-  BLUEPRINTS_SPEC_DIR   = File.join('spec', "blueprints")
-
-  # Factory Bot https://github.com/thoughtbot/factory_bot
-  FACTORY_BOT_TEST_DIR = File.join('test', "factories")
-  FACTORY_BOT_SPEC_DIR = File.join('spec', "factories")
-
-  # Fabrication https://github.com/paulelliott/fabrication.git
-  FABRICATORS_TEST_DIR  = File.join('test', "fabricators")
-  FABRICATORS_SPEC_DIR  = File.join('spec', "fabricators")
-
-  # Serializers https://github.com/rails-api/active_model_serializers
-  SERIALIZERS_DIR       = File.join('app',  "serializers")
-  SERIALIZERS_TEST_DIR  = File.join('test', "serializers")
-  SERIALIZERS_SPEC_DIR  = File.join('spec', "serializers")
-
-  # Controller files
-  CONTROLLER_DIR        = File.join('app', "controllers")
-
-  # Active admin registry files
-  ACTIVEADMIN_DIR        = File.join('app', "admin")
-
-  # Helper files
-  HELPER_DIR            = File.join('app', "helpers")
-
   # Don't show limit (#) on these column types
   # Example: show "integer" instead of "integer(4)"
   NO_LIMIT_COL_TYPES = %w(integer bigint boolean).freeze
@@ -110,82 +67,24 @@ module AnnotateModels
 
     attr_writer :root_dir
 
-    def test_files(root_directory)
-      [
-        File.join(root_directory, UNIT_TEST_DIR,  "%MODEL_NAME%_test.rb"),
-        File.join(root_directory, MODEL_TEST_DIR,  "%MODEL_NAME%_test.rb"),
-        File.join(root_directory, SPEC_MODEL_DIR, "%MODEL_NAME%_spec.rb")
-      ]
-    end
-
-    def fixture_files(root_directory)
-      [
-        File.join(root_directory, FIXTURE_TEST_DIR, "%TABLE_NAME%.yml"),
-        File.join(root_directory, FIXTURE_SPEC_DIR, "%TABLE_NAME%.yml"),
-        File.join(root_directory, FIXTURE_TEST_DIR, "%PLURALIZED_MODEL_NAME%.yml"),
-        File.join(root_directory, FIXTURE_SPEC_DIR, "%PLURALIZED_MODEL_NAME%.yml")
-      ]
-    end
-
-    def scaffold_files(root_directory)
-      [
-        File.join(root_directory, CONTROLLER_TEST_DIR, "%PLURALIZED_MODEL_NAME%_controller_test.rb"),
-        File.join(root_directory, CONTROLLER_SPEC_DIR, "%PLURALIZED_MODEL_NAME%_controller_spec.rb"),
-        File.join(root_directory, REQUEST_SPEC_DIR,    "%PLURALIZED_MODEL_NAME%_spec.rb"),
-        File.join(root_directory, ROUTING_SPEC_DIR,    "%PLURALIZED_MODEL_NAME%_routing_spec.rb")
-      ]
-    end
-
-    def factory_files(root_directory)
-      [
-        File.join(root_directory, EXEMPLARS_TEST_DIR,     "%MODEL_NAME%_exemplar.rb"),
-        File.join(root_directory, EXEMPLARS_SPEC_DIR,     "%MODEL_NAME%_exemplar.rb"),
-        File.join(root_directory, BLUEPRINTS_TEST_DIR,    "%MODEL_NAME%_blueprint.rb"),
-        File.join(root_directory, BLUEPRINTS_SPEC_DIR,    "%MODEL_NAME%_blueprint.rb"),
-        File.join(root_directory, FACTORY_BOT_TEST_DIR,  "%MODEL_NAME%_factory.rb"),    # (old style)
-        File.join(root_directory, FACTORY_BOT_SPEC_DIR,  "%MODEL_NAME%_factory.rb"),    # (old style)
-        File.join(root_directory, FACTORY_BOT_TEST_DIR,  "%TABLE_NAME%.rb"),            # (new style)
-        File.join(root_directory, FACTORY_BOT_SPEC_DIR,  "%TABLE_NAME%.rb"),            # (new style)
-        File.join(root_directory, FACTORY_BOT_TEST_DIR,  "%PLURALIZED_MODEL_NAME%.rb"), # (new style)
-        File.join(root_directory, FACTORY_BOT_SPEC_DIR,  "%PLURALIZED_MODEL_NAME%.rb"), # (new style)
-        File.join(root_directory, FABRICATORS_TEST_DIR,   "%MODEL_NAME%_fabricator.rb"),
-        File.join(root_directory, FABRICATORS_SPEC_DIR,   "%MODEL_NAME%_fabricator.rb")
-      ]
-    end
-
-    def serialize_files(root_directory)
-      [
-        File.join(root_directory, SERIALIZERS_DIR,       "%MODEL_NAME%_serializer.rb"),
-        File.join(root_directory, SERIALIZERS_TEST_DIR,  "%MODEL_NAME%_serializer_test.rb"),
-        File.join(root_directory, SERIALIZERS_SPEC_DIR,  "%MODEL_NAME%_serializer_spec.rb")
-      ]
-    end
+    def skip_subdirectory_model_load
+      # This option is set in options[:skip_subdirectory_model_load]
+      # and stops the get_loaded_model method from loading a model from a subdir
 
-    def files_by_pattern(root_directory, pattern_type, options)
-      case pattern_type
-      when 'test'       then test_files(root_directory)
-      when 'fixture'    then fixture_files(root_directory)
-      when 'scaffold'   then scaffold_files(root_directory)
-      when 'factory'    then factory_files(root_directory)
-      when 'serializer' then serialize_files(root_directory)
-      when 'additional_file_patterns'
-        [options[:additional_file_patterns] || []].flatten
-      when 'controller'
-        [File.join(root_directory, CONTROLLER_DIR, "%PLURALIZED_MODEL_NAME%_controller.rb")]
-      when 'admin'
-        [File.join(root_directory, ACTIVEADMIN_DIR, "%MODEL_NAME%.rb")]
-      when 'helper'
-        [File.join(root_directory, HELPER_DIR, "%PLURALIZED_MODEL_NAME%_helper.rb")]
+      if @skip_subdirectory_model_load.blank?
+        false
       else
-        []
+        @skip_subdirectory_model_load
       end
     end
 
+    attr_writer :skip_subdirectory_model_load
+
     def get_patterns(options, pattern_types = [])
       current_patterns = []
       root_dir.each do |root_directory|
         Array(pattern_types).each do |pattern_type|
-          patterns = files_by_pattern(root_directory, pattern_type, options)
+          patterns = FilePatterns.generate(root_directory, pattern_type, options)
 
           current_patterns += if pattern_type.to_sym == :additional_file_patterns
                                 patterns
@@ -249,52 +148,13 @@ module AnnotateModels
       cols = columns(klass, options)
       cols.each do |col|
         col_type = get_col_type(col)
-        attrs = []
-        attrs << "default(#{schema_default(klass, col)})" unless col.default.nil? || hide_default?(col_type, options)
-        attrs << 'unsigned' if col.respond_to?(:unsigned?) && col.unsigned?
-        attrs << 'not null' unless col.null
-        attrs << 'primary key' if klass.primary_key && (klass.primary_key.is_a?(Array) ? klass.primary_key.collect(&:to_sym).include?(col.name.to_sym) : col.name.to_sym == klass.primary_key.to_sym)
-
-        if col_type == 'decimal'
-          col_type << "(#{col.precision}, #{col.scale})"
-        elsif !%w[spatial geometry geography].include?(col_type)
-          if col.limit && !options[:format_yard]
-            if col.limit.is_a? Array
-              attrs << "(#{col.limit.join(', ')})"
-            else
-              col_type << "(#{col.limit})" unless hide_limit?(col_type, options)
-            end
-          end
-        end
-
-        # Check out if we got an array column
-        attrs << 'is an Array' if col.respond_to?(:array) && col.array
-
-        # Check out if we got a geometric column
-        # and print the type and SRID
-        if col.respond_to?(:geometry_type)
-          attrs << "#{col.geometry_type}, #{col.srid}"
-        elsif col.respond_to?(:geometric_type) && col.geometric_type.present?
-          attrs << "#{col.geometric_type.to_s.downcase}, #{col.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] && klass.table_exists?# Check out if this column is indexed
-          indices = retrieve_indexes_from_table(klass)
-          if indices = indices.select { |ind| ind.columns.include? col.name }
-            indices.sort_by(&:name).each do |ind|
-              next if ind.columns.is_a?(String)
-              ind = ind.columns.reject! { |i| i == col.name }
-              attrs << (ind.empty? ? "indexed" : "indexed => [#{ind.join(", ")}]")
-            end
-          end
-        end
+        attrs = get_attributes(col, col_type, klass, options)
         col_name = if with_comments?(klass, options) && col.comment
-                     "#{col.name}(#{col.comment})"
+                     "#{col.name}(#{col.comment.gsub(/\n/, "\\n")})"
                    else
                      col.name
                    end
+
         if options[:format_rdoc]
           info << sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col_name}*::", attrs.unshift(col_type).join(", ")).rstrip + "\n"
         elsif options[:format_yard]
@@ -739,14 +599,17 @@ module AnnotateModels
 
     # Retrieve loaded model class
     def get_loaded_model(model_path, file)
-      loaded_model_class = get_loaded_model_by_path(model_path)
-      return loaded_model_class if loaded_model_class
+      unless skip_subdirectory_model_load
+        loaded_model_class = get_loaded_model_by_path(model_path)
+        return loaded_model_class if loaded_model_class
+      end
 
       # We cannot get loaded model when `model_path` is loaded by Rails
       # auto_load/eager_load paths. Try all possible model paths one by one.
       absolute_file = File.expand_path(file)
       model_paths =
-        $LOAD_PATH.select { |path| absolute_file.include?(path) }
+        $LOAD_PATH.map(&:to_s)
+                  .select { |path| absolute_file.include?(path) }
                   .map { |path| absolute_file.sub(path, '').sub(/\.rb$/, '').sub(/^\//, '') }
       model_paths
         .map { |path| get_loaded_model_by_path(path) }
@@ -769,6 +632,7 @@ module AnnotateModels
     def parse_options(options = {})
       self.model_dir = split_model_dir(options[:model_dir]) if options[:model_dir]
       self.root_dir = options[:root_dir] if options[:root_dir]
+      self.skip_subdirectory_model_load = options[:skip_subdirectory_model_load].present?
     end
 
     def split_model_dir(option_value)
@@ -809,7 +673,7 @@ module AnnotateModels
       begin
         return false if /#{SKIP_ANNOTATION_PREFIX}.*/ =~ (File.exist?(file) ? File.read(file) : '')
         klass = get_model_class(file)
-        do_annotate = klass &&
+        do_annotate = klass.is_a?(Class) &&
           klass < ActiveRecord::Base &&
           (!options[:exclude_sti_subclasses] || !(klass.superclass < ActiveRecord::Base && klass.table_name == klass.superclass.table_name)) &&
           !klass.abstract_class? &&
@@ -982,9 +846,7 @@ module AnnotateModels
       # Construct the foreign column name in the translations table
       # eg. Model: Car, foreign column name: car_id
       foreign_column_name = [
-        klass.translation_class.to_s
-             .gsub('::Translation', '').gsub('::', '_')
-             .downcase,
+        klass.table_name.to_s.singularize,
         '_id'
       ].join.to_sym
 
@@ -996,6 +858,55 @@ module AnnotateModels
         foreign_column_name
       ]
     end
+
+    ##
+    # Get the list of attributes that should be included in the annotation for
+    # a given column.
+    def get_attributes(column, column_type, klass, options)
+      attrs = []
+      attrs << "default(#{schema_default(klass, column)})" unless column.default.nil? || hide_default?(column_type, options)
+      attrs << 'unsigned' if column.respond_to?(:unsigned?) && column.unsigned?
+      attrs << 'not null' unless column.null
+      attrs << 'primary key' if klass.primary_key && (klass.primary_key.is_a?(Array) ? klass.primary_key.collect(&:to_sym).include?(column.name.to_sym) : column.name.to_sym == klass.primary_key.to_sym)
+
+      if column_type == 'decimal'
+        column_type << "(#{column.precision}, #{column.scale})"
+      elsif !%w[spatial geometry geography].include?(column_type)
+        if column.limit && !options[:format_yard]
+          if column.limit.is_a? Array
+            attrs << "(#{column.limit.join(', ')})"
+          else
+            column_type << "(#{column.limit})" unless hide_limit?(column_type, options)
+          end
+        end
+      end
+
+      # Check out if we got an array column
+      attrs << 'is an Array' if column.respond_to?(:array) && column.array
+
+      # Check out if we got a geometric column
+      # and print the type and SRID
+      if column.respond_to?(:geometry_type)
+        attrs << [column.geometry_type, column.try(:srid)].compact.join(', ')
+      elsif column.respond_to?(:geometric_type) && column.geometric_type.present?
+        attrs << [column.geometric_type.to_s.downcase, column.try(:srid)].compact.join(', ')
+      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] && klass.table_exists?# Check out if this column is indexed
+        indices = retrieve_indexes_from_table(klass)
+        if indices = indices.select { |ind| ind.columns.include? column.name }
+          indices.sort_by(&:name).each do |ind|
+            next if ind.columns.is_a?(String)
+            ind = ind.columns.reject! { |i| i == column.name }
+            attrs << (ind.empty? ? "indexed" : "indexed => [#{ind.join(", ")}]")
+          end
+        end
+      end
+
+      attrs
+    end
   end
 
   class BadModelFileError < LoadError

data/lib/annotate/annotate_routes/header_generator.rb

@@ -0,0 +1,113 @@
+require_relative './helpers'
+
+module AnnotateRoutes
+  class HeaderGenerator
+    PREFIX = '== Route Map'.freeze
+    PREFIX_MD = '## Route Map'.freeze
+    HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
+
+    class << self
+      def generate(options = {})
+        new(options, routes_map(options)).generate
+      end
+
+      private :new
+
+      private
+
+      def routes_map(options)
+        result = `rake routes`.chomp("\n").split(/\n/, -1)
+
+        # 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 \/}
+
+        ignore_routes = options[:ignore_routes]
+        regexp_for_ignoring_routes = ignore_routes ? /#{ignore_routes}/ : nil
+
+        # Skip routes which match given regex
+        # Note: it matches the complete line (route_name, path, controller/action)
+        if regexp_for_ignoring_routes
+          result.reject { |line| line =~ regexp_for_ignoring_routes }
+        else
+          result
+        end
+      end
+    end
+
+    def initialize(options, routes_map)
+      @options = options
+      @routes_map = routes_map
+    end
+
+    def generate
+      magic_comments_map, contents_without_magic_comments = Helpers.extract_magic_comments_from_array(routes_map)
+
+      out = []
+
+      magic_comments_map.each do |magic_comment|
+        out << magic_comment
+      end
+      out << '' if magic_comments_map.any?
+
+      out << comment(options[:wrapper_open]) if options[:wrapper_open]
+
+      out << comment(markdown? ? PREFIX_MD : PREFIX) + timestamp_if_required
+      out << comment
+      return out if contents_without_magic_comments.size.zero?
+
+      maxs = [HEADER_ROW.map(&:size)] + contents_without_magic_comments[1..-1].map { |line| line.split.map(&:size) }
+
+      if markdown?
+        max = maxs.map(&:max).compact.max
+
+        out << comment(content(HEADER_ROW, 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 << comment(options[:wrapper_close]) if options[:wrapper_close]
+
+      out
+    end
+
+    private
+
+    attr_reader :options, :routes_map
+
+    def comment(row = '')
+      if row == ''
+        '#'
+      else
+        "# #{row}"
+      end
+    end
+
+    def content(line, maxs)
+      return line.rstrip unless markdown?
+
+      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('|', '-'))
+    end
+
+    def markdown?
+      options[:format_markdown]
+    end
+
+    def timestamp_if_required(time = Time.now)
+      if options[:timestamp]
+        time_formatted = time.strftime('%Y-%m-%d %H:%M')
+        " (Updated #{time_formatted})"
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/annotate/annotate_routes.rb

@@ -1,5 +1,3 @@
-# rubocop:disable  Metrics/ModuleLength
-
 # == Annotate Routes
 #
 # Based on:
@@ -21,18 +19,15 @@
 #
 
 require_relative './annotate_routes/helpers'
+require_relative './annotate_routes/header_generator'
 
 module AnnotateRoutes
-  PREFIX = '== Route Map'.freeze
-  PREFIX_MD = '## Route Map'.freeze
-  HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
-
   class << self
     def do_annotations(options = {})
       if routes_file_exist?
         existing_text = File.read(routes_file)
         content, header_position = Helpers.strip_annotations(existing_text)
-        new_content = annotate_routes(header(options), content, header_position, options)
+        new_content = annotate_routes(HeaderGenerator.generate(options), content, header_position, options)
         new_text = new_content.join("\n")
 
         if rewrite_contents(existing_text, new_text)
@@ -71,49 +66,6 @@ module AnnotateRoutes
       @routes_rb ||= File.join('config', 'routes.rb')
     end
 
-    def header(options = {})
-      routes_map = app_routes_map(options)
-
-      magic_comments_map, routes_map = Helpers.extract_magic_comments_from_array(routes_map)
-
-      out = []
-
-      magic_comments_map.each do |magic_comment|
-        out << magic_comment
-      end
-      out << '' if magic_comments_map.any?
-
-      out << comment(options[:wrapper_open]) if options[:wrapper_open]
-
-      out << comment(options[:format_markdown] ? PREFIX_MD : PREFIX) + (options[:timestamp] ? " (Updated #{Time.now.strftime('%Y-%m-%d %H:%M')})" : '')
-      out << comment
-      return out if routes_map.size.zero?
-
-      maxs = [HEADER_ROW.map(&:size)] + routes_map[1..-1].map { |line| line.split.map(&:size) }
-
-      if options[:format_markdown]
-        max = maxs.map(&:max).compact.max
-
-        out << comment(content(HEADER_ROW, maxs, options))
-        out << comment(content(['-' * max, '-' * max, '-' * max, '-' * max], maxs, options))
-      else
-        out << comment(content(routes_map[0], maxs, options))
-      end
-
-      out += routes_map[1..-1].map { |line| comment(content(options[:format_markdown] ? line.split(' ') : line, maxs, options)) }
-      out << comment(options[:wrapper_close]) if options[:wrapper_close]
-
-      out
-    end
-
-    def comment(row = '')
-      if row == ''
-        '#'
-      else
-        "# #{row}"
-      end
-    end
-
     def strip_on_removal(content, header_position)
       if header_position == :before
         content.shift while content.first == ''
@@ -162,32 +114,5 @@ module AnnotateRoutes
 
       new_content
     end
-
-    def app_routes_map(options)
-      routes_map = `rake routes`.chomp("\n").split(/\n/, -1)
-
-      # 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.
-      routes_map.shift if routes_map.first =~ /^\(in \//
-
-      # Skip routes which match given regex
-      # Note: it matches the complete line (route_name, path, controller/action)
-      if options[:ignore_routes]
-        routes_map.reject! { |line| line =~ /#{options[:ignore_routes]}/ }
-      end
-
-      routes_map
-    end
-
-    def content(line, maxs, options = {})
-      return line.rstrip unless options[:format_markdown]
-
-      line.each_with_index.map do |elem, index|
-        min_length = maxs.map { |arr| arr[index] }.max || 0
-
-        sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
-      end.join(' | ')
-    end
   end
 end

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '3.1.1'
+    '3.2.0'
   end
 end

data/lib/tasks/annotate_models_migrate.rake

@@ -4,7 +4,20 @@
 # Append annotations to Rake tasks for ActiveRecord, so annotate automatically gets
 # run after doing db:migrate.
 
-%w(db:migrate db:migrate:up db:migrate:down db:migrate:reset db:migrate:redo db:rollback).each do |task|
+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
+
+  ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |spec_name|
+    migration_tasks.concat(%w(db:migrate db:migrate:up db:migrate:down).map { |task| "#{task}:#{spec_name}" })
+  end
+end
+
+migration_tasks.each do |task|
+  next unless Rake::Task.task_defined?(task)
+
   Rake::Task[task].enhance do
     Rake::Task[Rake.application.top_level_tasks.last].enhance do
       annotation_options_task = if Rake::Task.task_defined?('app:set_annotation_options')

data/lib/tasks/annotate_routes.rake

@@ -1,6 +1,12 @@
+annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
+
+unless ENV['is_cli']
+  task :set_annotation_options
+  task annotate_routes: :set_annotation_options
+end
+
 desc "Adds the route map to routes.rb"
 task :annotate_routes => :environment do
-  annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
   require "#{annotate_lib}/annotate/annotate_routes"
 
   options={}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Alex Chaffee
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -43,7 +43,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
 email:
@@ -79,7 +79,9 @@ files:
 - lib/annotate.rb
 - lib/annotate/active_record_patch.rb
 - lib/annotate/annotate_models.rb
+- lib/annotate/annotate_models/file_patterns.rb
 - lib/annotate/annotate_routes.rb
+- lib/annotate/annotate_routes/header_generator.rb
 - lib/annotate/annotate_routes/helpers.rb
 - lib/annotate/constants.rb
 - lib/annotate/helpers.rb
@@ -93,11 +95,12 @@ files:
 - lib/tasks/annotate_models_migrate.rake
 - lib/tasks/annotate_routes.rake
 - potato.md
-homepage: http://github.com/ctran/annotate_models
+homepage: https://github.com/ctran/annotate_models
 licenses:
 - Ruby
 metadata:
-  github_repo: ssh://github.com/ctran/annotate_models
+  bug_tracker_uri: https://github.com/ctran/annotate_models/issues/
+  source_code_uri: https://github.com/ctran/annotate_models.git
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -113,8 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database