annotate 2.6.5 → 2.6.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWJjZmE2N2E0NDFhOGU5MmFjZGJlZjZmNTg4YjI4MWZmYjhlZDUxNw==
+    MzQ3ZjQ5NmY5Njc0ZjZiYjIyODVjODY3NDdlZjhlODYwMDAwZjMxYw==
   data.tar.gz: !binary |-
-    ZDViMWZlYjVlZWMxN2IzMjM2NWFlYmJmYTc2NGEyY2FlYmIyOWYxNQ==
+    ZDNlMGM0YWFmMWMxZjFjZjE1N2U4MTc3NTVhNjMwMDE3MTlhMzI1ZQ==
 SHA512:
   metadata.gz: !binary |-
-    NDBlMTlmZTczYjk0YjUxYzg1ZTljOWE3YmE1MjYxOGNhZjhmOGNlZWZhMDlh
-    N2EzNDRjMjcwZWRiYzk4ZmFlM2U5OGQ1ZDJlNTQ2YmM0ZTQwZDg5NzdmMDMx
-    NTU4NjM2OWY1ZmI3OTk3MTc2MTVkMTE4ZDNiMTJkZTk5NzA5M2I=
+    ZGRhYTFjOGUwOWVlZThhNGY1MzY4OWMwZGIwYTgxMjE4ZmZmZjE0ZmFjYjE1
+    ZGJkOGJmZmNjODRkZTRlNTc0MDg1Nzk4Y2Q5Y2QwZTc3MTBlNzJhZGU0NDIx
+    ZjM0MTJlOWI2MWJhMTY3YWY4Nzc5YTkyZWEzYTlmM2U1N2E0NjE=
   data.tar.gz: !binary |-
-    YzIzY2ZmNDA1YWEzYTVlZDY0ZDg4MDg3YThhYjBiYTQ1MjQ4ZTQwYzY2Mjc1
-    YmRjNjMxMTUwMDQ2OTIzZmFmNWI1ODM2Mzk5MjYwYmY2OWIzZTk0YmM5ODll
-    MDlmNTEwYjk2M2E1ZGZjOTUzZDE2ODJhYTQ1N2JlYzBjZTU4M2I=
+    YzEzMDgwNmUyMzk5ODA1ZjRlMTZkMDY3MzQ0ZmYwM2U1YTliMzcxZjU3ZGUw
+    NzU1NjMwNDMxNGI0OTZiMTA3NjVkNzZjNGJjMDQ2YmZhNGZlYWIzZjdmNWMx
+    MzE4NmE1ZGViZmM5MTJmOTNkYmFjYTRiMTAxMjRiMDE4MjFkZmM=

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+== 2.6.6
+* Makes it possible to wrap annotations, #225
+* Fix single model generation, #214
+* Fix default value for Rails 4.2, #212
+* Don't crash on inherited models in subdirectories, #232
+* Process model_dir in rake task, #197
+
 == 2.6.4
 * Skip "models/concerns", #194
 * Fix #173 where annotate says "Nothing to annotate" in rails 4.2

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.0"
+    gem 'annotate', '~> 2.6.5'
 
 Into Gemfile from Github:
 
@@ -86,13 +86,13 @@ To annotate just your models, tests, and factories:
 
 To annotate just your models:
 
-    annotate --exclude tests,fixtures,factories
+    annotate --exclude tests,fixtures,factories,serializers
 
 To annotate routes.rb:
 
     annotate --routes
 
-To remove model/test/fixture/factory annotations:
+To remove model/test/fixture/factory/serializer annotations:
 
     annotate --delete
 
@@ -137,11 +137,11 @@ executed whenever you run +rake db:migrate+ (but only in development mode).
 If you want to disable this behavior permanently, edit the +.rake+ file and
 change:
 
-    'skip_on_db_migrate'   => "false",
+    'skip_on_db_migrate'   => 'false',
 
 To:
 
-    'skip_on_db_migrate'   => "true",
+    'skip_on_db_migrate'   => 'true',
 
 If you want to run +rake db:migrate+ as a one-off without running annotate,
 you can do so with a simple environment variable, instead of editing the
