Annotate models

Run bin/annotate models

Author: rossta

app/models/admin_user.rb

@@ -1,3 +1,17 @@
+# == Schema Information
+#
+# Table name: admin_users
+#
+#  id              :integer          not null, primary key
+#  email           :string
+#  password_digest :string           not null
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#
+# Indexes
+#
+#  index_admin_users_on_email  (email) UNIQUE
+#
 class AdminUser < ApplicationRecord
   has_secure_password
 

app/models/color_scheme.rb

@@ -1,5 +1,29 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: color_schemes
+#
+#  id         :string           not null, primary key
+#  name       :string           not null
+#  weight_100 :string           not null
+#  weight_200 :string           not null
+#  weight_300 :string           not null
+#  weight_400 :string           not null
+#  weight_50  :string           not null
+#  weight_500 :string           not null
+#  weight_600 :string           not null
+#  weight_700 :string           not null
+#  weight_800 :string           not null
+#  weight_900 :string           not null
+#  weight_950 :string           not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+# Indexes
+#
+#  index_color_schemes_on_name  (name) UNIQUE
+#
 require "color_conversion"
 
 class ColorScheme < ApplicationRecord

app/models/email_exchange.rb

@@ -1,3 +1,23 @@
+# == Schema Information
+#
+# Table name: email_exchanges
+#
+#  id         :integer          not null, primary key
+#  email      :string           not null
+#  status     :string           default("pending"), not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  user_id    :string           not null
+#
+# Indexes
+#
+#  index_email_exchanges_on_user_id            (user_id)
+#  index_email_exchanges_on_user_id_and_email  (user_id,email) UNIQUE WHERE status = 0
+#
+# Foreign Keys
+#
+#  user_id  (user_id => users.id)
+#
 class EmailExchange < ApplicationRecord
   belongs_to :user
 

app/models/examples/post.rb

@@ -1,3 +1,18 @@
+# == Schema Information
+#
+# Table name: examples_posts
+#
+#  id            :integer          not null, primary key
+#  postable_type :string           not null
+#  title         :string           not null
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#  postable_id   :integer          not null
+#
+# Indexes
+#
+#  index_examples_posts_on_postable  (postable_type,postable_id)
+#
 class Examples::Post < ApplicationRecord
   POSTABLE_TYPES = %w[
     Examples::Posts::Markdown

app/models/examples/posts/image.rb

@@ -1,2 +1,11 @@
+# == Schema Information
+#
+# Table name: examples_posts_images
+#
+#  id         :integer          not null, primary key
+#  url        :string           not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
 class Examples::Posts::Image < ApplicationRecord
 end

app/models/examples/posts/link.rb

@@ -1,2 +1,11 @@
+# == Schema Information
+#
+# Table name: examples_posts_links
+#
+#  id         :integer          not null, primary key
+#  url        :string           not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
 class Examples::Posts::Link < ApplicationRecord
 end

app/models/examples/posts/markdown.rb

@@ -1,2 +1,11 @@
+# == Schema Information
+#
+# Table name: examples_posts_markdowns
+#
+#  id         :integer          not null, primary key
+#  body       :text             not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
 class Examples::Posts::Markdown < ApplicationRecord
 end

app/models/newsletter.rb

@@ -1,3 +1,18 @@
+# == Schema Information
+#
+# Table name: newsletters
+#
+#  id         :string           not null, primary key
+#  content    :text             not null
+#  sent_at    :datetime
+#  title      :string           not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+# Indexes
+#
+#  index_newsletters_on_sent_at  (sent_at)
+#
 class Newsletter < ApplicationRecord
   validates :title, presence: true
   validates :content, presence: true

app/models/newsletter_subscription.rb

@@ -1,3 +1,17 @@
+# == Schema Information
+#
+# Table name: newsletter_subscriptions
+#
+#  id              :string           not null, primary key
+#  subscriber_type :string           not null
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#  subscriber_id   :string           not null
+#
+# Indexes
+#
+#  index_newsletter_subscriptions_on_subscriber  (subscriber_type,subscriber_id) UNIQUE
+#
 class NewsletterSubscription < ApplicationRecord
   belongs_to :subscriber, polymorphic: true, inverse_of: :newsletter_subscription
 

app/models/notification.rb

@@ -1,3 +1,27 @@
+# == Schema Information
+#
+# Table name: notifications
+#
+#  id                    :integer          not null, primary key
+#  processed_at          :datetime
+#  read_at               :datetime
+#  recipient_type        :string           not null
+#  seen_at               :datetime
+#  type                  :string
+#  created_at            :datetime         not null
+#  updated_at            :datetime         not null
+#  notification_event_id :integer          not null
+#  recipient_id          :string           not null
+#
+# Indexes
+#
+#  index_notifications_on_notification_event_id  (notification_event_id)
+#  index_notifications_on_recipient              (recipient_type,recipient_id)
+#
+# Foreign Keys
+#
+#  notification_event_id  (notification_event_id => notification_events.id)
+#
 class Notification < ApplicationRecord
   belongs_to :notification_event, counter_cache: true
   belongs_to :recipient, polymorphic: true