#42 Tests for Level-System / Homepage

django_lostplaces/lostplaces/admin.py

@@ -35,3 +35,4 @@ admin.site.register(Voucher, VoucherAdmin)
 admin.site.register(Place, PlacesAdmin)
 admin.site.register(PlaceImage, PlaceImagesAdmin)
 admin.site.register(PhotoAlbum, PhotoAlbumsAdmin)
+admin.site.register(PlaceVoting)

django_lostplaces/lostplaces/forms.py

@@ -22,7 +22,7 @@ class SignupVoucherForm(UserCreationForm):
     )
 
     def is_valid(self):
-        super().is_valid()
+        super_result = super().is_valid()
         submitted_voucher = self.cleaned_data.get('voucher')
         try:
             fetched_voucher = Voucher.objects.get(code=submitted_voucher)
@@ -35,7 +35,7 @@ class SignupVoucherForm(UserCreationForm):
             return False
 
         fetched_voucher.delete()
-        return True
+        return super_result
 
 class ExplorerUserChangeForm(UserChangeForm):
     class Meta:

django_lostplaces/lostplaces/models/place.py

@@ -1,4 +1,5 @@
 import os
+from math import floor
 
 from django.db import models
 from django.urls import reverse
@@ -6,7 +7,7 @@ from django.dispatch import receiver
 from django.db.models.signals import post_delete, pre_save
 from django.utils.translation import ugettext_lazy as _
 
-from lostplaces.models.abstract_models import Submittable, Taggable, Mapable
+from lostplaces.models.abstract_models import Submittable, Taggable, Mapable, Expireable
 
 from easy_thumbnails.fields import ThumbnailerImageField
 from easy_thumbnails.files import get_thumbnailer
@@ -15,7 +16,7 @@ PLACE_LEVELS = (
     (1, 'Ruin'),
     (2, 'Vandalized'),
     (3, 'Natures Treasure'),
-    (4, 'Long Time no See'),
+    (4, 'Lost in History'),
     (5, 'Time Capsule')
 )
 
@@ -58,10 +59,15 @@ class Place(Submittable, Taggable, Mapable):
         return reverse('place_detail', kwargs={'pk': self.pk})
         
     def get_hero_index_in_queryset(self):
+        '''
+        Calculates the index of the hero image within
+        the list / queryset of images. Necessary for
+        the lightbox.
+        '''
         for i in range(0, len(self.placeimages.all())):
             image = self.placeimages.all()[i]
             if image == self.hero:
-	            return i
+                return i
         return None
     
 
@@ -84,6 +90,24 @@ class Place(Submittable, Taggable, Mapable):
 
         return {'latitude': latitude, 'longitude': longitude}
 
+    def calculate_place_level(self):
+        self.remove_expired_votes()
+
+        if self.placevotings.count() == 0:
+            return 5
+
+        level = 0
+
+        for vote in self.placevotings.all():
+            level += vote.vote
+
+        self.level = floor(level / self.placevotings.count())
+        
+    def remove_expired_votes(self):
+        for vote in self.placevotings.all():
+            if vote.is_expired:
+                vote.delete()
+
     def __str__(self):
         return self.name
 
