Cleanup blogs app (#1336)

* Add initial_data() factory
* Fix DoesNotExist when there is no Feed in update_blog_supernav()
* Remove unused Contributor and Translation models
* Do not trust the HTML in the entry.summary field
* Use update_or_create() when updating Blog entries

Author: jaap3

blogs/admin.py

@@ -1,29 +1,7 @@
 from django.contrib import admin
 from django.core.management import call_command
-from django.utils.html import format_html
 
-from cms.admin import ContentManageableModelAdmin
-
-from .models import BlogEntry, Contributor, Translation, Feed, FeedAggregate
-
-
-@admin.register(Translation)
-class TranslationAdmin(ContentManageableModelAdmin):
-    list_display = ['name', '_display_url']
-
-    def _display_url(self, obj):
-        return format_html('<a href="{0}">{0}</a>'.format(obj.url))
-
-
-@admin.register(Contributor)
-class ContributorAdmin(ContentManageableModelAdmin):
-    list_display = ['_display_name']
-
-    def _display_name(self, obj):
-        if obj.user.first_name or obj.user.last_name:
-            return "{} {}".format(obj.user.first_name, obj.user.last_name)
-        else:
-            return "{} (PK#{})".format(obj.user.username, obj.user.pk)
+from .models import BlogEntry, Feed, FeedAggregate
 
 
 @admin.register(BlogEntry)

blogs/factories.py

@@ -0,0 +1,17 @@
+from django.conf import settings
+
+from .models import Feed
+
+
+def initial_data():
+    feed, _ = Feed.objects.get_or_create(
+        id=1,
+        defaults={
+            'name': 'Python Insider',
+            'website_url': settings.PYTHON_BLOG_URL,
+            'feed_url': settings.PYTHON_BLOG_FEED_URL,
+        }
+    )
+    return {
+        'feeds': [feed],
+    }

blogs/management/commands/update_blogs.py

@@ -13,24 +13,10 @@ def handle(self, **options):
             entries = get_all_entries(feed.feed_url)
 
             for entry in entries:
-                try:
-                    e = BlogEntry.objects.get(url=entry['url'])
-
-                    # Update our info if it's changed
-                    if e.pub_date < entry['pub_date']:
-                        e.title = entry['title']
-                        e.summary = entry['summary']
-                        e.pub_date = entry['pub_date']
-                        e.save()
-
-                except BlogEntry.DoesNotExist:
-                    BlogEntry.objects.create(
-                        title=entry['title'],
-                        summary=entry['summary'],
-                        pub_date=entry['pub_date'],
-                        url=entry['url'],
-                        feed=feed,
-                    )
+                url = entry.pop('url')
+                BlogEntry.objects.update_or_create(
+                    feed=feed, url=url, defaults=entry,
+                )
 
             feed.last_import = now()
             feed.save()

blogs/migrations/0002_remove_translations_and_contributors.py

@@ -0,0 +1,39 @@
+# Generated by Django 2.0.6 on 2018-09-25 09:07
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('blogs', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='contributor',
+            name='creator',
+        ),
+        migrations.RemoveField(
+            model_name='contributor',
+            name='last_modified_by',
+        ),
+        migrations.RemoveField(
+            model_name='contributor',
+            name='user',
+        ),
+        migrations.RemoveField(
+            model_name='translation',
+            name='creator',
+        ),
+        migrations.RemoveField(
+            model_name='translation',
+            name='last_modified_by',
+        ),
+        migrations.DeleteModel(
+            name='Contributor',
+        ),
+        migrations.DeleteModel(
+            name='Translation',
+        ),
+    ]

blogs/models.py

@@ -1,7 +1,6 @@
 import feedparser
 
 from django.db import models
-from django.conf import settings
 
 from cms.models import ContentManageable
 
@@ -42,6 +41,7 @@ class Feed(models.Model):
     def __str__(self):
         return self.name
 
