Remove project's description field

docs/api/v2.rst

@@ -93,7 +93,7 @@ Project details
             "default_branch": "master",
             "repo_type": "git",
             "repo": "https://github.com/pypa/pip",
-            "description": "Pip Installs Packages.",
+            "description": "",
             "language": "en",
             "documentation_type": "sphinx_htmldir",
             "canonical_url": "http://pip.pypa.io/en/stable/",
@@ -109,7 +109,7 @@ Project details
     :>json string default_branch: The default version control branch
     :>json string repo_type: Version control repository of the project
     :>json string repo: The repository URL for the project
-    :>json string description: An RST description of the project
+    :>json string description: An empty string. This will be removed in future.
     :>json string language: The language code of this project
     :>json string documentation_type: An RST description of the project
     :>json string canonical_url: The canonical URL of the default docs

readthedocs/projects/forms.py

@@ -12,15 +12,13 @@
 from django.utils.safestring import mark_safe
 from django.utils.translation import ugettext_lazy as _
 from guardian.shortcuts import assign
-from textclassifier.validators import ClassifierValidator
 
 from readthedocs.builds.constants import TAG
 from readthedocs.core.utils import slugify, trigger_build
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.integrations.models import Integration
 from readthedocs.oauth.models import RemoteRepository
 from readthedocs.projects import constants
-from readthedocs.projects.exceptions import ProjectSpamError
 from readthedocs.projects.models import (
     Domain,
     EmailHook,
@@ -165,20 +163,13 @@ class ProjectExtraForm(ProjectForm):
     class Meta:
         model = Project
         fields = (
-            'description',
             'documentation_type',
             'language',
             'programming_language',
             'tags',
             'project_url',
         )
 
-    description = forms.CharField(
-        validators=[ClassifierValidator(raises=ProjectSpamError)],
-        required=False,
-        widget=forms.Textarea,
-    )
-
     def clean_tags(self):
         tags = self.cleaned_data.get('tags', [])
         for tag in tags:
@@ -299,7 +290,6 @@ class Meta:
             'repo',
             'repo_type',
             # Extra
-            'description',
             'language',
             'programming_language',
             'project_url',

readthedocs/projects/views/private.py

@@ -448,8 +448,7 @@ def post(self, request, *args, **kwargs):
         for key in ['name', 'repo', 'repo_type', 'remote_repository']:
             initial_data['basics'][key] = request.POST.get(key)
         initial_data['extra'] = {}
-        for key in ['description', 'project_url']:
-            initial_data['extra'][key] = request.POST.get(key)
+        initial_data['extra']['project_url'] = request.POST.get(key)
         request.method = 'GET'
         return self.wizard_class.as_view(initial_dict=initial_data)(request)
 

readthedocs/restapi/serializers.py

@@ -12,6 +12,15 @@
 
 class ProjectSerializer(serializers.ModelSerializer):
     canonical_url = serializers.ReadOnlyField(source='get_docs_url')
+    description = serializers.SerializerMethodField()
+
+    def get_description(self, obj):
+        """
+        Forcing the description field to be an empty string.
+
+        See https://github.com/rtfd/readthedocs.org/issues/3689.
+        """
+        return ''
 
     class Meta:
         model = Project

readthedocs/rtd_tests/tests/test_project_forms.py

@@ -3,7 +3,6 @@
 from django.test import TestCase
 from django.test.utils import override_settings
 from django_dynamic_fixture import get
-from textclassifier.validators import ClassifierValidator
 
 from readthedocs.builds.constants import LATEST
 from readthedocs.builds.models import Version
@@ -14,7 +13,6 @@
     REPO_TYPE_GIT,
     REPO_TYPE_HG,
 )
-from readthedocs.projects.exceptions import ProjectSpamError
 from readthedocs.projects.forms import (
     EnvironmentVariableForm,
     ProjectAdvancedForm,
@@ -30,20 +28,6 @@
 
 class TestProjectForms(TestCase):
 
-    @mock.patch.object(ClassifierValidator, '__call__')
-    def test_form_spam(self, mocked_validator):
-        """Form description field fails spam validation."""
-        mocked_validator.side_effect = ProjectSpamError
-
-        data = {
-            'description': 'foo',
-            'documentation_type': 'sphinx',
-            'language': 'en',
-        }
-        form = ProjectExtraForm(data)
-        with self.assertRaises(ProjectSpamError):
-            form.is_valid()
-
     def test_import_repo_url(self):
         """Validate different type of repository URLs on importing a Project."""
 

readthedocs/rtd_tests/tests/test_project_views.py

@@ -42,7 +42,6 @@ def setUp(self):
                 'repo_type': 'git',
             },
             'extra': {
-                'description': 'Describe foobar',
                 'language': 'en',
                 'documentation_type': 'sphinx',
             },
