annotate 2.5.0.pre1 → 2.5.0.pre2

data/History.txt

@@ -1,18 +1,18 @@
 == 2.5.0
 
-* Fixed that schema kept prepending additional newlines
-* Updates to make annotate smarter about when to touch a model 
+* Works better with Rails 3
+* Bugfix: schema kept prepending additional newlines
+* Updates to make annotate smarter about when to touch a model
 * Recognize column+type, and don't change a file unless the column+type combination of the new schema are different than that of the old (i.e., don't regenerate if columns happen to be in a different order. That's just how life is sometimes)
 * Grab old specification even if it has \r\n as line endings rather than pure \ns
 * Various warning and specification fixes
 * Fix "no such file to load -- annotate/annotate_models (MissingSourceFile)" error (require statements in tasks now use full path to lib files)
-* warn about macros, to mitigate when we're included during a production run, not just a rakefile run -- possibly at the expense of too much noise 
+* warn about macros, to mitigate when we're included during a production run, not just a rakefile run -- possibly at the expense of too much noise
 * Adding rake as a runtime dependency
-* If the schema is already in the model file, it will be replaced into the same location.  If it didn't previously exist, it'll be placed according to the "position", as before. 
+* If the schema is already in the model file, it will be replaced into the same location.  If it didn't previously exist, it'll be placed according to the "position", as before.
 * Allow task loading from Rakefile for gems (plugin installation already auto-detects).
-* Add skip_on_db_migrate option as well for people that don't want it 
-* Fix options parsing to convert strings to proper booleans. Change annotate to use opt
- ions hash instead of ENV. 
+* Add skip_on_db_migrate option as well for people that don't want it
+* Fix options parsing to convert strings to proper booleans
 * Add support for Fabrication fabricators
 * Leave magic encoding comment intact
 * Fix issue #14 - RuntimeError: Already memoized
