annotator 0.0.2 → 0.0.4

data/README.rdoc

@@ -20,7 +20,9 @@ voila!
 
 Let's say you have a Foo model:
 
-   class Foo < ActiveRecord::Base
+    # My Foo model, it's awesome
+
+    class Foo < ActiveRecord::Base
 
 Make sure your working tree is clean (it's suggested tu put annotations in separate commits so you can easily review changes done by annotator before commiting and you can always easily revert them all) and run:
 
@@ -59,10 +61,15 @@ Of course similar thing happens when you remove column or change it's type.
 * if you don't want it to update anything, put "Attributes(nodoc):" instead
 * 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
+
+Contributions are very much welcome.
 
 == Todos
 
-* tests :)
 * 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
 

data/lib/annotator.rb

@@ -7,14 +7,15 @@ module Annotator
       [filename, klass]
     end.sort_by {|x| x.last.to_s}
 
-    i = 0
+
     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
+      after_block = false # we are already after comments block
       changed = false
       skip_file = false
       attrs_arr = []
@@ -60,7 +61,7 @@ module Annotator
       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.to_str}"
+      puts "FAILURE while trying to update model #{model}:\n  #{e}"
     end
     end
 
@@ -80,10 +81,7 @@ module Annotator
         end
       else
         puts "  A #{model}##{column.name} [#{attrs_str}]"
-        desc = "TODO: document me"
-        desc = "primary key" if column.name == 'id'
-        desc = "creation time" if column.name == 'created_at'
-        desc = "last update time" if column.name == 'updated_at'
+        desc = initial_description model, column
         arr << [column.name, attrs_str, desc]
       end
     end
@@ -99,6 +97,61 @@ module Annotator
     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

data/lib/annotator/version.rb

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

data/test/annotator_test.rb

@@ -1,7 +1,61 @@
 require 'test_helper'
+require 'tempfile'
 
 class AnnotatorTest < ActiveSupport::TestCase
