wip

app/models/relationship.rb

@@ -8,14 +8,23 @@ class Relationship < ApplicationRecord
   belongs_to :section
   has_one :review, dependent: :restrict_with_exception
 
+  enum stored_status: {
+    planned: "planned",
+    subscribed: "subscribed",
+    enrolled: "enrolled",
+  }
+
   class Status < T::Enum
     enums do
-      Planned = new
-      Subscribed = new
-      Enrolled = new
+      # A relationship can be in one of the following states:
+      Planned = new("planned") # A user has put this section into their class plan for a quarter
+      Subscribed = new("subscribed") # The section is in a class plan and the user wants enrollment notifications for the section
+      Enrolled = new("enrolled") # The section has been enrolled in. No need to send further notifications.
+
+      Completed = new("completed") # Where enrolled sections go after the quarter ends. The user has taken the course!
+      Reviewed = new("reviewed") # The user has taken the section and reviewed it.
 
-      Completed = new
-      Reviewed = new
+      # How does Status differ from stored_status above? We track the first three states (planned, subscribed, enrolled) in the database on this relationship model. The other two states (completed, reviewed) are derived based off other information (term calendar and if a review was written, respectively).
     end
   end
 
@@ -25,8 +34,8 @@ def status
       Status::Reviewed
     elsif completed?
       Status::Completed
-      # else
-      # current_status
+    else
+      Status.deserialize(stored_status)
     end
   end
 

db/migrate/20230827154404_track_relationship_status.rb

@@ -19,7 +19,7 @@ def change
 
     change_table(:relationships, bulk: true) do |t|
       # Will make this non-null in a future migration
-      t.column(:status, :relationship_status)
+      t.column(:stored_status, :relationship_status)
     end
   end
 end

db/structure.sql

@@ -982,7 +982,7 @@ CREATE TABLE public.relationships (
     created_at timestamp(6) without time zone NOT NULL,
     updated_at timestamp(6) without time zone NOT NULL,
     notify boolean DEFAULT false NOT NULL,
-    status public.relationship_status
+    stored_status public.relationship_status
 );