@@ -104,7 +128,7 @@ class PlaceAsset(Submittable):
     """
 
     class Meta:
-            abstract = True
+        abstract = True
 
     place = models.ForeignKey(
         Place,
@@ -180,3 +204,13 @@ def auto_delete_file_on_change(sender, instance, **kwargs):
     new_file = instance.filename
     if not old_file == new_file:
         old_file.delete(save=False)
+
+
+class PlaceVoting(PlaceAsset, Expireable):
+    vote = models.IntegerField(choices=PLACE_LEVELS)
+    
+    def get_human_readable_level(self):
+        return PLACE_LEVELS[self.vote - 1][1]
+
+    def get_all_choices(self):
+        return reversed(PLACE_LEVELS)

django_lostplaces/lostplaces/static/fonts/MaterialDesignIcons/LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

django_lostplaces/lostplaces/templates/global.html

@@ -12,6 +12,7 @@
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <link rel="stylesheet" href="{% static 'main.css' %}">
+	<link rel="stylesheet" href="{% static 'materialdesignicons.css' %}">
     <link rel="icon" type="image/png" href="{% static 'favicon.ico' %}">
     <title>
         {% block title %}Urban Exploration{% endblock %}

django_lostplaces/lostplaces/templates/partials/voting.html

@@ -0,0 +1,39 @@
+{% load i18n %}
+
+<div class="LP-Voting">
+	<div class="LP-Voting__Left">
+		<h2 class="LP-Headline">
+			Place level
+		</h2>
+		<div class="LP-Voting__Choices">
+			{% for choice in voting.get_all_choices %}
+				<a href="{% url 'place_vote' place_id=place.id vote=choice.0 %}" class="LP-Voting__Vote {% if choice.0 <= place.level %} LP-Voting__Vote--overall{% endif %}" title="Vote place as &quot;{{choice.1}}&quot;">
+					<i class="mdi mdi-shield-home"></i>
+					<span class="LP-Voting__Label">
+						{{choice.1}}
+					</span>
+				</a>
+			{% endfor %}
+		</div>
+		<div class="LP-Voting__CurrentVote">
+			{{place.get_level_display}}
+		</div>
+	</div>
+	<div class="LP-Voting__Right">
+		<div class="LP-Voting__Info">
+			<div class="LP-Voting__UserVote">
+				<span class="LP-Voting__InfoLabel">You voted this place as</span>
+				<span class="LP-Voting__Vote">{{voting.get_human_readable_level}}</span>
+			</div>
+
+			<div class="LP-Voting__Expiration">
+				<span class="LP-Voting__InfoLabel">Your vote expires on</span>
+				<span class="LP-Voting__Date">
+					<time datetime="{{voting.expires_when|date:'Y-m-d'}}">
+						{{voting.expires_when|date:'d.m.Y'}}
+					</time>
+				</span>
+			</div>
+		</div>
+	</div>
+</div>

django_lostplaces/lostplaces/templates/place/place_detail.html

@@ -40,25 +40,64 @@
         <p class="LP-Paragraph">{{ place.description }}</p>
     </div>
 
-    <section class="LP-Section">
+	<div class="LP-Quickinfo">
-
+	    <section class="LP-Section">
-        {% url 'place_tag_submit' place_id=place.id as tag_submit_url%}
+			{% url 'place_tag_submit' place_id=place.id as tag_submit_url %}
-		{% partial tagging %}
+			{% partial tagging %}
-			{% set config=tagging_config %}
+				{% set config=tagging_config %}
-		{% endpartial %}
+			{% endpartial %}
-
+		</section>
-    </section>
+		
+		{{votingplace.vote}}
+		<section class="LP-Section">
+			{% partial voting %}
+				{% set place=place %}
+				{% set voting=placevoting %}
+			{% endpartial %}
+		</section>
+	</div>
 
     <section class="LP-Section">
         <h1 class="LP-Headline">{% translate 'Map links' %}</h1>
         {% partial osm_map config=mapping_config %}
-        <div class="LP-LinkList">
+		<ul class="LP-LinkList">
-            <ul class="LP-LinkList__Container">
+			<li class="LP-LinkList__Item">
-                <li class="LP-LinkList__Item"><a target="_blank" href="https://www.google.com/maps?q={{place.latitude|safe}},{{place.longitude|safe}}" class="LP-Link"><span class="LP-Text">Google Maps</span></a></li>
+				<a target="_blank" href="https://www.google.com/maps?q={{place.latitude|safe}},{{place.longitude|safe}}" class="LP-Link">
-                <li class="LP-LinkList__Item"><a target="_blank" href="https://www.tim-online.nrw.de/tim-online2/?center={{place.latitude|safe}},{{place.longitude|safe}}&icon=true&bg=dop" class="LP-Link"><span class="LP-Text">TIM Online</span></a></li>
+					<span class="LP-Text RV-Iconized">
-                <li class="LP-LinkList__Item"><a target="_blank" href="http://www.openstreetmap.org/?mlat={{place.latitude|safe}}&mlon={{place.longitude|safe}}&zoom=16" class="LP-Link"><span class="LP-Text">OSM</span></a></li>
+						<span class="RV-Iconized__Text">
-            </ul>
+							Google Maps
-        </div>
+						</span>
+						<span class="RV-Iconized__Icon RV-Iconized__Icon--left">
+							<i class="mdi mdi-map-outline"></i>
+						</span>
+					</span>
+				</a>
+			</li>
+			<li class="LP-LinkList__Item">
+				<a target="_blank" href="https://www.tim-online.nrw.de/tim-online2/?center={{place.latitude|safe}},{{place.longitude|safe}}&icon=true&bg=dop" class="LP-Link">
+					<span class="LP-Text RV-Iconized">
+						<span class="RV-Iconized__Text">
+							TIM Online
+						</span>
+						<span class="RV-Iconized__Icon RV-Iconized__Icon--left">
+							<i class="mdi mdi-map-outline"></i>
+						</span>
+					</span>
+				</a>
+			</li>
+			<li class="LP-LinkList__Item">
+				<a target="_blank" href="http://www.openstreetmap.org/?mlat={{place.latitude|safe}}&mlon={{place.longitude|safe}}&zoom=16" class="LP-Link">
+					<span class="LP-Text RV-Iconized">
+						<span class="RV-Iconized__Text">
+							OSM
+						</span>
+						<span class="RV-Iconized__Icon RV-Iconized__Icon--left">
+							<i class="mdi mdi-map-outline"></i>
+						</span>
+					</span>
+				</a>
+			</li>
+		</ul>
     </section>
 
     <section class=" LP-Section">

django_lostplaces/lostplaces/tests/views/test_views.py

@@ -33,6 +33,32 @@ class TestHomeView(GlobalTemplateTestCaseMixin, ViewTestCase):
         )
         place.tags.add('I a tag', 'testlocation')
         place.save()
+        
+        # Creating a place with level one to test against
+        # unauth's users and users with level 1
+        Place.objects.create(
+            name='Im a place level 1',
+            submitted_when=timezone.now(),
+            submitted_by=user.explorer,
+            location='Testtown',
+            latitude=50.5,
+            longitude=7.0,
+            description='This is just a test, do not worry',
+            level=1
+        )
+
+        # Creating a place with level two to test against
+        # unauth's users and users above level 1
+        Place.objects.create(
+            name='Im a place level 2',
+            submitted_when=timezone.now(),
+            submitted_by=user.explorer,
+            location='Testtown',
+            latitude=50.5,
+            longitude=7.0,
+            description='This is just a test, do not worry',
+            level=2
+        )
 
     def setUp(self):
         self.client = Client()
@@ -80,7 +106,26 @@ class TestHomeView(GlobalTemplateTestCaseMixin, ViewTestCase):
             ),
             msg='Expecting the test place to show up on the homepage'
         )
-        
+
+        print(response.content.decode().replace('\n', ''))
+        self.assertNotEqual(
+            None,
+            re.search(
+                """Im a place level 1""",
+                response.content.decode().replace('\n', '')
+            ),
+            msg="Expecting the level 1 places to show up on the homepage publicly"
+        )
+
+        self.assertEqual(
+            None,
+            re.search(
+                """Im a place level 2""",
+                response.content.decode().replace('\n', '')
+            ),
+            msg="Expecting the level 2 places to *not* show up on the homepage publicly"
+        )
+
     def test_map_authenticated(self):
         """
         Testing there is a map showing all the lates places

