annotate models

Author: SamSaffron

app/models/api_key.rb

@@ -20,3 +20,20 @@ def self.create_master_key
   end
 
 end
+
+# == Schema Information
+#
+# Table name: api_keys
+#
+#  id            :integer          not null, primary key
+#  key           :string(64)       not null
+#  user_id       :integer
+#  created_by_id :integer
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#
+# Indexes
+#
+#  index_api_keys_on_key      (key)
+#  index_api_keys_on_user_id  (user_id) UNIQUE
+#

app/models/category.rb

@@ -293,27 +293,31 @@ def self.resolve_permissions(permissions)
 #
 # Table name: categories
 #
-#  id              :integer          not null, primary key
-#  name            :string(50)       not null
-#  color           :string(6)        default("AB9364"), not null
-#  topic_id        :integer
-#  topic_count     :integer          default(0), not null
-#  created_at      :datetime         not null
-#  updated_at      :datetime         not null
-#  user_id         :integer          not null
-#  topics_year     :integer
-#  topics_month    :integer
-#  topics_week     :integer
-#  slug            :string(255)      not null
-#  description     :text
-#  text_color      :string(6)        default("FFFFFF"), not null
-#  hotness         :float            default(5.0), not null
-#  read_restricted :boolean          default(FALSE), not null
-#  auto_close_days :float
+#  id                 :integer          not null, primary key
+#  name               :string(50)       not null
+#  color              :string(6)        default("AB9364"), not null
+#  topic_id           :integer
+#  topic_count        :integer          default(0), not null
+#  created_at         :datetime         not null
+#  updated_at         :datetime         not null
+#  user_id            :integer          not null
+#  topics_year        :integer
+#  topics_month       :integer
+#  topics_week        :integer
+#  slug               :string(255)      not null
+#  description        :text
+#  text_color         :string(6)        default("FFFFFF"), not null
+#  hotness            :float            default(5.0), not null
+#  read_restricted    :boolean          default(FALSE), not null
+#  auto_close_days    :float
+#  post_count         :integer          default(0), not null
+#  latest_post_id     :integer
+#  latest_topic_id    :integer
+#  position           :integer          not null
+#  parent_category_id :integer
 #
 # Indexes
 #
 #  index_categories_on_forum_thread_count  (topic_count)
 #  index_categories_on_name                (name) UNIQUE
 #
-

app/models/incoming_link.rb

@@ -102,7 +102,7 @@ def referer_valid
 #  created_at      :datetime         not null
 #  updated_at      :datetime         not null
 #  user_id         :integer
-#  ip_address      :string
+#  ip_address      :inet
 #  current_user_id :integer
 #
 # Indexes
@@ -111,4 +111,3 @@ def referer_valid
 #  index_incoming_links_on_created_at_and_domain   (created_at,domain)
 #  index_incoming_links_on_created_at_and_user_id  (created_at,user_id)
 #
-

app/models/post.rb

@@ -455,11 +455,11 @@ def create_reply_relationship_with(post)
 #  notify_user_count       :integer          default(0), not null
 #  like_score              :integer          default(0), not null
 #  deleted_by_id           :integer
+#  edit_reason             :string(255)
 #
 # Indexes
 #
 #  idx_posts_user_id_deleted_at             (user_id)
 #  index_posts_on_reply_to_post_number      (reply_to_post_number)
 #  index_posts_on_topic_id_and_post_number  (topic_id,post_number) UNIQUE
 #
-

app/models/post_detail.rb

@@ -4,3 +4,20 @@ class PostDetail < ActiveRecord::Base
   validates_presence_of   :key, :value
   validates_uniqueness_of :key, scope: :post_id
 end
+
+# == Schema Information
+#
+# Table name: post_details
+#
+#  id         :integer          not null, primary key
+#  post_id    :integer
+#  key        :string(255)
+#  value      :string(255)
+#  extra      :text
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+# Indexes
+#
+#  index_post_details_on_post_id_and_key  (post_id,key) UNIQUE
+#

app/models/screened_email.rb

@@ -35,11 +35,10 @@ def self.should_block?(email)
 #  last_match_at :datetime
 #  created_at    :datetime         not null
 #  updated_at    :datetime         not null
-#  ip_address    :string
+#  ip_address    :inet
 #
 # Indexes
 #
 #  index_blocked_emails_on_email          (email) UNIQUE
 #  index_blocked_emails_on_last_match_at  (last_match_at)
 #
-

app/models/screened_ip_address.rb

@@ -50,3 +50,21 @@ def self.exists_for_ip_address_and_action?(ip_address, action_type)
     !!b and b.action_type == action_type
   end
 end
+
+# == Schema Information
+#
+# Table name: screened_ip_addresses
+#
+#  id            :integer          not null, primary key
+#  ip_address    :inet             not null
+#  action_type   :integer          not null
+#  match_count   :integer          default(0), not null
+#  last_match_at :datetime
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#
+# Indexes
+#
+#  index_screened_ip_addresses_on_ip_address     (ip_address) UNIQUE
+#  index_screened_ip_addresses_on_last_match_at  (last_match_at)
+#

app/models/screened_url.rb

@@ -49,11 +49,10 @@ def self.normalize_url(url)
 #  last_match_at :datetime
 #  created_at    :datetime         not null
 #  updated_at    :datetime         not null
-#  ip_address    :string
+#  ip_address    :inet
 #
 # Indexes
 #
 #  index_screened_urls_on_last_match_at  (last_match_at)
 #  index_screened_urls_on_url            (url) UNIQUE
 #
-

app/models/topic.rb

@@ -729,6 +729,7 @@ def apply_per_day_rate_limit_for(key, method_name)
 #  auto_close_user_id      :integer
 #  auto_close_started_at   :datetime
 #  deleted_by_id           :integer
+#  participant_count       :integer          default(1)
 #
 # Indexes
 #
@@ -737,4 +738,3 @@ def apply_per_day_rate_limit_for(key, method_name)
 #  index_topics_on_deleted_at_and_visible_and_archetype_and_id  (deleted_at,visible,archetype,id)
 #  index_topics_on_id_and_deleted_at                            (id,deleted_at)
 #
-

app/models/topic_link_click.rb

@@ -53,10 +53,9 @@ def self.create_from(args={})
 #  user_id       :integer
 #  created_at    :datetime         not null
 #  updated_at    :datetime         not null
-#  ip_address    :string           not null
+#  ip_address    :inet             not null
 #
 # Indexes
 #
 #  index_forum_thread_link_clicks_on_forum_thread_link_id  (topic_link_id)
 #
-