Refactor Gold Views (#6272)

* Refactor Gold Views

* Update gold projects template and CSS

Author: saadmk11

media/css/core.css

@@ -478,6 +478,9 @@ div.module.search-dashboard input {
 /* Admin project Translation */
 .module-translation { padding-bottom: 25px; }
 
+/* Accounts Gold Projects */
+.module-gold-projects { padding-bottom: 25px; }
+
 /* project bar */
 
 #project_bar { background: #E8ECEF url(../images/project-bar-bg.png) top left repeat; border-bottom: 1px solid #DAE1E5; overflow:hidden; position:relative; }

readthedocs/gold/forms.py

@@ -109,8 +109,11 @@ def generate_choices(self, active_user):
     def clean_project(self):
         project_slug = self.cleaned_data.get('project', '')
         project_instance = Project.objects.filter(slug=project_slug)
+
         if not project_instance.exists():
             raise forms.ValidationError(_('No project found.'))
+        elif project_instance.first() in self.projects:
+            raise forms.ValidationError(_('This project is already Ad-Free.'))
         else:
             return project_slug
 

readthedocs/gold/templates/gold/projects.html

@@ -22,16 +22,36 @@ <h3>{% trans "Gold Projects" %}</h3>
   </ul>
 
   <h3>{% trans 'Ad-free projects' %}</h3>
-  <ul class="donate-about">
-    {% for project in projects %}
-      <li>
-        <a href="{{ project.get_absolute_url }}">{{ project }}</a>
-        <span>(<a href="{% url "gold_projects_remove" project.slug %}">{% trans "Remove Ad-Free Status" %}</a>)</span>
-      </li>
-    {% empty %}
-      <p>{% trans 'No projects are currently ad-free.' %}</p>
-    {% endfor %}
-  </ul>
+
+  <div class="module-gold-projects">
+    <div class="module-list">
+      <div class="module-list-wrapper">
+        <ul>
+          {% for project in projects %}
+          <li class="module-item">
+            <a class="module-item-title" href="{{ project.get_absolute_url }}">
+              {{ project.name }}
+            </a>
+            <ul class="module-item-menu">
+              <li>
+                <form method="post" action="{% url "gold_projects_remove" project.slug %}">
+                  {% csrf_token %}
+                  <input type="submit" title="{% trans 'Remove Ad-Free Status' %}" value="{% trans 'Remove' %}">
+                </form>
+              </li>
+            </ul>
+          </li>
+          {% empty %}
+          <li class="module-item">
+            <p class="quiet">
+              {% trans 'No projects are currently ad-free.' %}
+            </p>
+          </li>
+          {% endfor %}
+        </ul>
+      </div>
+    </div>
+  </div>
 
   <h3>{% trans "Make a project ad-free" %}</h3>
   {% if gold_user.num_supported_projects > projects|length %}

readthedocs/gold/urls.py

@@ -20,14 +20,14 @@
         views.DeleteGoldSubscription.as_view(),
         name='gold_cancel',
     ),
-    url(r'^projects/$', views.projects, name='gold_projects'),
+    url(r'^projects/$', views.GoldProjectsListCreate.as_view(), name='gold_projects'),
     url(
         (
             r'^projects/remove/(?P<project_slug>{project_slug})/$'.format(
                 project_slug=PROJECT_SLUG_REGEX,
             )
         ),
-        views.projects_remove,
+        views.GoldProjectRemove.as_view(),
         name='gold_projects_remove',
     ),
 ]

readthedocs/gold/views.py

@@ -10,7 +10,7 @@
 from django.shortcuts import get_object_or_404, render
 from django.urls import reverse, reverse_lazy
 from django.utils.translation import ugettext_lazy as _
-from vanilla import DeleteView, DetailView, UpdateView
+from vanilla import DeleteView, DetailView, FormView, GenericView, UpdateView
 
 from readthedocs.core.mixins import PrivateViewMixin
 from readthedocs.payments.mixins import StripeMixin
@@ -98,45 +98,57 @@ def post(self, request, *args, **kwargs):
         return resp
 
 
-@login_required
-def projects(request):
-    gold_user = get_object_or_404(GoldUser, user=request.user)
-    gold_projects = gold_user.projects.all()
+class GoldProjectsMixin(PrivateViewMixin):
 
-    if request.method == 'POST':
-        form = GoldProjectForm(
-            active_user=request.user,
-            data=request.POST,
-            user=gold_user,
-            projects=gold_projects,
+    def get_gold_user(self):
+        return get_object_or_404(GoldUser, user=self.request.user)
+
+    def get_gold_projects(self):
+        return self.get_gold_user().projects.all()
+
+    def get_success_url(self):
+        return reverse('gold_projects')
+
+
+class GoldProjectsListCreate(GoldProjectsMixin, FormView):
+
+    """Gold Project list view and form view."""
+
+    form_class = GoldProjectForm
+    template_name = 'gold/projects.html'
+
+    def form_valid(self, form):
+        to_add = Project.objects.get(slug=form.cleaned_data['project'])
+        gold_user = self.get_gold_user()
+        gold_user.projects.add(to_add)
+        return HttpResponseRedirect(self.get_success_url())
+
+    def get_form(self, data=None, files=None, **kwargs):
+        kwargs['user'] = self.get_gold_user()
+        kwargs['projects'] = self.get_gold_projects()
+        return self.form_class(self.request.user, data, files, **kwargs)
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context['gold_user'] = self.get_gold_user()
+        context['publishable'] = settings.STRIPE_PUBLISHABLE
+        context['user'] = self.request.user
+        context['projects'] = self.get_gold_projects()
+        return context
+
+
+class GoldProjectRemove(GoldProjectsMixin, GenericView):
+
+    http_method_names = ['post']
+
+    def post(self, request, *args, **kwargs):
+        # pylint: disable=unused-argument
+        gold_user = self.get_gold_user()
+
+        project = get_object_or_404(
+            Project.objects.all(),
+            slug=self.kwargs.get('project_slug')
         )
-        if form.is_valid():
-            to_add = Project.objects.get(slug=form.cleaned_data['project'])
-            gold_user.projects.add(to_add)
-            return HttpResponseRedirect(reverse('gold_projects'))
-    else:
-        # HACK: active_user=request.user is passed
-        # as argument to get the currently active
-        # user in the GoldProjectForm which is used
-        # to filter the choices based on the user.
-        form = GoldProjectForm(active_user=request.user)
-
-    return render(
-        request,
-        'gold/projects.html',
-        {
-            'form': form,
-            'gold_user': gold_user,
-            'publishable': settings.STRIPE_PUBLISHABLE,
-            'user': request.user,
-            'projects': gold_projects,
-        },
-    )
-
-
-@login_required
-def projects_remove(request, project_slug):
-    gold_user = get_object_or_404(GoldUser, user=request.user)
-    project = get_object_or_404(Project.objects.all(), slug=project_slug)
-    gold_user.projects.remove(project)
-    return HttpResponseRedirect(reverse('gold_projects'))
+        gold_user.projects.remove(project)
+
+        return HttpResponseRedirect(self.get_success_url())