This commit includes the changes to models, forms, and admin interface in order to move whitelisting from the Project model into the UserProfile model.

Author: wapcaplet

core/models.py

@@ -4,7 +4,7 @@
 class UserProfile (models.Model):
     """Additional information about a User.
     """
-    user = models.ForeignKey(User, unique=True)
+    user = models.ForeignKey(User, unique=True, related_name='profile')
     whitelisted = models.BooleanField()
     homepage = models.CharField(max_length=100)
 

projects/admin.py

@@ -5,9 +5,9 @@
 
 class ProjectAdmin(admin.ModelAdmin):
     prepopulated_fields = {'slug': ('name',)}
-    list_display = ('name', 'repo', 'repo_type', 'theme', 'status', 'whitelisted')
+    list_display = ('name', 'repo', 'repo_type', 'theme', 'status')
     search_fields = ('name', 'repo')
-    list_filter = ('repo_type', 'whitelisted', 'status')
+    list_filter = ('repo_type', 'status')
 
 
 class FileAdmin(admin.ModelAdmin):

projects/forms.py

@@ -16,22 +16,22 @@ def clean_name(self):
             potential_slug = slugify(name)
             if Project.objects.filter(slug=potential_slug).count():
                 raise forms.ValidationError('A project with that name exists already!')
-        
+
         return name
 
 
 class CreateProjectForm(ProjectForm):
     class Meta:
         model = Project
-        exclude = ('skip', 'whitelisted', 'user', 'slug', 'repo',
+        exclude = ('skip', 'user', 'slug', 'repo',
                    'docs_directory', 'status', 'repo_type')
 
     def save(self, *args, **kwargs):
         created = self.instance.pk is None
-        
+
         # save the project
         project = super(CreateProjectForm, self).save(*args, **kwargs)
-        
+
         if created:
             # create a couple sample files
             for i, (sample_file, template) in enumerate(constants.SAMPLE_FILES):
@@ -42,10 +42,10 @@ def save(self, *args, **kwargs):
                     ordering=i+1,
                 )
                 file.create_revision(old_content='', comment='')
-        
+
         # kick off the celery job
         update_docs.delay(pk=project.pk)
-        
+
         return project
 
 
@@ -54,8 +54,8 @@ class ImportProjectForm(ProjectForm):
         help_text='URL for your code (hg or git). Ex. http://github.com/ericholscher/django-kong.git')
     class Meta:
         model = Project
-        exclude = ('skip', 'whitelisted', 'theme', 'docs_directory', 'user', 'slug', 'version', 'copyright', 'status')
-    
+        exclude = ('skip', 'theme', 'docs_directory', 'user', 'slug', 'version', 'copyright', 'status')
+
     def clean_repo(self):
         repo = self.cleaned_data.get('repo', '').strip()
         if '&&' in repo or '|' in repo:
@@ -70,15 +70,15 @@ def save(self, *args, **kwargs):
 
         # kick off the celery job
         update_docs.delay(pk=project.pk)
-        
+
         return project
 
 
 class FileForm(forms.ModelForm):
     content = forms.CharField(widget=forms.Textarea(attrs={'class': 'editor'}),
         help_text='<small><a href="http://sphinx.pocoo.org/rest.html">reStructuredText Primer</a></small>')
     revision_comment = forms.CharField(max_length=255, required=False)
-    
+
     class Meta:
         model = File
         exclude = ('project', 'slug', 'status')
@@ -89,28 +89,28 @@ def __init__(self, instance=None, *args, **kwargs):
             file_qs = file_qs.exclude(pk=instance.pk)
         self.base_fields['parent'].queryset = file_qs
         super(FileForm, self).__init__(instance=instance, *args, **kwargs)
-    
+
     def save(self, *args, **kwargs):
         # grab the old content before saving
         old_content = self.initial.get('content', '')
-        
+
         # save the file object
         file_obj = super(FileForm, self).save(*args, **kwargs)
-        
+
         # create a new revision from the old content -> new
         file_obj.create_revision(
             old_content,
             self.cleaned_data.get('revision_comment', '')
         )
 
         update_docs.delay(file_obj.project.pk)
-        
+
         return file_obj
 
 
 class FileRevisionForm(forms.Form):
     revision = forms.ModelChoiceField(queryset=None)
-    
+
     def __init__(self, file, *args, **kwargs):
         revision_qs = file.revisions.exclude(pk=file.current_revision.pk)
         self.base_fields['revision'].queryset = revision_qs

projects/models.py

@@ -47,7 +47,6 @@ class Project(models.Model):
     extensions = models.CharField(max_length=255, editable=False, default='')
     status = models.PositiveSmallIntegerField(choices=constants.STATUS_CHOICES,
         default=constants.LIVE_STATUS)
-    whitelisted = models.BooleanField()
     skip = models.BooleanField()
 
     tags = TaggableManager()
@@ -165,7 +164,7 @@ def get_rendered_conf(self):
 
     def write_to_disk(self):
         safe_write(self.conf_filename, self.get_rendered_conf())
-    
+
     def get_latest_build(self):
         try:
             return self.builds.all()[0]

projects/tasks.py

@@ -172,7 +172,7 @@ def build_docs(project):
     """
     A helper function for the celery task to do the actual doc building.
     """
-    if project.whitelisted:
+    if project.user.get_profile().whitelisted:
         sanitize_conf(project.conf_filename)
     else:
         project.write_to_disk()

projects/utils.py

@@ -67,8 +67,8 @@ def safe_write(filename, contents):
     fh.close()
 
 def sanitize_conf(conf_filename):
-    """Modify the given ``conf.py`` file from a whitelisted project. For now,
-    this just adds the RTD template directory to ``templates_path``.
+    """Modify the given ``conf.py`` file from a whitelisted user's project.
+    For now, this just adds the RTD template directory to ``templates_path``.
     """
     # The template directory for RTD
     template_dir = '%s/templates/sphinx' % settings.SITE_ROOT