annotator 0.0.4 → 0.0.5

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 Tech-Angels
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -62,15 +62,14 @@ Of course similar thing happens when you remove column or change it's type.
 * for some fields like title above you can just skip description including dash sometimes name is just obvious enough
 * multiline comments are ok
 * generating initial descriptions it understands things like
-** belongs_to association columns
-** devise columns
-** paperclip colums
+  * belongs_to association columns
+  * devise columns
+  * paperclip colums
 
 Contributions are very much welcome.
 
 == Todos
 
-* it could be written a bit cleaner
 * since name does not have "model" in it, we could possibly use "rake routes" to annotate controller actions, not sure if it's worth it
 
 == Authors

data/lib/annotator.rb

@@ -1,189 +1,15 @@
 require 'annotator/railtie'
+require 'annotator/model'
+require 'annotator/attributes'
+require 'annotator/initial_description'
 
 module Annotator
-  def self.run
-    models = Dir.glob("#{Rails.root}/app/models/*.rb").map do |filename|
-      klass = filename.split('/').last.split(/\.rb$/).first.camelize.constantize
-      [filename, klass]
-    end.sort_by {|x| x.last.to_s}
-
-
-    models.each do |filename, model|
-    next unless model.ancestors.include? ActiveRecord::Base
-    begin
-      file = File.read(filename)
-      lines = file.split("\n")
-      out = ''
-      ia = false # inside attributes block
-      after_block = false # we are already after comments block
-      changed = false
-      skip_file = false
-      attrs_arr = []
-      lines.each do |line|
-        break if skip_file
-        out << "#{line}\n" && next if after_block
-
-        if ia && !line.match(/^# \*/) && !line.match(/^#   \S/)
-          out << stringify_attrs_arr(update_attrs_arr(attrs_arr, model))
-          ia = false
-          changed = true
-        end
-
-        # check if we are still in the comments part of the file
-        unless line.strip.empty? || line.match(/^\s*#/)
-          after_block = true
-          unless changed
-            out << "# Attributes:\n"
-            out << stringify_attrs_arr(update_attrs_arr(attrs_arr, model))
-          end
-        end
-
-        if ia
-          if line.match(/^# \*/)
-            m = line.match(/^# \* (\w+) \[(.*?)\]( \- )?(.*)/)
-            if m
-              attrs_arr << [m[1], m[2], m[4]].map(&:strip)
-            else
-              puts "!! Unrecognized line format on attributes list in #{model}:"
-              puts line
-            end
-          else
-            attrs_arr[-1][2] << " #{line[4..-1]}"
-          end
-        else
-          out << "#{line}\n"
-        end
-
-        ia = true if line.match(/^# Attributes:/i)
-        skip_file = true if line.match(/^# Attributes\(nodoc\):/i)
-      end
-
-      File.open(filename,'w') { |f| f.write(out) } if out.strip != file.strip && !skip_file
-
-    rescue Exception => e
-      puts "FAILURE while trying to update model #{model}:\n  #{e}"
-    end
-    end
-
-
-  end
-
-  protected
-
-  def self.update_attrs_arr(arr, model)
-    arr = arr.dup
-    model.columns.each do |column|
-      attrs_str = column_attrs(column)
-      if row = arr.find {|x| x[0] == column.name}
-        if row[1] != attrs_str
-          puts "  M #{model}##{column.name} [#{row[1]} -> #{attrs_str}]"
-          row[1] = attrs_str
-        end
-      else
-        puts "  A #{model}##{column.name} [#{attrs_str}]"
-        desc = initial_description model, column
-        arr << [column.name, attrs_str, desc]
-      end
-    end
-
-    # find columns that no more exist in db
-    orphans = arr.map(&:first) - model.columns.map(&:name)
-    unless orphans.empty?
-      orphans.each do |orphan|
-        puts "  D #{model}#{orphan}"
-        arr = arr.select {|x| x[0] != orphan}
-      end
-    end
-    arr
-  end
 
-  def self.initial_description(model, column)
-    case column.name
-    when 'id' then return 'primary key'
-    when 'created_at' then return 'creation time'
-    when 'updated_at' then return 'last update time'
-    end
-
-    # TODO stop writing like it's functional lang and make class for Description ;)
-
-    # Belongs to association
-    model.reflect_on_all_associations.each do |reflect|
-      if reflect.foreign_key == column.name && reflect.macro == :belongs_to
-        return "belongs to #{reflect.klass}"
-      end
-    end
-
-    # Devise column names
-    if model.respond_to? :devise_modules
-      devise_columns = {
-        :reset_password_token       => "Devise Recoverable module",
-        :reset_password_sent_at     => "Devise Recoverable module",
-        :remember_created_at        => "Devise Rememberable module",
-        :sign_in_count              => "Devise Trackable module",
-        :current_sign_in_at         => "Devise Trackable module",
-        :last_sign_in_at            => "Devise Trackable module",
-        :current_sign_in_ip         => "Devise Trackable module",
-        :last_sign_in_ip            => "Devise Trackable module",
-        :password_salt              => "Devise Encriptable module",
-        :confirmation_token         => "Devise Confirmable module",
-        :confirmed_at               => "Devise Confirmable module",
-        :confiramtion_sent_at       => "Devise Confirmable module",
-        :unconfirmed_email          => "Devise Confirmable module",
-        :failed_attempts            => "Devise Lockable module",
-        :unlock_token               => "Devise Locakble module",
-        :locked_at                  => "Devise Lockable module",
-        :authentication_token       => "Devise Token authenticable module"
-      }
-      guess = devise_columns[column.name.to_sym]
-      return guess if guess
-    end
-
-    # Paperclip column names
-    if model.respond_to? :attachments_definitions
-      model.attachments_definitions.keys.each do |att|
-        cols = ["#{att}_file_name", "#{att}_content_type", "#{att}_file_size", "#{att}_updated_at"]
-        return "Paperclip for #{att}" if cols.include? column.name
-      end
-    end
-
-    # let's not add "document me" note for these obvious ones:
-    return '' if %w{email name title body}.include? column.name
-
-    return 'TODO: document me'
-  end
-
-  def self.column_attrs(c)
-    ret = c.type.to_s
-    ret << ", primary" if c.primary
-    ret << ", default=#{c.default}" if c.default
-    ret << ", not null" unless c.null
-    ret << ", limit=#{c.limit}" if c.limit && (c.limit != 255 && c.type != :string)
-    ret
-  end
-
-  def self.stringify_attrs_arr(arr)
-    ret = ''
-    arr.sort_by{|x| x[0] == 'id' ? '_' : x[0]}.each do |name, attrs, desc|
-      # split into lines that don't exceed 80 chars
-      desc = " - #{desc}" unless desc.empty?
-      line = "# * #{name} [#{attrs}]#{desc}"
-      lt = wrap_text(line, opts[:max_chars_per_line]-3).split("\n")
-      line = ([lt[0]] + lt[1..-1].map{|x| "#   #{x}"}).join("\n")
-      ret << "#{line}\n"
+  def self.run
+    Dir.glob("#{Rails.root}/app/models/**/*.rb").sort.map do |filename|
+      Model.new(filename).update!
     end
-    ret
   end
 
-  def self.wrap_text(txt, col)
-    txt.gsub(/(.{1,#{col}})( +|$)\n?|(.{#{col}})/,"\\1\\3\n")
-  end
-
-  def self.opts
-    {
-      :max_chars_per_line => 120
-    }
-  end
-
-
 end
 

data/lib/annotator/attributes.rb

@@ -0,0 +1,92 @@
+module Annotator
+
+  # Attributes within given model file
+  class Attributes
+    R_ATTRIBUTE = /^# \* (\w+) \[(.*?)\]( \- )?(.*)$/
+    R_ATTRIBUTE_NEXT_LINE = /^#   (.*?)$/
+    R_ATTRIBUTE_LINE = /(#{R_ATTRIBUTE})|(#{R_ATTRIBUTE_NEXT_LINE})/
+    HEADER = "# Attributes:" 
+    MAX_CHARS_PER_LINE = 120
+
+    def initialize(model, lines)
+      @model = model
+      @lines = lines
+      @attrs = []
+      @changes = []
+      parse
+    end
+
+    # Convert attributes array back to attributes lines representation to be put into file
+    def lines
+      ret = [Attributes::HEADER]
+      # Sort by name, but id goes first
+      @attrs.sort_by{|x| x[:name] == 'id' ? '_' : x[:name]}.each do |row|
+        line = "# * #{row[:name]} [#{row[:type]}]#{row[:desc].to_s.empty? ? "" : " - #{row[:desc]}"}"
+        # split into lines that don't exceed 80 chars
+        lt = wrap_text(line, MAX_CHARS_PER_LINE-3).split("\n")
+        line = ([lt[0]] + lt[1..-1].map{|x| "#   #{x}"}).join("\n")
+        ret << line
+      end
+      ret
+    end
+
+    # Update attribudes array to the current database state
+    def update!
+      @model.columns.each do |column|
+        if row = @attrs.find {|x| x[:name] == column.name}
+          if row[:type] != type_str(column)
+            puts "  M #{@model}##{column.name} [#{row[:type]} -> #{type_str(column)}]"
+            row[:type] = type_str(column)
+          end
+        else
+          puts "  A #{@model}##{column.name} [#{type_str(column)}]"
+          @attrs << {
+            :name => column.name,
+            :type => type_str(column),
+            :desc => InitialDescription.for(@model, column.name)
+          }
+        end
+      end
+
+      # find columns that no more exist in db
+      orphans = @attrs.map{|x| x[:name]} - @model.columns.map(&:name)
+      unless orphans.empty?
+        orphans.each do |orphan|
+          puts "  D #{@model}#{orphan}"
+          @attrs = @attrs.select {|x| x[0] != orphan}
+        end
+      end
+
+      @attrs
+    end
+
+    protected
+
+    # Convert attributes lines into meaniningful array
+    def parse
+      @lines.each do |line|
+        if m = line.match(R_ATTRIBUTE)
+          @attrs << {:name => m[1].strip, :type => m[2].strip, :desc => m[4].strip}
+        elsif m = line.match(R_ATTRIBUTE_NEXT_LINE) 
+          @attrs[-1][:desc] += " #{m[1].strip}"
+        end
+      end
+    end
+
+    # Human readable description of given column type
+    def type_str(c)
+      ret = c.type.to_s
+      ret << ", primary" if c.primary
+      ret << ", default=#{c.default}" if c.default
+      ret << ", not null" unless c.null
+      ret << ", limit=#{c.limit}" if c.limit && (c.limit != 255 && c.type != :string)
+      ret
+    end
+
+    # Wraps text nicely, not breaking in the middle of the word
+    def wrap_text(txt, col)
+      txt.gsub(/(.{1,#{col}})( +|$)\n?|(.{#{col}})/,"\\1\\3\n")
+    end
+
+  end
+end

data/lib/annotator/initial_description.rb

@@ -0,0 +1,23 @@
+require 'annotator/initial_description/base'
+Dir[File.dirname(__FILE__) + '/initial_description/*.rb'].each {|file| require file }
+
+module Annotator
+  module InitialDescription
+
+    NO_DESCRIPTION_COLUMNS = %w{email name title body} 
+
+    # Get initial description for given model & column
+    def self.for(model, column)
+      # Check if any module provides such description
+      Base.providers.each do |klass|
+        provider = klass.new model, column
+        return provider.text if provider.check
+      end
+      # Some columns are just too obvious
+      return "" if NO_DESCRIPTION_COLUMNS.include? column
+      # Let user do the work
+      return "TODO: document me"
+    end
+
+  end
+end

data/lib/annotator/initial_description/base.rb

@@ -0,0 +1,21 @@
+module Annotator
+  module InitialDescription
+
+    # Base class from which all other description providers inherit
+    class Base
+      def initialize(model, column)
+        @model = model
+        @column = column
+      end
+
+      def self.inherited(klass)
+        @providers ||= []
+        @providers << klass
+      end
+
+      def self.providers
+        @providers
+      end
+    end
+  end
+end

data/lib/annotator/initial_description/belongs_to.rb

@@ -0,0 +1,29 @@
+module Annotator
+  module InitialDescription
+
+    # Initial descriptions for columns associated with belongs_to
+    class BelongsTo < Base
+
+      def check
+        # check if there is belongs to association where this column is a foreign key
+        @model.reflect_on_all_associations.each do |reflection|
+          if reflection.foreign_key == @column && reflection.macro == :belongs_to
+            @reflection = reflection
+            return true
+          end
+        end
+
+        # Polymorphic association type column
+        if @column.ends_with? '_type'
+          return true if @reflection = @model.reflect_on_association(@column.match(/(.*?)_type$/)[1].to_sym) 
+        end
+
+        return false
+      end
+
+      def text
+        "belongs to :#{@reflection.name}#{@reflection.options[:polymorphic] ? ' (polymorphic)' : ''}"
+      end
+    end
+  end
+end

data/lib/annotator/initial_description/devise.rb

@@ -0,0 +1,39 @@
+module Annotator
+  module InitialDescription
+
+    # Initila descriptions for devise specific columns
+    class Devise < Base
+
+      def check
+        @model.respond_to?(:devise_modules) && columns.keys.include?(@column.to_sym)
+      end
+
+      def columns
+        {
+          :reset_password_token       => "Devise Recoverable module",
+          :reset_password_sent_at     => "Devise Recoverable module",
+          :remember_created_at        => "Devise Rememberable module",
+          :sign_in_count              => "Devise Trackable module",
+          :current_sign_in_at         => "Devise Trackable module",
+          :last_sign_in_at            => "Devise Trackable module",
+          :current_sign_in_ip         => "Devise Trackable module",
+          :last_sign_in_ip            => "Devise Trackable module",
+          :password_salt              => "Devise Encriptable module",
+          :confirmation_token         => "Devise Confirmable module",
+          :confirmed_at               => "Devise Confirmable module",
+          :confiramtion_sent_at       => "Devise Confirmable module",
+          :unconfirmed_email          => "Devise Confirmable module",
+          :failed_attempts            => "Devise Lockable module",
+          :unlock_token               => "Devise Locakble module",
+          :locked_at                  => "Devise Lockable module",
+          :authentication_token       => "Devise Token authenticable module"
+        }
+      end
+
+      def text
+        columns[@column.to_sym]
+      end
+
+    end
+  end
+end

data/lib/annotator/initial_description/paperclip.rb

@@ -0,0 +1,26 @@
+module Annotator
+  module InitialDescription
+
+    # Initial descriptinos for paperclip attachments columns
+    class Paperclip < Base
+
+      def check
+        if @model.respond_to? :attachments_definitions
+          @model.attachments_definitions.keys.each do |att|
+            cols = ["#{att}_file_name", "#{att}_content_type", "#{att}_file_size", "#{att}_updated_at"]
+            if cols.include? @column
+              @attachment = att
+              return true 
+            end
+          end
+        end
+        return false
+      end
+
+      def text
+        "Paperclip for #{@attachment}"
+      end
+
+    end
+  end
+end

data/lib/annotator/initial_description/rails.rb

@@ -0,0 +1,23 @@
+module Annotator
+  module InitialDescription
+
+    # Initial descriptions for rails specific columns
+    class Rails < Base
+      def check
+        columns.keys.include? @column.to_sym
+      end
+
+      def columns
+        {
+          :id => "primary key", # TODO check if it actually is a primary key, find primary keys with other names
+          :created_at => "creation time",
+          :updated_at => "last update time" 
+        }
+      end
+
+      def text
+        columns[@column.to_sym]
+      end
+    end
+  end
+end

data/lib/annotator/model.rb

@@ -0,0 +1,57 @@
+module Annotator
+
+  # Represents a single model file and associated class
+  class Model
+
+    def initialize(filename)
+      @filename = filename
+      @blocks = Hash.new {[]}
+    end
+
+    # Model class
+    def klass
+      @filename.split('app/models/').last.split(/\.rb$/).first.camelize.constantize rescue nil
+    end
+
+    # Split file into 3 blocks: before attributes, attributes block, and after
+    # If there's no attributes block, content will be in :after part (for easier insertion)
+    def parse
+      @file = File.read(@filename).strip
+      current_block = :before
+      return @nodoc = true if @file.match(/^# Attributes\(nodoc\):$/i)
+      @file.split("\n").each do |line|
+        if line.match(/^#{Regexp.escape Attributes::HEADER} *$/)
+          current_block = :attributes
+          next
+        end
+        current_block = :after if current_block == :attributes && !line.match(Attributes::R_ATTRIBUTE_LINE)
+        @blocks[current_block] += [line]
+      end
+
+      @blocks[:after], @blocks[:before] = @blocks[:before], [] if @blocks[:after].empty?
+    end
+
+    # If this file does not have associated AR class it should be skipped
+    def skipped?
+      !klass || !klass.ancestors.include?(ActiveRecord::Base) || @nodoc
+    end
+
+    # Save changes to file if there were any
+    def update_file
+      output = (@blocks[:before] + @blocks[:attributes] + @blocks[:after]).join("\n").strip + "\n"
+      File.open(@filename,'w') { |f| f.write(output) } if output != @file
+    end
+
+    # Update file with new database information
+    def update!
+      parse
+      return true if skipped?
+      attributes = Attributes.new klass, @blocks[:attributes]
+      attributes.update!
+      @blocks[:attributes] = attributes.lines
+      update_file
+    end
+  end
+end
+
+

data/lib/annotator/version.rb

@@ -1,3 +1,3 @@
 module Annotator
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/annotator_test.rb

@@ -3,7 +3,7 @@ require 'tempfile'
 
 class AnnotatorTest < ActiveSupport::TestCase
   def setup
-    @output = execute("cd #{$test_app} && rake annotate")
+    @output = execute("rake annotate")
   end
 
   test "annotating foo" do
@@ -12,13 +12,13 @@ class AnnotatorTest < ActiveSupport::TestCase
 
   test "leaving existing comments" do
     FileUtils.cp asset_file('foo_annotated_with_comments.rb'), app_file('foo.rb')
-    assert system("cd #{$test_app} && rake annotate")
+    execute "rake annotate"
     assert_equal File.read(asset_file 'foo_annotated_with_comments.rb' ), File.read(app_file 'foo.rb' )
   end
 
   test "updating column type" do
     FileUtils.cp asset_file('foo_annotated_bad_column.rb'), app_file('foo.rb')
-    output = execute("cd #{$test_app} && rake annotate")
+    output = execute "rake annotate"
     assert_equal File.read(asset_file 'foo_annotated_column_fixed.rb' ), File.read(app_file 'foo.rb' )
     assert output.include?('M Foo#title [octopus -> string]')
     assert output.include?('M Foo#created_at [foobar -> datetime, not null]')
@@ -26,34 +26,44 @@ class AnnotatorTest < ActiveSupport::TestCase
 
   test "skipping when nodoc is preesnt" do
     FileUtils.cp asset_file('foo_annotated_bad_column_nodoc.rb'), app_file('foo.rb')
-    execute("cd #{$test_app} && rake annotate")
+    execute "rake annotate"
     assert_equal File.read(asset_file 'foo_annotated_bad_column_nodoc.rb' ), File.read(app_file 'foo.rb' )
   end
 
   test "annotating devise columns" do
     assert_equal File.read(asset_file 'user_annotated.rb' ), File.read(app_file 'user.rb' )
-  end 
+  end
 
   test "annotating paperclip columns" do
     assert_equal File.read(asset_file 'paper_annotated.rb' ), File.read(app_file 'paper.rb' )
   end
 
-  test "annotating belongs_to associations" do
+  test "annotating belongs_to and polymorphic associations" do
     assert_equal File.read(asset_file 'boo_annotated.rb' ), File.read(app_file 'boo.rb' )
   end
 
+  test "handling some code before annotitions block" do
+    FileUtils.cp asset_file('foo_require_first.rb'), app_file('foo.rb')
+    execute "rake annotate"
+    assert_equal File.read(asset_file 'foo_require_first.rb' ), File.read(app_file 'foo.rb' )
+  end
+
+  test "annotating namespaced models" do
+    assert_equal File.read(asset_file 'moo_hoo_annotated.rb' ), File.read(app_file 'moo/hoo.rb' )
+  end
+
   def asset_file(name)
     File.join(File.expand_path("../assets/",  __FILE__), name)
   end
 
   def app_file(name)
-    File.join($test_app,'app','models',name)
+    File.join(TestApp.path,'app','models',name)
   end
 
   # Check exit code while grabbing output
   def execute(command)
     tmp = Tempfile.new "output"
-    assert system("#{command} > #{tmp.path}")
+    assert system("cd #{TestApp.path} && #{command} > #{tmp.path}")
     output = tmp.read
     tmp.unlink
     output

data/test/assets/boo_annotated.rb

@@ -1,8 +1,11 @@
 # Attributes:
 # * id [integer, primary, not null] - primary key
 # * created_at [datetime, not null] - creation time
-# * foo_id [integer] - belongs to Foo
+# * foo_id [integer] - belongs to :foo
+# * poly_id [integer] - belongs to :poly (polymorphic)
+# * poly_type [string] - belongs to :poly (polymorphic)
 # * updated_at [datetime, not null] - last update time
 class Boo < ActiveRecord::Base
   belongs_to :foo
+  belongs_to :poly, :polymorphic => true
 end

data/test/assets/foo_require_first.rb

@@ -0,0 +1,11 @@
+require 'pp'
+
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * body [text]
+# * created_at [datetime, not null] - creation time
+# * random_number [integer] - TODO: document me
+# * title [string]
+# * updated_at [datetime, not null] - last update time
+class Foo < ActiveRecord::Base
+end

data/test/assets/moo_hoo_annotated.rb

@@ -0,0 +1,13 @@
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * body [text]
+# * created_at [datetime, not null] - creation time
+# * random_number [integer] - TODO: document me
+# * title [string]
+# * updated_at [datetime, not null] - last update time
+# Some existing stupid comment
+module Moo
+  class Hoo < ActiveRecord::Base
+    self.table_name = 'foos'
+  end
+end

data/test/dummy/app/models/boo.rb

@@ -1,3 +1,4 @@
 class Boo < ActiveRecord::Base
   belongs_to :foo
+  belongs_to :poly, :polymorphic => true
 end

data/test/dummy/app/models/moo/hoo.rb

@@ -0,0 +1,6 @@
+# Some existing stupid comment
+module Moo
+  class Hoo < ActiveRecord::Base
+    self.table_name = 'foos'
+  end
+end

data/test/dummy/db/migrate/20120527025142_create_boos.rb

@@ -2,6 +2,8 @@ class CreateBoos < ActiveRecord::Migration
   def change
     create_table :boos do |t|
       t.references :foo
+      t.integer :poly_id
+      t.string :poly_type
       t.timestamps
     end
   end

data/test/dummy/db/schema.rb

@@ -11,7 +11,15 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120527020350) do
+ActiveRecord::Schema.define(:version => 20120527025142) do
+
+  create_table "boos", :force => true do |t|
+    t.integer  "foo_id"
+    t.integer  "poly_id"
+    t.string   "poly_type"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
 
   create_table "foos", :force => true do |t|
     t.text     "body"
@@ -21,6 +29,15 @@ ActiveRecord::Schema.define(:version => 20120527020350) do
     t.datetime "updated_at",    :null => false
   end
 
+  create_table "papers", :force => true do |t|
+    t.datetime "created_at",          :null => false
+    t.datetime "updated_at",          :null => false
+    t.string   "avatar_file_name"
+    t.string   "avatar_content_type"
+    t.integer  "avatar_file_size"
+    t.datetime "avatar_updated_at"
+  end
+
   create_table "users", :force => true do |t|
     t.string   "email",                  :default => "", :null => false
     t.string   "encrypted_password",     :default => "", :null => false

data/test/dummy/log/development.log

@@ -71,3 +71,100 @@ Migrating to DeviseCreateUsers (20120527020350)
    (0.0ms)  PRAGMA index_info('index_users_on_confirmation_token')
    (0.0ms)  PRAGMA index_info('index_users_on_reset_password_token')
    (0.0ms)  PRAGMA index_info('index_users_on_email')
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to CreateFoos (20120219112425)
+Migrating to DeviseCreateUsers (20120527020350)
+Migrating to CreatePapers (20120527023350)
+   (0.0ms)  select sqlite_version(*)
+   (0.0ms)  begin transaction
+   (0.2ms)  CREATE TABLE "papers" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120527023350')
+   (5.4ms)  commit transaction
+Migrating to AddAttachmentAvatarToPapers (20120527023417)
+   (0.0ms)  begin transaction
+   (0.3ms)  ALTER TABLE "papers" ADD "avatar_file_name" varchar(255)
+   (0.2ms)  ALTER TABLE "papers" ADD "avatar_content_type" varchar(255)
+   (0.2ms)  ALTER TABLE "papers" ADD "avatar_file_size" integer
+   (0.2ms)  ALTER TABLE "papers" ADD "avatar_updated_at" datetime
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120527023417')
+   (3.8ms)  commit transaction
+Migrating to CreateBoos (20120527025142)
+   (0.0ms)  begin transaction
+   (0.4ms)  CREATE TABLE "boos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "foo_id" integer, "poly_id" integer, "poly_type" integer, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120527025142')
+   (4.0ms)  commit transaction
+   (0.4ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.0ms)  PRAGMA index_list("boos")
+   (0.0ms)  PRAGMA index_list("foos")
+   (0.0ms)  PRAGMA index_list("papers")
+   (0.1ms)  PRAGMA index_list("users")
+   (0.1ms)  PRAGMA index_info('index_users_on_authentication_token')
+   (0.1ms)  PRAGMA index_info('index_users_on_unlock_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_confirmation_token')
+   (0.1ms)  PRAGMA index_info('index_users_on_reset_password_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_email')
+   (0.1ms)  select sqlite_version(*)
+   (14.9ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (4.1ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to CreateFoos (20120219112425)
+   (0.0ms)  begin transaction
+   (0.4ms)  CREATE TABLE "foos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "body" text, "title" varchar(255), "random_number" integer, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120219112425')
+   (7.1ms)  commit transaction
+Migrating to DeviseCreateUsers (20120527020350)
+   (0.0ms)  begin transaction
+   (0.4ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(255) DEFAULT '' NOT NULL, "encrypted_password" varchar(255) DEFAULT '' NOT NULL, "reset_password_token" varchar(255), "reset_password_sent_at" datetime, "remember_created_at" datetime, "sign_in_count" integer DEFAULT 0, "current_sign_in_at" datetime, "last_sign_in_at" datetime, "current_sign_in_ip" varchar(255), "last_sign_in_ip" varchar(255), "password_salt" varchar(255), "confirmation_token" varchar(255), "confirmed_at" datetime, "confirmation_sent_at" datetime, "unconfirmed_email" varchar(255), "failed_attempts" integer DEFAULT 0, "unlock_token" varchar(255), "locked_at" datetime, "authentication_token" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.0ms)  PRAGMA index_list("users")
+   (0.3ms)  CREATE UNIQUE INDEX "index_users_on_email" ON "users" ("email")
+   (0.1ms)  PRAGMA index_list("users")
+   (0.0ms)  PRAGMA index_info('index_users_on_email')
+   (0.2ms)  CREATE UNIQUE INDEX "index_users_on_reset_password_token" ON "users" ("reset_password_token")
+   (0.1ms)  PRAGMA index_list("users")
+   (0.1ms)  PRAGMA index_info('index_users_on_reset_password_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_email')
+   (0.2ms)  CREATE UNIQUE INDEX "index_users_on_confirmation_token" ON "users" ("confirmation_token")
+   (0.1ms)  PRAGMA index_list("users")
+   (0.1ms)  PRAGMA index_info('index_users_on_confirmation_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_reset_password_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_email')
+   (0.2ms)  CREATE UNIQUE INDEX "index_users_on_unlock_token" ON "users" ("unlock_token")
+   (0.1ms)  PRAGMA index_list("users")
+   (0.1ms)  PRAGMA index_info('index_users_on_unlock_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_confirmation_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_reset_password_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_email')
+   (0.2ms)  CREATE UNIQUE INDEX "index_users_on_authentication_token" ON "users" ("authentication_token")
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120527020350')
+   (3.8ms)  commit transaction
+Migrating to CreatePapers (20120527023350)
+   (0.0ms)  begin transaction
+   (0.2ms)  CREATE TABLE "papers" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120527023350')
+   (3.8ms)  commit transaction
+Migrating to AddAttachmentAvatarToPapers (20120527023417)
+   (0.0ms)  begin transaction
+   (0.3ms)  ALTER TABLE "papers" ADD "avatar_file_name" varchar(255)
+   (0.1ms)  ALTER TABLE "papers" ADD "avatar_content_type" varchar(255)
+   (0.2ms)  ALTER TABLE "papers" ADD "avatar_file_size" integer
+   (0.2ms)  ALTER TABLE "papers" ADD "avatar_updated_at" datetime
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120527023417')
+   (3.2ms)  commit transaction
+Migrating to CreateBoos (20120527025142)
+   (0.0ms)  begin transaction
+   (0.3ms)  CREATE TABLE "boos" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "foo_id" integer, "poly_id" integer, "poly_type" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120527025142')
+   (3.7ms)  commit transaction
+   (0.4ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.0ms)  PRAGMA index_list("boos")
+   (0.0ms)  PRAGMA index_list("foos")
+   (0.0ms)  PRAGMA index_list("papers")
+   (0.0ms)  PRAGMA index_list("users")
+   (0.0ms)  PRAGMA index_info('index_users_on_authentication_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_unlock_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_confirmation_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_reset_password_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_email')

data/test/support/test_app.rb

@@ -0,0 +1,19 @@
+module TestApp
+
+  # No mattr_accessor before initialization ;(
+  def self.path=(new_path)
+    @path = new_path
+  end
+
+  def self.path
+    @path
+  end
+
+  def self.prepare!
+    self.path = File.expand_path("../../../tmp/dummy",  __FILE__)
+    FileUtils.rm_rf path
+    FileUtils.mkdir_p path
+    FileUtils.cp_r File.expand_path("../../dummy//", __FILE__), File.expand_path(path+"/../")
+    system("cd #{path} && bundle exec rake db:migrate > /dev/null")
+  end
+end

data/test/test_helper.rb

@@ -3,17 +3,13 @@ require 'fileutils'
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
-$test_app = test_app_dir = File.expand_path("../../tmp/dummy",  __FILE__)
-FileUtils.rm_rf test_app_dir
-FileUtils.mkdir_p test_app_dir
-FileUtils.cp_r File.expand_path("../dummy//", __FILE__), File.expand_path(test_app_dir+"/../")
-system("cd #{$test_app} && bundle exec rake db:migrate > /dev/null")
- 
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+TestApp.prepare!
 
-require File.expand_path("#{test_app_dir}/config/environment.rb",  __FILE__)
+require File.expand_path("#{TestApp.path}/config/environment.rb",  __FILE__)
 require "rails/test_help"
 
 Rails.backtrace_cleaner.remove_silencers!
 
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotator
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-27 00:00:00.000000000 Z
+date: 2012-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,11 +53,20 @@ extra_rdoc_files: []
 files:
 - lib/tasks/annotator_tasks.rake
 - lib/annotator.rb
+- lib/annotator/initial_description/belongs_to.rb
+- lib/annotator/initial_description/devise.rb
+- lib/annotator/initial_description/paperclip.rb
+- lib/annotator/initial_description/base.rb
+- lib/annotator/initial_description/rails.rb
+- lib/annotator/model.rb
 - lib/annotator/version.rb
+- lib/annotator/attributes.rb
+- lib/annotator/initial_description.rb
 - lib/annotator/railtie.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
+- test/support/test_app.rb
 - test/test_helper.rb
 - test/assets/paper_annotated.rb
 - test/assets/foo_annotated_bad_column.rb
@@ -67,6 +76,8 @@ files:
 - test/assets/boo_annotated.rb
 - test/assets/foo_annotated.rb
 - test/assets/foo_annotated_column_fixed.rb
+- test/assets/foo_require_first.rb
+- test/assets/moo_hoo_annotated.rb
 - test/annotator_test.rb
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
@@ -93,6 +104,7 @@ files:
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/boo.rb
 - test/dummy/app/models/paper.rb
+- test/dummy/app/models/moo/hoo.rb
 - test/dummy/app/models/user.rb
 - test/dummy/app/models/foo.rb
 - test/dummy/app/models/nomodel.rb
@@ -138,11 +150,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Annotate your models and keep your comments about fields.
 test_files:
+- test/support/test_app.rb
 - test/test_helper.rb
 - test/assets/paper_annotated.rb
 - test/assets/foo_annotated_bad_column.rb
@@ -152,6 +165,8 @@ test_files:
 - test/assets/boo_annotated.rb
 - test/assets/foo_annotated.rb
 - test/assets/foo_annotated_column_fixed.rb
+- test/assets/foo_require_first.rb
+- test/assets/moo_hoo_annotated.rb
 - test/annotator_test.rb
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
@@ -178,6 +193,7 @@ test_files:
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/boo.rb
 - test/dummy/app/models/paper.rb
+- test/dummy/app/models/moo/hoo.rb
 - test/dummy/app/models/user.rb
 - test/dummy/app/models/foo.rb
 - test/dummy/app/models/nomodel.rb