@@ -154,33 +154,41 @@ you can do so with a simple environment variable, instead of editing the
 
     Usage: annotate [options] [model_file]*
         -d, --delete                     Remove annotations from all model files or the routes.rb file
-        -p, --position [before|after]    Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/routes file(s)
-            --pc, --position-in-class [before|after]
+        -p, --position [before|top|after|bottom]    Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/routes file(s)
+            --pc, --position-in-class [before|top|after|bottom]
                                          Place the annotations at the top (before) or the bottom (after) of the model file
-            --pf, --position-in-factory [before|after]
+            --pf, --position-in-factory [before|top|after|bottom]
                                          Place the annotations at the top (before) or the bottom (after) of any factory files
-            --px, --position-in-fixture [before|after]
+            --px, --position-in-fixture [before|top|after|bottom]
                                          Place the annotations at the top (before) or the bottom (after) of any fixture files
-            --pt, --position-in-test [before|after]
+            --pt, --position-in-test [before|top|after|bottom]
                                          Place the annotations at the top (before) or the bottom (after) of any test files
-            --pr, --position-in-routes [before|after]
+            --pr, --position-in-routes [before|top|after|bottom]
                                          Place the annotations at the top (before) or the bottom (after) of the routes.rb file
+            --ps, --position-in-serializer [before|top|after|bottom]
+                                         Place the annotations at the top (before) or the bottom (after) of the serializer files
+            --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
+            --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'
         -v, --version                    Show the current version of this gem
         -m, --show-migration             Include the migration version number in the annotation
         -i, --show-indexes               List the table's database indexes in the annotation
         -s, --simple-indexes             Concat the column's related indexes in the annotation
-            --model-dir dir              Annotate model files stored in dir rather than app/models
+            --model-dir dir              Annotate model files stored in dir rather than app/models, separate multiple dirs with comas
             --ignore-model-subdirects    Ignore subdirectories of the models directory
             --sort                       Sort columns alphabetically, rather than in creation order
         -R, --require path               Additional file to require before loading models, may be used multiple times
-        -e [tests,fixtures,factories],   Do not annotate fixtures, test files, and/or factories
-            --exclude
+        -e [tests,fixtures,factories,serializers],
+            --exclude                    Do not annotate fixtures, test files, factories, and/or serializers
         -f [bare|rdoc|markdown],         Render Schema Infomation as plain/RDoc/Markdown
             --format
             --force                      Force new annotations even if there are no changes.
+            --timestamp                  Include timestamp in (routes) annotation
             --trace                      If unable to annotate a file, print the full stack trace, not just the exception message.
