VERSION @@ -1,6 +1,10 @@ -== AnnotateModels + _ + /_| _/__/_ + ( |/)/)()/(//(- + ________________ -Add a comment summarizing the current schema to the bottom of each + +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. @@ -19,7 +23,7 @@ If you are using Object Daddy, it`ll annotate your example files too. class LineItem < ActiveRecord::Base belongs_to :product . . . - + Annotates geometrical columns, geom type and srid, when using SpatialAdapter or PostgisAdapter: # == Schema Info @@ -28,7 +32,15 @@ Annotates geometrical columns, geom type and srid, when using SpatialAdapter or # # local :geometry point, 4326 # path :geometry line_string, 4326 - + + +== INSTALL + + sudo gem install nofxx-annotate + + +== HOW TO USE: +======= == Warning Note that this code will blow away the initial/final comment @@ -37,13 +49,13 @@ 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 @@ -60,6 +72,46 @@ To annotate routes.rb: annotate -r +More: + + annotate -h + + +To migrate & annotate (TODO): + + +Options: + +Annotate on the head of the file: + + annotate -p [before|after] + + +== 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 (NOT IMPLEMENTED) +* Object Daddy => http://github.com/flogic/object_daddy + +* SpatialAdapter => http://github.com/pdeffendol/spatial_adapter +* PostgisAdapter => http://github.com/nofxx/postgis_adapter + + +== TODO + +* Spec + + +== LICENSE: +======= More options: Usage: annotate [options] @@ -81,6 +133,23 @@ Original code by: Dave Thomas -- Pragmatic Programmers, LLC +AnnotateModels mods by: + + Alexander Semyonov ( http://github.com/rotuka/annotate_models ) + +AnnotateRoutes originally by: + + Gavin Montague ( http://github.com/govan/annotate-routes ) + + +== Forked from: + + http://github.com/ctran/annotate_models + + +== Modifications + - alex@pivotallabs.com +======= Modifications by: - Alex Chaffee - http://github.com/alexch - alex@pivotallabs.com @@ -92,3 +161,6 @@ Modifications by: and many others that I may have missed to add. +== This fork + + Marcos Piccinini ( http://github.com/nofxx/annotate ) \ No newline at end of file README.rdoc @@ -1,28 +1,48 @@ -%w[rubygems rake rake/clean fileutils newgem rubigen].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' +require 'rubygems' +require 'rake' + +begin + require 'jeweler' + Jeweler::Tasks.new do |gem| + gem.name = "annotate" + gem.summary = "Annotates Rails Models, routes, and others" + gem.email = "x@nofxx.com" + gem.homepage = "http://github.com/nofxx/annotate" + gem.authors = ['Cuong Tran',"Marcos Piccinini"] + # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings + end + +rescue LoadError + puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler" +end + +require 'spec/rake/spectask' +Spec::Rake::SpecTask.new(:spec) do |spec| + spec.libs << 'lib' << 'spec' + spec.spec_files = FileList['spec/**/*_spec.rb'] +end + +Spec::Rake::SpecTask.new(:rcov) do |spec| + spec.libs << 'lib' << 'spec' + spec.pattern = 'spec/**/*_spec.rb' + spec.rcov = true 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] +task :default => :spec + +require 'rake/rdoctask' +Rake::RDocTask.new do |rdoc| + if File.exist?('VERSION.yml') + config = YAML.load(File.read('VERSION.yml')) + version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}" + else + version = "" + end + + rdoc.rdoc_dir = 'rdoc' + rdoc.title = "annotate #{version}" + rdoc.rdoc_files.include('README*') + rdoc.rdoc_files.include('lib/**/*.rb') +end + Rakefile @@ -1,39 +1,59 @@ +# Generated by jeweler +# DO NOT EDIT THIS FILE +# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec` # -*- encoding: utf-8 -*- Gem::Specification.new do |s| s.name = %q{annotate} - s.version = "2.0.2" + s.version = "2.3.2" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= - s.authors = ["Cuong Tran"] - s.date = %q{2009-05-06} + s.authors = ["Cuong Tran", "Marcos Piccinini"] + s.date = %q{2009-08-21} s.default_executable = %q{annotate} - s.description = %q{Annotates Rails Models, routes, and others} - s.email = ["ctran@pragmaquest.com"] + s.email = %q{x@nofxx.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/ctran/annotate_models} - s.rdoc_options = ["--main", "README.rdoc"] + s.extra_rdoc_files = [ + "README.rdoc" + ] + s.files = [ + ".gitignore", + "History.txt", + "README.rdoc", + "Rakefile", + "VERSION", + "annotate.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", + "spec/annotate/annotate_models_spec.rb", + "spec/annotate/annotate_routes_spec.rb", + "spec/annotate_spec.rb", + "spec/spec.opts", + "spec/spec_helper.rb" + ] + s.homepage = %q{http://github.com/nofxx/annotate} + s.rdoc_options = ["--charset=UTF-8"] s.require_paths = ["lib"] - s.rubyforge_project = %q{annotate-models} - s.rubygems_version = %q{1.3.1} + s.rubygems_version = %q{1.3.5} s.summary = %q{Annotates Rails Models, routes, and others} + s.test_files = [ + "spec/annotate/annotate_models_spec.rb", + "spec/annotate/annotate_routes_spec.rb", + "spec/spec_helper.rb", + "spec/annotate_spec.rb" + ] if s.respond_to? :specification_version then current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION - s.specification_version = 2 + s.specification_version = 3 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 annotate.gemspec @@ -7,31 +7,35 @@ task = :annotate_models OptionParser.new do |opts| opts.banner = "Usage: annotate [options]" - opts.on('-d', '--delete', + 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| + 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', + 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 + opts.on('-v', '--version', + "Show the current version of this gem") do + puts "Annotate v#{Annotate::VERSION}"; exit end - opts.on('-m', '--show-migration', + 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 + opts.on('-i', '--show-indexes', + "List the table's database indexes in the annotation") do ENV['show_indexes'] = "yes" end - opts.on('--model-dir dir', + 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 bin/annotate @@ -2,8 +2,6 @@ $:.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' @@ -13,4 +11,4 @@ module Annotate return false end end -end \ No newline at end of file +end lib/annotate.rb @@ -3,19 +3,21 @@ module AnnotateModels # 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") + EXEMPLARS_TEST_DIR = File.join("test", "exemplars") # Object Daddy http://github.com/flogic/object_daddy/tree/master - EXEMPLARS_DIR = File.join("spec", "exemplars") - + EXEMPLARS_SPEC_DIR = File.join("spec", "exemplars") + # Machinist http://github.com/notahat/machinist + BLUEPRINTS_DIR = File.join("test", "blueprints") + def model_dir @model_dir || "app/models" end - + def model_dir=(dir) @model_dir = dir end @@ -45,7 +47,7 @@ module AnnotateModels 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 << "default(#{quote(col.default)})" unless col.default.nil? attrs << "not null" unless col.null attrs << "primary key" if col.name == klass.primary_key @@ -55,13 +57,24 @@ module AnnotateModels 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 - + 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 info << sprintf("# %-#{max_size}.#{max_size}s:%-15.15s %s", col.name, col_type, attrs.join(", ")).rstrip + "\n" end @@ -92,10 +105,12 @@ module AnnotateModels # 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, + # :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) @@ -105,7 +120,7 @@ module AnnotateModels 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 @@ -113,20 +128,20 @@ module AnnotateModels 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) + new_content = options[:position] == '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 @@ -149,9 +164,11 @@ module AnnotateModels 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 + File.join(UNIT_TEST_DIR, "#{model_name}_test.rb"), # test + File.join(SPEC_MODEL_DIR, "#{model_name}_spec.rb"), # spec + 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_DIR, "#{model_name}_blueprint.rb"), # Machinist Blueprints ].each { |file| annotate_one_file(file, info) } FIXTURE_DIRS.each do |dir| @@ -177,7 +194,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. @@ -202,16 +219,16 @@ module AnnotateModels 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 end - + if options[:model_dir] self.model_dir = options[:model_dir] end @@ -235,7 +252,7 @@ module AnnotateModels puts "Annotated (#{annotated.length}): #{annotated.join(', ')}" end end - + def remove_annotations(options={}) if options[:model_dir] puts "removing" @@ -247,10 +264,10 @@ module AnnotateModels 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) lib/annotate/annotate_models.rb @@ -4,10 +4,11 @@ task :annotate_models => :environment do 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[: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'].split(',') + options[:require] = ENV['require'].split(',') rescue [] AnnotateModels.do_annotations(options) end lib/tasks/annotate_models.rake @@ -23,6 +23,7 @@ describe AnnotateModels do it "should get schema info" do AnnotateModels.get_schema_info(mock_klass( + :connection => mock("Conn", :indexes => []), :table_name => "users", :primary_key => "id", :column_names => ["id","login"], @@ -41,7 +42,7 @@ describe AnnotateModels do EOS end - + describe "#get_model_class" do module ::ActiveRecord class Base @@ -61,7 +62,7 @@ EOS AnnotateModels.model_dir = @dir create('foo.rb', <<-EOS) class Foo < ActiveRecord::Base - end + end EOS create('foo_with_macro.rb', <<-EOS) class FooWithMacro < ActiveRecord::Base spec/annotate/annotate_models_spec.rb @@ -1,9 +1,8 @@ require File.dirname(__FILE__) + '/spec_helper.rb' describe Annotate do - - it "should have a version" do - Annotate::VERSION.should be_instance_of(String) + + it "should have more tests..heh" do end - + end spec/annotate_spec.rb Manifest.txt annotate_models.gemspec script/console script/destroy script/generate tasks/rspec.rake ed2cf5ec8169116954e51a50f6a061955d003e8a ffceca9b0280a83200649736627f632b6299e58d Alex Chaffee alex@stinky.com http://github.com/ctran/annotate_models/commit/5b3d4459045f2b363523745d0c2ac9c28ff10fc9 5b3d4459045f2b363523745d0c2ac9c28ff10fc9 2009-10-23T09:14:39-07:00 2009-10-23T09:14:39-07:00 Merge remote branch 'nofxx/master' * nofxx/master: add simple_indexes option added blueprints/* dir annotate exemplars with unit tests added lil fix and v bump defaults to after the code jeweler!! merge IPGlider nice patches Now -p option also have effect on test, spec and Object Daddy files. Write default(FALSE) when the default value for a column is false. dont add whitespace on routes, and some minor stuff handle errors when not in a rails folder Organize the code better/adds some tests clean up hoe stuff forgot gemspec More lil fixes some fixes big commit.. * Now using jeweler * Rev version to 2.4 and get ready for big release 57d5bb3e486a2056e501c1da1fbee8a5334fce10 Alex Chaffee alex@stinky.com