Merge lp:~widelands-dev/widelands-website/replace_djangoratings into lp:widelands-website

[kaputtnik]

Exchange old app djangoratings with django-star-ratings

Another cleanup for the update of python. Exchange the old unmaintained app djangoratings with an up-to-date app.

I decided to get this in in two steps:

1. This branch adds the new app. The conversion of old votes to new votes can be done in the django shell (see below). In this branch the old values remains visible, so we can check if the conversion is done correctly.

2. In a another branch we clean up the code to remove the old app djangorating.

After merging this branch it is important to delete a remaining .pyc file:

djangoratings/templatetags/ratings.pyc

We can import the old ratings as follows in the django shell:

from djangoratings.models import Score, Vote
from star_ratings.models import Rating, UserRating

for obj in Score.objects.all():
   vote_obj = Rating.objects.create(object_id=obj.object_id, content_type=obj.content_type)
   for v in Vote.objects.filter(object_id=obj.object_id, content_type=obj.content_type):
      vote = UserRating.objects.create(user=v.user, ip=v.ip_address, score=v.score, rating=vote_obj)
      vote.save()
   vote_obj.calculate()

[lp:~widelands-dev/widelands-website/replace_djangoratings]

507. By kaputtnik on 2018-11-18

forgotton to add custom templates

508. By kaputtnik on 2018-11-18

fixed comment

[GunChleoc (gunchleoc)]

LGTM :)

review: Approve

[kaputtnik (franku)]

Merged and deployed.

Thanks for the review, and sorry for server errors... forgot some steps after merging the branch :-S

I have checked also the first 10 pages of the maps for the voting and all looks fine.

Some old Votings had no map associated map (map got deleted, but the voting objects remain), i deleted them.

=== renamed file 'djangoratings/templatetags/ratings.py' => 'djangoratings/templatetags/ratings_old.py'
=== modified file 'media/css/base.css'
--- media/css/base.css	2018-10-15 07:13:24 +0000
+++ media/css/base.css	2018-11-18 21:30:49 +0000
@@ -108,6 +108,10 @@
 	font-weight: bold;
 }
 
+.star-ratings input, button {
+	padding: inherit;
+}
+
 textarea {
 	font-weight: normal;
 	font-size: 0.9em;

=== modified file 'pip_requirements.txt'
--- pip_requirements.txt	2018-11-05 17:12:12 +0000
+++ pip_requirements.txt	2018-11-18 21:30:49 +0000
@@ -7,6 +7,7 @@
 # Do not install newer versions because our notifications app is affected
 -e git://github.com/arneb/django-messages.git@2d8dabb755e0b5ace876bde25f45d07c2051ac37#egg=django_messages
 django-nocaptcha-recaptcha==0.0.19
+django-star-ratings==0.7.0
 dj-pagination==2.3.2
 django-registration==2.4.1
 django-tagging==0.4.5

=== modified file 'settings.py'
--- settings.py	2018-11-12 19:36:22 +0000
+++ settings.py	2018-11-18 21:30:49 +0000
@@ -110,6 +110,7 @@
     'django_messages_wl.apps.WLDjangoMessagesConfig',
     'dj_pagination',
     'tagging',
+    'star_ratings',
     'djangoratings',    # included as wlapp
 ]
 
@@ -333,6 +334,14 @@
 # See: https://docs.djangoproject.com/en/dev/ref/settings/#csrf-cookie-age
 CSRF_COOKIE_AGE = None
 
+#############################
+# star_rating configuration #
+#############################
+
+STAR_RATINGS_STAR_HEIGHT = 14
+STAR_RATINGS_STAR_WIDTH = 14
+STAR_RATINGS_RANGE = 10
+
 try:
     from local_settings import *
 except ImportError:

