Address review feedback

Author: ericholscher

readthedocs/projects/tasks.py

@@ -60,7 +60,7 @@
 )
 from readthedocs.doc_builder.loader import get_builder_class
 from readthedocs.doc_builder.python_environments import Conda, Virtualenv
-from readthedocs.domaindata.models import DomainData
+from readthedocs.sphinx_domains.models import SphinxDomain
 from readthedocs.projects.models import APIProject
 from readthedocs.restapi.client import api as api_v2
 from readthedocs.vcs_support import utils as vcs_support_utils
@@ -1160,7 +1160,8 @@ def _update_intersphinx_data(version, path, commit):
     """
     object_file = os.path.join(path, 'objects.inv')
 
-    # These classes are from copied from Sphinx tests
+    # These classes are from copied from Sphinx
+    # https://git.io/fhFbI
     class MockConfig:
         intersphinx_timeout = None
         tls_verify = False
@@ -1173,16 +1174,18 @@ def warn(self, msg):
             log.warning('Sphinx MockApp: %s', msg)
 
     invdata = intersphinx.fetch_inventory(MockApp(), '', object_file)
-    for key in sorted(invdata or {}):
+    for key, value in sorted(invdata.items() or {}):
         domain, _type = key.split(':')
-        for name, einfo in sorted(invdata[key].items()):
+        for name, einfo in sorted(value.items()):
+            # project, version, url, display_name
+            # ('Sphinx', '1.7.9', 'faq.html#epub-faq', 'Epub info')
             url = einfo[2]
             if '#' in url:
                 doc_name, anchor = url.split('#')
             else:
                 doc_name, anchor = url, ''
             display_name = einfo[3]
-            obj, _ = DomainData.objects.get_or_create(
+            obj, _ = SphinxDomain.objects.get_or_create(
                 project=version.project,
                 version=version,
                 domain=domain,
@@ -1195,9 +1198,9 @@ def warn(self, msg):
             if obj.commit != commit:
                 obj.commit = commit
                 obj.save()
-    DomainData.objects.filter(project=version.project,
-                              version=version
-                              ).exclude(commit=commit).delete()
+    SphinxDomain.objects.filter(project=version.project,
+                                version=version
+                                ).exclude(commit=commit).delete()
 
 
 def _manage_imported_files(version, path, commit):

readthedocs/restapi/urls.py

@@ -25,7 +25,7 @@
     SocialAccountViewSet,
     VersionViewSet,
 )
-from readthedocs.domaindata.api import DomainDataAPIView
+from readthedocs.sphinx_domains.api import SphinxDomainAPIView
 
 
 router = routers.DefaultRouter()
@@ -35,7 +35,7 @@
 router.register(r'project', ProjectViewSet, basename='project')
 router.register(r'notification', NotificationViewSet, basename='emailhook')
 router.register(r'domain', DomainViewSet, basename='domain')
-router.register(r'domaindata', DomainDataAPIView, base_name='domaindata')
+router.register(r'sphinx_domains', SphinxDomainAPIView, base_name='sphinx_domains')
 router.register(
     r'remote/org',
     RemoteOrganizationViewSet,

readthedocs/rtd_tests/tests/test_privacy_urls.py

@@ -364,7 +364,7 @@ def setUp(self):
             'api_webhook_gitlab': {'status_code': 405},
             'api_webhook_bitbucket': {'status_code': 405},
             'api_webhook_generic': {'status_code': 403},
-            'domaindata-detail': {'status_code': 404},
+            'sphinx_domains-detail': {'status_code': 404},
             'remoteorganization-detail': {'status_code': 404},
             'remoterepository-detail': {'status_code': 404},
             'remoteaccount-detail': {'status_code': 404},

readthedocs/settings/base.py

@@ -103,7 +103,7 @@ def INSTALLED_APPS(self):  # noqa
             'readthedocs.notifications',
             'readthedocs.integrations',
             'readthedocs.analytics',
-            'readthedocs.domaindata',
+            'readthedocs.sphinx_domains',
             'readthedocs.search',
 
 

readthedocs/domaindata/__init__.py renamed to readthedocs/sphinx_domains/__init__.py

@@ -1,13 +1,13 @@
 """Domain Admin classes."""
 from django.contrib import admin
 
-from .models import DomainData
+from .models import SphinxDomain
 
 
-class DomainDataAdmin(admin.ModelAdmin):
+class SphinxDomainAdmin(admin.ModelAdmin):
     list_filter = ('type', 'project')
     raw_id_fields = ('project', 'version')
     search_fields = ('doc_name', 'name')
 
 
-admin.site.register(DomainData, DomainDataAdmin)
+admin.site.register(SphinxDomain, SphinxDomainAdmin)

readthedocs/domaindata/admin.py renamed to readthedocs/sphinx_domains/admin.py

@@ -4,35 +4,35 @@
 
 from readthedocs.restapi.views.model_views import UserSelectViewSet
 
-from .models import DomainData
+from .models import SphinxDomain
 
 
-class DomainDataSerializer(serializers.ModelSerializer):
+class SphinxDomainSerializer(serializers.ModelSerializer):
     project = serializers.SlugRelatedField(slug_field='slug', read_only=True)
     version = serializers.SlugRelatedField(slug_field='slug', read_only=True)
 
     class Meta:
-        model = DomainData
+        model = SphinxDomain
         fields = (
             'project',
             'version',
             'name',
             'display_name',
-            'doc_type',
-            'doc_url',
+            'role_name',
+            'docs_url',
         )
 
 
-class DomainDataAdminSerializer(DomainDataSerializer):
+class SphinxDomainAdminSerializer(SphinxDomainSerializer):
 
-    class Meta(DomainDataSerializer.Meta):
+    class Meta(SphinxDomainSerializer.Meta):
         fields = '__all__'
 
 
-class DomainDataAPIView(UserSelectViewSet):  # pylint: disable=too-many-ancestors
-    model = DomainData
-    serializer_class = DomainDataSerializer
-    admin_serializer_class = DomainDataAdminSerializer
+class SphinxDomainAPIView(UserSelectViewSet):  # pylint: disable=too-many-ancestors
+    model = SphinxDomain
+    serializer_class = SphinxDomainSerializer
+    admin_serializer_class = SphinxDomainAdminSerializer
     filter_fields = (
         'project__slug',
         'version__slug',

readthedocs/domaindata/api.py renamed to readthedocs/sphinx_domains/api.py

@@ -15,7 +15,7 @@
 from readthedocs.projects.querysets import RelatedProjectQuerySet
 
 
-class DomainData(TimeStampedModel):
+class SphinxDomain(TimeStampedModel):
 
     """
     Information from a project about it's Sphinx domains.
