miyucy-annotate 2.4.3

data/History.txt

@@ -0,0 +1,51 @@
+== 2.4.2 2009-11-21
+
+* Annotates (spec|test)/factories/<model>_factory.rb files
+
+== 2.4.1 2009-11-20
+
+* Annotates thoughtbot's factory_girl factories (test/factories/<model>_factory.rb)
+* Move default annotation position back to top
+
+== 2.4.0 2009-12-13
+
+* Incorporated lots of patches from the Github community, including support for Blueprints fixtures
+* Several bug fixes
+
+== 2.1 2009-10-18
+
+* New options
+  * -R to require additional files before loading the models
+  * -i to show database indexes in annotations
+  * -e to exclude annotating tests or fixtures
+  * -m to include the migration version number in the annotation
+  * --model-dir to annotate model files stored a different place than app/models  
+* Ignore unknown macros ('acts_as_whatever')
+
+== 2.0 2009-02-03
+
+* Add annotate_models plugin fork additions
+  * Annotates Rspec and Test Unit models
+  * Annotates Object Daddy exemplars
+  * Annotates geometrical columns
+* Add AnnotateRoutes rake task
+* Up gem structure to newgem defaults
+
+== 1.0.4 2008-09-04
+
+* Only update modified models since last run, thanks to sant0sk1
+
+== 1.0.3 2008-05-02
+
+* Add misc changes from Dustin Sallings and Henrik N
+  * Remove trailing whitespace
+  * More intuitive info messages
+  * Update README file with update-to-date example
+
+== 1.0.2 2008-03-22
+
+* Add contributions from Michael Bumann (http://github.com/bumi)
+  * added an option "position" to choose to put the annotation,
+  * spec/fixtures now also get annotated
+  * added a task to remove the annotations
+  * these options can be specified from command line as -d and -p [before|after]

data/README.rdoc

@@ -0,0 +1,145 @@
+== Annotate (aka AnnotateModels)
+
+Add a comment summarizing the current schema to the top or bottom of each of your...
+
+  * ActiveRecord models
+  * Fixture files
+  * Tests and Specs
+  * Object Daddy exemplars
+  * Machinist blueprints
+  * Thoughtbot's factory_girl factories, i.e. the (spec|test)/factories/<model>_factory.rb files
+
+The schema comment looks like this:
+
+   # == Schema Info
+   #
+   # Table name: line_items
+   #
+   #  id                  :integer(11)    not null, primary key
+   #  quantity            :integer(11)    not null
+   #  product_id          :integer(11)    not null
+   #  unit_price          :float
+   #  order_id            :integer(11)
+   #
+
+    class LineItem < ActiveRecord::Base
+      belongs_to :product
+     . . .
+
+It also annotates geometrical columns, geom type and srid, when using SpatialAdapter or PostgisAdapter:
+
+   # == Schema Info
+   #
+   # Table name: trips
+   #
+   #  local           :geometry        point, 4326
+   #  path            :geometry        line_string, 4326
+
+Also, if you pass the -r option, it'll annotate routes.rb with the output of "rake routes".
+
+== INSTALL
+
+From rubyforge:
+
+  sudo gem install annotate
+
+From github:
+
+  git clone git://github.com/ctran/annotate_models.git annotate
+  cd annotate
+  gem build annotate.gemspec
+  sudo gem install annotate-<version>.gem
+
+== USAGE
+
+To annotate all your models, tests, fixtures, etc.:
+
+  cd /path/to/app
+  annotate
+
+To annotate your models and tests:
+
+  annotate --exclude fixtures
+
+To annotate just your models:
+
+  annotate --exclude tests,fixtures
+
+To annotate routes.rb:
+
+  annotate -r
+
+To automatically annotate after running 'rake db:migrate':
+  
+  [needs more clarity] unpack the gem into vendor/plugins, or maybe vendor/gems, or maybe just require tasks/migrate.rake.
+
+If you install annotate_models as a plugin, it will automatically
+adjust your <tt>rake db:migrate</tt> tasks so that they update the
+annotations in your model files for you once the migration is
+completed.
+
+Warning: ImageMagick installs a tool called `annotate` too (if you're using MacPorts it's in `/opt/local/bin/annotate`. So if you see Usage: annotate imagein.jpg imageout.jpg then put `/usr/bin` ahead on the path and you'll get ours instead. 
+
+
+== OPTIONS
+
+    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'
+        -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
+        -R, --require path               Additional files to require before loading models
+        -e [tests,fixtures,factories]    Do not annotate fixtures, test files, and/or factories
+            --exclude
+
+
+== WARNING
+
+Note that this code will blow away the initial/final comment
+block in your models if it looks like it was previously added
+by annotate models, so you don't want to add additional text
+to an automatically created comment block.
+
+        * * Back up your model files before using... * *
+
+== LINKS
+
+* Factory Girl => http://github.com/thoughtbot/factory_girl
+* Object Daddy => http://github.com/flogic/object_daddy
+* SpatialAdapter => http://github.com/pdeffendol/spatial_adapter
+* PostgisAdapter => http://github.com/nofxx/postgis_adapter
+
+== LICENSE:
+
+Released under the same license as Ruby. No Support. No Warranty.
+
+== AUTHOR:
+
+Original code by: Dave Thomas -- Pragmatic Programmers, LLC
+Overhauled by: Alex Chaffee
+Gemmed by: Cuong Tran
+Maintained by: Alex Chaffee and Cuong Tran
+Homepage: http://github.com/ctran/annotate_models
+
+Modifications by:
+
+ - Alex Chaffee - http://github.com/alexch - alex@pivotallabs.com
+ - Cuong Tran - http://github.com/ctran - ctran@pragmaquest.com
+ - Jack Danger - http://github.com/JackDanger
+ - Michael Bumann - http://github.com/bumi
+ - Henrik Nyh - http://github.com/henrik
+ - Marcos Piccinini - http://github.com/nofxx
+ - Neal Clark - http://github.com/nclark
+ - Jacqui Maher - http://github.com/jacqui
+ - Nick Plante - http://github.com/zapnap - http://blog.zerosum.org
+ - Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com
+ - Bob Potter - http://github.com/bpot
+ - Gavin Montague - http://github.com/govan/
+ - Alexander Semyonov - http://github.com/rotuka/
+ - Nathan Brazil - http://github.com/bitaxis/
+ 
+and many others that I may have missed to add.

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 2
+:minor: 4
+:patch: 3
+:build: 

data/bin/annotate

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'annotate'
+
+task = :annotate_models
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: annotate [options] [model_file]*"
+
+  opts.on('-d', '--delete',
+          "Remove annotations from all model files") do
+    task = :remove_annotation
+  end
+
+  opts.on('-p', '--position [before|after]', ['before', 'after'],
+          "Place the annotations at the top (before) or the bottom (after) of the model file") do |p|
+    ENV['position'] = p
+  end
+
+  opts.on('-r', '--routes',
+          "Annotate routes.rb with the output of 'rake routes'") do
+    task = :annotate_routes
+  end
+
+  opts.on('-v', '--version',
+          "Show the current version of this gem") do
+    puts "annotate v#{Annotate.version}"; exit
+  end
+
+  opts.on('-m', '--show-migration',
+          "Include the migration version number in the annotation") do
+    ENV['include_version'] = "yes"
+  end
+
+  opts.on('-i', '--show-indexes',
+          "List the table's database indexes in the annotation") do
+    ENV['show_indexes'] = "yes"
+  end
+
+  opts.on('-s', '--simple-indexes',
+          "Concat the column's related indexes in the annotation") do
+    ENV['simple_indexes'] = "yes"
+  end
+
+  opts.on('--model-dir dir',
+          "Annotate model files stored in dir rather than app/models") do |dir|
+    ENV['model_dir'] = dir
+  end
+
+  opts.on('-R', '--require path',
+          "Additional files to require before loading models") do |path|
+    if ENV['require']
+      ENV['require'] = ENV['require'] + ",#{path}"
+    else
+      ENV['require'] = path
+    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" }
+  end
+
+  opts.on('-f', '--format [bare|rdoc]', ['bare', 'rdoc'], 'rdoc: render Schema Infomation as RDoc') do |fmt|
+    ENV['format_#{fmt}'] = 'yes'
+  end
+
+end.parse!
+
+if Annotate.load_tasks
+  Rake::Task[task].invoke
+else
+  STDERR.puts "Can't find Rakefile. Are we in a Rails folder?"
+end

data/lib/annotate.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+module Annotate
+  def self.version
+    version_file = File.dirname(__FILE__) + "/../VERSION.yml"
+    if File.exist?(version_file)
+      config = YAML.load(File.read(version_file))
+      version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+    else
+      version = "0.0.0"
+    end
+  end
+
+  def self.load_tasks
+    if File.exists?('Rakefile')
+      load 'Rakefile'
+      Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
+      return true
+    else
+      return false
+    end
+  end
+end

data/lib/annotate/annotate_models.rb

@@ -0,0 +1,356 @@
+module AnnotateModels
+  # Annotate Models plugin use this header
+  COMPAT_PREFIX = "== Schema Info"
+  PREFIX        = "== Schema Information"
+  END_MARK      = "== Schema Information End"
+  PATTERN       = /^\n?# #{COMPAT_PREFIX}.*?\n(#.*\n)*\n/
+
+  # File.join for windows reverse bar compat?
+  # I dont use windows, can`t test
+  UNIT_TEST_DIR         = File.join("test", "unit"  )
+  SPEC_MODEL_DIR        = File.join("spec", "models")
+  FIXTURE_TEST_DIR      = File.join("test", "fixtures")
+  FIXTURE_SPEC_DIR      = File.join("spec", "fixtures")
+  # Object Daddy http://github.com/flogic/object_daddy/tree/master
+  EXEMPLARS_TEST_DIR    = File.join("test", "exemplars")
+  EXEMPLARS_SPEC_DIR    = File.join("spec", "exemplars")
+  # Machinist http://github.com/notahat/machinist
+  BLUEPRINTS_TEST_DIR   = File.join("test", "blueprints")
+  BLUEPRINTS_SPEC_DIR   = File.join("spec", "blueprints")
+  # Factory Girl http://github.com/thoughtbot/factory_girl
+  FACTORY_GIRL_TEST_DIR = File.join("test", "factories")
+  FACTORY_GIRL_SPEC_DIR = File.join("spec", "factories")
+
+  # 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"
+    end
+
+    def model_dir=(dir)
+      @model_dir = dir
+    end
+
+    # Simple quoting for the default column value
+    def quote(value)
+      case value
+      when NilClass                 then "NULL"
+      when TrueClass                then "TRUE"
+      when FalseClass               then "FALSE"
+      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')
+      else
+        value.inspect
+      end
+    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,
+    # the type (and length), and any optional attributes
+    def get_schema_info(klass, header, options = {})
+      info = "# #{header}\n"
+      info<< "#\n"
+      info<< "# Table name: #{klass.table_name}\n"
+      info<< "#\n"
+
+      max_size = klass.column_names.map{|name| name.size}.max + (ENV['format_rdoc'] ? 5 : 1)
+      klass.columns.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
+
+        col_type = col.type.to_s
+        if col_type == "decimal"
+          col_type << "(#{col.precision}, #{col.scale})"
+        else
+          if (col.limit)
+            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)
+          attrs << "#{col.geometry_type}, #{col.srid}"
+        end
+
+        # Check if the column has indices and print "indexed" if true
+        # If the indice include another colum, print it too.
+        if options[:simple_indexes] # 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|
+              ind = ind.columns.reject! { |i| i == col.name }
+              attrs << (ind.length == 0 ? "indexed" : "indexed => [#{ind.join(", ")}]")
+            end
+          end
+        end
+
+        if ENV['format_rdoc']
+          info << sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col.name}*::", attrs.unshift(col_type).join(", ")).rstrip + "\n"
+        else
+          info << sprintf("#  %-#{max_size}.#{max_size}s:%-15.15s %s", col.name, col_type, attrs.join(", ")).rstrip + "\n"
+        end
+      end
+
+      if options[:show_indexes]
+        info << get_index_info(klass)
+      end
+
+      if ENV['format_rdoc']
+        info << "#--\n"
+        info << "# #{END_MARK}\n"
+        info << "#++\n\n"
+      else
+        info << "#\n\n"
+      end
+    end
+
+    def get_index_info(klass)
+      index_info = "#\n# Indexes\n#\n"
+
+      indexes = klass.connection.indexes(klass.table_name)
+      return "" if indexes.empty?
+
+      max_size = indexes.collect{|index| index.name.size}.max + 1
+      indexes.each do |index|
+        index_info << sprintf("#  %-#{max_size}.#{max_size}s %s %s", index.name, "(#{index.columns.join(",")})", index.unique ? "UNIQUE" : "").rstrip + "\n"
+      end
+      return index_info
+    end
+
+    # Add a schema block to a file. If the file already contains
+    # a schema info block (a comment starting with "== Schema Information"), check if it
+    # matches the block that is already there. If so, leave it be. If not, remove the old
+    # info block and write a new one.
+    # Returns true or false depending on whether the file was modified.
+    #
+    # === Options (opts)
+    #  :position<Symbol>:: where to place the annotated section in fixture or model file,
+    #                      "before" or "after". Default is "before".
+    #  :position_in_class<Symbol>:: where to place the annotated section in model file
+    #  :position_in_fixture<Symbol>:: where to place the annotated section in fixture file
+    #  :position_in_others<Symbol>:: where to place the annotated section in the rest of
+    #                      supported files
+    #
+    def annotate_one_file(file_name, info_block, options={})
+      if File.exist?(file_name)
+        old_content = File.read(file_name)
+
+        # Ignore the Schema version line because it changes with each migration
+        header = Regexp.new(/(^# Table name:.*?\n(#.*\n)*\n)/)
+        old_header = old_content.match(header).to_s
+        new_header = info_block.match(header).to_s
+
+        if old_header == new_header
+          false
+        else
+          # Remove old schema info
+          old_content.sub!(PATTERN, '')
+
+          # Write it back
+          new_content = options[:position].to_s == 'after' ? (old_content + "\n" + info_block) : (info_block + old_content)
+
+          File.open(file_name, "wb") { |f| f.puts new_content }
+          true
+        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
+
+    # Given the name of an ActiveRecord class, create a schema
+    # info block (basically a comment containing information
+    # on the columns and their types) and put it at the front
+    # of the model and fixture source files.
+    # Returns true or false depending on whether the source
+    # files were modified.
+    def annotate(klass, file, header,options={})
+      info = get_schema_info(klass, header, options)
+      annotated = false
+      model_name = klass.name.underscore
+      model_file_name = File.join(model_dir, file)
+
+      if annotate_one_file(model_file_name, info, options_with_position(options, :position_in_class))
+        annotated = true
+      end
+
+      unless ENV['exclude_tests']
+        [
+         File.join(UNIT_TEST_DIR,      "#{model_name}_test.rb"), # test
+         File.join(SPEC_MODEL_DIR,     "#{model_name}_spec.rb"), # spec
+        ].each do |file|
+          # todo: add an option "position_in_test" -- or maybe just ask if anyone ever wants different positions for model vs. test vs. fixture
+          annotate_one_file(file, info, options_with_position(options, :position_in_fixture)) if File.exist?(file)
+        end
+      end
+
+      unless ENV['exclude_fixtures']
+        [
+         File.join(FIXTURE_TEST_DIR,       "#{klass.table_name}.yml"),    # fixture
+         File.join(FIXTURE_SPEC_DIR,       "#{klass.table_name}.yml"),    # fixture
+         File.join(EXEMPLARS_TEST_DIR,     "#{model_name}_exemplar.rb"),  # Object Daddy
+         File.join(EXEMPLARS_SPEC_DIR,     "#{model_name}_exemplar.rb"),  # Object Daddy
+         File.join(BLUEPRINTS_TEST_DIR,    "#{model_name}_blueprint.rb"), # Machinist Blueprints
+         File.join(BLUEPRINTS_SPEC_DIR,    "#{model_name}_blueprint.rb"), # Machinist Blueprints
+         File.join(FACTORY_GIRL_TEST_DIR,  "#{model_name}_factory.rb"),   # Factory Girl Factories
+         File.join(FACTORY_GIRL_SPEC_DIR,  "#{model_name}_factory.rb"),   # Factory Girl Factories
+        ].each do |file|
+          annotate_one_file(file, info, options_with_position(options, :position_in_fixture)) if File.exist?(file)
+        end
+      end
+
+      annotated
+    end
+
+    # position = :position_in_fixture or :position_in_class
+    def options_with_position(options, position_in)
+      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.
+    def get_model_files
+      models = ARGV.dup
+      models.shift
+      models.reject!{|m| m.match(/^(.*)=/)}
+      if models.empty?
+        begin
+          Dir.chdir(model_dir) do
+            models = Dir["**/*.rb"]
+          end
+        rescue SystemCallError
+          puts "No models found in directory '#{model_dir}'."
+          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
+
+    # 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.
+    def get_model_class(file)
+      require File.expand_path("#{model_dir}/#{file}") # this is for non-rails projects, which don't get Rails auto-require magic
+      model = file.gsub(/\.rb$/, '').camelize
+      parts = model.split('::')
+      begin
+        parts.inject(Object) {|klass, part| klass.const_get(part) }
+      rescue LoadError, NameError
+        Object.const_get(parts.last)
+      end
+    end
+
+    # We're passed a name of things that might be
+    # ActiveRecord models. If we can find the class, and
+    # if its a subclass of ActiveRecord::Base,
+    # then pass it to the associated block
+    def do_annotations(options={})
+      if options[:require]
+        options[:require].each do |path|
+          require path
+        end
+      end
+
+      header = PREFIX.dup
+
+      if options[:include_version]
+        version = ActiveRecord::Migrator.current_version rescue 0
+        if version > 0
+          header << "\n# Schema version: #{version}"
+        end
+      end
+
+      if options[:model_dir]
+        self.model_dir = options[:model_dir]
+      end
+
+      annotated = []
+      get_model_files.each do |file|
+        begin
+          klass = get_model_class(file)
+          if 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} (#{e.backtrace.first})"
+        end
+      end
+      if annotated.empty?
+        puts "Nothing annotated."
+      else
+        puts "Annotated (#{annotated.length}): #{annotated.join(', ')}"
+      end
+    end
+
+    def remove_annotations(options={})
+      if options[:model_dir]
+        puts "removing"
+        self.model_dir = options[:model_dir]
+      end
+      deannotated = []
+      get_model_files.each do |file|
+        begin
+          klass = get_model_class(file)
+          if klass < ActiveRecord::Base && !klass.abstract_class?
+            deannotated << klass
+
+            model_name = klass.name.underscore
+            model_file_name = File.join(model_dir, file)
+            remove_annotation_of_file(model_file_name)
+
+            [
+             File.join(UNIT_TEST_DIR,          "#{model_name}_test.rb"),
+             File.join(SPEC_MODEL_DIR,         "#{model_name}_spec.rb"),
+             File.join(FIXTURE_TEST_DIR,       "#{klass.table_name}.yml"),    # fixture
+             File.join(FIXTURE_SPEC_DIR,       "#{klass.table_name}.yml"),    # fixture
+             File.join(EXEMPLARS_TEST_DIR,     "#{model_name}_exemplar.rb"),  # Object Daddy
+             File.join(EXEMPLARS_SPEC_DIR,     "#{model_name}_exemplar.rb"),  # Object Daddy
+             File.join(BLUEPRINTS_TEST_DIR,    "#{model_name}_blueprint.rb"), # Machinist Blueprints
+             File.join(BLUEPRINTS_SPEC_DIR,    "#{model_name}_blueprint.rb"), # Machinist Blueprints
+             File.join(FACTORY_GIRL_TEST_DIR,  "#{model_name}_factory.rb"),   # Factory Girl Factories
+             File.join(FACTORY_GIRL_SPEC_DIR,  "#{model_name}_factory.rb"),   # Factory Girl Factories
+            ].each do |file|
+              remove_annotation_of_file(file) if File.exist?(file)
+            end
+
+          end
+        rescue Exception => e
+          puts "Unable to annotate #{file}: #{e.message}"
+        end
+      end
+      puts "Removed annotation from: #{deannotated.join(', ')}"
+    end
+  end
+end
+
+# monkey patches
+
+module ::ActiveRecord
+  class Base
+    def self.method_missing(name, *args)
+      # ignore this, so unknown/unloaded macros won't cause parsing to fail
+    end
+  end
+end

data/lib/annotate/annotate_routes.rb

@@ -0,0 +1,41 @@
+# == Annotate Routes
+# 
+# Based on:
+# 
+# 
+#
+# Prepends the output of "rake routes" to the top of your routes.rb file.
+# Yes, it's simple but I'm thick and often need a reminder of what my routes mean.
+# 
+# Running this task will replace any exising route comment generated by the task.
+# Best to back up your routes file before running:
+# 
+# Author:
+#  Gavin Montague
+#  gavin@leftbrained.co.uk
+#   
+# Released under the same license as Ruby. No Support. No Warranty.module AnnotateRoutes
+#
+module AnnotateRoutes 
+  PREFIX = "#== Route Map"
+  
+  def self.do_annotate 
+    routes_rb = File.join("config", "routes.rb")
+    header = PREFIX + "\n# Generated on #{Time.now.strftime("%d %b %Y %H:%M")}\n#"
+    if File.exists? routes_rb
+      routes_map = `rake routes`
+      routes_map = routes_map.split("\n")
+      routes_map.shift # remove the first line of rake routes which is just a file path
+      routes_map = routes_map.inject(header){|sum, line| sum<<"\n# "<<line}
+      content = File.read(routes_rb)
+      content, old = content.split(/^#== Route .*?\n/)
+      File.open(routes_rb, "wb") do |f| 
+        f.puts content.sub!(/\n?\z/, "\n") + routes_map 
+      end
+      puts "Route file annotated."
+    else
+      puts "Can`t find routes.rb"
+    end
+  end
+
+end

data/lib/tasks/annotate_models.rake

@@ -0,0 +1,22 @@
+desc "Add schema information (as comments) to model and fixture files"
+task :annotate_models => :environment do
+  require 'annotate/annotate_models'
+  options={}
+  options[:position_in_class]   = ENV['position_in_class']   || ENV['position'] || :before
+  options[:position_in_factory] = ENV['position_in_factory'] || ENV['position'] || :before
+  options[:position_in_fixture] = ENV['position_in_fixture'] || ENV['position'] || :before
+  options[:show_indexes]        = ENV['show_indexes']
+  options[:simple_indexes]      = ENV['simple_indexes']
+  options[:model_dir]           = ENV['model_dir']
+  options[:include_version]     = ENV['include_version']
+  options[:require]             = ENV['require'] ? ENV['require'].split(', ') : []
+  AnnotateModels.do_annotations(options)
+end
+
+desc "Remove schema information from model and fixture files"
+task :remove_annotation => :environment do
+  require 'annotate/annotate_models'
+  options={}
+  options[:model_dir] = ENV['model_dir']
+  AnnotateModels.remove_annotations(options)
+end

data/lib/tasks/annotate_routes.rake

@@ -0,0 +1,5 @@
+desc "Prepends the route map to the top of routes.rb"
+task :annotate_routes => :environment do
+  require 'annotate/annotate_routes'
+  AnnotateRoutes.do_annotate
+end

data/lib/tasks/migrate.rake

@@ -0,0 +1,50 @@
+# These tasks are added to the project if you install annotate as a Rails plugin.
+# (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.
+
+def run_annotate_models?
+  update_on_migrate = true
+  (defined? ANNOTATE_MODELS_PREFS::UPDATE_ON_MIGRATE) && 
+    (!ANNOTATE_MODELS_PREFS::UPDATE_ON_MIGRATE.nil?) ? 
+      ANNOTATE_MODELS_PREFS::UPDATE_ON_MIGRATE : true
+end
+
+
+namespace :db do
+  task :migrate do
+    if run_annotate_models?
+      Annotate::Migration.update_annotations
+    end
+  end
+
+  task :update => [:migrate] do
+    Annotate::Migration.update_annotations
+  end
+
+  namespace :migrate do
+    [:up, :down, :reset, :redo].each do |t|
+      task t do
+        if run_annotate_models?
+          Annotate::Migration.update_annotations
+        end
+      end
+    end
+  end
+end
+
+module Annotate
+  class Migration
+    @@working = false
+
+    def self.update_annotations
+      unless @@working
+        @@working = true
+        Rake::Task['annotate_models'].invoke
+      end
+    end
+  end
+end

data/spec/annotate/annotate_models_spec.rb

@@ -0,0 +1,230 @@
+#encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'annotate/annotate_models'
+require 'active_support'
+require 'fakefs/spec_helpers'
+require 'tmpdir'
+
+describe AnnotateModels do
+  include FakeFS::SpecHelpers
+
+  def mock_class(table_name, primary_key, columns)
+    options = {
+      :connection   => mock("Conn", :indexes => []),
+      :table_name   => table_name,
+      :primary_key  => primary_key.to_s,
+      :column_names => columns.map { |col| col.name.to_s },
+      :columns      => columns
+    }
+
+    mock("An ActiveRecord class", options)
+  end
+
+  def mock_column(name, type, options={})
+    default_options = {
+      :limit   => nil,
+      :null    => false,
+      :default => nil
+    }
+
+    stubs = default_options.dup
+    stubs.merge!(options)
+    stubs.merge!(:name => name, :type => type)
+
+    mock("Column", stubs)
+  end
+
+  it { AnnotateModels.quote(nil).should eql("NULL") }
+  it { AnnotateModels.quote(true).should eql("TRUE") }
+  it { AnnotateModels.quote(false).should eql("FALSE") }
+  it { AnnotateModels.quote(25).should eql("25") }
+  it { AnnotateModels.quote(25.6).should eql("25.6") }
+  it { AnnotateModels.quote(1e-20).should eql("1.0e-20") }
+
+  it "should get schema info" do
+    klass = mock_class(:users, :id, [
+                                     mock_column(:id, :integer),
+                                     mock_column(:name, :string, :limit => 50)
+                                    ])
+
+    AnnotateModels.get_schema_info(klass, "Schema Info").should eql(<<-EOS)
+# Schema Info
+#
+# Table name: users
+#
+#  id   :integer         not null, primary key
+#  name :string(50)      not null
+#
+
+EOS
+  end
+
+  it "should get schema info as RDoc" do
+    klass = mock_class(:users, :id, [
+                                     mock_column(:id, :integer),
+                                     mock_column(:name, :string, :limit => 50)
+                                    ])
+    ENV.stub!(:[]).with('format_rdoc').and_return(true)
+    AnnotateModels.get_schema_info(klass, AnnotateModels::PREFIX).should eql(<<-EOS)
+# #{AnnotateModels::PREFIX}
+#
+# Table name: users
+#
+# *id*::   <tt>integer, not null, primary key</tt>
+# *name*:: <tt>string(50), not null</tt>
+#--
+# #{AnnotateModels::END_MARK}
+#++
+
+EOS
+  end
+
+  describe "#get_model_class" do
+
+    def create(file, body="hi")
+      path = @dir + '/' + file
+      File.open(path, "w") do |f|
+        f.puts(body)
+      end
+      path
+    end
+
+    before :all do
+      @dir = File.join Dir.tmpdir, "annotate_models"
+      FileUtils.mkdir_p(@dir)
+      AnnotateModels.model_dir = @dir
+
+      create('foo.rb', <<-EOS)
+        class Foo < ActiveRecord::Base
+        end
+      EOS
+      create('foo_with_macro.rb', <<-EOS)
+        class FooWithMacro < ActiveRecord::Base
+          acts_as_awesome :yah
+        end
+      EOS
+      create('foo_with_utf8.rb', <<-EOS)
+        #encoding: utf-8
+        class FooWithUtf8 < ActiveRecord::Base
+          UTF8STRINGS = %w[résumé façon âge]
+        end
+      EOS
+    end
+
+    it "should work" do
+      klass = AnnotateModels.get_model_class("foo.rb")
+      klass.name.should == "Foo"
+    end
+
+    it "should not care about unknown macros" do
+      klass = AnnotateModels.get_model_class("foo_with_macro.rb")
+      klass.name.should == "FooWithMacro"
+    end
+
+    it "should not complain of invalid multibyte char (USASCII)" do
+      klass = AnnotateModels.get_model_class("foo_with_utf8.rb")
+      klass.name.should == "FooWithUtf8"
+    end
+  end
+
+  describe "#remove_annotation_of_file" do
+    def create(file, body="hi")
+      File.open(file, "w") do |f|
+        f.puts(body)
+      end
+    end
+
+    def content(file)
+      File.read(file)
+    end
+
+    it "should remove before annotate" do
+      create("before.rb", <<-EOS)
+# == Schema Information
+#
+# Table name: foo
+#
+#  id                  :integer         not null, primary key
+#  created_at          :datetime
+#  updated_at          :datetime
+#
+
+class Foo < ActiveRecord::Base
+end
+      EOS
+
+      AnnotateModels.remove_annotation_of_file("before.rb")
+
+      content("before.rb").should == <<-EOS
+class Foo < ActiveRecord::Base
+end
+      EOS
+    end
+
+    it "should remove after annotate" do
+      create("after.rb", <<-EOS)
+class Foo < ActiveRecord::Base
+end
+
+# == Schema Information
+#
+# Table name: foo
+#
+#  id                  :integer         not null, primary key
+#  created_at          :datetime
+#  updated_at          :datetime
+#
+
+      EOS
+
+      AnnotateModels.remove_annotation_of_file("after.rb")
+
+      content("after.rb").should == <<-EOS
+class Foo < ActiveRecord::Base
+end
+      EOS
+    end
+  end
+
+  describe "annotating a file" do
+    before do
+      @file_name    = "user.rb"
+      @file_content = <<-EOS
+class User < ActiveRecord::Base
+end
+      EOS
+      File.open(@file_name, "wb") { |f| f.write @file_content }
+      @klass = mock_class(:users, :id, [
+                                        mock_column(:id, :integer),
+                                        mock_column(:name, :string, :limit => 50)
+                                       ])
+      @schema_info = AnnotateModels.get_schema_info(@klass, "== Schema Info")
+    end
+
+    it "should annotate the file before the model if position == 'before'" do
+      AnnotateModels.annotate_one_file(@file_name, @schema_info, :position => "before")
+      File.read(@file_name).should == "#{@schema_info}#{@file_content}"
+    end
+
+    it "should annotate before if given :position => :before" do
+      AnnotateModels.annotate_one_file(@file_name, @schema_info, :position => :before)
+      File.read(@file_name).should == "#{@schema_info}#{@file_content}"
+    end
+
+    it "should annotate before if given :position => :after" do
+      AnnotateModels.annotate_one_file(@file_name, @schema_info, :position => :after)
+      File.read(@file_name).should == "#{@file_content}\n#{@schema_info}"
+    end
+
+    it "should update annotate position" do
+      AnnotateModels.annotate_one_file(@file_name, @schema_info, :position => :before)
+
+      another_schema_info = AnnotateModels.get_schema_info(mock_class(:users, :id, [mock_column(:id, :integer),]),
+                                                           "== Schema Info")
+
+      AnnotateModels.annotate_one_file(@file_name, another_schema_info, :position => :after)
+
+      File.read(@file_name).should == "#{@file_content}\n#{another_schema_info}"
+    end
+  end
+end

data/spec/annotate/annotate_routes_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'annotate/annotate_routes'
+
+describe AnnotateRoutes do
+
+  def mock_file(stubs={})
+    @mock_file ||= mock(File, stubs)
+  end
+
+  describe "Annotate Job" do
+
+    before(:each) do
+      File.should_receive(:join).with("config", "routes.rb").and_return("config/routes.rb")
+    end
+
+    it "should check if routes.rb exists" do
+      File.should_receive(:exists?).with("config/routes.rb").and_return(false)
+      AnnotateRoutes.should_receive(:puts).with("Can`t find routes.rb")
+      AnnotateRoutes.do_annotate
+    end
+
+    describe "When Annotating" do
+
+      before(:each) do
+        File.should_receive(:exists?).with("config/routes.rb").and_return(true)
+        AnnotateRoutes.should_receive(:`).with("rake routes").and_return("bad line\ngood line")
+        File.should_receive(:open).with("config/routes.rb", "wb").and_yield(mock_file)
+        AnnotateRoutes.should_receive(:puts).with("Route file annotated.")
+      end
+
+      it "should annotate and add a newline!" do
+        File.should_receive(:read).with("config/routes.rb").and_return("ActionController::Routing...\nfoo")
+        @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n#== Route Map\n# Generated on .*\n#\n# good line/)
+        AnnotateRoutes.do_annotate
+      end
+
+      it "should not add a newline if there are empty lines" do
+        File.should_receive(:read).with("config/routes.rb").and_return("ActionController::Routing...\nfoo\n")
+        @mock_file.should_receive(:puts).with(/ActionController::Routing...\nfoo\n#== Route Map\n# Generated on .*\n#\n# good line/)
+        AnnotateRoutes.do_annotate
+      end
+
+    end
+
+  end
+
+end

data/spec/annotate_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Annotate do
+
+  it "should have a version" do
+    Annotate.version.should be_instance_of(String)
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format=specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'annotate'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: miyucy-annotate
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 2
+  - 4
+  - 3
+  version: 2.4.3
+platform: ruby
+authors: 
+- Cuong Tran
+- Alex Chaffee
+- Marcos Piccinini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-15 00:00:00 +09:00
+default_executable: annotate
+dependencies: []
+
+description: Annotates Rails Models, routes, fixtures, and others based on the database schema.
+email: 
+- alex@stinky.com
+- ctran@pragmaquest.com
+- x@nofxx.com
+executables: 
+- annotate
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- README.rdoc
+- VERSION.yml
+- bin/annotate
+- lib/annotate.rb
+- lib/annotate/annotate_models.rb
+- lib/annotate/annotate_routes.rb
+- lib/tasks/annotate_models.rake
+- lib/tasks/annotate_routes.rake
+- lib/tasks/migrate.rake
+- spec/annotate/annotate_models_spec.rb
+- spec/annotate/annotate_routes_spec.rb
+- spec/annotate_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/miyucy/annotate
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: annotate
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Annotates Rails Models, routes, fixtures, and others based on the database schema.
+test_files: 
+- spec/annotate_spec.rb
+- spec/spec_helper.rb
+- spec/annotate/annotate_models_spec.rb
+- spec/annotate/annotate_routes_spec.rb