Rename Invitation -> TeacherInvitation

To match the two `/teacher_invitations` API endpoints added in previous
commits.

The invitation is already kind of specific to teachers and in any case,
I think it will be simpler to extract duplication if/when we come to add
other invitations, e.g. for school owners, rather than try to come up
with a generic invitation model upfront.

Note that I've left the `InvitationMailer` & `InvitationPreview`
unchanged, because they both already have `#invite_teacher` methods
which are already sufficient to discriminate between different types of
invitation.

Author: floehopper

app/controllers/api/teacher_invitations_controller.rb

@@ -26,7 +26,7 @@ def accept
     private
 
     def load_invitation
-      @invitation = Invitation.find_by_token_for!(:teacher_invitation, params[:token])
+      @invitation = TeacherInvitation.find_by_token_for!(:teacher_invitation, params[:token])
     end
 
     def ensure_invitation_email_matches_user_email

app/models/invitation.rb renamed to app/models/teacher_invitation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Invitation < ApplicationRecord
+class TeacherInvitation < ApplicationRecord
   delegate :name, to: :school, prefix: true
 
   belongs_to :school

db/migrate/20240624122250_rename_invitations_to_teacher_invitations.rb

@@ -0,0 +1,5 @@
+class RenameInvitationsToTeacherInvitations < ActiveRecord::Migration[7.1]
+  def change
+    rename_table :invitations, :teacher_invitations
+  end
+end

db/schema.rb

@@ -17,7 +17,7 @@ def call(school:, school_teacher_params:, token:)
 
       def invite_teacher(school, school_teacher_params, _token)
         email_address = school_teacher_params.fetch(:email_address)
-        Invitation.create!(school:, email_address:)
+        TeacherInvitation.create!(school:, email_address:)
       end
     end
   end

lib/concepts/school_teacher/invite.rb

@@ -16,8 +16,8 @@
     expect(response.success?).to be(true)
   end
 
-  it 'creates an Invitation' do
-    expect { described_class.call(school:, school_teacher_params:, token:) }.to change(Invitation, :count)
+  it 'creates a TeacherInvitation' do
+    expect { described_class.call(school:, school_teacher_params:, token:) }.to change(TeacherInvitation, :count)
   end
 
   context 'when creation fails' do

spec/concepts/school_teacher/invite_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 FactoryBot.define do
-  factory :invitation do
+  factory :teacher_invitation do
     email_address { '[email protected]' }
     school factory: :verified_school
   end

spec/factories/invitation.rb renamed to spec/factories/teacher_invitation.rb

@@ -21,7 +21,7 @@
     end
 
     context 'when invitation does not exist' do
-      let(:invitation) { build(:invitation) }
+      let(:invitation) { build(:teacher_invitation) }
       let!(:token) { invitation.generate_token_for(:teacher_invitation) }
 
       it 'responds 404 Not Found' do
@@ -33,7 +33,7 @@
     context 'when invitation exists' do
       let(:school) { create(:verified_school) }
       let(:invitation_email) { user.email }
-      let(:invitation) { create(:invitation, email_address: invitation_email, school:) }
+      let(:invitation) { create(:teacher_invitation, email_address: invitation_email, school:) }
       let!(:token) { invitation.generate_token_for(:teacher_invitation) }
 
       context 'when invitation token is not valid because invitation email has changed' do

spec/features/teacher_invitations/accepting_an_invitation_spec.rb

@@ -21,7 +21,7 @@
     end
 
     context 'when invitation does not exist' do
-      let(:invitation) { build(:invitation) }
+      let(:invitation) { build(:teacher_invitation) }
       let!(:token) { invitation.generate_token_for(:teacher_invitation) }
 
       it 'responds 404 Not Found' do
@@ -32,7 +32,7 @@
 
     context 'when invitation exists' do
       let(:invitation_email) { user.email }
-      let(:invitation) { create(:invitation, email_address: invitation_email) }
+      let(:invitation) { create(:teacher_invitation, email_address: invitation_email) }
       let!(:token) { invitation.generate_token_for(:teacher_invitation) }
 
       context 'when invitation token is not valid because invitation email has changed' do

spec/features/teacher_invitations/viewing_an_invitation_spec.rb

@@ -6,7 +6,7 @@
   describe 'invite_teacher' do
     subject(:email) { described_class.with(invitation:).invite_teacher }
 
-    let(:invitation) { create(:invitation) }
+    let(:invitation) { create(:teacher_invitation) }
 
     before do
       allow(ENV).to receive(:fetch).with('EDITOR_PUBLIC_URL').and_return('http://example.com')

spec/mailers/invitation_mailer_spec.rb

@@ -4,7 +4,7 @@
 class InvitationPreview < ActionMailer::Preview
   def invite_teacher
     school = School.new(name: 'Elmwood Secondary School')
-    invitation = Invitation.new(email_address: '[email protected]', school:)
+    invitation = TeacherInvitation.new(email_address: '[email protected]', school:)
     InvitationMailer.with(invitation:).invite_teacher
   end
 end

spec/mailers/previews/invitation_preview.rb

@@ -2,25 +2,25 @@
 
 require 'rails_helper'
 
-RSpec.describe Invitation do
+RSpec.describe TeacherInvitation do
   include ActionMailer::TestHelper
   include ActiveSupport::Testing::TimeHelpers
 
   it 'has a valid factory' do
-    invitation = build(:invitation)
+    invitation = build(:teacher_invitation)
 
     expect(invitation).to be_valid
   end
 
   it 'is invalid with an incorrectly formatted email address' do
-    invitation = build(:invitation, email_address: 'not-an-email-address')
+    invitation = build(:teacher_invitation, email_address: 'not-an-email-address')
 
     expect(invitation).not_to be_valid
   end
 
   it 'is invalid with an unverified school' do
     school = build(:school, verified_at: nil)
-    invitation = build(:invitation, school:)
+    invitation = build(:teacher_invitation, school:)
 
     expect(invitation).not_to be_valid
   end
@@ -34,14 +34,14 @@
   end
 
   it 'generates a token for teacher invitation' do
-    invitation = create(:invitation)
+    invitation = create(:teacher_invitation)
     token = invitation.generate_token_for(:teacher_invitation)
 
     expect(described_class.find_by_token_for(:teacher_invitation, token)).to eq(invitation)
   end
 
   it 'generates a token valid for 30 days' do
-    invitation = create(:invitation)
+    invitation = create(:teacher_invitation)
     token = invitation.generate_token_for(:teacher_invitation)
 
     travel 31.days do
@@ -50,7 +50,7 @@
   end
 
   it 'invalidates the token if the email address changes' do
-    invitation = create(:invitation)
+    invitation = create(:teacher_invitation)
     token = invitation.generate_token_for(:teacher_invitation)
 
     invitation.update(email_address: '[email protected]')
@@ -60,7 +60,7 @@
 
   it 'delegates #school_name to School#name' do
     school = build(:school, name: 'school-name')
-    invitation = build(:invitation, school:)
+    invitation = build(:teacher_invitation, school:)
 
     expect(invitation.school_name).to eq('school-name')
   end