Commit 4012cbe8 by Cuong Tran

Merge branch 'master' of git://github.com/JackDanger/annotate_models into JackDanger/master

parents da0a6841 6713e923
module AnnotateModels
class << self
MODEL_DIR = "app/models"
FIXTURE_DIR = "test/fixtures"
PREFIX = "== Schema Information"
# Simple quoting for the default column value
def self.quote(value)
def quote(value)
case value
when NilClass then "NULL"
when TrueClass then "TRUE"
......@@ -21,7 +22,7 @@ module AnnotateModels
# 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 self.get_schema_info(klass, header)
def get_schema_info(klass, header)
info = "# #{header}\n#\n"
info << "# Table name: #{klass.table_name}\n#\n"
......@@ -48,7 +49,7 @@ module AnnotateModels
# a schema info block (a comment starting
# with "Schema as of ..."), remove it first.
def self.annotate_one_file(file_name, info_block)
def annotate_one_file(file_name, info_block)
if File.exist?(file_name)
content = File.read(file_name)
......@@ -65,10 +66,10 @@ module AnnotateModels
# on the columns and their types) and put it at the front
# of the model and fixture source files.
def self.annotate(klass, header)
def annotate(klass, file, header)
info = get_schema_info(klass, header)
model_file_name = File.join(MODEL_DIR, klass.name.underscore + ".rb")
model_file_name = File.join(MODEL_DIR, file)
annotate_one_file(model_file_name, info)
fixture_file_name = File.join(FIXTURE_DIR, klass.table_name + ".yml")
......@@ -80,7 +81,7 @@ module AnnotateModels
# the underscore or CamelCase versions of model names.
# Otherwise we take all the model files in the
# app/models directory.
def self.get_model_names
def get_model_files
models = ARGV.dup
models.shift
......@@ -92,12 +93,24 @@ module AnnotateModels
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 self.do_annotations
def do_annotations
header = PREFIX.dup
version = ActiveRecord::Migrator.current_version rescue 0
if version > 0
......@@ -105,19 +118,18 @@ module AnnotateModels
end
annotated = []
self.get_model_names.each do |m|
class_name = m.sub(/\.rb$/,'').camelize
get_model_files.each do |file|
begin
klass = class_name.split('::').inject(Object){ |klass,part| klass.const_get(part) }
klass = get_model_class(file)
if klass < ActiveRecord::Base && !klass.abstract_class?
annotated << class_name
self.annotate(klass, header)
annotated << klass
annotate(klass, file, header)
end
rescue Exception => e
puts "Unable to annotate #{class_name}: #{e.message}"
puts "Unable to annotate #{file}: #{e.message}"
end
end
puts "Annotated #{annotated.join(', ')}"
end
end
end
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment