tonyday-annotate 2.0.2

data/History.txt

@@ -0,0 +1,28 @@
+== 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,94 @@
+== AnnotateModels
+
+Add a comment summarizing the current schema to the bottom of each 
+ActiveRecord model, fixture file.
+
+If you are using Object Daddy, it`ll annotate your example files too.
+
+ # == 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
+   . . .
+   
+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
+          
+== 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... * *
+         
+== Install
+
+From rubyforge:
+
+  sudo gem install annotate
+  
+From github:
+
+  gem sources -a http://gems.github.com
+  sudo gem install ctran-annotate
+
+== Usage
+
+To annotate all your models:
+
+  cd /path/to/app
+  annotate
+
+To annotate routes.rb:
+
+  annotate -r
+
+More options:
+
+  Usage: annotate [options]
+      -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
+          --model-dir dir              Annotate model files stored in dir rather than app/models
+
+== LICENSE:
+
+Released under the same license as Ruby. No Support. No Warranty.
+
+== Author:
+
+Original code by:
+
+  Dave Thomas -- Pragmatic Programmers, LLC
+
+Modifications by:
+
+ - Alex Chaffee - http://github.com/alexch - alex@pivotallabs.com
+ - Cuong Tran - http://github.com/ctran
+ - Jack Danger - http://github.com/JackDanger
+ - Michael Bumann - http://github.com/bumi
+ - Henrik Nyh - http://github.com/henrik
+ - Marcos Piccinini - http://github.com/nofxx
+
+and many others that I may have missed to add.
+

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen hoe].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/annotate'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('annotate', Annotate::VERSION) do |p|
+  p.developer('Cuong Tran', 'ctran@pragmaquest.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = 'annotate-models'
+  p.url                  = "http://github.com/ctran/annotate_models"
+  p.summary              = "Annotates Rails Models, routes, and others"
+  p.description          = "Annotates Rails Models, routes, and others"
+  
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/annotate_models.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{annotate}
+  s.version = "2.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tony Day"]
+  s.date = %q{2009-07-23}
+  s.default_executable = %q{annotate}
+  s.description = %q{Annotates Rails Models, routes, and others}
+  s.email = ["tonyd@panztell.com"]
+  s.executables = ["annotate"]
+  s.extra_rdoc_files = ["History.txt", "README.rdoc"]
+  s.files = ["History.txt", "README.rdoc", "Rakefile", "annotate_models.gemspec", "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"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/tonyday/annotate_models}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{annotate-models}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Annotates Rails Models, routes, and others}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<newgem>, [">= 1.4.1"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.4.1"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.4.1"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end
+

data/bin/annotate

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'annotate'
+
+task = :annotate_models
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: annotate [options]"
+  opts.on('-d', '--delete', "Remove annotations from all model files") { task = :remove_annotation }
+  opts.on('-p', '--position [before|after]', ['before', 'after'], "Place the annotations at the top (before) or the bottom (after) of the model file") { |p| ENV['position'] = p }
+  opts.on('-r', '--routes', "Annotate routes.rb with the output of 'rake routes'") { task = :annotate_routes }
+  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!
+
+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,16 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Annotate
+  VERSION = '2.0.2'
+  
+  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,264 @@
+module AnnotateModels
+  class << self
+    # Annotate Models plugin use this header
+    COMPAT_PREFIX = "== Schema Info"
+    PREFIX = "== Schema Information"
+    
+    FIXTURE_DIRS = ["test/fixtures","spec/fixtures"]
+    # 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")
+    # Object Daddy http://github.com/flogic/object_daddy/tree/master
+    EXEMPLARS_DIR     = File.join("spec", "exemplars")
+    
+    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#\n"
+      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
+        attrs << "not null" unless col.null
+        attrs << "primary key" if col.name == klass.primary_key
+
+        col_type = col.type.to_s
+        if col_type == "decimal"
+          col_type << "(#{col.precision}, #{col.scale})"
+        else
+          col_type << "(#{col.limit})" if col.limit
+        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  
+        
+        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)
+      end
+
+      info << "#\n\n"
+    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
+    #
+    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!(/^# #{COMPAT_PREFIX}.*?\n(#.*\n)*\n/, '')
+
+          # Write it back
+          new_content = ((options[:position] || :before).to_sym == :before) ?  (info_block + old_content) : (old_content + "\n" + info_block)
+
+          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!(/^# #{COMPAT_PREFIX}.*?\n(#.*\n)*\n/, '')
+        
+        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.merge(
+              :position=>(options[:position_in_class] || options[:position])))
+        annotated = true
+      end
+
+      [
+        File.join(UNIT_TEST_DIR,      "#{model_name}_test.rb"), # test
+        File.join(SPEC_MODEL_DIR,     "#{model_name}_spec.rb"), # spec
+        File.join(EXEMPLARS_DIR,      "#{model_name}_exemplar.rb"),   # Object Daddy     
+      ].each { |file| annotate_one_file(file, info) }
+
+      FIXTURE_DIRS.each do |dir|
+        fixture_file_name = File.join(dir,klass.table_name + ".yml")
+        annotate_one_file(fixture_file_name, info, options.merge(:position=>(options[:position_in_fixture] || options[:position]))) if File.exist?(fixture_file_name)
+      end
+      annotated
+    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.starts_with?("position=")}
+      if models.empty?
+        Dir.chdir(model_dir) do
+          models = Dir["**/*.rb"]
+        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 "#{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
+        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 pas it to the associated block
+    def do_annotations(options={})
+      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={})
+      p 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_file_name = File.join(model_dir, file)
+            remove_annotation_of_file(model_file_name)
+            
+            FIXTURE_DIRS.each do |dir|
+              fixture_file_name = File.join(dir,klass.table_name + ".yml")
+              remove_annotation_of_file(fixture_file_name) if File.exist?(fixture_file_name)
+            end
+          end
+        rescue Exception => e
+          puts "Unable to annotate #{file}: #{e.message}"
+        end
+      end
+      puts "Removed annotation from: #{deannotated.join(', ')}"
+    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,20 @@
+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_fixture] = ENV['position_in_fixture'] || ENV['position']  || :before
+  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
+
+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 do
+  require 'annotate/annotate_routes'
+  AnnotateRoutes.do_annotate
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: tonyday-annotate
+version: !ruby/object:Gem::Version 
+  version: 2.0.2
+platform: ruby
+authors: 
+- Tony Day
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-23 00:00:00 -07:00
+default_executable: annotate
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Annotates Rails Models, routes, and others
+email: 
+- tonyd@panztell.com
+executables: 
+- annotate
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.rdoc
+files: 
+- History.txt
+- README.rdoc
+- Rakefile
+- annotate_models.gemspec
+- 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
+has_rdoc: true
+homepage: http://github.com/tonyday/annotate_models
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: annotate-models
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Annotates Rails Models, routes, and others
+test_files: []
+