Replace countries.json fixture by management command

I started looking at this because on the mailing list, having the UK as
only shipping country led to confusion. This is mostly due to the
shipping address form hiding the country field if there's only one
country enabled, but all the validation then requiring UK postcodes and
phone numbers.

It's bothered me for a while that we're using a fixture to populate the
countries, which is at risk of becoming stale.
pycountry offers an excellent data source for a list of countries, so I
polished an existing management command to use it to populate the
country database.

This commit has two immediate effects:
* New setups will use a more current country database
* By default, all countries will be marked as shipping countries

pycountry also ships with localised names of the countries, which should
allow us to populate the database with localised country names.

Makefile

@@ -18,7 +18,8 @@ sandbox: install
 	sites/sandbox/manage.py loaddata sites/sandbox/fixtures/variants.json
 	sites/sandbox/manage.py oscar_import_catalogue sites/sandbox/fixtures/*.csv
 	sites/sandbox/manage.py oscar_import_catalogue_images sites/sandbox/fixtures/images.tar.gz
-	sites/sandbox/manage.py loaddata countries.json sites/_fixtures/pages.json sites/_fixtures/auth.json sites/_fixtures/ranges.json sites/_fixtures/offers.json
+	sites/sandbox/manage.py oscar_populate_countries
+	sites/sandbox/manage.py loaddata sites/_fixtures/pages.json sites/_fixtures/auth.json sites/_fixtures/ranges.json sites/_fixtures/offers.json
 	sites/sandbox/manage.py clear_index --noinput
 	sites/sandbox/manage.py update_index catalogue
 
@@ -36,7 +37,8 @@ demo: install
 	sites/demo/manage.py syncdb --noinput
 	sites/demo/manage.py migrate
 	# Import some core fixtures
-	sites/demo/manage.py loaddata countries.json sites/_fixtures/pages.json
+	sites/demo/manage.py oscar_populate_countries
+	sites/demo/manage.py loaddata sites/_fixtures/pages.json
 	# Create catalogue (create product classes from fixture than import CSV files)
 	sites/demo/manage.py loaddata sites/_fixtures/auth.json sites/demo/fixtures/offers.json
 	sites/demo/manage.py loaddata sites/demo/fixtures/product-classes.json sites/demo/fixtures/product-attributes.json sites/demo/fixtures/shipping-event-types.json
@@ -56,6 +58,7 @@ us_site: install
 	sites/us/manage.py syncdb --noinput
 	sites/us/manage.py migrate
 	# Import some fixtures
+	sites/us/manage.py oscar_populate_countries
 	sites/us/manage.py loaddata sites/us/fixtures/*.json
 	sites/us/manage.py loaddata sites/_fixtures/auth.json sites/_fixtures/ranges.json 
 	# Create catalogue (using a fixture from the demo site)

docs/source/internals/getting_started.rst

@@ -251,24 +251,23 @@ Fixtures
 
 The default checkout process requires a shipping address with a country.  Oscar
 uses a model for countries with flags that indicate which are valid shipping
-countries and so the ``address_country`` database table must be populated before
+countries and so the ``country`` database table must be populated before
 a customer can check out.
 
-This is easily achieved using fixtures.  Oscar ships with a ``countries.json``
-fixture that loads most countries from the `ISO 3166 standard`_.  This can loaded
-via::
+The easiest way to achieve this is to use country data from the `pycountry`_
+package. Oscar ships with a management command to parse that data::
 
-    $ python manage.py loaddata countries
+.. code-block:: bash
 
-Note however that this file only sets the UK as a valid shipping country.  If
-you want other countries to be available, it would make more sense to take a
-copy of Oscar's countries fixture and edit it as you see it before loading it.
+    $ pip install pycountry
+    [...]
+    $ python manage.py oscar_populate_countries
 
-Further, a simple way of loading countries for your project is to use a `data
-migration`_.
+By default, this command will mark all countries as a shipping country. Call
+it with the ``--no-shipping`` option to prevent that. You then need to
+manually mark at least one country as a shipping country.
 
-.. _`ISO 3166 standard`: http://en.wikipedia.org/wiki/ISO_3166
-.. _`data migration`: http://codeinthehole.com/writing/prefer-data-migrations-to-initial-data/
+.. _pycountry: https://pypi.python.org/pypi/pycountry
 
 
 Creating product classes and fulfillment partners

docs/source/releases/v0.8.rst

@@ -200,6 +200,10 @@ Minor changes
   optional. It usually is desired behaviour, but can slow down an app when
   using a remote storage.
 
+* Oscar now ships with a ``oscar_populate_countries`` management command to
+  populate the country databases. It replaces the ``countries.json`` fixture.
+  The command relies on the ``pycountry`` library being installed.
+
 .. _incompatible_changes_in_0.8:
 
 Backwards incompatible changes in 0.8

oscar/apps/address/abstract_models.py

@@ -387,8 +387,7 @@ class AbstractCountry(models.Model):
     iso_3166_1_numeric = models.CharField(
         _('ISO 3166-1 numeric'), blank=True, max_length=3)
 
-    #: The commonly used name
-    #: e.g. 'United Kingdom'
+    #: The commonly used name; e.g. 'United Kingdom'
     printable_name = models.CharField(_('Country name'), max_length=128)
     #: The full official name of a country
     #: e.g. 'United Kingdom of Great Britain and Northern Ireland'
@@ -405,7 +404,7 @@ class AbstractCountry(models.Model):
         abstract = True
         verbose_name = _('Country')
         verbose_name_plural = _('Countries')
-        ordering = ('-display_order', 'name',)
+        ordering = ('-display_order', 'printable_name',)
 
     def __unicode__(self):
         return self.printable_name or self.name

oscar/management/commands/oscar_populate_countries.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+from optparse import make_option
+
+from django.core.management.base import BaseCommand, CommandError
+from oscar.core.loading import get_model
+
+Country = get_model('address', 'Country')
+
+
+class Command(BaseCommand):
+    help = "Populates the list of countries with data from pycountry."
+    # TODO: Allow setting locale to fetch country names in right locale
+    # https://code.djangoproject.com/ticket/6376
+
+    option_list = BaseCommand.option_list + (
+        make_option(
+            '--no-shipping',
+            action='store_false',
+            dest='is_shipping',
+            default=True,
+            help="Don't mark countries for shipping"),
+    )
+
+    def handle(self, *args, **options):
+        try:
+            import pycountry
+        except ImportError:
+            raise CommandError(
+                "You are missing the pycountry library. Install it with "
+                "'pip install pycountry'")
+
+        if Country.objects.exists():
+            raise CommandError(
+                "You already have countries in your database. This command"
+                "currently does not support updating existing countries.")
+
+        countries = [
+            Country(
+                iso_3166_1_a2=country.alpha2,
+                iso_3166_1_a3=country.alpha3,
+                iso_3166_1_numeric=country.numeric,
+                printable_name=country.name,
+                name=getattr(country, 'official_name', ''),
+                is_shipping_country=options['is_shipping'])
+            for country in pycountry.countries]
+
+        Country.objects.bulk_create(countries)
+        self.stdout.write("Successfully added %s countries." % len(countries))

requirements.txt

@@ -34,3 +34,6 @@ flake8>=2.1
 pyprof2calltree==1.3.1
 ipdb>=0.8,<0.9
 ipython>=1.1.0,<1.2.0
+
+# Country data
+pycountry>=1.8,<2.0

tests/integration/order/model_tests.py

@@ -5,23 +5,21 @@ from django.test import TestCase
 from django.utils import timezone
 import mock
 
-from oscar.apps.address.models import Country
 from oscar.apps.order.models import ShippingAddress, Order, Line, \
         ShippingEvent, ShippingEventType, ShippingEventQuantity, OrderNote, \
         OrderDiscount
 from oscar.apps.order.exceptions import (InvalidOrderStatus, InvalidLineStatus,
                                          InvalidShippingEvent)
-from oscar.test.factories import create_order, create_offer, create_voucher, create_basket
+from oscar.test.factories import create_order, create_offer, create_voucher, create_basket, CountryFactory
 from oscar.test.basket import add_product
 
 ORDER_PLACED = 'order_placed'
 
 
 class ShippingAddressTest(TestCase):
-    fixtures = ['countries.json']
 
     def test_titleless_salutation_is_stripped(self):
-        country = Country.objects.get(iso_3166_1_a2='GB')
+        country = CountryFactory()
         a = ShippingAddress.objects.create(
             last_name='Barrington', line1="75 Smith Road", postcode="N4 8TY", country=country)
         self.assertEqual("Barrington", a.salutation)