tomkersten-annotate-models 1.0.4

data/History.txt

@@ -0,0 +1,15 @@
+== 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]
+
+== 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
+

data/License.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 Dave Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,27 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/annotate_models.rb
+lib/annotate_models/version.rb
+lib/annotate_models/tasks.rb
+lib/tasks/annotate.rake
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+bin/annotate
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_annotate_models.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,50 @@
+== AnnotateModels
+
+Add a comment summarizing the current schema to the top of each ActiveRecord model source file.
+
+  # == Schema Information
+  #
+  #  id                  :integer(11)   not null
+  #  quantity            :integer(11)   
+  #  product_id          :integer(11)   
+  #  unit_price          :float         
+  #  order_id            :integer(11)   
+  #
+
+  class LineItem < ActiveRecord::Base 
+    belongs_to :product
+  
+   end
+  
+Note that this code will blow away the initial 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.
+
+== Install
+
+  sudo gem install annotate-models
+  
+== Usage
+
+  cd [your project]
+  annotate
+  annotate -d
+  annotate -p [before|after]
+  annotate -h
+
+== Source
+
+  http://github.com/ctran/annotate_models
+  
+== Author
+   Dave Thomas
+   Pragmatic Programmers, LLC
+
+Released under the same license as Ruby. No Support. No Warranty. 
+
+== Modifications
+ - 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

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/annotate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'annotate_models/tasks'
+
+task = "annotate_models"
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: annotate [options]"
+  opts.on('-d', '--delete') { task = "remove_annotation" }
+  opts.on('-p', '--position [before|after]', ['before', 'after']) { |p| ENV['position'] = p }
+end.parse!
+
+Rake::Task[task].invoke

data/config/hoe.rb

@@ -0,0 +1,69 @@
+require 'annotate_models/version'
+
+AUTHOR = 'Dave Thomas'  # can also be an array of Authors
+EMAIL = "ctran@pragmaquest.com"
+DESCRIPTION = "Add a comment summarizing the current schema to the top of each ActiveRecord model source file"
+GEM_NAME = 'annotate-models' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'annotate-models' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = AnnotateModels::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'annotate_models documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'annotate_models'

data/lib/annotate_models.rb

@@ -0,0 +1,201 @@
+module AnnotateModels
+  class << self
+    MODEL_DIR   = "app/models"
+    FIXTURE_DIRS = ["test/fixtures","spec/fixtures"]
+    PREFIX = "== Schema Information"
+
+    # 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)
+      info = "# #{header}\n#\n"
+      info << "# Table name: #{klass.table_name}\n#\n"
+
+      max_size = klass.column_names.collect{|name| name.size}.max + 1
+      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
+        info << sprintf("#  %-#{max_size}.#{max_size}s:%-15.15s %s", col.name, col_type, attrs.join(", ")).rstrip + "\n"
+      end
+
+      info << "#\n\n"
+    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!(/^# #{PREFIX}.*?\n(#.*\n)*\n/, '')
+
+          # Write it back
+          new_content = options[:position] == "after" ? (old_content + "\n" + info_block) : (info_block + old_content)
+
+          File.open(file_name, "w") { |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!(/^# #{PREFIX}.*?\n(#.*\n)*\n/, '')
+        
+        File.open(file_name, "w") { |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)
+      annotated = false
+
+      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
+
+      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
+    # app/models 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)
+      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
+      version = ActiveRecord::Migrator.current_version rescue 0
+      if version > 0
+        header << "\n# Schema version: #{version}"
+      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}"
+        end
+      end
+      if annotated.empty?
+        puts "Nothing annotated!"
+      else
+        puts "Annotated #{annotated.join(', ')}"
+      end
+    end
+    
+    def remove_annotations
+      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_models/tasks.rb

@@ -0,0 +1,2 @@
+load 'Rakefile'
+Dir[File.join(File.dirname(__FILE__), '../tasks', '**/*.rake')].each { |rake| load rake }

data/lib/annotate_models/version.rb

@@ -0,0 +1,9 @@
+module AnnotateModels #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 4
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/tasks/annotate.rake

@@ -0,0 +1,14 @@
+desc "Add schema information (as comments) to model and fixture files"
+task :annotate_models => :environment do
+  require 'annotate_models'
+  options={}
+  options[:position_in_class] = ENV['position_in_class'] || ENV['position']
+  options[:position_in_fixture] = ENV['position_in_fixture'] || ENV['position']  
+  AnnotateModels.do_annotations(options)
+end
+
+desc "Remove schema information from model and fixture files"
+task :remove_annotation => :environment do
+  require 'annotate_models'
+  AnnotateModels.remove_annotations
+end