-  test "truth" do
-    assert_kind_of Module, Annotator
+  def setup
+    @output = execute("cd #{$test_app} && rake annotate")
+  end
+
+  test "annotating foo" do
+    assert_equal File.read(asset_file 'foo_annotated.rb' ), File.read(app_file 'foo.rb' )
+  end
+
+  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")
+    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")
+    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]')
+  end
+
+  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")
+    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 
+
+  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
+    assert_equal File.read(asset_file 'boo_annotated.rb' ), File.read(app_file 'boo.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)
+  end
+
+  # Check exit code while grabbing output
+  def execute(command)
+    tmp = Tempfile.new "output"
+    assert system("#{command} > #{tmp.path}")
+    output = tmp.read
+    tmp.unlink
+    output
   end
 end

data/test/assets/boo_annotated.rb

@@ -0,0 +1,8 @@
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * created_at [datetime, not null] - creation time
+# * foo_id [integer] - belongs to Foo
+# * updated_at [datetime, not null] - last update time
+class Boo < ActiveRecord::Base
+  belongs_to :foo
+end

data/test/assets/foo_annotated.rb

@@ -0,0 +1,9 @@
+# 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/foo_annotated_bad_column.rb

@@ -0,0 +1,11 @@
+# Foo class is very foo
+#
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * body [text] - whatever
+# * created_at [foobar] - creation time
+# * random_number [integer] - We still haven't found what this actually means, WTF
+# * title [octopus] - yellow
+# * updated_at [datetime, not null] - last update time
+class Foo < ActiveRecord::Base
+end

data/test/assets/foo_annotated_bad_column_nodoc.rb

@@ -0,0 +1,11 @@
+# Foo class is very foo
+#
+# Attributes(nodoc):
+# * id [integer, primary, not null] - primary key
+# * body [text] - whatever
+# * created_at [foobar] - creation time
+# * random_number [integer] - We still haven't found what this actually means, WTF
+# * title [octopus] - yellow
+# * updated_at [datetime, not null] - last update time
+class Foo < ActiveRecord::Base
+end

data/test/assets/foo_annotated_column_fixed.rb

@@ -0,0 +1,11 @@
+# Foo class is very foo
+#
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * body [text] - whatever
+# * created_at [datetime, not null] - creation time
+# * random_number [integer] - We still haven't found what this actually means, WTF
+# * title [string] - yellow
+# * updated_at [datetime, not null] - last update time
+class Foo < ActiveRecord::Base
+end

data/test/assets/foo_annotated_with_comments.rb

@@ -0,0 +1,11 @@
+# Foo class is very foo
+#
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * body [text] - whatever
+# * created_at [datetime, not null] - creation time
+# * random_number [integer] - We still haven't found what this actually means, WTF
+# * title [string]
+# * updated_at [datetime, not null] - last update time
+class Foo < ActiveRecord::Base
+end

data/test/assets/paper_annotated.rb

@@ -0,0 +1,16 @@
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * avatar_content_type [string] - Paperclip for avatar
+# * avatar_file_name [string] - Paperclip for avatar
+# * avatar_file_size [integer] - Paperclip for avatar
+# * avatar_updated_at [datetime] - Paperclip for avatar
+# * created_at [datetime, not null] - creation time
+# * updated_at [datetime, not null] - last update time
+class Paper < ActiveRecord::Base
+  # has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
+
+  # stub for tests
+  def self.attachments_definitions
+    {:avatar=>{:styles=>{:medium=>"300x300>", :thumb=>"100x100>"}}} 
+  end
+end

data/test/assets/user_annotated.rb

@@ -0,0 +1,34 @@
+# Attributes:
+# * id [integer, primary, not null] - primary key
+# * authentication_token [string] - Devise Token authenticable module
+# * confirmation_sent_at [datetime] - TODO: document me
+# * confirmation_token [string] - Devise Confirmable module
+# * confirmed_at [datetime] - Devise Confirmable module
+# * created_at [datetime, not null] - creation time
+# * current_sign_in_at [datetime] - Devise Trackable module
+# * current_sign_in_ip [string] - Devise Trackable module
+# * email [string, default=, not null]
+# * encrypted_password [string, default=, not null] - TODO: document me
+# * failed_attempts [integer, default=0] - Devise Lockable module
+# * last_sign_in_at [datetime] - Devise Trackable module
+# * last_sign_in_ip [string] - Devise Trackable module
+# * locked_at [datetime] - Devise Lockable module
+# * password_salt [string] - Devise Encriptable module
+# * remember_created_at [datetime] - Devise Rememberable module
+# * reset_password_sent_at [datetime] - Devise Recoverable module
+# * reset_password_token [string] - Devise Recoverable module
+# * sign_in_count [integer, default=0] - Devise Trackable module
+# * unconfirmed_email [string] - Devise Confirmable module
+# * unlock_token [string] - Devise Locakble module
+# * updated_at [datetime, not null] - last update time
+class User < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # :token_authenticatable, :encryptable, :confirmable, :lockable, :timeoutable and :omniauthable
+  def self.devise_modules
+    [:database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable]
+  end
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :email, :password, :password_confirmation, :remember_me
+end

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

@@ -0,0 +1,3 @@
+class Boo < ActiveRecord::Base
+  belongs_to :foo
+end

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

@@ -0,0 +1,3 @@
+class Nomodel
+  # Something that's not really a database thingy
+end

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

@@ -0,0 +1,8 @@
+class Paper < ActiveRecord::Base
+  # has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
+
+  # stub for tests
+  def self.attachments_definitions
+    {:avatar=>{:styles=>{:medium=>"300x300>", :thumb=>"100x100>"}}} 
+  end
+end

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

@@ -0,0 +1,11 @@
+class User < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # :token_authenticatable, :encryptable, :confirmable, :lockable, :timeoutable and :omniauthable
+  def self.devise_modules
+    [:database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable]
+  end
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :email, :password, :password_confirmation, :remember_me
+end

data/test/dummy/db/migrate/20120219112425_create_foos.rb

@@ -3,7 +3,7 @@ class CreateFoos < ActiveRecord::Migration
     create_table :foos do |t|
       t.text :body
       t.string :title
-      t.interger :random_number
+      t.integer :random_number
       t.timestamps
     end
   end

data/test/dummy/db/migrate/20120527020350_devise_create_users.rb

@@ -0,0 +1,49 @@
+class DeviseCreateUsers < ActiveRecord::Migration
+  def change
+    create_table(:users) do |t|
+      ## Database authenticatable
+      t.string :email,              :null => false, :default => ""
+      t.string :encrypted_password, :null => false, :default => ""
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Trackable
+      t.integer  :sign_in_count, :default => 0
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string   :current_sign_in_ip
+      t.string   :last_sign_in_ip
+
+      ## Encryptable
+      t.string :password_salt
+
+      ## Confirmable
+      t.string   :confirmation_token
+      t.datetime :confirmed_at
+      t.datetime :confirmation_sent_at
+      t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## Lockable
+      t.integer  :failed_attempts, :default => 0 # Only if lock strategy is :failed_attempts
+      t.string   :unlock_token # Only if unlock strategy is :email or :both
+      t.datetime :locked_at
+
+      ## Token authenticatable
+      t.string :authentication_token
+
+
+      t.timestamps
+    end
+
+    add_index :users, :email,                :unique => true
+    add_index :users, :reset_password_token, :unique => true
+    add_index :users, :confirmation_token,   :unique => true
+    add_index :users, :unlock_token,         :unique => true
+    add_index :users, :authentication_token, :unique => true
+  end
+end

data/test/dummy/db/migrate/20120527023350_create_papers.rb

@@ -0,0 +1,8 @@
+class CreatePapers < ActiveRecord::Migration
+  def change
+    create_table :papers do |t|
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/migrate/20120527023417_add_attachment_avatar_to_papers.rb

@@ -0,0 +1,15 @@
+class AddAttachmentAvatarToPapers < ActiveRecord::Migration
+  def self.up
+    add_column :papers, :avatar_file_name, :string
+    add_column :papers, :avatar_content_type, :string
+    add_column :papers, :avatar_file_size, :integer
+    add_column :papers, :avatar_updated_at, :datetime
+  end
+
+  def self.down
+    remove_column :papers, :avatar_file_name
+    remove_column :papers, :avatar_content_type
+    remove_column :papers, :avatar_file_size
+    remove_column :papers, :avatar_updated_at
+  end
+end

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

@@ -0,0 +1,8 @@
+class CreateBoos < ActiveRecord::Migration
+  def change
+    create_table :boos do |t|
+      t.references :foo
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20120527020350) do
+
+  create_table "foos", :force => true do |t|
+    t.text     "body"
+    t.string   "title"
+    t.integer  "random_number"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "email",                  :default => "", :null => false
+    t.string   "encrypted_password",     :default => "", :null => false
+    t.string   "reset_password_token"
+    t.datetime "reset_password_sent_at"
+    t.datetime "remember_created_at"
+    t.integer  "sign_in_count",          :default => 0
+    t.datetime "current_sign_in_at"
+    t.datetime "last_sign_in_at"
+    t.string   "current_sign_in_ip"
+    t.string   "last_sign_in_ip"
+    t.string   "password_salt"
+    t.string   "confirmation_token"
+    t.datetime "confirmed_at"
+    t.datetime "confirmation_sent_at"
+    t.string   "unconfirmed_email"
+    t.integer  "failed_attempts",        :default => 0
+    t.string   "unlock_token"
+    t.datetime "locked_at"
+    t.string   "authentication_token"
+    t.datetime "created_at",                             :null => false
+    t.datetime "updated_at",                             :null => false
+  end
+
+  add_index "users", ["authentication_token"], :name => "index_users_on_authentication_token", :unique => true
+  add_index "users", ["confirmation_token"], :name => "index_users_on_confirmation_token", :unique => true
+  add_index "users", ["email"], :name => "index_users_on_email", :unique => true
+  add_index "users", ["reset_password_token"], :name => "index_users_on_reset_password_token", :unique => true
+  add_index "users", ["unlock_token"], :name => "index_users_on_unlock_token", :unique => true
+
+end

