External version name added everywhere

Author: saadmk11

readthedocs/builds/constants.py

@@ -31,15 +31,21 @@
     ('dash', _('Dash')),
 )
 
+# Manager name for Internal Versions or Builds.
+# ie: Versions and Builds Excluding pull request/merge request Versions and Builds.
+INTERNAL = 'internal'
+# Manager name for External Versions or Builds.
+# ie: Only pull request/merge request Versions and Builds.
+EXTERNAL = 'external'
+
 BRANCH = 'branch'
 TAG = 'tag'
-PULL_REQUEST = 'pull_request'
 UNKNOWN = 'unknown'
 
 VERSION_TYPES = (
     (BRANCH, _('Branch')),
     (TAG, _('Tag')),
-    (PULL_REQUEST, _('Pull Request')),
+    (EXTERNAL, _('External')),
     (UNKNOWN, _('Unknown')),
 )
 
@@ -55,10 +61,3 @@
     LATEST,
     STABLE,
 )
-
-# Manager name for Internal Versions or Builds.
-# ie: Versions and Builds Excluding PULL_REQUEST Type.
-INTERNAL = 'internal'
-# Manager name for External Versions or Builds.
-# ie: Only PULL_REQUEST Type Versions and Builds.
-EXTERNAL = 'external'

readthedocs/builds/managers.py

@@ -19,7 +19,7 @@
     STABLE,
     STABLE_VERBOSE_NAME,
     TAG,
-    PULL_REQUEST,
+    EXTERNAL,
 )
 from .querysets import VersionQuerySet
 
@@ -91,24 +91,24 @@ class InternalVersionManagerBase(VersionManagerBase):
     """
     Version manager that only includes internal version.
 
-    It will exclude PULL_REQUEST type from the queries
+    It will exclude pull request/merge request versions from the queries
     and only include BRANCH, TAG, UNKONWN type Versions.
     """
 
     def get_queryset(self):
-        return super().get_queryset().exclude(type=PULL_REQUEST)
+        return super().get_queryset().exclude(type=EXTERNAL)
 
 
 class ExternalVersionManagerBase(VersionManagerBase):
 
     """
     Version manager that only includes external version.
 
-    It will only include PULL_REQUEST type Versions in the queries.
+    It will only include pull request/merge request Versions in the queries.
     """
 
     def get_queryset(self):
-        return super().get_queryset().filter(type=PULL_REQUEST)
+        return super().get_queryset().filter(type=EXTERNAL)
 
 
 class VersionManager(SettingsOverrideObject):

readthedocs/builds/migrations/0008_added_pull_request_version_type.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Generated by Django 1.11.20 on 2019-06-06 16:51
+# Generated by Django 1.11.21 on 2019-06-17 19:26
 from __future__ import unicode_literals
 
 from django.db import migrations, models
@@ -15,11 +15,11 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='version',
             name='type',
-            field=models.CharField(choices=[('branch', 'Branch'), ('tag', 'Tag'), ('pull_request', 'Pull Request'), ('unknown', 'Unknown')], default='unknown', max_length=20, verbose_name='Type'),
+            field=models.CharField(choices=[('branch', 'Branch'), ('tag', 'Tag'), ('external', 'External'), ('unknown', 'Unknown')], default='unknown', max_length=20, verbose_name='Type'),
         ),
         migrations.AlterField(
             model_name='versionautomationrule',
             name='version_type',
-            field=models.CharField(choices=[('branch', 'Branch'), ('tag', 'Tag'), ('pull_request', 'Pull Request'), ('unknown', 'Unknown')], max_length=32, verbose_name='Version type'),
+            field=models.CharField(choices=[('branch', 'Branch'), ('tag', 'Tag'), ('external', 'External'), ('unknown', 'Unknown')], max_length=32, verbose_name='Version type'),
         ),
     ]

readthedocs/builds/models.py

@@ -41,7 +41,7 @@
     INTERNAL,
     LATEST,
     NON_REPOSITORY_VERSIONS,
-    PULL_REQUEST,
+    EXTERNAL,
     STABLE,
     TAG,
     VERSION_TYPES,
@@ -119,7 +119,7 @@ class Version(models.Model):
     objects = VersionManager.from_queryset(VersionQuerySet)()
     # Only include BRANCH, TAG, UNKONWN type Versions.
     internal = InternalVersionManager.from_queryset(VersionQuerySet)()