@@ -25,14 +25,14 @@ class DomainData(TimeStampedModel):
 
     project = models.ForeignKey(
         Project,
-        related_name='domain_data',
+        related_name='sphinx_domains',
     )
     version = models.ForeignKey(
         Version,
         verbose_name=_('Version'),
-        related_name='domain_data',
+        related_name='sphinx_domains',
     )
-    commit = models.CharField(_('Commit'), max_length=255)
+    commit = models.CharField(_('Commit'), max_length=255, null=True)
 
     domain = models.CharField(
         _('Domain'),
@@ -62,16 +62,17 @@ class DomainData(TimeStampedModel):
 
     def __str__(self):
         return f'''
-            DomainData [{self.project.slug}:{self.version.slug}]
-            [{self.domain}:{self.type}] {self.name} -> {self.doc_name}#{self.anchor}
+            SphinxDomain [{self.project.slug}:{self.version.slug}]
+            [{self.domain}:{self.type}] {self.name} ->
+            {self.doc_name}#{self.anchor}
         '''
 
     @property
-    def doc_type(self):
+    def role_name(self):
         return f'{self.domain}:{self.type}'
 
     @property
-    def doc_url(self):
+    def docs_url(self):
         path = self.doc_name
         if self.anchor:
             path += f'#{self.anchor}'