Using STABLE constant instead of string 'stable' where applicable.

Author: gregmuellegger

readthedocs/builds/constants.py

@@ -24,3 +24,6 @@
     ('tag', _('Tag')),
     ('unknown', _('Unknown')),
 )
+
+STABLE = 'stable'
+STABLE_VERBOSE_NAME = 'stable'

readthedocs/projects/models.py

@@ -292,8 +292,8 @@ def save(self, *args, **kwargs):
             if not self.versions.filter(slug='latest').exists():
                 self.versions.create(
                     slug='latest', verbose_name='latest', machine=True, type='branch', active=True, identifier=branch)
-            # if not self.versions.filter(slug='stable').exists():
-            #     self.versions.create(slug='stable', verbose_name='stable', type='branch', active=True, identifier=branch)
+            # if not self.versions.filter(slug=STABLE).exists():
+            #     self.versions.create_stable(type='branch', identifier=branch)
         except Exception:
             log.error('Error creating default branches', exc_info=True)
 

readthedocs/projects/tasks.py

@@ -25,6 +25,7 @@
 from projects.models import ImportedFile, Project
 from projects.utils import run, make_api_version, make_api_project
 from projects.constants import LOG_TEMPLATE
+from builds.constants import STABLE
 from projects import symlinks
 from privacy.loader import Syncer
 from tastyapi import api, apiv2
@@ -650,7 +651,7 @@ def finish_build(version_pk, build_pk, hostname=None, html=False,
     update_static_metadata.delay(version.project.pk)
     fileify.delay(version.pk, commit=build.commit)
     update_search.delay(version.pk, commit=build.commit)
-    if not html and version.slug != 'stable' and build.exit_code != 423:
+    if not html and version.slug != STABLE and build.exit_code != 423:
         send_notifications.delay(version.pk, build_pk=build.pk)
 
 

readthedocs/projects/templatetags/projects_tags.py

@@ -2,6 +2,7 @@
 
 from distutils2.version import NormalizedVersion
 from projects.utils import mkversion
+from builds.constants import STABLE
 
 register = template.Library()
 
@@ -11,7 +12,7 @@ def make_version(version):
     if not ver:
         if version.slug == 'latest':
             return NormalizedVersion('99999.0', error_on_huge_major_num=False)
-        elif version.slug == 'stable':
+        elif version.slug == STABLE:
             return NormalizedVersion('9999.0', error_on_huge_major_num=False)
         else:
             return NormalizedVersion('999.0', error_on_huge_major_num=False)

readthedocs/restapi/views/model_views.py

@@ -11,6 +11,7 @@
 from builds.models import Build, Version
 from core.utils import trigger_build
 from oauth import utils as oauth_utils
+from builds.constants import STABLE
 from projects.filters import ProjectFilter
 from projects.models import Project, EmailHook
 from restapi.permissions import APIPermission
@@ -111,7 +112,7 @@ def sync_versions(self, request, **kwargs):
                 new_stable = project.versions.get(verbose_name=new_stable_slug)
 
                 # Update stable version
-                stable = project.versions.filter(slug='stable').first()
+                stable = project.versions.filter(slug=STABLE).first()
                 if stable:
                     if (new_stable.identifier != stable.identifier) and (stable.machine is True):
                         stable.identifier = new_stable.identifier
@@ -120,7 +121,7 @@ def sync_versions(self, request, **kwargs):
                         trigger_build(project=project, version=stable)
                 else:
                     log.info("Creating new stable version: {project}:{version}".format(project=project.slug, version=new_stable.identifier))
-                    version = project.versions.create(slug='stable', verbose_name='stable', machine=True, type=new_stable.type, active=True, identifier=new_stable.identifier)
+                    version = project.versions.create(slug=STABLE, verbose_name=STABLE_VERBOSE_NAME, machine=True, type=new_stable.type, active=True, identifier=new_stable.identifier)
                     trigger_build(project=project, version=version)
 
                 # Build new tag if enabled

readthedocs/rtd_tests/tests/test_sync_versions.py

@@ -3,6 +3,7 @@
 from django.test import TestCase
 
 from builds.models import Version
+from builds.constants import STABLE
 from projects.models import Project
 
 
@@ -69,14 +70,14 @@ def test_stable_versions(self):
         self.assertRaises(
             Version.DoesNotExist,
             Version.objects.get,
-            slug='stable'
+            slug=STABLE
         )
         self.client.post(
             '/api/v2/project/%s/sync_versions/' % self.pip.pk,
             data=json.dumps(version_post_data),
             content_type='application/json',
         )
-        version_stable = Version.objects.get(slug='stable')
+        version_stable = Version.objects.get(slug=STABLE)
         self.assertTrue(version_stable.active)
         self.assertEqual(version_stable.identifier, '0.9')