-    # Only include PULL_REQUEST type Versions.
+    # Only include EXTERNAL type Versions.
     external = ExternalVersionManager.from_queryset(VersionQuerySet)()
 
     class Meta:
@@ -155,7 +155,7 @@ def vcs_url(self):
         Generate VCS (github, gitlab, bitbucket) URL for this version.
 
         Branch/Tag Example: https://github.com/rtfd/readthedocs.org/tree/3.4.2/.
-        Pull Request Example: https://github.com/rtfd/readthedocs.org/pull/9999/.
+        Pull/merge Request Example: https://github.com/rtfd/readthedocs.org/pull/9999/.
         """
         url = ''
         if self.slug == STABLE:
@@ -165,7 +165,7 @@ def vcs_url(self):
         else:
             slug_url = self.slug
 
-        if self.type == PULL_REQUEST:
+        if self.type == EXTERNAL:
             if 'github' in self.project.repo:
                 url = f'/pull/{slug_url}/'
 
@@ -245,14 +245,14 @@ def commit_name(self):
             # the actual tag name.
             return self.verbose_name
 
-        if self.type == PULL_REQUEST:
-            # If this version is a Pull Request, the identifier will
+        if self.type == EXTERNAL:
+            # If this version is a EXTERNAL version, the identifier will
             # contain the actual commit hash. which we can use to
             # generate url for a given file name
             return self.identifier
 
         # If we came that far it's not a special version
-        # nor a branch, tag or Pull Request.
+        # nor a branch, tag or EXTERNAL version.
         # Therefore just return the identifier to make a safe guess.
         log.debug(
             'TODO: Raise an exception here. Testing what cases it happens',

readthedocs/rtd_tests/tests/test_doc_serving.py

@@ -10,7 +10,7 @@
 from django.urls import reverse
 from mock import mock_open, patch
 
-from readthedocs.builds.constants import PULL_REQUEST, INTERNAL
+from readthedocs.builds.constants import LATEST, EXTERNAL, INTERNAL
 from readthedocs.builds.models import Version
 from readthedocs.core.middleware import SubdomainMiddleware
 from readthedocs.core.views import server_error_404_subdomain
@@ -249,15 +249,15 @@ def test_sitemap_xml(self):
             project=self.public,
             active=True
         )
-        # This is a Pull Request Version
+        # This is a EXTERNAL Version
         pr_version = fixture.get(
             Version,
             identifier='pr-version',
             verbose_name='pr-version',
             slug='pr-9999',
             project=self.public,
             active=True,
-            type=PULL_REQUEST
+            type=EXTERNAL
         )
         # This also creates a Version `latest` Automatically for this project
         translation = fixture.get(

readthedocs/rtd_tests/tests/test_managers.py

@@ -2,7 +2,7 @@
 from django.test import TestCase
 from django_dynamic_fixture import get
 
-from readthedocs.builds.constants import PULL_REQUEST, BRANCH, TAG
+from readthedocs.builds.constants import EXTERNAL, BRANCH, TAG
 from readthedocs.builds.models import Version
 from readthedocs.projects.constants import PUBLIC, PRIVATE, PROTECTED
 from readthedocs.projects.models import Project
@@ -19,37 +19,37 @@ def setUp(self):
         self.user = User.objects.create(username='test_user', password='test')
         self.client.login(username='test_user', password='test')
         self.pip = Project.objects.get(slug='pip')
-        # Create a External Version. ie: PULL_REQUEST type Version.
+        # Create a External Version. ie: pull/merge request Version.
         self.public_pr_version = get(
             Version,
             project=self.pip,
             active=True,
-            type=PULL_REQUEST,
+            type=EXTERNAL,
             privacy_level=PUBLIC
         )
         self.private_pr_version = get(
             Version,
             project=self.pip,
             active=True,
-            type=PULL_REQUEST,
+            type=EXTERNAL,
             privacy_level=PRIVATE
         )
         self.protected_pr_version = get(
             Version,
             project=self.pip,
             active=True,
-            type=PULL_REQUEST,
+            type=EXTERNAL,
             privacy_level=PROTECTED
         )
-        self.internal_versions = Version.objects.exclude(type=PULL_REQUEST)
+        self.internal_versions = Version.objects.exclude(type=EXTERNAL)
 
 
 class TestInternalVersionManager(TestVersionManagerBase):
 
     """
     Queries using Internal Manager should only include Internal Versions.
 
