Add m2m corpus-follower table

app/models.py

@@ -3,6 +3,7 @@ from enum import Enum, IntEnum
 from flask import current_app, url_for
 from flask_hashids import HashidMixin
 from flask_login import UserMixin
+from sqlalchemy.ext.associationproxy import association_proxy
 from time import sleep
 from tqdm import tqdm
 from werkzeug.security import generate_password_hash, check_password_hash
@@ -169,7 +170,7 @@ class Role(HashidMixin, db.Model):
     default = db.Column(db.Boolean, default=False, index=True)
     permissions = db.Column(db.Integer, default=0)
     # Relationships
-    users = db.relationship('User', backref='role', lazy='dynamic')
+    users = db.relationship('User', back_populates='role', lazy='dynamic')
 
     def __repr__(self):
         return f'<Role {self.name}>'
@@ -239,7 +240,8 @@ class Token(db.Model):
     access_expiration = db.Column(db.DateTime)
     refresh_token = db.Column(db.String(64), index=True)
     refresh_expiration = db.Column(db.DateTime)
-    # Backrefs: user: User
+    # Relationships
+    user = db.relationship('User', back_populates='tokens')
 
     def expire(self):
         self.access_expiration = datetime.utcnow()
@@ -258,7 +260,9 @@ class Avatar(HashidMixin, FileMixin, db.Model):
     id = db.Column(db.Integer, primary_key=True)
     # Foreign keys
     user_id = db.Column(db.Integer, db.ForeignKey('users.id'))
-    
+    # Relationships
+    user = db.relationship('User', back_populates='avatar')
+
     @property
     def path(self):
         return os.path.join(self.user.path, 'avatar')
@@ -278,19 +282,22 @@ class Avatar(HashidMixin, FileMixin, db.Model):
         return json_serializeable
 
 
-corpus_followers = db.Table(
-    'corpus_followers',
-    db.Model.metadata,
-    db.Column('user_id', db.ForeignKey('users.id'), primary_key=True),
-    db.Column('corpus_id', db.ForeignKey('corpora.id'), primary_key=True)
-)
+class CorpusFollowerAssociation(db.Model):
+    __tablename__ = 'corpus_follower_associations'
+    # Primary key
+    id = db.Column(db.Integer, primary_key=True)
+    # Foreign keys
+    following_user_id = db.Column(db.Integer, db.ForeignKey('users.id'))
+    followed_corpus_id = db.Column(db.Integer, db.ForeignKey('corpora.id'))
+    # Fields
+    permissions = db.Column(db.Integer, default=0, nullable=False)
+    # Relationships
+    followed_corpus = db.relationship('Corpus', back_populates='following_user_associations')
+    following_user = db.relationship('User', back_populates='followed_corpus_associations')
+
+    def __repr__(self):
+        return f'<CorpusFollowerAssociation {self.following_user.__repr__()} ~ {self.followed_corpus.__repr__()}>'
 
-user_followers = db.Table(
-    'user_followers',
-    db.Model.metadata,
-    db.Column('follower_user_id', db.ForeignKey('users.id'), primary_key=True),
-    db.Column('followed_user_id', db.ForeignKey('users.id'), primary_key=True)
-)
 
 class User(HashidMixin, UserMixin, db.Model):
     __tablename__ = 'users'
@@ -316,56 +323,53 @@ class User(HashidMixin, UserMixin, db.Model):
     organization = db.Column(db.String(128))
     is_public = db.Column(db.Boolean, default=False)
     profile_privacy_settings = db.Column(db.Integer(), default=0)
-    # Backrefs: role: Role
     # Relationships
     avatar = db.relationship(
         'Avatar',
-        backref='user',
+        back_populates='user',
         cascade='all, delete-orphan',
         uselist=False
     )
-    tesseract_ocr_pipeline_models = db.relationship(
-        'TesseractOCRPipelineModel',
-        backref='user',
-        cascade='all, delete-orphan',
-        lazy='dynamic'
-    )
-    spacy_nlp_pipeline_models = db.relationship(
-        'SpaCyNLPPipelineModel',
-        backref='user',
-        cascade='all, delete-orphan',
-        lazy='dynamic'
-    )
     corpora = db.relationship(
         'Corpus',
-        backref='user',
+        back_populates='user',
         cascade='all, delete-orphan',
         lazy='dynamic'
     )