+
 class FeedAggregate(models.Model):
     """
     An aggregate of RSS feeds.
@@ -57,48 +57,6 @@ class FeedAggregate(models.Model):
     def __str__(self):
         return self.name
 
-class Translation(ContentManageable):
-    """ Model to store blog translation links """
-    name = models.CharField(max_length=100)
-    url = models.URLField('URL')
-
-    class Meta:
-        verbose_name = 'Translation'
-        verbose_name_plural = 'Translations'
-        ordering = ('name', )
-
-    def __str__(self):
-        return self.name
-
-    def get_absolute_url(self):
-        return self.url
-
-
-class Contributor(ContentManageable):
-    """ Blog Contributors """
-    user = models.ForeignKey(
-        settings.AUTH_USER_MODEL,
-        related_name='blog_contributor',
-        on_delete=models.CASCADE,
-    )
-
-    class Meta:
-        verbose_name = 'Contributor'
-        verbose_name_plural = 'Contributors'
-        ordering = ('user__last_name', 'user__first_name')
-
-    def __str__(self):
-        return self.user.get_full_name()
-
-    def get_absolute_url(self):
-        return self.user.get_absolute_url()
-
-    def get_display_name(self):
-        if self.user.first_name or self.user.last_name:
-            return """{} {}""".format(self.user.first_name, self.user.last_name)
-        else:
-            return self.user.username
-
 
 class RelatedBlog(ContentManageable):
     name = models.CharField(max_length=100, help_text="Internal Name")

blogs/parser.py

@@ -1,11 +1,12 @@
 import datetime
 import feedparser
 
+from django.conf import settings
 from django.template.loader import render_to_string
 from django.utils.timezone import make_aware, utc
 
 from boxes.models import Box
-from .models import BlogEntry
+from .models import BlogEntry, Feed
 
 
 def get_all_entries(feed_url):
@@ -37,13 +38,20 @@ def _render_blog_supernav(entry):
 
 def update_blog_supernav():
     """Retrieve latest entry and update blog supernav item """
-    latest_entry = BlogEntry.objects.filter(feed_id=1).latest()
-    rendered_box = _render_blog_supernav(latest_entry)
-
-    box, _ = Box.objects.update_or_create(
-        label='supernav-python-blog',
-        defaults={
-            'content': rendered_box,
-            'content_markup_type': 'html',
-        }
-    )
+    try:
+        latest_entry = BlogEntry.objects.filter(
+            feed=Feed.objects.get(
+                feed_url=settings.PYTHON_BLOG_FEED_URL,
+            )
+        ).latest()
+    except (BlogEntry.DoesNotExist, Feed.DoesNotExist):
+        pass
+    else:
+        rendered_box = _render_blog_supernav(latest_entry)
+        box, _ = Box.objects.update_or_create(
+            label='supernav-python-blog',
+            defaults={
+                'content': rendered_box,
+                'content_markup_type': 'html',
+            }
+        )

blogs/tests/test_models.py

@@ -1,19 +1,11 @@
 from django.test import TestCase
 from django.utils import timezone
 
-from ..models import Translation, BlogEntry, Feed
+from ..models import BlogEntry, Feed
 
 
 class BlogModelTest(TestCase):
 
-    def test_translation(self):
-        t = Translation.objects.create(
-            name='Swiss',
-            url='http://python.ch',
-        )
-        self.assertEqual(str(t), 'Swiss')
-        self.assertEqual(t.get_absolute_url(), t.url)
-
     def test_blog_entry(self):
         now = timezone.now()
 

blogs/tests/test_templatetags.py

@@ -3,10 +3,7 @@
 from django.template import Template, Context
 from django.utils.timezone import now
 
-from boxes.models import Box
-
 from ..templatetags.blogs import get_latest_blog_entries
-from ..parser import _render_blog_supernav
 from ..models import BlogEntry, Feed, FeedAggregate
 from .utils import get_test_rss_path
 
@@ -22,9 +19,8 @@ def test_get_latest_entries(self):
         management command
         """
         Feed.objects.create(
-            id=1, name='psf default', website_url='example.org',
+            name='psf default', website_url='https://example.org',
             feed_url=self.test_file_path)
-        entries = None
         call_command('update_blogs')
         entries = get_latest_blog_entries()
 
@@ -33,9 +29,6 @@ def test_get_latest_entries(self):
             entries[0].pub_date.isoformat(),
             '2013-03-04T15:00:00+00:00'
         )
-        b = Box.objects.get(label='supernav-python-blog')
-        rendered_box = _render_blog_supernav(BlogEntry.objects.latest())
-        self.assertEqual(b.content.raw, rendered_box)
 
     def test_feed_list(self):
         f1 = Feed.objects.create(
@@ -61,14 +54,14 @@ def test_feed_list(self):
             summary='',
             pub_date=now(),
             url='path/to/foo',
-            feed=f1
+            feed=f2
         )
         fa = FeedAggregate.objects.create(
             name='test',
             slug='test',
             description='testing',
         )
-        fa.feeds.add(f1,f2)
+        fa.feeds.add(f1, f2)
 
 
         t = Template("""

blogs/views.py

@@ -1,6 +1,6 @@
 from django.views.generic import TemplateView
 
-from .models import BlogEntry, Translation, Contributor
+from .models import BlogEntry
 
 
 class BlogHome(TemplateView):
@@ -21,8 +21,6 @@ def get_context_data(self, **kwargs):
         context.update({
             'latest_entry': latest_entry,
             'entries': other_entries,
-            'translations': Translation.objects.all(),
-            'contributors': Contributor.objects.all(),
         })
 
         return context

pydotorg/settings/base.py

@@ -222,8 +222,8 @@
 HONEYPOT_VALUE = 'write your message'
 
 ### Blog Feed URL
-PYTHON_BLOG_FEED_URL = "http://feeds.feedburner.com/PythonInsider"
-PYTHON_BLOG_URL = "http://blog.python.org"
+PYTHON_BLOG_FEED_URL = "https://feeds.feedburner.com/PythonInsider"
+PYTHON_BLOG_URL = "https://blog.python.org"
 
 ### Registration mailing lists
 MAILING_LIST_PSF_MEMBERS = "[email protected]"