-    It will exclude PULL_REQUEST type Versions from the queries
+    It will exclude EXTERNAL type Versions from the queries
     and only include BRANCH, TAG, UNKONWN type Versions.
     """
 
@@ -83,7 +83,7 @@ class TestExternalVersionManager(TestVersionManagerBase):
     """
     Queries using External Manager should only include External Versions.
 
-    It will only include PULL_REQUEST type Versions in the queries.
+    It will only include pull/merge request Version in the queries.
     """
 
     def test_external_version_manager_with_all(self):

readthedocs/rtd_tests/tests/test_project.py

@@ -14,7 +14,7 @@
     BUILD_STATE_FINISHED,
     BUILD_STATE_TRIGGERED,
     LATEST,
-    PULL_REQUEST,
+    EXTERNAL,
 )
 from readthedocs.builds.models import Build, Version
 from readthedocs.projects.exceptions import ProjectConfigurationError
@@ -30,15 +30,15 @@ class ProjectMixin:
     def setUp(self):
         self.client.login(username='eric', password='test')
         self.pip = Project.objects.get(slug='pip')
-        # Create a External Version. ie: PULL_REQUEST type Version.
+        # Create a External Version. ie: pull/merge request Version.
         self.pr_version = get(
             Version,
             identifier='pr-version',
             verbose_name='pr-version',
             slug='pr-9999',
             project=self.pip,
             active=True,
-            type=PULL_REQUEST
+            type=EXTERNAL
         )
 
 
@@ -156,7 +156,7 @@ def test_all_active_versions_excludes_pr_versions(self):
 
     def test_update_stable_version_excludes_pr_versions(self):
         # Delete all versions excluding PR Versions.
-        self.pip.versions.exclude(type=PULL_REQUEST).delete()
+        self.pip.versions.exclude(type=EXTERNAL).delete()
         # Test that PR Version is not considered for stable.
         self.assertEqual(self.pip.update_stable_version(), None)
 

readthedocs/rtd_tests/tests/test_project_forms.py

@@ -5,7 +5,7 @@
 from django_dynamic_fixture import get
 from textclassifier.validators import ClassifierValidator
 
-from readthedocs.builds.constants import LATEST, STABLE, PULL_REQUEST
+from readthedocs.builds.constants import LATEST, STABLE, EXTERNAL
 from readthedocs.builds.models import Version
 from readthedocs.projects.constants import (
     PRIVATE,
@@ -391,7 +391,7 @@ def test_pr_version_not_in_default_branch_choices(self):
             slug='pr-9999',
             project=self.project,
             active=True,
-            type=PULL_REQUEST,
+            type=EXTERNAL,
             privacy_level=PUBLIC,
         )
         form = ProjectAdvancedForm(instance=self.project)

readthedocs/rtd_tests/tests/test_project_views.py

@@ -12,7 +12,7 @@
 from django_dynamic_fixture import get, new
 from mock import patch
 
-from readthedocs.builds.constants import LATEST, PULL_REQUEST
+from readthedocs.builds.constants import LATEST, EXTERNAL
 from readthedocs.builds.models import Build, Version
 from readthedocs.oauth.models import RemoteRepository
 from readthedocs.projects import tasks
@@ -377,7 +377,7 @@ def setUp(self):
             slug='pr-9999',
             project=self.pip,
             active=True,
-            type=PULL_REQUEST
+            type=EXTERNAL
         )
 
     def test_project_download_media(self):

readthedocs/rtd_tests/tests/test_version.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 from django_dynamic_fixture import get
 
-from readthedocs.builds.constants import PULL_REQUEST, BRANCH, TAG
+from readthedocs.builds.constants import EXTERNAL, BRANCH, TAG
 from readthedocs.builds.models import Version
 from readthedocs.projects.models import Project
 
@@ -13,15 +13,15 @@ class VersionMixin:
     def setUp(self):
         self.client.login(username='eric', password='test')
         self.pip = Project.objects.get(slug='pip')
-        # Create a External Version. ie: PULL_REQUEST type Version.
+        # Create a External Version. ie: pull/merge request Version.
         self.pr_version = get(
             Version,
             identifier='9F86D081884C7D659A2FEAA0C55AD015A',
             verbose_name='pr-version',
             slug='9999',
             project=self.pip,
             active=True,
-            type=PULL_REQUEST
+            type=EXTERNAL
         )
         self.branch_version = get(
             Version,