Include option to sort columns alphabetically.

Rakefile

-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+%w[rubygems rake rake/clean fileutils newgem rubigen hoe].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/annotate'
 
 # Generate all the Rake tasks

bin/annotate

@@ -13,6 +13,7 @@ OptionParser.new do |opts|
   opts.on('-v', '--version', "Show the current version of this gem") { puts "Annotate v#{Annotate::VERSION}"; exit }
   opts.on('-m', '--show-migration', "Include the migration version number in the annotation") { ENV['include_version'] = "yes" }
   opts.on('-i', '--show-indexes', "List the table's database indexes in the annotation") { ENV['show_indexes'] = "yes" }
+  opts.on('-s', '--sort', "Sort columns alphabetically (rather than listing in creation order)") { ENV['sort'] = "yes" }
   opts.on('--model-dir dir', "Annotate model files stored in dir rather than app/models") {|dir| ENV['model_dir'] = dir }
 end.parse!
 

lib/annotate/annotate_models.rb

@@ -43,6 +43,7 @@ module AnnotateModels
       info << "# Table name: #{klass.table_name}\n#\n"
 
       max_size = klass.column_names.collect{|name| name.size}.max + 1
+      cols = []
       klass.columns.each do |col|
         attrs = []
         attrs << "default(#{quote(col.default)})" if col.default
@@ -62,8 +63,10 @@ module AnnotateModels
           attrs << "#{col.geometry_type}, #{col.srid}"
         end  
         
-        info << sprintf("#  %-#{max_size}.#{max_size}s:%-15.15s %s", col.name, col_type, attrs.join(", ")).rstrip + "\n"
+        cols << sprintf("#  %-#{max_size}.#{max_size}s:%-15.15s %s", col.name, col_type, attrs.join(", ")).rstrip + "\n"
       end
+      cols.sort! if options[:sort]
+      info << cols.join
 
       if options[:show_indexes]
         info << get_index_info(klass)

lib/tasks/annotate_models.rake

@@ -7,6 +7,7 @@ task :annotate_models => :environment do
   options[:show_indexes] = ENV['show_indexes'] 
   options[:model_dir] = ENV['model_dir']
   options[:include_version] = ENV['include_version']
+  options[:sort] = ENV['sort']
   AnnotateModels.do_annotations(options)
 end