django_lostplaces/lostplaces/urls.py

@@ -22,7 +22,8 @@ from lostplaces.views import (
     PhotoAlbumCreateView,
 	PhotoAlbumDeleteView,
     ExplorerProfileView,
-    ExplorerProfileUpdateView
+    ExplorerProfileUpdateView,
+    PlaceVoteView
 )
 
 urlpatterns = [
@@ -47,6 +48,8 @@ urlpatterns = [
 
     path('place_image/create/<int:place_id>/', PlaceImageCreateView.as_view(), name='place_image_create'),
     path('place_image/delete/<int:pk>/', PlaceImageDeleteView.as_view(), name='place_image_delete'),
+    
+    path('place/vote/<int:place_id>/<int:vote>', PlaceVoteView.as_view(), name='place_vote'),
 
 	path('photo_album/create/<int:place_id>/', PhotoAlbumCreateView.as_view(), name='photo_album_create'),
 	path('photo_album/delete/<int:pk>/', PhotoAlbumDeleteView.as_view(), name='photo_album_delete')

django_lostplaces/lostplaces/views/place_views.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+from datetime import timedelta
 
 from django.db.models.functions import Lower
 
@@ -10,11 +11,17 @@ from django.views.generic.detail import SingleObjectMixin
 from django.contrib import messages
 from django.contrib.messages.views import SuccessMessageMixin
 from django.utils.translation import ugettext_lazy as _
+from django.utils import timezone
 
 from django.shortcuts import render, redirect, get_object_or_404
 from django.urls import reverse_lazy, reverse
 
-from lostplaces.models import Place, PlaceImage
+from lostplaces.models import (
+    Place,
+    PlaceImage,
+    PlaceVoting
+)
+
 from lostplaces.views.base_views import (
     IsAuthenticatedMixin,
     IsPlaceSubmitterMixin,
@@ -46,8 +53,10 @@ class PlaceDetailView(IsAuthenticatedMixin, IsEligibleToSeePlaceMixin, View):
     def get_place(self):
         return get_object_or_404(Place, pk=self.kwargs['pk'])
 
-    def get(self, request, pk):        
+    def get(self, request, pk): 
         place = self.get_place()
+        place.calculate_place_level()
+        explorer = request.user.explorer
 
         context = {
             'place': place,
@@ -61,7 +70,8 @@ class PlaceDetailView(IsAuthenticatedMixin, IsEligibleToSeePlaceMixin, View):
                 'tagged_item': place,
                 'submit_url': reverse('place_tag_submit', kwargs={'tagged_id': place.id}),
                 'delete_url_name': 'place_tag_delete'
-            }
+            },
+            'placevoting': PlaceVoting.objects.filter(place=place, submitted_by=explorer).first()
         }
         return render(request, 'place/place_detail.html', context)
 
@@ -185,3 +195,32 @@ class PlaceVisitDeleteView(IsAuthenticatedMixin, View):
             request.user.explorer.save()
 
         return redirect_referer_or(request, reverse('place_detail', kwargs={'pk': place.pk}))                    
+
+
+class PlaceVoteView(IsEligibleToSeePlaceMixin, View):
+    delta = timedelta(weeks=24)
+    
+    def get(self, request, place_id, vote):
+        place = get_object_or_404(Place, id=place_id)
+        explorer = request.user.explorer
+        
+        voting = PlaceVoting.objects.filter(
+            submitted_by=explorer,
+            place=place
+        ).first()
+        
+        if voting is None:
+            voting = PlaceVoting.objects.create(
+                submitted_by=explorer,
+                place=place,
+                vote=vote,
+                expires_when=timezone.now()+self.delta
+            )
+            messages.success(self.request, _('Vote submitted'))
+        else:
+            voting.expires_when=timezone.now()+self.delta
+            voting.vote = vote
+            messages.success(self.request, _('Your vote has been update'))
+
+        voting.save()
+        return redirect_referer_or(request, reverse('place_detail', kwargs={'pk': place.pk}))

django_lostplaces/lostplaces/views/views.py

@@ -42,7 +42,7 @@ class HomeView(IsAuthenticatedMixin, View):
         return render(request, 'home.html', context)
 
     def handle_no_permission(self):
-        place_list = Place.objects.all().order_by('-submitted_when')[:5]
+        place_list = Place.objects.filter(level=1)[:5]
         context = {
             'place_list': place_list
         }