-    followed_corpora = db.relationship(
-        'Corpus',
-        secondary=corpus_followers,
-        primaryjoin=(corpus_followers.c.user_id == id),
-        backref=db.backref('followers', lazy='dynamic'),
-        lazy='dynamic'
+    followed_corpus_associations = db.relationship(
+        'CorpusFollowerAssociation',
+        back_populates='following_user'
     )
-    followed_users = db.relationship(
-        'User',
-        secondary=user_followers,
-        primaryjoin=(user_followers.c.follower_user_id == id),
-        secondaryjoin=(user_followers.c.followed_user_id == id),
-        backref=db.backref('followers', lazy='dynamic'),
-        lazy='dynamic'
+    followed_corpora = association_proxy(
+        'followed_corpus_associations',
+        'followed_corpus',
+        creator=lambda c: CorpusFollowerAssociation(followed_corpus=c)
     )
     jobs = db.relationship(
         'Job',
-        backref='user',
+        back_populates='user',
+        cascade='all, delete-orphan',
+        lazy='dynamic'
+    )
+    role = db.relationship(
+        'Role',
+        back_populates='users'
+    )
+    spacy_nlp_pipeline_models = db.relationship(
+        'SpaCyNLPPipelineModel',
+        back_populates='user',
+        cascade='all, delete-orphan',
+        lazy='dynamic'
+    )
+    tesseract_ocr_pipeline_models = db.relationship(
+        'TesseractOCRPipelineModel',
+        back_populates='user',
         cascade='all, delete-orphan',
         lazy='dynamic'
     )
     tokens = db.relationship(
         'Token',
-        backref='user',
+        back_populates='user',
         cascade='all, delete-orphan',
         lazy='dynamic'
     )
@@ -572,30 +576,6 @@ class User(HashidMixin, UserMixin, db.Model):
         self.profile_privacy_settings = 0
     #endregion Profile Privacy settings
 
-    def follow_corpus(self, corpus):
-        if not self.is_following_corpus(corpus):
-            self.followed_corpora.append(corpus)
-
-    def unfollow_corpus(self, corpus):
-        if self.is_following_corpus(corpus):
-            self.followed_corpora.remove(corpus)
-    
-    def is_following_corpus(self, corpus):
-        return self.followed_corpora.filter(
-            corpus_followers.c.corpus_id == corpus.id).count() > 0
-
-    def follow_user(self, user):
-        if not self.is_following_user(user):
-            self.followed_users.append(user)
-
-    def unfollow_user(self, user):
-        if self.is_following_user(user):
-            self.followed_users.remove(user)
-    
-    def is_following_user(self, user):
-        return self.followed_users.filter(
-            user_followers.c.followed_user_id == user.id).count() > 0
-
     def to_json_serializeable(self, backrefs=False, relationships=False, filter_by_privacy_settings=False):
         json_serializeable = {
             'id': self.hashid,
@@ -670,7 +650,8 @@ class TesseractOCRPipelineModel(FileMixin, HashidMixin, db.Model):
     publishing_url = db.Column(db.String(512))
     publishing_year = db.Column(db.Integer)
     is_public = db.Column(db.Boolean, default=False)
-    # Backrefs: user: User
+    # Relationships
+    user = db.relationship('User', back_populates='tesseract_ocr_pipeline_models')
 
     @property
     def path(self):
@@ -794,7 +775,8 @@ class SpaCyNLPPipelineModel(FileMixin, HashidMixin, db.Model):
     publishing_year = db.Column(db.Integer)
     pipeline_name = db.Column(db.String(64))
     is_public = db.Column(db.Boolean, default=False)
-    # Backrefs: user: User
+    # Relationships
+    user = db.relationship('User', back_populates='spacy_nlp_pipeline_models')
 
     @property
     def path(self):
@@ -909,7 +891,11 @@ class JobInput(FileMixin, HashidMixin, db.Model):
     id = db.Column(db.Integer, primary_key=True)
     # Foreign keys
     job_id = db.Column(db.Integer, db.ForeignKey('jobs.id'))
-    # Backrefs: job: Job
+    # Relationships
+    job = db.relationship(
+        'Job',
+        back_populates='inputs'
+    )
 
     def __repr__(self):
         return f'<JobInput {self.filename}>'
@@ -965,7 +951,11 @@ class JobResult(FileMixin, HashidMixin, db.Model):
     job_id = db.Column(db.Integer, db.ForeignKey('jobs.id'))
     # Fields
     description = db.Column(db.String(255))
-    # Backrefs: job: Job
+    # Relationships
+    job = db.relationship(
+        'Job',
+        back_populates='results'
+    )
 
     def __repr__(self):
         return f'<JobResult {self.filename}>'
@@ -1039,20 +1029,23 @@ class Job(HashidMixin, db.Model):
         default=JobStatus.INITIALIZING
     )
     title = db.Column(db.String(32))
-    # Backrefs: user: User
     # Relationships
     inputs = db.relationship(
         'JobInput',
-        backref='job',
+        back_populates='job',
         cascade='all, delete-orphan',
         lazy='dynamic'
     )
     results = db.relationship(
         'JobResult',
-        backref='job',
+        back_populates='job',
         cascade='all, delete-orphan',
         lazy='dynamic'
     )
+    user = db.relationship(
+        'User',
+        back_populates='jobs'
+    )
 
     def __repr__(self):
         return f'<Job {self.title}>'
@@ -1173,7 +1166,11 @@ class CorpusFile(FileMixin, HashidMixin, db.Model):
     pages = db.Column(db.String(255))
     publisher = db.Column(db.String(255))
     school = db.Column(db.String(255))
-    # Backrefs: corpus: Corpus
+    # Relationships
+    corpus = db.relationship(
+        'Corpus',
+        back_populates='files'
+    )
 
     @property
     def download_url(self):
@@ -1262,14 +1259,23 @@ class Corpus(HashidMixin, db.Model):
     num_analysis_sessions = db.Column(db.Integer, default=0)
     num_tokens = db.Column(db.Integer, default=0)
     is_public = db.Column(db.Boolean, default=False)
-    # Backrefs: user: User
     # Relationships
     files = db.relationship(
         'CorpusFile',
-        backref='corpus',
+        back_populates='corpus',
         lazy='dynamic',
         cascade='all, delete-orphan'
     )
+    following_user_associations = db.relationship(
+        'CorpusFollowerAssociation',
+        back_populates='followed_corpus'
+    )
+    following_users = association_proxy(
+        'following_user_associations',
+        'following_user',
+        creator=lambda u: CorpusFollowerAssociation(following_user=u)
+    )
+    user = db.relationship('User', back_populates='corpora')
     # "static" attributes
     max_num_tokens = 2_147_483_647