annotate 2.5.0.pre2 → 2.5.0.pre3

data/History.txt

@@ -61,6 +61,7 @@
 * Add --format=markdown option
 * "Table name" annotation (if table name is different from model name)
 * "Human name" annotation (enabling translation to non-English locales)
+* --trace option to help debug "Unable to annotate" errors
 
 == 2.4.2 2009-11-21
 

data/README.rdoc

@@ -43,7 +43,7 @@ Also, if you pass the -r option, it'll annotate routes.rb with the output of "ra
 
 Into Gemfile from rubygems.org:
 
-    gem 'annotate', ">=2.5.0.pre1"
+    gem 'annotate', ">=2.5.0.pre3"
 
 Into Gemfile from Github:
 
@@ -101,7 +101,7 @@ anywhere in the file:
 
 == OPTIONS
 
-    Usage: annotate_models [options] [model_file]*
+    Usage: annotate [options] [model_file]*
         -d, --delete                     Remove annotations from all model files
         -p, --position [before|after]    Place the annotations at the top (before) or the bottom (after) of the model file
         -r, --routes                     Annotate routes.rb with the output of 'rake routes'
@@ -117,6 +117,7 @@ anywhere in the file:
         -f [bare|rdoc|markdown],         Render Schema Infomation as plain/RDoc/Markdown
             --format
             --force                      Force new annotations even if there are no changes.
+            --trace                      If unable to annotate a file, print the full stack trace, not just the exception message.
 
 
 == SORTING

data/bin/annotate

@@ -13,7 +13,7 @@ end
 task = :annotate_models
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: annotate_models [options] [model_file]*"
+  opts.banner = "Usage: annotate [options] [model_file]*"
 
   opts.on('-d', '--delete',
           "Remove annotations from all model files") do
@@ -87,6 +87,11 @@ OptionParser.new do |opts|
     ENV['force'] = 'yes'
   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
+
+
 end.parse!
 
 ENV['is_cli'] = '1'

data/lib/annotate/annotate_models.rb

@@ -344,25 +344,11 @@ module AnnotateModels
         end        
       end
       
-      if options[:model_dir]
-        self.model_dir = options[:model_dir]
-      end
+      self.model_dir = options[:model_dir] if options[:model_dir]
 
       annotated = []
       get_model_files(options).each do |file|
-        begin
-          klass = get_model_class(file)
-          if klass && klass < ActiveRecord::Base && !klass.abstract_class?
-            if annotate(klass, file, header, options)
-              annotated << klass
-            end
-          end
-        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
+        annotate_model_file(annotated, file, header, options)
       end
       if annotated.empty?
         puts "Nothing annotated."
@@ -370,12 +356,23 @@ module AnnotateModels
         puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
       end
     end
-    
-    def remove_annotations(options={})
-      if options[:model_dir]
-        puts "removing"
-        self.model_dir = options[:model_dir]
+
+    def annotate_model_file(annotated, file, header, options)
+      begin
+        klass = get_model_class(file)
+        if klass && klass < ActiveRecord::Base && !klass.abstract_class?
+          if annotate(klass, file, header, options)
+            annotated << klass
+          end
+        end
+      rescue Exception => e
+        puts "Unable to annotate #{file}: #{e.message}"
+        puts "\t" + e.backtrace.join("\n\t") if options[:trace]
       end
+    end
+
+    def remove_annotations(options={})
+      self.model_dir = options[:model_dir] if options[:model_dir]
       deannotated = []
       get_model_files(options).each do |file|
         begin
@@ -406,7 +403,8 @@ module AnnotateModels
 
           end
         rescue Exception => e
-          puts "Unable to annotate #{file}: #{e.message}"
+          puts "Unable to deannotate #{file}: #{e.message}"
+          puts "\t" + e.backtrace.join("\n\t") if options[:trace]          
         end
       end
       puts "Removed annotation from: #{deannotated.join(', ')}"

data/lib/annotate/version.rb

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

data/lib/tasks/annotate_models.rake

@@ -28,6 +28,7 @@ task :annotate_models => :environment do
   options[:format_markdown] = ENV['format_markdown'] =~ true_re
   options[:sort] = ENV['sort'] =~ true_re
   options[:force] = ENV['force'] =~ true_re
+  options[:trace] = ENV['trace'] =~ 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.pre2
+  version: 2.5.0.pre3
   prerelease: 6
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2012-07-26 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: 3749853893858180843
+      hash: 4381666328163276586
 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.24
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Annotates Rails Models, routes, fixtures, and others based on the database