annotate 2.7.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c80b25d2326ba60d78120276156ea6223fd07024dd9b9c771d4fa405f68204
-  data.tar.gz: 6e8409e098cdecbc97053480e8948f04e4cba6c758b8035255d5e027ed46097d
+  metadata.gz: 0e4ee3c38fb2ebf3d88712e8836f00570e891cd1a43a6c2bc32c95dc35b7a0d2
+  data.tar.gz: 1082be239480425543d84491e8c03d54ad99b362cc142b93224517499d4417fa
 SHA512:
-  metadata.gz: 0b8dcb130221c519f1639d8fbea17f0047e915ad6fc7cb3a95cdb9f20b6d25088b04f8cd181519f8ef4ce39e62986d9edee7cabd2824673a4c41878e27d6c24d
-  data.tar.gz: f0b1f5b74e818782c6ecda0aafe926a055734f5aaaf9ef82592a3dfcfe96d4589b82f6253b4cc72595e6aeef0fa8e07c177c6a0ef70f8511ceeea81ef167b122
+  metadata.gz: 4896d07fc9b6d6b95d5916e566cc0d9a304cd16c1592ac0a0546bb273d533c7dfb275c55b2833586e677027e7f34f6a4f38281053e6e454553be527f4e23055c
+  data.tar.gz: c72e8ba788014600e40ba24fe7385b9c6c10c08d293ee98bd71e0d91cc235c1a14242293ae963c9265c8e318fa09a104e60547a24c7697218b06be68f320fa63

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== 3.0.0
+* Added `--models` CLI option fixing issue #563 (#647)
+* Added `--additional_file_patterns` option for additional file patterns (#633) #636) #637)
+* Refactored CLI parser (#646)
+* Fixed BigDecimal.new deprecation warning (#634)
+* Fixed annotations for columns with long data types (#622)
+* Made methods private in AnnotateRoutes (#598)
+
+See https://github.com/ctran/annotate_models/releases/tag/v3.0.0
+
 == 2.7.5
 See https://github.com/ctran/annotate_models/releases/tag/v2.7.5
 

data/README.rdoc

@@ -6,7 +6,6 @@
 {<img src="https://coveralls.io/repos/ctran/annotate_models/badge.svg?branch=develop" />}[https://coveralls.io/r/ctran/annotate_models?branch=develop]
 {<img src="https://codeclimate.com/github/ctran/annotate_models/badges/gpa.svg" />}[https://codeclimate.com/github/ctran/annotate_models]
 {<img src="http://inch-ci.org/github/ctran/annotate_models.svg?branch=develop" alt="Inline docs" />}[http://inch-ci.org/github/ctran/annotate_models]
-{<img src="https://gemnasium.com/ctran/annotate_models.png" />}[https://gemnasium.com/ctran/annotate_models]
 
 Add a comment summarizing the current schema to the top or bottom of each of
 your...
@@ -90,11 +89,11 @@ To annotate all your models, tests, fixtures, and factories:
 
 To annotate just your models, tests, and factories:
 
-    annotate --exclude fixtures
+    annotate --models --exclude fixtures
 
 To annotate just your models:
 
-    annotate --exclude tests,fixtures,factories,serializers
+    annotate --models
 
 To annotate routes.rb:
 
@@ -164,6 +163,7 @@ you can do so with a simple environment variable, instead of editing the
 == Options
 
     Usage: annotate [options] [model_file]*
+            --additional_file_patterns   Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
         -d, --delete                     Remove annotations from all model files or the routes.rb file
         -p [before|top|after|bottom],    Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)
             --position
@@ -184,6 +184,7 @@ you can do so with a simple environment variable, instead of editing the
             --wo, --wrapper-open STR     Annotation wrapper opening.
             --wc, --wrapper-close STR    Annotation wrapper closing
         -r, --routes                     Annotate routes.rb with the output of 'rake routes'
+            --models                     Annotate ActiveRecord models
         -a, --active-admin               Annotate active_admin models
         -v, --version                    Show the current version of this gem
         -m, --show-migration             Include the migration version number in the annotation
@@ -206,16 +207,35 @@ you can do so with a simple environment variable, instead of editing the
             --frozen                     Do not allow to change annotations. Exits non-zero if there are going to be changes to files.
             --timestamp                  Include timestamp in (routes) annotation
             --trace                      If unable to annotate a file, print the full stack trace, not just the exception message.
-        -I, --ignore-columns REGEX       don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`
-            --ignore-routes REGEX        don't annotate routes that match a given REGEX (i.e., `annotate -I '(mobile|resque|pghero)'`
+        -I, --ignore-columns REGEX       don't annotate columns that match a given REGEX (e.g. `annotate -I '^(id|updated_at|created_at)'`)
+            --ignore-routes REGEX        don't annotate routes that match a given REGEX (e.g. `annotate -I '(mobile|resque|pghero)'`)_
             --hide-limit-column-types VALUES
-                                         don't show limit for given column types, separated by commas (i.e., `integer,boolean,text`)
+                                         don't show limit for given column types, separated by commas (e.g. `integer,boolean,text`)
             --hide-default-column-types VALUES
-                                         don't show default for given column types, separated by commas (i.e., `json,jsonb,hstore`)
+                                         don't show default for given column types, separated by commas (e.g. `json,jsonb,hstore`)
             --ignore-unknown-models      don't display warnings for bad model files
             --with-comment               include database comments in model annotations
 
+=== Option: +additional_file_patterns+
 
+CLI: +--additional_file_patterns+<br>
+Ruby: +:additional_file_patterns+
+
+Provide additional paths for the gem to annotate.  These paths can include globs.
+It is recommended to use absolute paths.  Here are some examples:
+
+
+- <code>/app/lib/decorates/%MODEL_NAME%/&ast;.rb</code>
+- <code>/app/lib/forms/%PLURALIZED_MODEL_NAME%/&ast;&ast;/&ast;.rb</code>
+- <code>/app/lib/forms/%TABLE_NAME%/&ast;.rb</code>
+
+The appropriate model will be inferred using the <code>%*%</code> syntax, annotating any matching files.
+It works with existing filename resolutions (options for which can be found in the +resolve_filename+ method of
++annotate_models.rb+).
+
+When using in a Rails config, you can use the following:
+
+<code>File.join(Rails.application.root, 'app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb')</code>
 
 == Sorting
 

data/annotate.gemspec

@@ -38,7 +38,6 @@ Gem::Specification.new do |s|
   s.homepage = 'http://github.com/ctran/annotate_models'
   s.licenses = ['Ruby']
   s.require_paths = ['lib']
-  s.rubyforge_project = 'annotate'
   s.rubygems_version = '2.1.11'
   s.summary = 'Annotates Rails Models, routes, fixtures, and others based on the database schema.'
 

data/bin/annotate

@@ -14,203 +14,19 @@ end
 here = File.expand_path(File.dirname __FILE__)
 $LOAD_PATH << "#{here}/../lib"
 
-require 'optparse'
 require 'annotate'
-Annotate.bootstrap_rake
-
-has_set_position = {}
-target_action = :do_annotations
-positions = %w(before top after bottom)
-
-OptionParser.new do |opts|
-  opts.banner = 'Usage: annotate [options] [model_file]*'
-
-  opts.on('-d', '--delete', 'Remove annotations from all model files or the routes.rb file') do
-    target_action = :remove_annotations
-  end
-
-  opts.on('-p', '--position [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)') do |p|
-    ENV['position'] = p
-    %w(position_in_class position_in_factory position_in_fixture position_in_test position_in_routes position_in_serializer).each do |key|
-      ENV[key] = p unless has_set_position[key]
-    end
-  end
-
-  opts.on('--pc', '--position-in-class [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the model file') do |p|
-    ENV['position_in_class'] = p
-    has_set_position['position_in_class'] = true
-  end
-
-  opts.on('--pf', '--position-in-factory [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any factory files') do |p|
-    ENV['position_in_factory'] = p
-    has_set_position['position_in_factory'] = true
-  end
-
-  opts.on('--px', '--position-in-fixture [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any fixture files') do |p|
-    ENV['position_in_fixture'] = p
-    has_set_position['position_in_fixture'] = true
-  end
-
-  opts.on('--pt', '--position-in-test [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any test files') do |p|
-    ENV['position_in_test'] = p
-    has_set_position['position_in_test'] = true
-  end
-
-  opts.on('--pr', '--position-in-routes [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the routes.rb file') do |p|
-    ENV['position_in_routes'] = p
-    has_set_position['position_in_routes'] = true
-  end
-
-  opts.on('--ps', '--position-in-serializer [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the serializer files') do |p|
-    ENV['position_in_serializer'] = p
-    has_set_position['position_in_serializer'] = true
-  end
-
-  opts.on('--w', '--wrapper STR', 'Wrap annotation with the text passed as parameter.',
-          'If --w option is used, the same text will be used as opening and closing') do |p|
-    ENV['wrapper'] = p
-  end
-
-  opts.on('--wo', '--wrapper-open STR', 'Annotation wrapper opening.') do |p|
-    ENV['wrapper_open'] = p
-  end
-
-  opts.on('--wc', '--wrapper-close STR', 'Annotation wrapper closing') do |p|
-    ENV['wrapper_close'] = p
-  end
-
-  opts.on('-r', '--routes', "Annotate routes.rb with the output of 'rake routes'") do
-    ENV['routes'] = 'true'
-  end
-
-  opts.on('-a', '--active-admin', 'Annotate active_admin models') do
-    ENV['active_admin'] = 'true'
-  end
-
-  opts.on('-v', '--version', 'Show the current version of this gem') do
-    puts "annotate v#{Annotate.version}"; exit
-  end
-
-  opts.on('-m', '--show-migration', 'Include the migration version number in the annotation') do
-    ENV['include_version'] = 'yes'
-  end
-
-  opts.on('-k', '--show-foreign-keys',
-          "List the table's foreign key constraints in the annotation") do
-    ENV['show_foreign_keys'] = 'yes'
-  end
+require 'annotate/parser'
 
-  opts.on('--ck',
-          '--complete-foreign-keys', 'Complete foreign key names in the annotation') do
-    ENV['show_foreign_keys'] = 'yes'
-    ENV['show_complete_foreign_keys'] = 'yes'
-  end
-
-  opts.on('-i', '--show-indexes',
-          "List the table's database indexes in the annotation") do
-    ENV['show_indexes'] = 'yes'
-  end
-
-  opts.on('-s', '--simple-indexes',
-          "Concat the column's related indexes in the annotation") do
-    ENV['simple_indexes'] = 'yes'
-  end
-
-  opts.on('--model-dir dir',
-          "Annotate model files stored in dir rather than app/models, separate multiple dirs with commas") do |dir|
-    ENV['model_dir'] = dir
-  end
-
-  opts.on('--root-dir dir',
-          "Annotate files stored within root dir projects, separate multiple dirs with commas") do |dir|
-    ENV['root_dir'] = dir
-  end
-
-  opts.on('--ignore-model-subdirects',
-          "Ignore subdirectories of the models directory") do |dir|
-    ENV['ignore_model_sub_dir'] = 'yes'
-  end
-
-  opts.on('--sort',
-          "Sort columns alphabetically, rather than in creation order") do |dir|
-    ENV['sort'] = 'yes'
-  end
-
-  opts.on('--classified-sort',
-          "Sort columns alphabetically, but first goes id, then the rest columns, then the timestamp columns and then the association columns") do |dir|
-    ENV['classified_sort'] = 'yes'
-  end
-
-  opts.on('-R', '--require path',
-          "Additional file to require before loading models, may be used multiple times") do |path|
-    if !ENV['require'].blank?
-      ENV['require'] = ENV['require'] + ",#{path}"
-    else
-      ENV['require'] = path
-    end
-  end
-
-  opts.on('-e', '--exclude [tests,fixtures,factories,serializers]', Array, "Do not annotate fixtures, test files, factories, and/or serializers") do |exclusions|
-    exclusions ||= %w(tests fixtures factories)
-    exclusions.each { |exclusion| ENV["exclude_#{exclusion}"] = 'yes' }
-  end
-
-  opts.on('-f', '--format [bare|rdoc|markdown]', %w(bare rdoc markdown), 'Render Schema Infomation as plain/RDoc/Markdown') do |fmt|
-    ENV["format_#{fmt}"] = 'yes'
-  end
-
-  opts.on('--force', 'Force new annotations even if there are no changes.') do |force|
-    ENV['force'] = 'yes'
-  end
-
-  opts.on('--frozen', 'Do not allow to change annotations. Exits non-zero if there are going to be changes to files.') do
-    ENV['frozen'] = 'yes'
-  end
-
-  opts.on('--timestamp', 'Include timestamp in (routes) annotation') do
-    ENV['timestamp'] = 'true'
-  end
-
-  opts.on('--trace', 'If unable to annotate a file, print the full stack trace, not just the exception message.') do |value|
-    ENV['trace'] = 'yes'
-  end
-
-  opts.on('-I', '--ignore-columns REGEX', "don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`") do |regex|
-    ENV['ignore_columns'] = regex
-  end
-
-  opts.on('--ignore-routes REGEX', "don't annotate routes that match a given REGEX (i.e., `annotate -I '(mobile|resque|pghero)'`") do |regex|
-    ENV['ignore_routes'] = regex
-  end
-
-  opts.on('--hide-limit-column-types VALUES', "don't show limit for given column types, separated by commas (i.e., `integer,boolean,text`)") do |values|
-    ENV['hide_limit_column_types'] = "#{values}"
-  end
-
-  opts.on('--hide-default-column-types VALUES', "don't show default for given column types, separated by commas (i.e., `json,jsonb,hstore`)") do |values|
-    ENV['hide_default_column_types'] = "#{values}"
-  end
+Annotate.bootstrap_rake
 
-  opts.on('--ignore-unknown-models', "don't display warnings for bad model files") do |values|
-    ENV['ignore_unknown_models'] = 'true'
-  end
+options_result = Annotate::Parser.parse(ARGV)
 
-  opts.on('--with-comment', "include database comments in model annotations") do |values|
-    ENV['with_comment'] = 'true'
-  end
-end.parse!
+exit if options_result[:exit]
 
 options = Annotate.setup_options(
   is_rake: ENV['is_rake'] && !ENV['is_rake'].empty?
 )
 Annotate.eager_load(options) if Annotate.include_models?
 
-AnnotateModels.send(target_action, options) if Annotate.include_models?
-AnnotateRoutes.send(target_action, options) if Annotate.include_routes?
+AnnotateModels.send(options_result[:target_action], options) if Annotate.include_models?
+AnnotateRoutes.send(options_result[:target_action], options) if Annotate.include_routes?

data/lib/annotate.rb

@@ -36,8 +36,8 @@ module Annotate
     :exclude_sti_subclasses, :ignore_unknown_models, :with_comment
   ].freeze
   OTHER_OPTIONS = [
-    :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close,
-    :wrapper, :routes, :hide_limit_column_types, :hide_default_column_types,
+    :additional_file_patterns, :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close,
+    :wrapper, :routes, :models, :hide_limit_column_types, :hide_default_column_types,
     :ignore_routes, :active_admin
   ].freeze
   PATH_OPTIONS = [
@@ -88,6 +88,7 @@ module Annotate
       options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s].split(',') : []
     end
 
+    options[:additional_file_patterns] ||= []
     options[:model_dir] = ['app/models'] if options[:model_dir].empty?
 
     options[:wrapper_open] ||= options[:wrapper]
@@ -114,7 +115,7 @@ module Annotate
   end
 
   def self.include_models?
-    ENV['routes'] !~ TRUE_RE
+    ENV['models'] =~ TRUE_RE
   end
 
   def self.loaded_tasks=(val)

data/lib/annotate/annotate_models.rb

@@ -159,13 +159,15 @@ module AnnotateModels
       ]
     end
 
-    def files_by_pattern(root_directory, pattern_type)
+    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'
@@ -177,14 +179,20 @@ module AnnotateModels
       end
     end
 
-    def get_patterns(pattern_types = [])
+    def get_patterns(options, pattern_types = [])
       current_patterns = []
       root_dir.each do |root_directory|
         Array(pattern_types).each do |pattern_type|
-          current_patterns += files_by_pattern(root_directory, pattern_type)
+          patterns = files_by_pattern(root_directory, pattern_type, options)
+
+          current_patterns += if pattern_type.to_sym == :additional_file_patterns
+                                patterns
+                              else
+                                patterns.map { |p| p.sub(/^[\/]*/, '') }
+                              end
         end
       end
-      current_patterns.map { |p| p.sub(/^[\/]*/, '') }
+      current_patterns
     end
 
     # Simple quoting for the default column value
@@ -581,8 +589,9 @@ module AnnotateModels
     end
 
     def matched_types(options)
-      types = MATCHED_TYPES
+      types = MATCHED_TYPES.dup
       types << 'admin' if options[:active_admin] =~ TRUE_RE && !types.include?('admin')
+      types << 'additional_file_patterns' if options[:additional_file_patterns].present?
 
       types
     end
@@ -634,8 +643,11 @@ module AnnotateModels
           end
 
           next if options[exclusion_key]
-          get_patterns(key)
+
+          get_patterns(options, key)
             .map { |f| resolve_filename(f, model_name, table_name) }
+            .map { |f| expand_glob_into_files(f) }
+            .flatten
             .each do |f|
               if annotate_one_file(f, info, position_key, options_with_position(options, position_key))
                 annotated << f
@@ -793,6 +805,10 @@ module AnnotateModels
       end
     end
 
+    def expand_glob_into_files(glob)
+      Dir.glob(glob)
+    end
+
     def annotate_model_file(annotated, file, header, options)
       begin
         return false if /#{SKIP_ANNOTATION_PREFIX}.*/ =~ (File.exist?(file) ? File.read(file) : '')
@@ -830,7 +846,7 @@ module AnnotateModels
             model_file_name = file
             deannotated_klass = true if remove_annotation_of_file(model_file_name, options)
 
-            get_patterns(matched_types(options))
+            get_patterns(options, matched_types(options))
               .map { |f| resolve_filename(f, model_name, table_name) }
               .each do |f|
                 if File.exist?(f)
@@ -910,7 +926,11 @@ module AnnotateModels
     def mb_chars_ljust(string, length)
       string = string.to_s
       padding = length - width(string)
-      string + (' ' * padding)
+      if padding > 0
+        string + (' ' * padding)
+      else
+        string[0..length-1]
+      end
     end
   end
 

data/lib/annotate/annotate_routes.rb

@@ -10,7 +10,7 @@
 # Yes, it's simple but I'm thick and often need a reminder of what my routes
 # mean.
 #
-# Running this task will replace any exising route comment generated by the
+# Running this task will replace any existing route comment generated by the
 # task. Best to back up your routes file before running:
 #
 # Author:
@@ -25,14 +25,53 @@ module AnnotateRoutes
   HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action']
 
   class << self
-    def content(line, maxs, options = {})
-      return line.rstrip unless options[:format_markdown]
+    def do_annotations(options = {})
+      return unless routes_exists?
+      existing_text = File.read(routes_file)
 
-      line.each_with_index.map do |elem, index|
-        min_length = maxs.map { |arr| arr[index] }.max || 0
+      if rewrite_contents_with_header(existing_text, header(options), options)
+        puts "#{routes_file} annotated."
+      end
+    end
 
-        sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
-      end.join(' | ')
+    def remove_annotations(_options={})
+      return unless routes_exists?
+      existing_text = File.read(routes_file)
+      content, where_header_found = strip_annotations(existing_text)
+      new_content = strip_on_removal(content, where_header_found)
+      if rewrite_contents(existing_text, new_content)
+        puts "Removed annotations from #{routes_file}."
+      end
+    end
+
+    private
+
+    def routes_exists?
+      routes_exists = File.exists?(routes_file)
+      puts "Can't find routes.rb" unless routes_exists
+
+      routes_exists
+    end
+
+    def routes_file
+      @routes_rb ||= File.join('config', 'routes.rb')
+    end
+
+    def rewrite_contents_with_header(existing_text, header, options = {})
+      content, where_header_found = strip_annotations(existing_text)
+      new_content = annotate_routes(header, content, where_header_found, options)
+
+      # Make sure we end on a trailing newline.
+      new_content << '' unless new_content.last == ''
+      new_text = new_content.join("\n")
+
+      if existing_text == new_text
+        puts "#{routes_file} unchanged."
+        false
+      else
+        File.open(routes_file, 'wb') { |f| f.puts(new_text) }
+        true
+      end
     end
 
     def header(options = {})
@@ -70,180 +109,143 @@ module AnnotateRoutes
       out
     end
 
-    def do_annotations(options = {})
-      return unless routes_exists?
-      existing_text = File.read(routes_file)
-
-      if rewrite_contents_with_header(existing_text, header(options), options)
-        puts "#{routes_file} annotated."
+    # TODO: write the method doc using ruby rdoc formats
+    # where_header_found => This will either be :before, :after, or
+    # a number.  If the number is > 0, the
+    # annotation was found somewhere in the
+    # middle of the file.  If the number is
+    # zero, no annotation was found.
+    def strip_annotations(content)
+      real_content = []
+      mode = :content
+      header_found_at = 0
+
+      content.split(/\n/, -1).each_with_index do |line, line_number|
+        if mode == :header && line !~ /\s*#/
+          mode = :content
+          real_content << line unless line.blank?
+        elsif mode == :content
+          if line =~ /^\s*#\s*== Route.*$/
+            header_found_at = line_number + 1 # index start's at 0
+            mode = :header
+          else
+            real_content << line
+          end
+        end
       end
+
+      where_header_found(real_content, header_found_at)
     end
 
-    def remove_annotations(_options={})
-      return unless routes_exists?
-      existing_text = File.read(routes_file)
-      content, where_header_found = strip_annotations(existing_text)
-      new_content = strip_on_removal(content, where_header_found)
-      if rewrite_contents(existing_text, new_content)
-        puts "Removed annotations from #{routes_file}."
+    def strip_on_removal(content, where_header_found)
+      if where_header_found == :before
+        content.shift while content.first == ''
+      elsif where_header_found == :after
+        content.pop while content.last == ''
       end
-    end
-  end
 
-  def self.magic_comment_matcher
-    Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/)
-  end
+      # 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
+      # TODO: below...
+      content
+    end
 
-  # @param [Array<String>] content
-  # @return [Array<String>] all found magic comments
-  # @return [Array<String>] content without magic comments
-  def self.extract_magic_comments_from_array(content_array)
-    magic_comments = []
-    new_content = []
+    # @param [String, Array<String>]
+    def rewrite_contents(existing_text, new_content)
+      # Make sure we end on a trailing newline.
+      new_content << '' unless new_content.last == ''
+      new_text = new_content.join("\n")
 
-    content_array.map do |row|
-      if row =~ magic_comment_matcher
-        magic_comments << row.strip
+      if existing_text == new_text
+        puts "#{routes_file} unchanged."
+        false
       else
-        new_content << row
+        File.open(routes_file, 'wb') { |f| f.puts(new_text) }
+        true
       end
     end
 
-    [magic_comments, new_content]
-  end
-
-  def self.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 self.routes_file
-    @routes_rb ||= File.join('config', 'routes.rb')
-  end
+    def annotate_routes(header, content, where_header_found, options = {})
+      magic_comments_map, content = extract_magic_comments_from_array(content)
+      if %w(before top).include?(options[:position_in_routes])
+        header = header << '' if content.first != ''
+        magic_comments_map << '' if magic_comments_map.any?
+        new_content = magic_comments_map + header + content
+      else
+        # Ensure we have adequate trailing newlines at the end of the file to
+        # ensure a blank line separating the content from the annotation.
+        content << '' unless content.last == ''
 
-  def self.routes_exists?
-    routes_exists = File.exists?(routes_file)
-    puts "Can't find routes.rb" unless routes_exists
+        # We're moving something from the top of the file to the bottom, so ditch
+        # the spacer we put in the first time around.
+        content.shift if where_header_found == :before && content.first == ''
 
-    routes_exists
-  end
+        new_content = magic_comments_map + content + header
+      end
 
-  # @param [String, Array<String>]
-  def self.rewrite_contents(existing_text, new_content)
-    # Make sure we end on a trailing newline.
-    new_content << '' unless new_content.last == ''
-    new_text = new_content.join("\n")
-
-    if existing_text == new_text
-      puts "#{routes_file} unchanged."
-      false
-    else
-      File.open(routes_file, 'wb') { |f| f.puts(new_text) }
-      true
+      new_content
     end
-  end
 
-  def self.rewrite_contents_with_header(existing_text, header, options = {})
-    content, where_header_found = strip_annotations(existing_text)
-    new_content = annotate_routes(header, content, where_header_found, options)
+    def app_routes_map(options)
+      routes_map = `rake routes`.chomp("\n").split(/\n/, -1)
 
-    # Make sure we end on a trailing newline.
-    new_content << '' unless new_content.last == ''
-    new_text = new_content.join("\n")
+      # 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 \//
 
-    if existing_text == new_text
-      puts "#{routes_file} unchanged."
-      false
-    else
-      File.open(routes_file, 'wb') { |f| f.puts(new_text) }
-      true
-    end
-  end
+      # 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
 
-  def self.annotate_routes(header, content, where_header_found, options = {})
-    magic_comments_map, content = extract_magic_comments_from_array(content)
-    if %w(before top).include?(options[:position_in_routes])
-      header = header << '' if content.first != ''
-      magic_comments_map << '' if magic_comments_map.any?
-      new_content = magic_comments_map + header + content
-    else
-      # Ensure we have adequate trailing newlines at the end of the file to
-      # ensure a blank line separating the content from the annotation.
-      content << '' unless content.last == ''
-
-      # We're moving something from the top of the file to the bottom, so ditch
-      # the spacer we put in the first time around.
-      content.shift if where_header_found == :before && content.first == ''
-
-      new_content = magic_comments_map + content + header
+      routes_map
     end
 
-    new_content
-  end
+    # @param [Array<String>] content
+    # @return [Array<String>] all found magic comments
+    # @return [Array<String>] content without magic comments
+    def extract_magic_comments_from_array(content_array)
+      magic_comments = []
+      new_content = []
 
-  # TODO: write the method doc using ruby rdoc formats
-  # where_header_found => This will either be :before, :after, or
-  # a number.  If the number is > 0, the
-  # annotation was found somewhere in the
-  # middle of the file.  If the number is
-  # zero, no annotation was found.
-  def self.strip_annotations(content)
-    real_content = []
-    mode = :content
-    header_found_at = 0
-
-    content.split(/\n/, -1).each_with_index do |line, line_number|
-      if mode == :header && line !~ /\s*#/
-        mode = :content
-        real_content << line unless line.blank?
-      elsif mode == :content
-        if line =~ /^\s*#\s*== Route.*$/
-          header_found_at = line_number + 1 # index start's at 0
-          mode = :header
+      content_array.map do |row|
+        if row =~ magic_comment_matcher
+          magic_comments << row.strip
         else
-          real_content << line
+          new_content << row
         end
       end
+
+      [magic_comments, new_content]
     end
 
-    where_header_found(real_content, header_found_at)
-  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
 
-  def self.where_header_found(real_content, header_found_at)
-    # By default assume the annotation was found in the middle of the file
+        sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
+      end.join(' | ')
+    end
 
-    # ... unless we have evidence it was at the beginning ...
-    return real_content, :before if header_found_at == 1
+    def where_header_found(real_content, header_found_at)
+      # By default assume the annotation was found in the middle of the file
 
-    # ... or that it was at the end.
-    return real_content, :after if header_found_at >= real_content.count
+      # ... unless we have evidence it was at the beginning ...
+      return real_content, :before if header_found_at == 1
 
-    # and the default
-    return real_content, header_found_at
-  end
+      # ... or that it was at the end.
+      return real_content, :after if header_found_at >= real_content.count
 
-  def self.strip_on_removal(content, where_header_found)
-    if where_header_found == :before
-      content.shift while content.first == ''
-    elsif where_header_found == :after
-      content.pop while content.last == ''
+      # and the default
+      return real_content, header_found_at
     end
 
-    # 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
-    # TODO: below...
-    content
+    def magic_comment_matcher
+      Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/)
+    end
   end
 end

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '2.7.5'
+    '3.0.0'
   end
 end

data/lib/generators/annotate/templates/auto_annotate_models.rake

@@ -7,47 +7,49 @@ if Rails.env.development?
     # You can override any of these by setting an environment variable of the
     # same name.
     Annotate.set_defaults(
-      'routes'                    => 'false',
-      'position_in_routes'        => 'before',
-      'position_in_class'         => 'before',
-      'position_in_test'          => 'before',
-      'position_in_fixture'       => 'before',
-      'position_in_factory'       => 'before',
-      'position_in_serializer'    => 'before',
-      'show_foreign_keys'         => 'true',
-      'show_complete_foreign_keys' => 'false',
-      'show_indexes'              => 'true',
-      'simple_indexes'            => 'false',
-      'model_dir'                 => 'app/models',
-      'root_dir'                  => '',
-      'include_version'           => 'false',
-      'require'                   => '',
-      'exclude_tests'             => 'false',
-      'exclude_fixtures'          => 'false',
-      'exclude_factories'         => 'false',
-      'exclude_serializers'       => 'false',
-      'exclude_scaffolds'         => 'true',
-      'exclude_controllers'       => 'true',
-      'exclude_helpers'           => 'true',
-      'exclude_sti_subclasses'    => 'false',
-      'ignore_model_sub_dir'      => 'false',
-      'ignore_columns'            => nil,
-      'ignore_routes'             => nil,
-      'ignore_unknown_models'     => 'false',
-      'hide_limit_column_types'   => '<%= AnnotateModels::NO_LIMIT_COL_TYPES.join(",") %>',
-      'hide_default_column_types' => '<%= AnnotateModels::NO_DEFAULT_COL_TYPES.join(",") %>',
-      'skip_on_db_migrate'        => 'false',
-      'format_bare'               => 'true',
-      'format_rdoc'               => 'false',
-      'format_markdown'           => 'false',
-      'sort'                      => 'false',
-      'force'                     => 'false',
-      'frozen'                    => 'false',
-      'classified_sort'           => 'true',
-      'trace'                     => 'false',
-      'wrapper_open'              => nil,
-      'wrapper_close'             => nil,
-      'with_comment'              => 'true'
+      'additional_file_patterns'    => [],
+      'routes'                      => 'false',
+      'models'                      => 'false',
+      'position_in_routes'          => 'before',
+      'position_in_class'           => 'before',
+      'position_in_test'            => 'before',
+      'position_in_fixture'         => 'before',
+      'position_in_factory'         => 'before',
+      'position_in_serializer'      => 'before',
+      'show_foreign_keys'           => 'true',
+      'show_complete_foreign_keys'  => 'false',
+      'show_indexes'                => 'true',
+      'simple_indexes'              => 'false',
+      'model_dir'                   => 'app/models',
+      'root_dir'                    => '',
+      'include_version'             => 'false',
+      'require'                     => '',
+      'exclude_tests'               => 'false',
+      'exclude_fixtures'            => 'false',
+      'exclude_factories'           => 'false',
+      'exclude_serializers'         => 'false',
+      'exclude_scaffolds'           => 'true',
+      'exclude_controllers'         => 'true',
+      'exclude_helpers'             => 'true',
+      'exclude_sti_subclasses'      => 'false',
+      'ignore_model_sub_dir'        => 'false',
+      'ignore_columns'              => nil,
+      'ignore_routes'               => nil,
+      'ignore_unknown_models'       => 'false',
+      'hide_limit_column_types'     => '<%= AnnotateModels::NO_LIMIT_COL_TYPES.join(",") %>',
+      'hide_default_column_types'   => '<%= AnnotateModels::NO_DEFAULT_COL_TYPES.join(",") %>',
+      'skip_on_db_migrate'          => 'false',
+      'format_bare'                 => 'true',
+      'format_rdoc'                 => 'false',
+      'format_markdown'             => 'false',
+      'sort'                        => 'false',
+      'force'                       => 'false',
+      'frozen'                      => 'false',
+      'classified_sort'             => 'true',
+      'trace'                       => 'false',
+      'wrapper_open'                => nil,
+      'wrapper_close'               => nil,
+      'with_comment'                => 'true'
     )
   end
 

data/lib/tasks/annotate_models.rake

@@ -12,6 +12,7 @@ task annotate_models: :environment do
 
   options = {is_rake: true}
   ENV['position'] = options[:position] = Annotate.fallback(ENV['position'], 'before')
+  options[:additional_file_patterns] = ENV['additional_file_patterns'] ? ENV['additional_file_patterns'].split(',') : []
   options[:position_in_class] = Annotate.fallback(ENV['position_in_class'], ENV['position'])
   options[:position_in_fixture] = Annotate.fallback(ENV['position_in_fixture'], ENV['position'])
   options[:position_in_factory] = Annotate.fallback(ENV['position_in_factory'], ENV['position'])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.7.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Alex Chaffee
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-27 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,7 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database