=== added directory 'templates/star_rating'
=== added file 'templates/star_rating/average.html'
--- templates/star_rating/average.html	1970-01-01 00:00:00 +0000
+++ templates/star_rating/average.html	2018-11-18 21:30:49 +0000
@@ -0,0 +1,7 @@
+{% extends "star_ratings/widget_base.html" %}
+{% block rating_stars %}
+    {# No stars here #}
+{% endblock %}
+{% block rating_detail %}
+{{ rating.average|floatformat:"-2" }} ({{ rating.count }} Vote{{ rating.count|pluralize }})
+{% endblock %}
\ No newline at end of file

=== added file 'templates/star_rating/rate.html'
--- templates/star_rating/rate.html	1970-01-01 00:00:00 +0000
+++ templates/star_rating/rate.html	2018-11-18 21:30:49 +0000
@@ -0,0 +1,27 @@
+{% extends "star_ratings/widget_base.html" %}
+{% load i18n %}
+
+{% block rating_detail %}
+{% if not user.is_authenticated and not anonymous_ratings and not read_only %}
+    <p>
+        {{ rating.average|floatformat:"-2" }} ({{ rating.count }} Vote{{ rating.count|pluralize }})
+        <a href="{% url 'auth_login' %}?next={{ request.path }}">{% trans 'Please log in to vote.' %}</a>
+    </p>
+{% else %}
+    {% block rating_user %}
+    <p class="star-ratings-rating-user">
+        {{ rating.average|floatformat:"-2" }} ({{ rating.count }} Vote{{ rating.count|pluralize }}) - 
+        {% trans 'You voted: ' %}
+        <span class='star-ratings-rating-value'>
+        {% if user_rating %}
+            {{ user_rating.score }}
+        {% else %}
+            {% trans 'Not voted' %}
+        {% endif %}
+        </span>
+    </p>
+    {% endblock rating_user %}
+    <p class="star-ratings-errors"><p>
+{% endif %}
+{% endblock rating_detail %}
+

=== modified file 'templates/wlmaps/base.html'
--- templates/wlmaps/base.html	2015-02-18 22:30:08 +0000
+++ templates/wlmaps/base.html	2018-11-18 21:30:49 +0000
@@ -1,4 +1,5 @@
 {% extends "base.html" %}
+{% load static %}
 
 {% comment %}
    vim:ft=htmldjango
@@ -7,6 +8,8 @@
 {% block extra_head %}
 <link rel="stylesheet" type="text/css" media="all" href="{{ MEDIA_URL }}css/forum.css" />
 <link rel="stylesheet" type="text/css" media="all" href="{{ MEDIA_URL }}css/maps.css" />
+<link rel="stylesheet" href="{% static 'star-ratings/css/star-ratings.css' %}">
+<script type="text/javascript" src="{% static 'star-ratings/js/dist/star-ratings.min.js' %}"></script>
 {{block.super}}
 {% endblock %}
 

=== modified file 'templates/wlmaps/index.html'
--- templates/wlmaps/index.html	2018-10-14 13:24:15 +0000
+++ templates/wlmaps/index.html	2018-11-18 21:30:49 +0000
@@ -8,6 +8,8 @@
 {% load wlmaps_extra %}
 {% load threadedcommentstags %}
 {% load pagination_tags %}
+{% load ratings %}
+{% load ratings_old %}
 
 {% block content_header %}
 	<h1>Maps</h1>
@@ -55,7 +57,9 @@
 					</tr>
 					<tr>
 						<td class="grey">Rating:</td>
-						<td>{{ map.rating|average_rating }} ({{ map.rating.votes }} Votes)</td>
+						<td>
+							{% ratings map read_only template_name='star_rating/average.html' %}
+							{{ map.rating|average_rating }} ({{ map.rating.votes }} Votes)</td>
 						<td class="spacer"></td>
 						{% get_comment_count for map as ccount %}
 						<td class="grey">Comments:</td><td>{{ ccount }}</td>

=== modified file 'templates/wlmaps/map_detail.html'
--- templates/wlmaps/map_detail.html	2018-10-14 13:24:15 +0000
+++ templates/wlmaps/map_detail.html	2018-11-18 21:30:49 +0000
@@ -8,6 +8,8 @@
 {% load wlprofile_extras %}
 {% load threadedcommentstags %}
 {% load wl_markdown %}
+{% load ratings %}
+{% load ratings_old %}
 
 {% block title %}{{ map.name }} - {{ block.super }}{% endblock %}
 
@@ -29,6 +31,7 @@
         });
 });
 </script>
+
 {% endif %}
 {% endblock %}
 
@@ -94,7 +97,7 @@
 			</tr>
 			<tr>
 				<td class="grey">Rating:</td>
-				<td>
+				<td>{% ratings map template_name='star_rating/rate.html' %}
 					{{ map.rating|average_rating }} ({{ map.rating.votes }} Votes)
 					{% if not user.is_anonymous %}
 					<span id="vote"></span>

=== modified file 'urls.py'
--- urls.py	2018-10-10 17:04:53 +0000
+++ urls.py	2018-11-18 21:30:49 +0000
@@ -27,6 +27,7 @@
     url(r'^accounts/', include('registration.backends.hmac.urls')),
     url('^', include('django.contrib.auth.urls')),
 
+    url(r'^ratings/', include('star_ratings.urls', namespace='ratings', app_name='ratings')),
     # Formerly 3rd party
     url(r'^notification/', include('notification.urls')),
     

=== modified file 'wlmaps/templatetags/wlmaps_extra.py'
--- wlmaps/templatetags/wlmaps_extra.py	2016-12-13 18:28:51 +0000
+++ wlmaps/templatetags/wlmaps_extra.py	2018-11-18 21:30:49 +0000
@@ -12,4 +12,4 @@
         avg = '%.1f' % (float(rating.score) / rating.votes)
     else:
         avg = '0.0'
-    return avg
+    return 'Old: {}'.format(avg)