Adding the Annotate gem to add schema information to the top of each …

…model

  - rake task
  - comments added to models, will need to be updated with each schema change

added annotate gem and rake task

left out annotate.rake from last check in

Gemfile

@@ -39,6 +39,7 @@ group :test do
 end
 
 group :test, :development do
+  gem 'annotate', '~> 2.4.1.beta'
   gem 'rspec-rails'
 end
 

Gemfile.lock

@@ -30,6 +30,7 @@ GEM
     activesupport (3.1.3)
       multi_json (~> 1.0)
     addressable (2.2.6)
+    annotate (2.4.1.beta1)
     arel (2.2.1)
     bcrypt-ruby (3.0.1)
     builder (3.0.0)
@@ -165,6 +166,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  annotate (~> 2.4.1.beta)
   capybara
   coffee-rails (~> 3.1.1)
   database_cleaner

app/models/event.rb

@@ -1,3 +1,16 @@
+# == Schema Information
+# Schema version: 20120410060636
+#
+# Table name: events
+#
+#  id          :integer         not null, primary key
+#  title       :string(255)
+#  created_at  :datetime
+#  updated_at  :datetime
+#  date        :datetime
+#  location_id :integer
+#
+
 class Event < ActiveRecord::Base
   belongs_to :location
   has_many :volunteerRsvps

app/models/location.rb

@@ -1,3 +1,15 @@
+# == Schema Information
+# Schema version: 20120410060636
+#
+# Table name: locations
+#
+#  id         :integer         not null, primary key
+#  name       :string(255)
+#  address    :text
+#  created_at :datetime
+#  updated_at :datetime
+#
+
 class Location < ActiveRecord::Base
   has_many :events
 end

app/models/user.rb

@@ -1,3 +1,51 @@
+# == Schema Information
+# Schema version: 20120410060636
+#
+# Table name: users
+#
+#  id                     :integer         not null, primary key
+#  email                  :string(255)     default(""), not null
+#  encrypted_password     :string(128)     default(""), not null
+#  reset_password_token   :string(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     :string(255)
+#  last_sign_in_ip        :string(255)
+#  confirmation_token     :string(255)
+#  confirmed_at           :datetime
+#  confirmation_sent_at   :datetime
+#  failed_attempts        :integer         default(0)
+#  unlock_token           :string(255)
+#  locked_at              :datetime
+#  authentication_token   :string(255)
+#  created_at             :datetime
+#  updated_at             :datetime
+#  teaching               :boolean
+#  taing                  :boolean
+#  coordinating           :boolean
+#  childcaring            :boolean
+#  writing                :boolean
+#  hacking                :boolean
+#  designing              :boolean
+#  evangelizing           :boolean
+#  mentoring              :boolean
+#  macosx                 :boolean
+#  windows                :boolean
+#  linux                  :boolean
+#  other                  :string(255)
+#  name                   :string(255)
+#
+# Indexes
+#
+#  index_users_on_unlock_token          (unlock_token) UNIQUE
+#  index_users_on_confirmation_token    (confirmation_token) UNIQUE
+#  index_users_on_reset_password_token  (reset_password_token) UNIQUE
+#  index_users_on_email                 (email) UNIQUE
+#
+
 class User < ActiveRecord::Base
   # Include default devise modules. Others available are:
   # :token_authenticatable, :encryptable, :confirmable, :lockable, :timeoutable and :omniauthable

app/models/volunteer_rsvp.rb

@@ -1,3 +1,16 @@
+# == Schema Information
+# Schema version: 20120410060636
+#
+# Table name: volunteer_rsvps
+#
+#  id         :integer         not null, primary key
+#  user_id    :integer
+#  event_id   :integer
+#  attending  :boolean
+#  created_at :datetime
+#  updated_at :datetime
+#
+
 class VolunteerRsvp < ActiveRecord::Base
   belongs_to :user
   belongs_to :event

lib/tasks/annotate.rake

@@ -0,0 +1,6 @@
+namespace :annotate do
+  desc "Generate model annotation"
+  task :generate do
+    `annotate --position before --show-migration --show-indexes --exclude tests --exclude fixtures`
+  end
+end