@@ -57,6 +57,10 @@
   no replacement. It will be removed on or after 2011-10-01.`
 * Fix handling of files with no trailing newline when putting annotations at
   the end of the file.
+* Now works on tables with no primary key.
+* Add --format=markdown option
+* "Table name" annotation (if table name is different from model name)
+* "Human name" annotation (enabling translation to non-English locales)
 
 == 2.4.2 2009-11-21
 

data/README.rdoc

@@ -41,9 +41,13 @@ Also, if you pass the -r option, it'll annotate routes.rb with the output of "ra
 
 == INSTALL
 
+Into Gemfile from rubygems.org:
+
+    gem 'annotate', ">=2.5.0.pre1"
+
 Into Gemfile from Github:
 
-    gem 'annotate', :git => 'git://github.com/MrJoy/annotate_models.git'
+    gem 'annotate', :git => 'git://github.com/ctran/annotate_models.git'
 
 Into environment gems From rubygems.org:
 
@@ -51,10 +55,10 @@ Into environment gems From rubygems.org:
 
 Into environment gems from Github checkout:
 
-  git clone git://github.com/MrJoy/annotate_models.git annotate_models
-  cd annotate_models
-  rake build
-  gem install pkg/annotate-*.gem
+    git clone git://github.com/ctran/annotate_models.git annotate_models
+    cd annotate_models
+    rake build
+    gem install pkg/annotate-*.gem
 
 == USAGE
 
@@ -63,23 +67,23 @@ Into environment gems from Github checkout:
 To annotate all your models, tests, fixtures, etc.:
 
   cd /path/to/app
-  annotate_models
+  annotate
 
 To annotate your models and tests:
 
-  annotate_models --exclude fixtures
+  annotate --exclude fixtures
 
 To annotate just your models:
 
-  annotate_models --exclude tests,fixtures
+  annotate --exclude tests,fixtures
 
 To annotate routes.rb:
 
-  annotate_models -r
+  annotate -r
 
 To remove annotations:
 
-  annotate_models -d
+  annotate -d
 
 To automatically annotate after running 'rake db:migrate', ensure you've added
 annotate_models to your Rails project's Gemfile, and run this:
@@ -103,21 +107,24 @@ anywhere in the file:
         -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 indexes for the table in the annotation
-        -s, --simple-indexes             Include information about indexes inline with the relevant column
+        -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
-            --ignore-model-subdirs       Ignore sub-directories of the models directory.
+            --ignore-model-subdirects    Ignore subdirectories of the models directory
+            --sort                       Sort columns alphabetically, rather than in creation order
         -R, --require path               Additional files to require before loading models
-        -e [tests,fixtures]              Skip annotation of fixtures/factories/test files
-            --exclude
-        -n  --no-sort                    Sort by column creation order rather than alphabetical order
+        -e, --exclude [tests,fixtures]   Do not annotate fixtures, test files, or both
+        -f [bare|rdoc|markdown],         Render Schema Infomation as plain/RDoc/Markdown
+            --format
+            --force                      Force new annotations even if there are no changes.
+
 
 == SORTING
 
-By default, columns will be sorted alphabetically so that the results of
-annotation are consistent regardless of what order migrations are executed in.
+By default, columns will be sorted in database order (i.e. the order in which migrations were run).
 
-If you prefer the old behavior, use --no-sort.
+If you prefer to sort alphabetically so that the results of
+annotation are consistent regardless of what order migrations are executed in, use  --sort.
 
 == WARNING
 
@@ -165,5 +172,12 @@ With help from:
 - Nathan Brazil - http://github.com/bitaxis
 - Ian Duggan http://github.com/ijcd
 - Jon Frisby http://github.com/mrjoy
+- Tsutomu Kuroda
+- Kevin Moore
+- Philip Hallstrom
+- Brent Greeff
+- Paul Alexander
+- Dmitry Lihachev
+- qichunren
 
 and many others that I may have missed to add.

data/bin/annotate

@@ -61,9 +61,9 @@ OptionParser.new do |opts|
     ENV['ignore_model_sub_dir'] = "yes"
   end
 
-  opts.on('-n', '--no-sort',
-          "Sort columns in creation order rather than alphabetically") do |dir|
-    ENV['no_sort'] = "yes"
+  opts.on('--sort',
+          "Sort columns alphabetically, rather than in creation order") do |dir|
+    ENV['sort'] = "yes"
   end
 
   opts.on('-R', '--require path',
@@ -73,7 +73,7 @@ OptionParser.new do |opts|
     else
       ENV['require'] = path
     end
-  end
+  end\
 
   opts.on('-e', '--exclude [tests,fixtures]', Array, "Do not annotate fixtures, test files, or both") do |exclusions|
     exclusions.each { |exclusion| ENV["exclude_#{exclusion}"] = "yes" }

data/lib/annotate/annotate_models.rb

@@ -39,7 +39,7 @@ module AnnotateModels
     def model_dir
       @model_dir || "app/models"
     end
-
+    
     def model_dir=(dir)
       @model_dir = dir
     end
@@ -77,12 +77,12 @@ module AnnotateModels
       end
 
       cols = klass.columns
-      cols = cols.sort_by(&:name) unless(options[:no_sort])
+      cols = cols.sort_by(&:name) if(options[:sort])
       cols.each do |col|
         attrs = []
         attrs << "default(#{quote(col.default)})" unless col.default.nil?
         attrs << "not null" unless col.null
-        attrs << "primary key" if col.name.to_sym == klass.primary_key.to_sym
+        attrs << "primary key" if klass.primary_key && col.name.to_sym == klass.primary_key.to_sym
 
         col_type = (col.type || col.sql_type).to_s
         if col_type == "decimal"
@@ -92,7 +92,7 @@ module AnnotateModels
             col_type << "(#{col.limit})" unless NO_LIMIT_COL_TYPES.include?(col_type)
           end
         end
-
+       
         # Check out if we got a geometric column
         # and print the type and SRID
         if col.respond_to?(:geometry_type)
@@ -207,13 +207,11 @@ module AnnotateModels
         end
       end
     end
-
+    
     def remove_annotation_of_file(file_name)
       if File.exist?(file_name)
         content = File.read(file_name)
-
         content.sub!(PATTERN, '')
-
         File.open(file_name, "wb") { |f| f.puts content }
       end
     end
@@ -304,7 +302,7 @@ module AnnotateModels
       end
       models
     end
-
+  
     # Retrieve the classes belonging to the model names we're asked to process
     # Check for namespaced models in subdirectories as well as models
     # in subdirectories without namespacing.
@@ -319,7 +317,10 @@ module AnnotateModels
     # Retrieve loaded model class by path to the file where it's supposed to be defined.
     def get_loaded_model(model_path)
       ObjectSpace.each_object.
-        select { |c| c.is_a?(Class) && c.ancestors.include?(ActiveRecord::Base) }.
+        select { |c|
+          Class === c and    # note: we use === to avoid a bug in activesupport 2.3.14 OptionMerger vs. is_a?
+          c.ancestors.include?(ActiveRecord::Base) 
+        }.
         detect { |c| ActiveSupport::Inflector.underscore(c) == model_path }
     end
 
@@ -340,9 +341,9 @@ module AnnotateModels
         version = ActiveRecord::Migrator.current_version rescue 0
         if version > 0
           header << "\n# Schema version: #{version}"
-        end
+        end        
       end
-
+      
       if options[:model_dir]
         self.model_dir = options[:model_dir]
       end
@@ -359,6 +360,8 @@ module AnnotateModels
         rescue Exception => e
           # todo: check if all backtrace lines are in "gems" -- if so, it's an annotate bug, so print the whole stack trace.
           puts "Unable to annotate #{file}: #{e.message} (#{e.backtrace.first})"
+          # todo: save this backtrace somewhere nice
+          # puts "\t" + e.backtrace.join("\n\t")
         end
       end
       if annotated.empty?
@@ -367,7 +370,7 @@ module AnnotateModels
         puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
       end
     end
-
+    
     def remove_annotations(options={})
       if options[:model_dir]
         puts "removing"

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    "2.5.0.pre1"
+    "2.5.0.pre2"
   end
 end

data/lib/tasks/annotate_models.rake

@@ -26,7 +26,7 @@ task :annotate_models => :environment do
   options[:ignore_model_sub_dir] = ENV['ignore_model_sub_dir'] =~ true_re
   options[:format_rdoc] = ENV['format_rdoc'] =~ true_re
   options[:format_markdown] = ENV['format_markdown'] =~ true_re
-  options[:no_sort] = ENV['no_sort'] =~ true_re
+  options[:sort] = ENV['sort'] =~ true_re
   options[:force] = ENV['force'] =~ true_re
   AnnotateModels.do_annotations(options)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotate
 version: !ruby/object:Gem::Version
-  version: 2.5.0.pre1
+  version: 2.5.0.pre2
   prerelease: 6
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,7 +74,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2416321078825126796
+      hash: 3749853893858180843
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: annotate
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Annotates Rails Models, routes, fixtures, and others based on the database