@@ -151,7 +150,6 @@ def setUp(self):
         super().setUp()
         self.step_data['basics']['advanced'] = True
         self.step_data['extra'] = {
-            'description': 'Describe foobar',
             'language': 'en',
             'documentation_type': 'sphinx',
             'tags': 'foo, bar, baz',
@@ -205,54 +203,6 @@ def test_remote_repository_is_added(self):
         self.assertIsNotNone(proj)
         self.assertEqual(proj.remote_repository, remote_repo)
 
-    @patch(
-        'readthedocs.projects.views.private.ProjectExtraForm.clean_description',
-        create=True,
-    )
-    def test_form_spam(self, mocked_validator):
-        """Don't add project on a spammy description."""
-        self.user.date_joined = timezone.now() - timedelta(days=365)
-        self.user.save()
-        mocked_validator.side_effect = ProjectSpamError
-
-        with self.assertRaises(Project.DoesNotExist):
-            proj = Project.objects.get(name='foobar')
-
-        resp = self.post_step('basics')
-        self.assertWizardResponse(resp, 'extra')
-        resp = self.post_step('extra', session=list(resp._request.session.items()))
-        self.assertIsInstance(resp, HttpResponseRedirect)
-        self.assertEqual(resp.status_code, 302)
-        self.assertEqual(resp['location'], '/')
-
-        with self.assertRaises(Project.DoesNotExist):
-            proj = Project.objects.get(name='foobar')
-        self.assertFalse(self.user.profile.banned)
-
-    @patch(
-        'readthedocs.projects.views.private.ProjectExtraForm.clean_description',
-        create=True,
-    )
-    def test_form_spam_ban_user(self, mocked_validator):
-        """Don't add spam and ban new user."""
-        self.user.date_joined = timezone.now()
-        self.user.save()
-        mocked_validator.side_effect = ProjectSpamError
-
-        with self.assertRaises(Project.DoesNotExist):
-            proj = Project.objects.get(name='foobar')
-
-        resp = self.post_step('basics')
-        self.assertWizardResponse(resp, 'extra')
-        resp = self.post_step('extra', session=list(resp._request.session.items()))
-        self.assertIsInstance(resp, HttpResponseRedirect)
-        self.assertEqual(resp.status_code, 302)
-        self.assertEqual(resp['location'], '/')
-
-        with self.assertRaises(Project.DoesNotExist):
-            proj = Project.objects.get(name='foobar')
-        self.assertTrue(self.user.profile.banned)
-
 
 class TestImportDemoView(MockBuildTestCase):
     """Test project import demo view."""

readthedocs/settings/base.py

@@ -81,7 +81,6 @@ def INSTALLED_APPS(self):  # noqa
             'django_gravatar',
             'rest_framework',
             'corsheaders',
-            'textclassifier',
             'annoying',
             'django_extensions',
             'crispy_forms',

readthedocs/templates/core/project_details.html

@@ -75,15 +75,6 @@ <h3>{% trans "Build a version" %}</h3>
 {% endif %}
 {% endblock %}
 
-{% if project.description %}
-<div id="project_description">
-  <h3>{% trans "Description" %}</h3>
-  <p>
-    {{ project.description|restructuredtext }}
-  </p>
-</div>
-{% endif %}
-
 </div>{# END .module #}
 
 <div class="project_details">

requirements/pip.txt

@@ -81,7 +81,6 @@ django-crispy-forms==1.7.2
 # https://github.com/rtfd/readthedocs.org/issues/3999
 docker==3.1.3  # pyup: ignore
 
-django-textclassifier==1.0
 django-annoying==0.10.4
 django-messages-extends==0.6.0
 djangorestframework-jsonp==1.0.2