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

[kaputtnik]

Fix wares oredring in encyclopedia by ordering of wares.

This fixes bug 1704955 by sorting a dict and provide a default ordering when querying a ware.

[GunChleoc (gunchleoc)]

LGTM :)

Maybe add a comment to the line as to why this was done?

review: Approve

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

467. By kaputtnik on 2017-07-20

added comments

[kaputtnik (franku)]

I forgot: This is tested locally for 'build_cost' and 'produces'. But only for the mentioned buildings which have known faulty entries.

Commenting is a good idea... Added some comments, please review if the comments fit, are understandable and worded correctly :-)

Thanks for the review :-)

review: Needs Resubmitting

[GunChleoc (gunchleoc)]

1 Nit. Let's get this in and do more testing on the live site.

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

468. By kaputtnik on 2017-07-21

adjusted comment

[kaputtnik (franku)]

This is pushed onto the server now, but not committed yet.

The encyclopedia is manually updated so the new code is executed and the wares should appear properly (hopefully).

[kaputtnik (franku)]

After worldsavior confirmed that all is working, the changes are comittet.

=== modified file 'wlhelp/management/commands/update_help.py'
--- wlhelp/management/commands/update_help.py	2016-07-02 12:38:06 +0000
+++ wlhelp/management/commands/update_help.py	2017-07-21 14:54:39 +0000
@@ -24,6 +24,7 @@
 import re
 import json
 import subprocess
+import collections
 
 from settings import MEDIA_ROOT, WIDELANDS_SVN_DIR, MEDIA_URL
 
@@ -209,6 +210,10 @@
             element_set = {}
             for element in json_:
                 element_set[element['name']] = str(element['amount'])
+            # Sort the dictionary alphabetical. Otherwise a wrong relation will
+            # be made, e.g. build_cost and build_wares in 
+            # models.get_build_cost() and other functions over there.
+            element_set = collections.OrderedDict(sorted(element_set.items()))
             counts = ' '.join(element_set.values())
             objects = [objtype.objects.get_or_create(name=w, tribe=self._to)[
                 0] for w in element_set.keys()]
 
=== modified file 'wlhelp/models.py'
--- wlhelp/models.py	2016-07-02 12:38:06 +0000
+++ wlhelp/models.py	2017-07-21 14:54:39 +0000
@@ -55,6 +55,9 @@
     # This limit shall probably cover the longest help (found 209, nothing
     # more)
     help = models.TextField(max_length=256)
+    
+    class Meta:
+        ordering = ['name']
 
     if settings.USE_SPHINX:
         search = SphinxSearch(
@@ -176,6 +179,8 @@
         return (self.build_wares.all().count() != 0)
 
     def get_build_cost(self):
+        # Creating the relation between build_cost and build_wares
+        # Querying the wares returns the wares in alphabetical order!
         count = map(int, self.build_costs.split())
         for c, w in zip(count, self.build_wares.all()):
             yield [w] * c