annotate 2.6.10 → 2.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d69e9ad0ab7a59e673f3cb7287d6cccb78b8ba20
+  data.tar.gz: a3b5adea28b4f3ebedc4f7af1df32907167d2bb9
+SHA512:
+  metadata.gz: e6b5b503403df98d298e29c1ea4413999496d4c67326704c4c59a079bcd58fa3c6160e0e8812793a5e2796ddd8dcb216482793e5ff11e789463432c93d76cadd
+  data.tar.gz: 15d8f31b8c2bebd74cb0447b5f8283bf0397ae73b8e5a5fd6dc1306b19511cbbd03523338327da32fe2acc599c292fe2f0d434b5969b6eca2468d3bd2c4b9139

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 2.7.0
+See https://github.com/ctran/annotate_models/releases/tag/v2.7.0
+
 == 2.6.9
 * Support foreigh key (#241)
 * Check if model has skip tag in annotate_model_file (#167)

data/README.rdoc

@@ -51,7 +51,7 @@ Also, if you pass the -r option, it'll annotate routes.rb with the output of
 
 Into Gemfile from rubygems.org:
 
-    gem 'annotate', '~> 2.6.6'
+    gem 'annotate'
 
 Into Gemfile from Github:
 
@@ -100,9 +100,7 @@ To remove routes.rb annotations:
 
     annotate --routes --delete
 
-
-== Configuration
-
+To automatically annotate every time you run +db:migrate+, either run +rails g annotate:install+ or add +Annotate.load_tasks+ to your `Rakefile`. See the [configuration in Rails](#configuration-in-rails) section for more info.
 
 === Usage Outside of Rails
 
@@ -112,7 +110,6 @@ or more +--model-dir+ options to inform annotate about the structure of your
 project and help it bootstrap and load the relevant code.
 
 
-
 == Configuration
 
 If you want to always skip annotations on a particular model, add this string
@@ -130,7 +127,13 @@ default options:
 Edit this file to control things like output format, where annotations are
 added (top or bottom of file), and in which artifacts.
 
-== Rails Integration
+The generated rakefile +lib/tasks/auto_annotate_models.rake+ also contains
+`Annotate.load_tasks`. This adds a few rake tasks which duplicate command-line
+functionality:
+
+    rake annotate_models                          # Add schema information (as comments) to model and fixture files
+    rake annotate_routes                          # Adds the route map to routes.rb
+    rake remove_annotation                        # Remove schema information from model and fixture files
 
 By default, once you've generated a configuration file, annotate will be
 executed whenever you run +rake db:migrate+ (but only in development mode).

data/annotate.gemspec

@@ -27,13 +27,13 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rake>, ["~> 10.4"])
-      s.add_runtime_dependency(%q<activerecord>, [">= 3.2", "<= 4.3"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
     else
       s.add_dependency(%q<rake>, ["~> 10.4"])
-      s.add_dependency(%q<activerecord>, [">= 3.2", "<= 4.3"])
+      s.add_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
     end
   else
     s.add_dependency(%q<rake>, [">= 0.8.7"])
-    s.add_dependency(%q<activerecord>, [">= 3.2", "<= 4.3"])
+    s.add_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
   end
 end

data/bin/annotate

@@ -18,18 +18,16 @@ require 'optparse'
 require 'annotate'
 Annotate.bootstrap_rake
 
-target = {
-  :klass => AnnotateModels,
-  :task => :do_annotations,
-}
 has_set_position = {}
+target_action = :do_annotations
+
 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[:task] = :remove_annotations
+    target_action = :remove_annotations
   end
 
   opts.on('-p', '--position [before|top|after|bottom]', ['before', 'top', 'after', 'bottom'],
@@ -93,10 +91,7 @@ OptionParser.new do |opts|
 
   opts.on('-r', '--routes',
           "Annotate routes.rb with the output of 'rake routes'") do
-    target = {
-      :klass => AnnotateRoutes,
-      :task => :do_annotations
-    }
+    ENV['routes'] = 'true'
   end
 
   opts.on('-v', '--version',
@@ -129,6 +124,11 @@ OptionParser.new do |opts|
     ENV['model_dir'] = dir
   end
 
+  opts.on('--root-dir dir',
+          "Annotate files stored within root dir projects, separate multiple dirs with comas") 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"
@@ -178,8 +178,18 @@ OptionParser.new do |opts|
     ENV['ignore_columns'] = regex
   end
 
+  opts.on('--hide-limit-column-types VALUES', "don't show limit for given column types, separated by comas (i.e., `integer,boolean,text`)" ) do |values|
+    ENV['hide_limit_column_types'] = "#{values}"
+  end
+
+  opts.on('--ignore-unknown-models', "don't display warnings for bad model files" ) do |values|
+    ENV['ignore_unknown_models'] = "true"
+  end
+
 end.parse!
 
 options = Annotate.setup_options({ :is_rake => ENV['is_rake'] && !ENV['is_rake'].empty? })
 Annotate.eager_load(options)
-target[:klass].send(target[:task], options)
+
+AnnotateModels.send(target_action, options) if Annotate.include_models?
+AnnotateRoutes.send(target_action, options) if Annotate.include_routes?

data/lib/annotate.rb

@@ -7,7 +7,7 @@ begin
   # ActiveSupport 3.x...
   require 'active_support/hash_with_indifferent_access'
   require 'active_support/core_ext/object/blank'
-rescue Exception => e
+rescue Exception
   # ActiveSupport 2.x...
   require 'active_support/core_ext/hash/indifferent_access'
   require 'active_support/core_ext/blank'
@@ -27,32 +27,36 @@ module Annotate
     :exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
     :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace,
     :timestamp, :exclude_serializers, :classified_sort, :show_foreign_keys,
+    :exclude_scaffolds, :exclude_controllers, :exclude_helpers, :ignore_unknown_models,
   ]
   OTHER_OPTIONS=[
-    :ignore_columns
+    :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close, :wrapper, :routes,
+    :hide_limit_column_types,
   ]
   PATH_OPTIONS=[
-    :require, :model_dir
+    :require, :model_dir, :root_dir
   ]
 
-
   ##
   # Set default values that can be overridden via environment variables.
   #
   def self.set_defaults(options = {})
     return if(@has_set_defaults)
     @has_set_defaults = true
+
     options = HashWithIndifferentAccess.new(options)
+
     [POSITION_OPTIONS, FLAG_OPTIONS, PATH_OPTIONS, OTHER_OPTIONS].flatten.each do |key|
-      if(options.has_key?(key))
-        default_value = if(options[key].is_a?(Array))
+      if options.has_key?(key)
+        default_value = if options[key].is_a?(Array)
           options[key].join(",")
         else
           options[key]
         end
       end
-      default_value = ENV[key.to_s] if(!ENV[key.to_s].blank?)
-      ENV[key.to_s] = default_value.to_s
+
+      default_value = ENV[key.to_s] if !ENV[key.to_s].blank?
+      ENV[key.to_s] = default_value.nil? ? nil : default_value.to_s
     end
   end
 
@@ -75,13 +79,34 @@ module Annotate
       options[:model_dir] = ['app/models']
     end
 
+    if(options[:root_dir].empty?)
+      options[:root_dir] = ['']
+    end
+
+    options[:wrapper_open] ||= options[:wrapper]
+    options[:wrapper_close] ||= options[:wrapper]
+
     return options
   end
 
+  def self.reset_options
+    [POSITION_OPTIONS, FLAG_OPTIONS, PATH_OPTIONS, OTHER_OPTIONS].flatten.each do |key|
+      ENV[key.to_s] = nil
+    end
+  end
+
   def self.skip_on_migration?
     ENV['skip_on_db_migrate'] =~ TRUE_RE
   end
 
+  def self.include_routes?
+    ENV['routes'] =~ TRUE_RE
+  end
+
+  def self.include_models?
+    true
+  end
+
   def self.loaded_tasks=(val); @loaded_tasks = val; end
   def self.loaded_tasks; return @loaded_tasks; end
 
@@ -124,7 +149,7 @@ module Annotate
   def self.bootstrap_rake
     begin
       require 'rake/dsl_definition'
-    rescue Exception => e
+    rescue Exception
       # We might just be on an old version of Rake...
     end
     require 'rake'

data/lib/annotate/annotate_models.rb

@@ -9,6 +9,8 @@ module AnnotateModels
   END_MARK         = "== Schema Information End"
   PATTERN          = /^\r?\n?# (?:#{COMPAT_PREFIX}|#{COMPAT_PREFIX_MD}).*?\r?\n(#.*\r?\n)*(\r?\n)*/
 
+  MATCHED_TYPES = %w(test fixture factory serializer scaffold controller helper)
+
   # File.join for windows reverse bar compat?
   # I dont use windows, can`t test
   UNIT_TEST_DIR         = File.join("test", "unit")
@@ -17,6 +19,12 @@ module AnnotateModels
   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")
@@ -38,36 +46,11 @@ module AnnotateModels
   SERIALIZERS_TEST_DIR  = File.join("test", "serializers")
   SERIALIZERS_SPEC_DIR  = File.join("spec", "serializers")
 
+  # Controller files
+  CONTROLLER_DIR        = File.join("app", "controllers")
 
-  TEST_PATTERNS = [
-    File.join(UNIT_TEST_DIR,  "%MODEL_NAME%_test.rb"),
-    File.join(MODEL_TEST_DIR,  "%MODEL_NAME%_test.rb"),
-    File.join(SPEC_MODEL_DIR, "%MODEL_NAME%_spec.rb"),
-  ]
-
-  FIXTURE_PATTERNS = [
-    File.join(FIXTURE_TEST_DIR, "%TABLE_NAME%.yml"),
-    File.join(FIXTURE_SPEC_DIR, "%TABLE_NAME%.yml"),
-  ]
-
-  FACTORY_PATTERNS = [
-    File.join(EXEMPLARS_TEST_DIR,     "%MODEL_NAME%_exemplar.rb"),
-    File.join(EXEMPLARS_SPEC_DIR,     "%MODEL_NAME%_exemplar.rb"),
-    File.join(BLUEPRINTS_TEST_DIR,    "%MODEL_NAME%_blueprint.rb"),
-    File.join(BLUEPRINTS_SPEC_DIR,    "%MODEL_NAME%_blueprint.rb"),
-    File.join(FACTORY_GIRL_TEST_DIR,  "%MODEL_NAME%_factory.rb"),    # (old style)
-    File.join(FACTORY_GIRL_SPEC_DIR,  "%MODEL_NAME%_factory.rb"),    # (old style)
-    File.join(FACTORY_GIRL_TEST_DIR,  "%TABLE_NAME%.rb"),            # (new style)
-    File.join(FACTORY_GIRL_SPEC_DIR,  "%TABLE_NAME%.rb"),            # (new style)
-    File.join(FABRICATORS_TEST_DIR,   "%MODEL_NAME%_fabricator.rb"),
-    File.join(FABRICATORS_SPEC_DIR,   "%MODEL_NAME%_fabricator.rb"),
-  ]
-
-  SERIALIZER_PATTERNS = [
-    File.join(SERIALIZERS_DIR,       "%MODEL_NAME%_serializer.rb"),
-    File.join(SERIALIZERS_TEST_DIR,  "%MODEL_NAME%_serializer_spec.rb"),
-    File.join(SERIALIZERS_SPEC_DIR,  "%MODEL_NAME%_serializer_spec.rb")
-  ]
+  # Helper files
+  HELPER_DIR            = File.join("app", "helpers")
 
   # Don't show limit (#) on these column types
   # Example: show "integer" instead of "integer(4)"
@@ -82,6 +65,72 @@ module AnnotateModels
       @model_dir = dir
     end
 
+    def root_dir
+      @root_dir.is_a?(Array) ? @root_dir : [@root_dir || ""]
+    end
+
+    def root_dir=(dir)
+      @root_dir = dir
+    end
+
+    def get_patterns(pattern_types=MATCHED_TYPES)
+      current_patterns = []
+      root_dir.each do |root_directory|
+        Array(pattern_types).each do |pattern_type|
+          current_patterns += case pattern_type
+          when 'test'
+            [
+              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"),
+            ]
+          when 'fixture'
+            [
+              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"),
+            ]
+          when 'scaffold'
+            [
+              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"),
+            ]
+          when 'factory'
+            [
+              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_GIRL_TEST_DIR,  "%MODEL_NAME%_factory.rb"),    # (old style)
+              File.join(root_directory, FACTORY_GIRL_SPEC_DIR,  "%MODEL_NAME%_factory.rb"),    # (old style)
+              File.join(root_directory, FACTORY_GIRL_TEST_DIR,  "%TABLE_NAME%.rb"),            # (new style)
+              File.join(root_directory, FACTORY_GIRL_SPEC_DIR,  "%TABLE_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"),
+            ]
+          when 'serializer'
+            [
+              File.join(root_directory, SERIALIZERS_DIR,       "%MODEL_NAME%_serializer.rb"),
+              File.join(root_directory, SERIALIZERS_TEST_DIR,  "%MODEL_NAME%_serializer_spec.rb"),
+              File.join(root_directory, SERIALIZERS_SPEC_DIR,  "%MODEL_NAME%_serializer_spec.rb")
+            ]
+          when 'controller'
+            [
+              File.join(root_directory, CONTROLLER_DIR,  "%PLURALIZED_MODEL_NAME%_controller.rb")
+            ]
+          when 'helper'
+            [
+              File.join(root_directory, HELPER_DIR,  "%PLURALIZED_MODEL_NAME%_helper.rb")
+            ]
+          end
+        end
+      end
+      current_patterns.map{ |p| p.sub(/^[\/]*/, '') }
+    end
+
     # Simple quoting for the default column value
     def quote(value)
       case value
@@ -91,6 +140,7 @@ module AnnotateModels
       when Float, Fixnum, Bignum    then value.to_s
         # BigDecimals need to be output in a non-normalized form and quoted.
       when BigDecimal               then value.to_s('F')
+      when Array                    then value.map {|v| quote(v)}
       else
         value.inspect
       end
@@ -127,20 +177,24 @@ module AnnotateModels
         info<< "# #{ '-' * ( max_size + md_names_overhead ) } | #{'-' * md_type_allowance} | #{ '-' * 27 }\n"
       end
 
-      cols = klass.columns
-      if options[:ignore_columns]
-        cols.reject! { |col| col.name.match(/#{options[:ignore_columns]}/) }
-      end
+      cols = if ignore_columns = options[:ignore_columns]
+               klass.columns.reject do |col|
+                 col.name.match(/#{ignore_columns}/)
+               end
+             else
+               klass.columns
+             end
 
       cols = cols.sort_by(&:name) if(options[:sort])
       cols = classified_sort(cols) if(options[:classified_sort])
       cols.each do |col|
+        col_type = (col.type || col.sql_type).to_s
+
         attrs = []
-        attrs << "default(#{schema_default(klass, col)})" unless col.default.nil?
+        attrs << "default(#{schema_default(klass, col)})" unless col.default.nil? || col_type == "jsonb"
         attrs << "not null" unless col.null
         attrs << "primary key" if klass.primary_key && (klass.primary_key.is_a?(Array) ? klass.primary_key.collect{|c|c.to_sym}.include?(col.name.to_sym) : col.name.to_sym == klass.primary_key.to_sym)
 
-        col_type = (col.type || col.sql_type).to_s
         if col_type == "decimal"
           col_type << "(#{col.precision}, #{col.scale})"
         elsif col_type != "spatial"
@@ -148,7 +202,7 @@ module AnnotateModels
             if col.limit.is_a? Array
               attrs << "(#{col.limit.join(', ')})"
             else
-              col_type << "(#{col.limit})" unless NO_LIMIT_COL_TYPES.include?(col_type)
+              col_type << "(#{col.limit})" unless hide_limit?(col_type, options)
             end
           end
         end
@@ -227,6 +281,17 @@ module AnnotateModels
       return index_info
     end
 
+    def hide_limit?(col_type, options)
+      excludes = 
+        if options[:hide_limit_column_types].blank?
+          NO_LIMIT_COL_TYPES
+        else
+          options[:hide_limit_column_types].split(',')
+        end
+
+      excludes.include?(col_type)
+    end
+
     def get_foreign_key_info(klass, options={})
       if(options[:format_markdown])
         fk_info = "#\n# ### Foreign Keys\n#\n"
@@ -234,7 +299,9 @@ module AnnotateModels
         fk_info = "#\n# Foreign Keys\n#\n"
       end
 
-      foreign_keys = klass.connection.respond_to?(:foreign_keys) ? klass.connection.foreign_keys(klass.table_name) : []
+      return "" unless klass.connection.supports_foreign_keys? && klass.connection.respond_to?(:foreign_keys)
+
+      foreign_keys = klass.connection.foreign_keys(klass.table_name)
       return "" if foreign_keys.empty?
 
       max_size = foreign_keys.collect{|fk| fk.name.size}.max + 1
@@ -274,8 +341,8 @@ module AnnotateModels
         old_columns = old_header && old_header.scan(column_pattern).sort
         new_columns = new_header && new_header.scan(column_pattern).sort
 
-        encoding = Regexp.new(/(^#\s*encoding:.*\n)|(^# coding:.*\n)|(^# -\*- coding:.*\n)|(^# -\*- encoding\s?:.*\n)/)
-        encoding_header = old_content.match(encoding).to_s
+        magic_comment_matcher= Regexp.new(/(^#\s*encoding:.*\n)|(^# coding:.*\n)|(^# -\*- coding:.*\n)|(^# -\*- encoding\s?:.*\n)|(^#\s*frozen_string_literal:.+\n)|(^# -\*- frozen_string_literal\s*:.+-\*-\n)/)
+        magic_comments= old_content.scan(magic_comment_matcher).flatten.compact
 
         if old_columns == new_columns && !options[:force]
           return false
@@ -288,17 +355,17 @@ module AnnotateModels
           end
 
           wrapper_open = options[:wrapper_open] ? "# #{options[:wrapper_open]}\n" : ""
-          wrapper_close = options[:wrapper_close] ? "\n# #{options[:wrapper_close]}" : ""
+          wrapper_close = options[:wrapper_close] ? "# #{options[:wrapper_close]}\n" : ""
           wrapped_info_block = "#{wrapper_open}#{info_block}#{wrapper_close}"
           # if there *was* no old schema info (no substitution happened) or :force was passed,
           # we simply need to insert it in correct position
           if new_content == old_content || options[:force]
-            old_content.sub!(encoding, '')
+            old_content.sub!(magic_comment_matcher, '')
             old_content.sub!(PATTERN, '')
 
             new_content = %w(after bottom).include?(options[position].to_s) ?
-              (encoding_header + (old_content.rstrip + "\n\n" + wrapped_info_block)) :
-              (encoding_header + wrapped_info_block + "\n" + old_content)
+              (magic_comments.join + (old_content.rstrip + "\n\n" + wrapped_info_block)) :
+              (magic_comments.join + wrapped_info_block + "\n" + old_content)
           end
 
           File.open(file_name, "wb") { |f| f.puts new_content }
@@ -340,6 +407,9 @@ module AnnotateModels
     #  :exclude_fixtures<Symbol>:: whether to skip modification of fixture files
     #  :exclude_factories<Symbol>:: whether to skip modification of factory files
     #  :exclude_serializers<Symbol>:: whether to skip modification of serializer files
+    #  :exclude_scaffolds<Symbol>:: whether to skip modification of scaffold files
+    #  :exclude_controllers<Symbol>:: whether to skip modification of controller files
+    #  :exclude_helpers<Symbol>:: whether to skip modification of helper files
     #
     def annotate(klass, file, header, options={})
       begin
@@ -353,15 +423,14 @@ module AnnotateModels
           did_annotate = true
         end
 
-        %w(test fixture factory serializer).each do |key|
+        MATCHED_TYPES.each do |key|
           exclusion_key = "exclude_#{key.pluralize}".to_sym
-          patterns_constant = "#{key.upcase}_PATTERNS".to_sym
           position_key = "position_in_#{key}".to_sym
 
           unless options[exclusion_key]
-            did_annotate = self.const_get(patterns_constant).
-              map { |file| resolve_filename(file, model_name, table_name) }.
-              map { |file| annotate_one_file(file, info, position_key, options_with_position(options, position_key)) }.
+            did_annotate = self.get_patterns(key).
+              map { |f| resolve_filename(f, model_name, table_name) }.
+              map { |f| annotate_one_file(f, info, position_key, options_with_position(options, position_key)) }.
               detect { |result| result } || did_annotate
           end
         end
@@ -419,11 +488,11 @@ module AnnotateModels
       model_path = file.gsub(/\.rb$/, '')
       model_dir.each { |dir| model_path = model_path.gsub(/^#{dir}/, '').gsub(/^\//, '') }
       begin
-        get_loaded_model(model_path) or raise LoadError.new("cannot load a model from #{file}")
+        get_loaded_model(model_path) or raise BadModelFileError.new
       rescue LoadError
         # this is for non-rails projects, which don't get Rails auto-require magic
         file_path = File.expand_path(file)
-        if File.file?(file_path) && Kernel.require(file_path)
+        if File.file?(file_path) && silence_warnings { Kernel.require(file_path) }
           retry
         elsif model_path.match(/\//)
           model_path = model_path.split('/')[1..-1].join('/').to_s
@@ -465,13 +534,14 @@ module AnnotateModels
       end
 
       self.model_dir = options[:model_dir] if options[:model_dir]
+      self.root_dir = options[:root_dir] if options[:root_dir]
 
       annotated = []
       get_model_files(options).each do |file|
         annotate_model_file(annotated, File.join(file), header, options)
       end
       if annotated.empty?
-        puts "Nothing to annotate."
+        puts "Model files unchanged."
       else
         puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
       end
@@ -483,9 +553,14 @@ module AnnotateModels
         klass = get_model_class(file)
         if klass && klass < ActiveRecord::Base && !klass.abstract_class? && klass.table_exists?
           if annotate(klass, file, header, options)
-            annotated << klass
+            annotated << file
           end
         end
+      rescue BadModelFileError => e
+        unless options[:ignore_unknown_models]
+          puts "Unable to annotate #{file}: #{e.message}"
+          puts "\t" + e.backtrace.join("\n\t") if options[:trace]
+        end
       rescue Exception => e
         puts "Unable to annotate #{file}: #{e.message}"
         puts "\t" + e.backtrace.join("\n\t") if options[:trace]
@@ -494,6 +569,7 @@ module AnnotateModels
 
     def remove_annotations(options={})
       self.model_dir = options[:model_dir] if options[:model_dir]
+      self.root_dir = options[:root_dir] if options[:root_dir]
       deannotated = []
       deannotated_klass = false
       get_model_files(options).each do |file|
@@ -506,11 +582,11 @@ module AnnotateModels
             model_file_name = file
             deannotated_klass = true if(remove_annotation_of_file(model_file_name))
 
-            (TEST_PATTERNS + FIXTURE_PATTERNS + FACTORY_PATTERNS + SERIALIZER_PATTERNS).
-              map { |file| resolve_filename(file, model_name, table_name) }.
-              each do |file|
-                if File.exist?(file)
-                  remove_annotation_of_file(file)
+            get_patterns.
+              map { |f| resolve_filename(f, model_name, table_name) }.
+              each do |f|
+                if File.exist?(f)
+                  remove_annotation_of_file(f)
                   deannotated_klass = true
                 end
               end
@@ -527,6 +603,7 @@ module AnnotateModels
     def resolve_filename(filename_template, model_name, table_name)
       return filename_template.
         gsub('%MODEL_NAME%', model_name).
+        gsub('%PLURALIZED_MODEL_NAME%', model_name.pluralize).
         gsub('%TABLE_NAME%', table_name || model_name.pluralize)
     end
 
@@ -551,5 +628,19 @@ module AnnotateModels
 
       return ([id] << rest_cols << timestamps << associations).flatten
     end
+
+    # Ignore warnings for the duration of the block ()
+    def silence_warnings
+      old_verbose, $VERBOSE = $VERBOSE, nil
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
+  end
+
+  class BadModelFileError < LoadError
+    def to_s
+      "file doesn't contain a valid model class"
+    end
   end
 end

data/lib/annotate/annotate_routes.rb

@@ -37,7 +37,8 @@ module AnnotateRoutes
       "#"
     ] + routes_map.map { |line| "# #{line}".rstrip }
 
-    (content, where_header_found) = strip_annotations(File.read(routes_file))
+    existing_text = File.read(routes_file)
+    (content, where_header_found) = strip_annotations(existing_text)
     changed = where_header_found != 0 # This will either be :before, :after, or
                                       # a number.  If the number is > 0, the
                                       # annotation was found somewhere in the
@@ -60,21 +61,25 @@ module AnnotateRoutes
 
     content = position_after ? (content + header) : header + content
 
-    write_contents(content)
-
-    puts "Route file annotated."
+    if write_contents(existing_text, content)
+      puts "#{routes_file} annotated."
+    else
+      puts "#{routes_file} unchanged."
+    end
   end
 
   def self.remove_annotations(options={})
     return unless(routes_exists?)
-
-    (content, where_header_found) = strip_annotations(File.read(routes_file))
+    existing_text = File.read(routes_file)
+    (content, where_header_found) = strip_annotations(existing_text)
 
     content = strip_on_removal(content, where_header_found)
 
-    write_contents(content)
-
-    puts "Removed annotations from routes file."
+    if write_contents(existing_text, content)
+      puts "Removed annotations from #{routes_file}."
+    else
+      puts "#{routes_file} unchanged."
+    end
   end
 
 protected
@@ -89,11 +94,15 @@ protected
     return routes_exists
   end
 
-  def self.write_contents(content)
-    content << '' unless(content.last == '') # Make sure we end on a trailing
-                                             # newline.
+  def self.write_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")
+
+    return false if existing_text == new_text
 
-    File.open(routes_file, "wb") { |f| f.puts(content.join("\n")) }
+    File.open(routes_file, "wb") { |f| f.puts(new_text) }
+    return true
   end
 
   def self.strip_annotations(content)

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '2.6.10'
+    '2.7.0'
   end
 end

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

@@ -5,32 +5,42 @@ if Rails.env.development?
   task :set_annotation_options do
     # You can override any of these by setting an environment variable of the
     # same name.
-    Annotate.set_defaults({
-      '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_indexes'            => "true",
-      'simple_indexes'          => "false",
-      'model_dir'               => "app/models",
-      'include_version'         => "false",
-      'require'                 => "",
-      'exclude_tests'           => "false",
-      'exclude_fixtures'        => "false",
-      'exclude_factories'       => "false",
-      'exclude_serializers'     => "false",
-      'ignore_model_sub_dir'    => "false",
-      'skip_on_db_migrate'      => "false",
-      'format_bare'             => "true",
-      'format_rdoc'             => "false",
-      'format_markdown'         => "false",
-      'sort'                    => "false",
-      'force'                   => "false",
-      'trace'                   => "false",
-    })
+    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_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'       => 'false',
+      'exclude_controllers'     => 'false',
+      'exclude_helpers'         => 'false',
+      'ignore_model_sub_dir'    => 'false',
+      'ignore_columns'          => nil,
+      'ignore_unknown_models'   => 'false',
+      'hide_limit_column_types' => '<%= AnnotateModels::NO_LIMIT_COL_TYPES.join(',') %>',
+      'skip_on_db_migrate'      => 'false',
+      'format_bare'             => 'true',
+      'format_rdoc'             => 'false',
+      'format_markdown'         => 'false',
+      'sort'                    => 'false',
+      'force'                   => 'false',
+      'trace'                   => 'false',
+      'wrapper_open'            => nil,
+      'wrapper_close'           => nil,
+    )
   end
 
   Annotate.load_tasks

data/lib/tasks/annotate_models.rake

@@ -1,6 +1,6 @@
 annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
 
-if(!ENV['is_cli'])
+if !ENV['is_cli']
   task :set_annotation_options
   task :annotate_models => :set_annotation_options
 end
@@ -17,15 +17,20 @@ task :annotate_models => :environment do
   options[:position_in_factory] = Annotate.fallback(ENV['position_in_factory'], ENV['position'])
   options[:position_in_test] = Annotate.fallback(ENV['position_in_test'], ENV['position'])
   options[:position_in_serializer] = Annotate.fallback(ENV['position_in_serializer'], ENV['position'])
+  options[:show_foreign_keys] = Annotate.true?(ENV['show_foreign_keys'])
   options[:show_indexes] = Annotate.true?(ENV['show_indexes'])
   options[:simple_indexes] = Annotate.true?(ENV['simple_indexes'])
-  options[:model_dir] = ENV['model_dir'] ? ENV['model_dir'].split(',') : []
+  options[:model_dir] = ENV['model_dir'] ? ENV['model_dir'].split(',') : ['app/models']
+  options[:root_dir] = ENV['root_dir'] ? ENV['root_dir'].split(',') : ['']
   options[:include_version] = Annotate.true?(ENV['include_version'])
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
   options[:exclude_tests] = Annotate.true?(ENV['exclude_tests'])
   options[:exclude_factories] = Annotate.true?(ENV['exclude_factories'])
   options[:exclude_fixtures] = Annotate.true?(ENV['exclude_fixtures'])
   options[:exclude_serializers] = Annotate.true?(ENV['exclude_serializers'])
+  options[:exclude_scaffolds] = Annotate.true?(ENV['exclude_scaffolds'])
+  options[:exclude_controllers] = Annotate.true?(ENV['exclude_controllers'])
+  options[:exclude_helpers] = Annotate.true?(ENV['exclude_helpers'])
   options[:ignore_model_sub_dir] = Annotate.true?(ENV['ignore_model_sub_dir'])
   options[:format_bare] = Annotate.true?(ENV['format_bare'])
   options[:format_rdoc] = Annotate.true?(ENV['format_rdoc'])
@@ -36,6 +41,8 @@ task :annotate_models => :environment do
   options[:trace] = Annotate.true?(ENV['trace'])
   options[:wrapper_open] = Annotate.fallback(ENV['wrapper_open'], ENV['wrapper'])
   options[:wrapper_close] = Annotate.fallback(ENV['wrapper_close'], ENV['wrapper'])
+  options[:ignore_columns] = ENV.fetch('ignore_columns', nil)
+
   AnnotateModels.do_annotations(options)
 end
 
@@ -46,6 +53,7 @@ task :remove_annotation => :environment do
 
   options={ :is_rake => true }
   options[:model_dir] = ENV['model_dir']
+  options[:root_dir] = ENV['root_dir']
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
   options[:trace] = Annotate.true?(ENV['trace'])
   AnnotateModels.remove_annotations(options)

data/lib/tasks/migrate.rake

@@ -2,20 +2,23 @@
 # (They are not used to build annotate itself.)
 
 # Append annotations to Rake tasks for ActiveRecord, so annotate automatically gets
-# run after doing db:migrate. 
-# Unfortunately it relies on ENV for options; it'd be nice to be able to set options
-# in a per-project config file so this task can read them.
+# run after doing db:migrate.
+
 namespace :db do
-  task :migrate do
-    Annotate::Migration.update_annotations
-  end
+  [:migrate, :rollback].each do |cmd|
+    task cmd do
+      Rake::Task['set_annotation_options'].invoke
+      Annotate::Migration.update_annotations
+    end
 
-  namespace :migrate do
-    [:change, :up, :down, :reset, :redo].each do |t|
-      task t do
-        Annotate::Migration.update_annotations 
+    namespace cmd do
+      [:change, :up, :down, :reset, :redo].each do |t|
+        task t do
+          Rake::Task['set_annotation_options'].invoke
+          Annotate::Migration.update_annotations
+        end
       end
-    end 
+    end
   end
 end
 
@@ -24,9 +27,25 @@ module Annotate
     @@working = false
 
     def self.update_annotations
-      unless @@working || (ENV['skip_on_db_migrate'] =~ /(true|t|yes|y|1)$/i)
+      unless @@working || Annotate.skip_on_migration?
         @@working = true
-        Rake::Task['annotate_models'].invoke 
+
+        self.update_models if Annotate.include_models?
+        self.update_routes if Annotate.include_routes?
+      end
+    end
+
+    def self.update_models
+      if Rake::Task.task_defined?("annotate_models")
+        Rake::Task["annotate_models"].invoke
+      elsif Rake::Task.task_defined?("app:annotate_models")
+        Rake::Task["app:annotate_models"].invoke
+      end
+    end
+
+    def self.update_routes
+      if Rake::Task.task_defined?("annotate_routes")
+        Rake::Task["annotate_routes"].invoke
       end
     end
   end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.6.10
-  prerelease: 
+  version: 2.7.0
 platform: ruby
 authors:
 - Alex Chaffee
@@ -13,46 +12,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.4'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <=
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <=
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '6.0'
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
 email:
@@ -91,25 +86,24 @@ files:
 homepage: http://github.com/ctran/annotate_models
 licenses:
 - Ruby
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: annotate
-rubygems_version: 1.8.23.2
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database