Add annotate_rb gem and annotate all models

test/fixtures/completions.yml

@@ -1,5 +1,29 @@
 # Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
+# == Schema Information
+#
+# Table name: completions
+#
+#  id            :integer          not null, primary key
+#  time_seconds  :integer
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#  contest_id    :integer          not null
+#  contestant_id :integer          not null
+#  puzzle_id     :integer          not null
+#
+# Indexes
+#
+#  index_completions_on_contest_id     (contest_id)
+#  index_completions_on_contestant_id  (contestant_id)
+#  index_completions_on_puzzle_id      (puzzle_id)
+#
+# Foreign Keys
+#
+#  contest_id     (contest_id => contests.id)
+#  contestant_id  (contestant_id => contestants.id)
+#  puzzle_id      (puzzle_id => puzzles.id)
+#
 one:
   time_seconds: 1
   contestant: one

test/fixtures/contestants.yml

@@ -1,5 +1,24 @@
 # Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
+# == Schema Information
+#
+# Table name: contestants
+#
+#  id         :integer          not null, primary key
+#  email      :string
+#  name       :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  contest_id :integer          not null
+#
+# Indexes
+#
+#  index_contestants_on_contest_id  (contest_id)
+#
+# Foreign Keys
+#
+#  contest_id  (contest_id => contests.id)
+#
 one:
   name: MyString
   email: MyString

test/fixtures/contests.yml

@@ -1,5 +1,25 @@
 # Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
+# == Schema Information
+#
+# Table name: contests
+#
+#  id                 :integer          not null, primary key
+#  allow_registration :boolean          default(FALSE)
+#  name               :string
+#  team               :boolean          default(FALSE)
+#  created_at         :datetime         not null
+#  updated_at         :datetime         not null
+#  user_id            :integer          not null
+#
+# Indexes
+#
+#  index_contests_on_user_id  (user_id)
+#
+# Foreign Keys
+#
+#  user_id  (user_id => users.id)
+#
 one:
   name: MyString
   user: one

test/fixtures/puzzles.yml

@@ -1,5 +1,24 @@
 # Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
+# == Schema Information
+#
+# Table name: puzzles
+#
+#  id         :integer          not null, primary key
+#  brand      :string
+#  name       :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  contest_id :integer          not null
+#
+# Indexes
+#
+#  index_puzzles_on_contest_id  (contest_id)
+#
+# Foreign Keys
+#
+#  contest_id  (contest_id => contests.id)
+#
 one:
   name: MyString
 

test/fixtures/users.yml

@@ -1,5 +1,21 @@
 <% password_digest = BCrypt::Password.create("password") %>
 
+# == Schema Information
+#
+# Table name: users
+#
+#  id              :integer          not null, primary key
+#  admin           :boolean          default(FALSE), not null
+#  email_address   :string           not null
+#  password_digest :string           not null
+#  username        :string
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#
+# Indexes
+#
+#  index_users_on_email_address  (email_address) UNIQUE
+#
 one:
   email_address: one@example.com
   password_digest: <%= password_digest %>

test/models/completion_test.rb

@@ -1,3 +1,27 @@
+# == Schema Information
+#
+# Table name: completions
+#
+#  id            :integer          not null, primary key
+#  time_seconds  :integer
+#  created_at    :datetime         not null
+#  updated_at    :datetime         not null
+#  contest_id    :integer          not null
+#  contestant_id :integer          not null
+#  puzzle_id     :integer          not null
+#
+# Indexes
+#
+#  index_completions_on_contest_id     (contest_id)
+#  index_completions_on_contestant_id  (contestant_id)
+#  index_completions_on_puzzle_id      (puzzle_id)
+#
+# Foreign Keys
+#
+#  contest_id     (contest_id => contests.id)
+#  contestant_id  (contestant_id => contestants.id)
+#  puzzle_id      (puzzle_id => puzzles.id)
+#
 require "test_helper"
 
 class CompletionTest < ActiveSupport::TestCase

test/models/contest_test.rb

@@ -1,3 +1,23 @@
+# == Schema Information
+#
+# Table name: contests
+#
+#  id                 :integer          not null, primary key
+#  allow_registration :boolean          default(FALSE)
+#  name               :string
+#  team               :boolean          default(FALSE)
+#  created_at         :datetime         not null
+#  updated_at         :datetime         not null
+#  user_id            :integer          not null
+#
+# Indexes
+#
+#  index_contests_on_user_id  (user_id)
+#
+# Foreign Keys
+#
+#  user_id  (user_id => users.id)
+#
 require "test_helper"
 
 class ContestTest < ActiveSupport::TestCase

test/models/contestant_test.rb

@@ -1,3 +1,22 @@
+# == Schema Information
+#
+# Table name: contestants
+#
+#  id         :integer          not null, primary key
+#  email      :string
+#  name       :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  contest_id :integer          not null
+#
+# Indexes
+#
+#  index_contestants_on_contest_id  (contest_id)
+#
+# Foreign Keys
+#
+#  contest_id  (contest_id => contests.id)
+#
 require "test_helper"
 
 class ContestantTest < ActiveSupport::TestCase

test/models/puzzle_test.rb

@@ -1,3 +1,22 @@
+# == Schema Information
+#
+# Table name: puzzles
+#
+#  id         :integer          not null, primary key
+#  brand      :string
+#  name       :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  contest_id :integer          not null
+#
+# Indexes
+#
+#  index_puzzles_on_contest_id  (contest_id)
+#
+# Foreign Keys
+#
+#  contest_id  (contest_id => contests.id)
+#
 require "test_helper"
 
 class PuzzleTest < ActiveSupport::TestCase

test/models/user_test.rb

@@ -1,3 +1,19 @@
+# == Schema Information
+#
+# Table name: users
+#
+#  id              :integer          not null, primary key
+#  admin           :boolean          default(FALSE), not null
+#  email_address   :string           not null
+#  password_digest :string           not null
+#  username        :string
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#
+# Indexes
+#
+#  index_users_on_email_address  (email_address) UNIQUE
+#
 require "test_helper"
 
 class UserTest < ActiveSupport::TestCase