-        --timestamp                      Include an updated time in routes.rb
+        -I, --ignore-columns REGEX       don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`
+
 
 
 == Sorting

data/TODO.rdoc

@@ -2,7 +2,6 @@
 
 - clean up history
 - change default position back to "top" for all annotations
-- add "top" and "bottom" as synonyms for "before" and "after"
 - change 'exclude' to 'only' (double negatives are not unconfusing)
 
 == TODO (proposed)

data/annotate.gemspec

@@ -8,8 +8,7 @@ Gem::Specification.new do |s|
   s.version = Annotate.version
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Cuong Tran", "Alex Chaffee", "Marcos Piccinini", "Turadg Aleahmad", "Jon Frisby"]
-  s.date = "2014-06-16"
+  s.authors = ["Alex Chaffee", "Cuong Tran", "Marcos Piccinini", "Turadg Aleahmad", "Jon Frisby"]
   s.description = "Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema."
   s.email = ["alex@stinky.com", "cuong.tran@gmail.com", "x@nofxx.com", "turadg@aleahmad.net", "jon@cloudability.com"]
   s.executables = ["annotate"]
@@ -26,7 +25,7 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_runtime_dependency(%q<rake>, ["~> 10.4.2", ">= 10.4.2"])
       s.add_runtime_dependency(%q<activerecord>, [">= 2.3.0"])
     else
       s.add_dependency(%q<rake>, [">= 0.8.7"])

data/bin/annotate

@@ -32,46 +32,65 @@ OptionParser.new do |opts|
     target[:task] = :remove_annotations
   end
 
-  opts.on('-p', '--position [before|after]', ['before', 'after'],
+  opts.on('-p', '--position [before|top|after|bottom]', ['before', 'top', 'after', 'bottom'],
           "Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/routes file(s)") do |p|
     ENV['position'] = p
     [
-      'position_in_class','position_in_factory','position_in_fixture','position_in_test', 'position_in_routes'
+      '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|after]', ['before', 'after'],
+  opts.on('--pc', '--position-in-class [before|top|after|bottom]', ['before', 'top', 'after', 'bottom'],
           "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|after]', ['before', 'after'],
+  opts.on('--pf', '--position-in-factory [before|top|after|bottom]', ['before', 'top', 'after', 'bottom'],
           "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|after]', ['before', 'after'],
+  opts.on('--px', '--position-in-fixture [before|top|after|bottom]', ['before', 'top', 'after', 'bottom'],
           "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|after]', ['before', 'after'],
+  opts.on('--pt', '--position-in-test [before|top|after|bottom]', ['before', 'top', 'after', 'bottom'],
           "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|after]', ['before', 'after'],
+  opts.on('--pr', '--position-in-routes [before|top|after|bottom]', ['before', 'top', 'after', 'bottom'],
           "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]', ['before', 'top', 'after', 'bottom'],
+          "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
     target = {
@@ -101,7 +120,7 @@ OptionParser.new do |opts|
   end
 
   opts.on('--model-dir dir',
-          "Annotate model files stored in dir rather than app/models") do |dir|
+          "Annotate model files stored in dir rather than app/models, separate multiple dirs with comas") do |dir|
     ENV['model_dir'] = dir
   end
 
@@ -115,6 +134,11 @@ OptionParser.new do |opts|
     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?
@@ -124,7 +148,7 @@ OptionParser.new do |opts|
     end
   end
 
-  opts.on('-e', '--exclude [tests,fixtures,factories]', Array, "Do not annotate fixtures, test files, and/or factories") do |exclusions|
+  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

data/lib/annotate.rb

@@ -6,9 +6,11 @@ require 'annotate/annotate_routes'
 begin
   # ActiveSupport 3.x...
   require 'active_support/hash_with_indifferent_access'
+  require 'active_support/core_ext/object/blank'
 rescue Exception => e
   # ActiveSupport 2.x...
   require 'active_support/core_ext/hash/indifferent_access'
+  require 'active_support/core_ext/blank'
 end
 
 module Annotate
@@ -18,17 +20,19 @@ module Annotate
   POSITION_OPTIONS=[
     :position_in_routes, :position_in_class, :position_in_test,
     :position_in_fixture, :position_in_factory, :position,
+    :position_in_serializer,
   ]
   FLAG_OPTIONS=[
     :show_indexes, :simple_indexes, :include_version, :exclude_tests,
     :exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
-    :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace, :timestamp
+    :format_bare, :format_rdoc, :format_markdown, :sort, :force, :trace,
+    :timestamp, :exclude_serializers, :classified_sort
   ]
   OTHER_OPTIONS=[
-    :model_dir, :ignore_columns
+    :ignore_columns
   ]
   PATH_OPTIONS=[
-    :require,
+    :require, :model_dir
   ]
 
 
@@ -39,7 +43,7 @@ module Annotate
     return if(@has_set_defaults)
     @has_set_defaults = true
     options = HashWithIndifferentAccess.new(options)
-    [POSITION_OPTIONS, FLAG_OPTIONS, PATH_OPTIONS].flatten.each do |key|
+    [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))
           options[key].join(",")
@@ -68,7 +72,7 @@ module Annotate
     end
 
     if(!options[:model_dir])
-      options[:model_dir] = 'app/models'
+      options[:model_dir] = ['app/models']
     end
 
     return options
@@ -109,8 +113,10 @@ module Annotate
         klass.eager_load!
       end
     else
-      FileList["#{options[:model_dir]}/**/*.rb"].each do |fname|
-        require File.expand_path(fname)
+      options[:model_dir].each do |dir|
+        FileList["#{dir}/**/*.rb"].each do |fname|
+          require File.expand_path(fname)
+        end
       end
     end
   end

data/lib/annotate/annotate_models.rb

@@ -1,3 +1,5 @@
+require 'bigdecimal'
+
 module AnnotateModels
   # Annotate Models plugin use this header
   COMPAT_PREFIX    = "== Schema Info"
@@ -31,6 +33,12 @@ module AnnotateModels
   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")
+
+
   TEST_PATTERNS = [
     File.join(UNIT_TEST_DIR,  "%MODEL_NAME%_test.rb"),
     File.join(MODEL_TEST_DIR,  "%MODEL_NAME%_test.rb"),
@@ -55,13 +63,19 @@ module AnnotateModels
     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")
+  ]
+
   # Don't show limit (#) on these column types
   # Example: show "integer" instead of "integer(4)"
   NO_LIMIT_COL_TYPES = ["integer", "boolean"]
 
   class << self
     def model_dir
-      @model_dir || "app/models"
+      @model_dir.is_a?(Array) ? @model_dir : [@model_dir || "app/models"]
     end
 
     def model_dir=(dir)
@@ -82,6 +96,10 @@ module AnnotateModels
       end
     end
 
+    def schema_default(klass, column)
+      quote(klass.column_defaults[column.name])
+    end
+
     # Use the column information in an ActiveRecord class
     # to create a comment block containing a line for
     # each column. The line contains the column name,
@@ -113,10 +131,12 @@ module AnnotateModels
       if options[:ignore_columns]
         cols.reject! { |col| col.name.match(/#{options[:ignore_columns]}/) }
       end
+
       cols = cols.sort_by(&:name) if(options[:sort])
+      cols = classified_sort(cols) if(options[:classified_sort])
       cols.each do |col|
         attrs = []
-        attrs << "default(#{quote(col.default)})" unless col.default.nil?
+        attrs << "default(#{schema_default(klass, col)})" unless col.default.nil?
         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)
 
@@ -151,7 +171,7 @@ module AnnotateModels
         if options[:simple_indexes] && klass.table_exists?# Check out if this column is indexed
           indices = klass.connection.indexes(klass.table_name)
           if indices = indices.select { |ind| ind.columns.include? col.name }
-            indices.each do |ind|
+            indices.sort_by{|ind| ind.name}.each do |ind|
               ind = ind.columns.reject! { |i| i == col.name }
               attrs << (ind.length == 0 ? "indexed" : "indexed => [#{ind.join(", ")}]")
             end
@@ -212,7 +232,7 @@ module AnnotateModels
     # === Options (opts)
     #  :force<Symbol>:: whether to update the file even if it doesn't seem to need it.
     #  :position_in_*<Symbol>:: where to place the annotated section in fixture or model file,
-    #                           :before or :after. Default is :before.
+    #                           :before, :top, :after or :bottom. Default is :before.
     #
     def annotate_one_file(file_name, info_block, position, options={})
       if File.exist?(file_name)
@@ -241,15 +261,18 @@ module AnnotateModels
             new_content = old_content.sub(PATTERN, "\n" + info_block)
           end
 
+          wrapper_open = options[:wrapper_open] ? "# #{options[:wrapper_open]}\n" : ""
+          wrapper_close = options[:wrapper_close] ? "\n# #{options[:wrapper_close]}" : ""
+          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!(PATTERN, '')
 
-            new_content = options[position].to_s == 'after' ?
-              (encoding_header + (old_content.rstrip + "\n\n" + info_block)) :
-              (encoding_header + info_block + "\n" + old_content)
+            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)
           end
 
           File.open(file_name, "wb") { |f| f.puts new_content }
@@ -296,31 +319,23 @@ module AnnotateModels
         did_annotate = false
         model_name = klass.name.underscore
         table_name = klass.table_name
-        model_file_name = File.join(model_dir, file)
+        model_file_name = File.join(file)
 
         if annotate_one_file(model_file_name, info, :position_in_class, options_with_position(options, :position_in_class))
           did_annotate = true
         end
 
-        unless options[:exclude_tests]
-          did_annotate = TEST_PATTERNS.
-            map { |file| resolve_filename(file, model_name, table_name) }.
-            map { |file| annotate_one_file(file, info, :position_in_test, options_with_position(options, :position_in_test)) }.
-            detect { |result| result } || did_annotate
-        end
-
-        unless options[:exclude_fixtures]
-          did_annotate = FIXTURE_PATTERNS.
-            map { |file| resolve_filename(file, model_name, table_name) }.
-            map { |file| annotate_one_file(file, info, :position_in_fixture, options_with_position(options, :position_in_fixture)) }.
-            detect { |result| result } || did_annotate
-        end
+        %w(test fixture factory serializer).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[:exclude_factories]
-          did_annotate = FACTORY_PATTERNS.
-            map { |file| resolve_filename(file, model_name, table_name) }.
-            map { |file| annotate_one_file(file, info, :position_in_factory, options_with_position(options, :position_in_factory)) }.
-            detect { |result| result } || did_annotate
+          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)) }.
+              detect { |result| result } || did_annotate
+          end
         end
 
         return did_annotate
@@ -335,35 +350,37 @@ module AnnotateModels
       options.merge(:position=>(options[position_in] || options[:position]))
     end
 
-    # Return a list of the model files to annotate. If we have
-    # command line arguments, they're assumed to be either
-    # the underscore or CamelCase versions of model names.
-    # Otherwise we take all the model files in the
-    # model_dir directory.
+    # Return a list of the model files to annotate. 
+    # If we have command line arguments, they're assumed to the path
+    # of model files from root dir. Otherwise we take all the model files 
+    # in the model_dir directory.
     def get_model_files(options)
+      models = []
       if(!options[:is_rake])
-        models = ARGV.dup
-        models.shift
-      else
-        models = []
+        models = ARGV.dup.reject{|m| m.match(/^(.*)=/)}
       end
-      models.reject!{|m| m.match(/^(.*)=/)}
+
       if models.empty?
         begin
-          Dir.chdir(model_dir) do
-            models = if options[:ignore_model_sub_dir]
-              Dir["*.rb"]
-            else
-              Dir["**/*.rb"].reject{ |f| f["concerns/"] }
+          model_dir.each do |dir|
+            Dir.chdir(dir) do
+              lst = 
+                if options[:ignore_model_sub_dir]
+                  Dir["*.rb"].map{ |f| [dir, f] }
+                else
+                  Dir["**/*.rb"].reject{ |f| f["concerns/"] }.map{ |f| [dir, f] }
+                end
+              models.concat(lst)
             end
           end
         rescue SystemCallError
-          puts "No models found in directory '#{model_dir}'."
+          puts "No models found in directory '#{model_dir.join("', '")}'."
           puts "Either specify models on the command line, or use the --model-dir option."
           puts "Call 'annotate --help' for more info."
           exit 1
         end
       end
+
       models
     end
 
@@ -372,11 +389,13 @@ module AnnotateModels
     # in subdirectories without namespacing.
     def get_model_class(file)
       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}")
       rescue LoadError
         # this is for non-rails projects, which don't get Rails auto-require magic
-        if Kernel.require(File.expand_path("#{model_dir}/#{model_path}"))
+        file_path = File.expand_path(file)
+        if File.file?(file_path) && Kernel.require(file_path)
           retry
         elsif model_path.match(/\//)
           model_path = model_path.split('/')[1..-1].join('/').to_s
@@ -421,10 +440,10 @@ module AnnotateModels
 
       annotated = []
       get_model_files(options).each do |file|
-        annotate_model_file(annotated, file, header, options)
+        annotate_model_file(annotated, File.join(file), header, options)
       end
       if annotated.empty?
-        puts "Nothing annotated."
+        puts "Nothing to annotate."
       else
         puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
       end
@@ -449,12 +468,13 @@ module AnnotateModels
       deannotated = []
       deannotated_klass = false
       get_model_files(options).each do |file|
+        file = File.join(file)
         begin
           klass = get_model_class(file)
           if klass < ActiveRecord::Base && !klass.abstract_class?
             model_name = klass.name.underscore
             table_name = klass.table_name
-            model_file_name = File.join(model_dir, file)
+            model_file_name = file
             deannotated_klass = true if(remove_annotation_of_file(model_file_name))
 
             (TEST_PATTERNS + FIXTURE_PATTERNS + FACTORY_PATTERNS).
@@ -468,7 +488,7 @@ module AnnotateModels
           end
           deannotated << klass if(deannotated_klass)
         rescue Exception => e
-          puts "Unable to deannotate #{file}: #{e.message}"
+          puts "Unable to deannotate #{File.join(file)}: #{e.message}"
           puts "\t" + e.backtrace.join("\n\t") if options[:trace]
         end
       end
@@ -480,5 +500,27 @@ module AnnotateModels
         gsub('%MODEL_NAME%', model_name).
         gsub('%TABLE_NAME%', table_name || model_name.pluralize)
     end
+
+    def classified_sort(cols)
+      rest_cols = []
+      timestamps = []
+      associations = []
+      id = nil
+
+      cols = cols.each do |c|
+        if c.name.eql?("id")
+          id = c
+        elsif (c.name.eql?("created_at") || c.name.eql?("updated_at"))
+          timestamps << c
+        elsif c.name[-3,3].eql?("_id")
+          associations << c
+        else
+          rest_cols << c
+        end
+      end
+      [rest_cols, timestamps, associations].each {|a| a.sort_by!(&:name) }
+
+      return ([id] << rest_cols << timestamps << associations).flatten
+    end
   end
 end

data/lib/annotate/annotate_routes.rb

@@ -23,7 +23,7 @@ module AnnotateRoutes
   def self.do_annotations(options={})
     return unless(routes_exists?)
 
-    position_after = options[:position_in_routes] != 'before'
+    position_after = ! %w(before top).include?(options[:position_in_routes])
 
     routes_map = `rake routes`.split(/\n/, -1)
 

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '2.6.5'
+    '2.6.6'
   end
 end

data/lib/tasks/annotate_models.rake

@@ -18,7 +18,7 @@ task :annotate_models => :environment do
   options[:position_in_test] = Annotate.fallback(ENV['position_in_test'], ENV['position'])
   options[:show_indexes] = Annotate.true?(ENV['show_indexes'])
   options[:simple_indexes] = Annotate.true?(ENV['simple_indexes'])
-  options[:model_dir] = ENV['model_dir']
+  options[:model_dir] = ENV['model_dir'] ? ENV['model_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'])
@@ -30,7 +30,10 @@ task :annotate_models => :environment do
   options[:format_markdown] = Annotate.true?(ENV['format_markdown'])
   options[:sort] = Annotate.true?(ENV['sort'])
   options[:force] = Annotate.true?(ENV['force'])
+  options[:classified_sort] = Annotate.true?(ENV['classified_sort'])
   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'])
   AnnotateModels.do_annotations(options)
 end
 

metadata

@@ -1,49 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.6.5
+  version: 2.6.6
 platform: ruby
 authors:
-- Cuong Tran
 - Alex Chaffee
+- Cuong Tran
 - Marcos Piccinini
 - Turadg Aleahmad
 - Jon Frisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MTAuNC4y
     - - ! '>='
       - !ruby/object:Gem::Version
         version: !binary |-
-          MC44Ljc=
+          MTAuNC4y
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MTAuNC4y
     - - ! '>='
       - !ruby/object:Gem::Version
         version: !binary |-
-          MC44Ljc=
+          MTAuNC4y
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: !binary |-
+          Mi4zLjA=
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: !binary |-
+          Mi4zLjA=
 description: Annotates Rails/ActiveRecord Models, routes, fixtures, and others based
   on the database schema.
 email:
@@ -99,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: annotate
-rubygems_version: 2.3.0
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Annotates Rails Models, routes, fixtures, and others based on the database