data/test/dummy/log/development.log

@@ -0,0 +1,73 @@
+   (0.0ms)  select sqlite_version(*)
+   (14.5ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (3.3ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to CreateFoos (20120219112425)
+   (0.1ms)  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')
+   (2.8ms)  commit transaction
+   (0.2ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.0ms)  PRAGMA index_list("foos")
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  select sqlite_version(*)
+   (15.7ms)  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) 
+   (3.6ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (3.4ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (4.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('20120219112425')
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (5.8ms)  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) 
+   (3.2ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (3.4ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (3.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20120219112425')
+   (0.0ms)  select sqlite_version(*)
+   (5.2ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (4.8ms)  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')
+   (3.3ms)  commit transaction
+Migrating to DeviseCreateUsers (20120527020350)
+   (0.0ms)  begin transaction
+   (0.3ms)  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.1ms)  CREATE UNIQUE INDEX "index_users_on_email" ON "users" ("email")
+   (0.0ms)  PRAGMA index_list("users")
+   (0.0ms)  PRAGMA index_info('index_users_on_email')
+   (0.1ms)  CREATE UNIQUE INDEX "index_users_on_reset_password_token" ON "users" ("reset_password_token")
+   (0.0ms)  PRAGMA index_list("users")
+   (0.0ms)  PRAGMA index_info('index_users_on_reset_password_token')
+   (0.0ms)  PRAGMA index_info('index_users_on_email')
+   (0.1ms)  CREATE UNIQUE INDEX "index_users_on_confirmation_token" ON "users" ("confirmation_token")
+   (0.0ms)  PRAGMA index_list("users")
+   (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)  CREATE UNIQUE INDEX "index_users_on_unlock_token" ON "users" ("unlock_token")
+   (0.0ms)  PRAGMA index_list("users")
+   (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')
+   (0.1ms)  CREATE UNIQUE INDEX "index_users_on_authentication_token" ON "users" ("authentication_token")
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20120527020350')
+   (3.6ms)  commit transaction
+   (0.2ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.0ms)  PRAGMA index_list("foos")
+   (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/dummy/log/test.log

@@ -0,0 +1,2 @@
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction

data/test/dummy/test/fixtures/boos.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value

data/test/dummy/test/fixtures/papers.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value

data/test/dummy/test/fixtures/users.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value

data/test/dummy/test/unit/boo_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BooTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/dummy/test/unit/paper_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class PaperTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/dummy/test/unit/user_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class UserTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/test_helper.rb

@@ -1,7 +1,16 @@
+require 'fileutils'
+
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+$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")
+ 
+
+require File.expand_path("#{test_app_dir}/config/environment.rb",  __FILE__)
 require "rails/test_help"
 
 Rails.backtrace_cleaner.remove_silencers!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-19 00:00:00.000000000 Z
+date: 2012-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &17912340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *17912340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &19057700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +38,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19057700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - kacper.ciesla@tech-angels.com
@@ -49,6 +59,14 @@ files:
 - Rakefile
 - README.rdoc
 - test/test_helper.rb
+- test/assets/paper_annotated.rb
+- test/assets/foo_annotated_bad_column.rb
+- test/assets/foo_annotated_with_comments.rb
+- test/assets/user_annotated.rb
+- test/assets/foo_annotated_bad_column_nodoc.rb
+- test/assets/boo_annotated.rb
+- test/assets/foo_annotated.rb
+- test/assets/foo_annotated_column_fixed.rb
 - test/annotator_test.rb
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
@@ -71,8 +89,13 @@ files:
 - test/dummy/config/environment.rb
 - test/dummy/config/database.yml
 - test/dummy/log/development.log
+- test/dummy/log/test.log
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/models/boo.rb
+- test/dummy/app/models/paper.rb
+- test/dummy/app/models/user.rb
 - test/dummy/app/models/foo.rb
+- test/dummy/app/models/nomodel.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
@@ -80,10 +103,22 @@ files:
 - test/dummy/config.ru
 - test/dummy/script/rails
 - test/dummy/test/unit/foo_test.rb
+- test/dummy/test/unit/user_test.rb
+- test/dummy/test/unit/paper_test.rb
+- test/dummy/test/unit/boo_test.rb
+- test/dummy/test/fixtures/papers.yml
+- test/dummy/test/fixtures/users.yml
 - test/dummy/test/fixtures/foos.yml
+- test/dummy/test/fixtures/boos.yml
 - test/dummy/README.rdoc
+- test/dummy/db/schema.rb
+- test/dummy/db/migrate/20120527020350_devise_create_users.rb
+- test/dummy/db/migrate/20120527025142_create_boos.rb
+- test/dummy/db/migrate/20120527023350_create_papers.rb
+- test/dummy/db/migrate/20120527023417_add_attachment_avatar_to_papers.rb
 - test/dummy/db/migrate/20120219112425_create_foos.rb
-homepage: ''
+- test/dummy/db/development.sqlite3
+homepage: https://github.com/tech-angels/annotator
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -103,12 +138,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Annotate your models and keep your comments about fields.
 test_files:
 - test/test_helper.rb
+- test/assets/paper_annotated.rb
+- test/assets/foo_annotated_bad_column.rb
+- test/assets/foo_annotated_with_comments.rb
+- test/assets/user_annotated.rb
+- test/assets/foo_annotated_bad_column_nodoc.rb
+- test/assets/boo_annotated.rb
+- test/assets/foo_annotated.rb
+- test/assets/foo_annotated_column_fixed.rb
 - test/annotator_test.rb
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
@@ -131,8 +174,13 @@ test_files:
 - test/dummy/config/environment.rb
 - test/dummy/config/database.yml
 - test/dummy/log/development.log
+- test/dummy/log/test.log
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/models/boo.rb
+- test/dummy/app/models/paper.rb
+- test/dummy/app/models/user.rb
 - test/dummy/app/models/foo.rb
+- test/dummy/app/models/nomodel.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
@@ -140,6 +188,18 @@ test_files:
 - test/dummy/config.ru
 - test/dummy/script/rails
 - test/dummy/test/unit/foo_test.rb
+- test/dummy/test/unit/user_test.rb
+- test/dummy/test/unit/paper_test.rb
+- test/dummy/test/unit/boo_test.rb
+- test/dummy/test/fixtures/papers.yml
+- test/dummy/test/fixtures/users.yml
 - test/dummy/test/fixtures/foos.yml
+- test/dummy/test/fixtures/boos.yml
 - test/dummy/README.rdoc
+- test/dummy/db/schema.rb
+- test/dummy/db/migrate/20120527020350_devise_create_users.rb
+- test/dummy/db/migrate/20120527025142_create_boos.rb
+- test/dummy/db/migrate/20120527023350_create_papers.rb
+- test/dummy/db/migrate/20120527023417_add_attachment_avatar_to_papers.rb
 - test/dummy/db/migrate/20120219112425_create_foos.rb
+- test/dummy/db/development.sqlite3