chore: add annotations to factories and models specs

spec/factories/address_endpoint_factory.rb

@@ -1,5 +1,17 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: address_endpoints
+#
+#  id           :integer          not null, primary key
+#  address      :string(255)
+#  last_used_at :datetime
+#  uuid         :string(255)
+#  created_at   :datetime         not null
+#  updated_at   :datetime         not null
+#  server_id    :integer
+#
 FactoryBot.define do
   factory :address_endpoint do
     server

spec/factories/ip_pool_rule_factory.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: ip_pool_rules
+#
+#  id         :integer          not null, primary key
+#  from_text  :text(65535)
+#  owner_type :string(255)
+#  to_text    :text(65535)
+#  uuid       :string(255)
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  ip_pool_id :integer
+#  owner_id   :integer
+#
 FactoryBot.define do
   factory :ip_pool_rule do
     owner factory: :organization

spec/factories/smtp_endpoint_factory.rb

@@ -1,5 +1,22 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: smtp_endpoints
+#
+#  id             :integer          not null, primary key
+#  disabled_until :datetime
+#  error          :text(65535)
+#  hostname       :string(255)
+#  last_used_at   :datetime
+#  name           :string(255)
+#  port           :integer
+#  ssl_mode       :string(255)
+#  uuid           :string(255)
+#  created_at     :datetime
+#  updated_at     :datetime
+#  server_id      :integer
+#
 FactoryBot.define do
   factory :smtp_endpoint do
     server

spec/factories/webhook_factory.rb

@@ -1,5 +1,25 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: webhooks
+#
+#  id           :integer          not null, primary key
+#  all_events   :boolean          default(FALSE)
+#  enabled      :boolean          default(TRUE)
+#  last_used_at :datetime
+#  name         :string(255)
+#  sign         :boolean          default(TRUE)
+#  url          :string(255)
+#  uuid         :string(255)
+#  created_at   :datetime
+#  updated_at   :datetime
+#  server_id    :integer
+#
+# Indexes
+#
+#  index_webhooks_on_server_id  (server_id)
+#
 FactoryBot.define do
   factory :webhook do
     server

spec/factories/worker_role_factory.rb

@@ -1,5 +1,18 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: worker_roles
+#
+#  id          :bigint           not null, primary key
+#  acquired_at :datetime
+#  role        :string(255)
+#  worker      :string(255)
+#
+# Indexes
+#
+#  index_worker_roles_on_role  (role) UNIQUE
+#
 FactoryBot.define do
   factory :worker_role do
     role { "test" }

spec/models/domain_spec.rb

@@ -1,5 +1,40 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: domains
+#
+#  id                     :integer          not null, primary key
+#  dkim_error             :string(255)
+#  dkim_identifier_string :string(255)
+#  dkim_private_key       :text(65535)
+#  dkim_status            :string(255)
+#  dns_checked_at         :datetime
+#  incoming               :boolean          default(TRUE)
+#  mx_error               :string(255)
+#  mx_status              :string(255)
+#  name                   :string(255)
+#  outgoing               :boolean          default(TRUE)
+#  owner_type             :string(255)
+#  return_path_error      :string(255)
+#  return_path_status     :string(255)
+#  spf_error              :string(255)
+#  spf_status             :string(255)
+#  use_for_any            :boolean
+#  uuid                   :string(255)
+#  verification_method    :string(255)
+#  verification_token     :string(255)
+#  verified_at            :datetime
+#  created_at             :datetime
+#  updated_at             :datetime
+#  owner_id               :integer
+#  server_id              :integer
+#
+# Indexes
+#
+#  index_domains_on_server_id  (server_id)
+#  index_domains_on_uuid       (uuid)
+#
 require "rails_helper"
 
 describe Domain do

spec/models/organization_spec.rb

@@ -1,5 +1,27 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: organizations
+#
+#  id                :integer          not null, primary key
+#  deleted_at        :datetime
+#  name              :string(255)
+#  permalink         :string(255)
+#  suspended_at      :datetime
+#  suspension_reason :string(255)
+#  time_zone         :string(255)
+#  uuid              :string(255)
+#  created_at        :datetime
+#  updated_at        :datetime
+#  ip_pool_id        :integer
+#  owner_id          :integer
+#
+# Indexes
+#
+#  index_organizations_on_permalink  (permalink)
+#  index_organizations_on_uuid       (uuid)
+#
 require "rails_helper"
 
 describe Organization do

spec/models/server_spec.rb

@@ -1,5 +1,46 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: servers
+#
+#  id                                 :integer          not null, primary key
+#  allow_sender                       :boolean          default(FALSE)
+#  deleted_at                         :datetime
+#  domains_not_to_click_track         :text(65535)
+#  log_smtp_data                      :boolean          default(FALSE)
+#  message_retention_days             :integer
+#  mode                               :string(255)
+#  name                               :string(255)
+#  outbound_spam_threshold            :decimal(8, 2)
+#  permalink                          :string(255)
+#  postmaster_address                 :string(255)
+#  privacy_mode                       :boolean          default(FALSE)
+#  raw_message_retention_days         :integer
+#  raw_message_retention_size         :integer
+#  send_limit                         :integer
+#  send_limit_approaching_at          :datetime
+#  send_limit_approaching_notified_at :datetime
+#  send_limit_exceeded_at             :datetime
+#  send_limit_exceeded_notified_at    :datetime
+#  spam_failure_threshold             :decimal(8, 2)
+#  spam_threshold                     :decimal(8, 2)
+#  suspended_at                       :datetime
+#  suspension_reason                  :string(255)
+#  token                              :string(255)
+#  uuid                               :string(255)
+#  created_at                         :datetime
+#  updated_at                         :datetime
+#  ip_pool_id                         :integer
+#  organization_id                    :integer
+#
+# Indexes
+#
+#  index_servers_on_organization_id  (organization_id)
+#  index_servers_on_permalink        (permalink)
+#  index_servers_on_token            (token)
+#  index_servers_on_uuid             (uuid)
+#
 require "rails_helper"
 
 describe Server do

spec/models/user_spec.rb

@@ -1,5 +1,29 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: users
+#
+#  id                               :integer          not null, primary key
+#  admin                            :boolean          default(FALSE)
+#  email_address                    :string(255)
+#  email_verification_token         :string(255)
+#  email_verified_at                :datetime
+#  first_name                       :string(255)
+#  last_name                        :string(255)
+#  password_digest                  :string(255)
+#  password_reset_token             :string(255)
+#  password_reset_token_valid_until :datetime
+#  time_zone                        :string(255)
+#  uuid                             :string(255)
+#  created_at                       :datetime
+#  updated_at                       :datetime
+#
+# Indexes
+#
+#  index_users_on_email_address  (email_address)
+#  index_users_on_uuid           (uuid)
+#
 require "rails_helper"
 
 describe User do

spec/models/worker_role_spec.rb

@@ -1,5 +1,18 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: worker_roles
+#
+#  id          :bigint           not null, primary key
+#  acquired_at :datetime
+#  role        :string(255)
+#  worker      :string(255)
+#
+# Indexes
+#
+#  index_worker_roles_on_role  (role) UNIQUE
+#
 require "rails_helper"
 
 RSpec.describe WorkerRole do