example of improved zipcode handling (see #20)

Author: sheppard

tests/data_app/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 2.1.7 on 2019-02-28 23:53
+# Generated by Django 2.2.4 on 2019-08-21 02:43
 
 from django.db import migrations, models
 import django.db.models.deletion
@@ -13,10 +13,11 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name='FKModel',
+            name='Address',
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('notes', models.TextField()),
+                ('city', models.CharField(max_length=50)),
+                ('postal_code', models.CharField(max_length=10)),
             ],
         ),
         migrations.CreateModel(
@@ -35,9 +36,12 @@ class Migration(migrations.Migration):
                 ('name', models.CharField(max_length=255)),
             ],
         ),
-        migrations.AddField(
-            model_name='fkmodel',
-            name='type',
-            field=models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='data_app.Type'),
+        migrations.CreateModel(
+            name='FKModel',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('notes', models.TextField()),
+                ('type', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='data_app.Type')),
+            ],
         ),
     ]

tests/data_app/models.py

@@ -38,3 +38,14 @@ def __str__(self):
             self.type,
             self.notes,
         )
+
+
+class Address(models.Model):
+    city = models.CharField(max_length=50)
+    postal_code = models.CharField(max_length=10)
+
+    def __str__(self):
+        return "%s %s" % (
+            self.city,
+            self.postal_code,
+        )

tests/data_app/wizard.py

@@ -1,5 +1,5 @@
 from rest_framework import serializers
-from .models import SimpleModel, Type, FKModel
+from .models import SimpleModel, Type, FKModel, Address
 import data_wizard
 
 
@@ -49,8 +49,25 @@ class Meta:
         fields = "__all__"
 
 
+class NumericCharField(serializers.CharField):
+    def to_internal_value(self, data):
+        if isinstance(data, float):
+            data = int(data)
+        return str(data)
+
+
+class AddressSerializer(serializers.ModelSerializer):
+    postal_code = NumericCharField()
+
+    class Meta:
+        model = Address
+        fields = "__all__"
+
+
 data_wizard.register(SimpleModel)
 data_wizard.register('Simple Model - Incomplete', IncompleteSerializer)
 data_wizard.register(FKModel)
 data_wizard.register('FK Model By Name', SlugSerializer)
 data_wizard.register('New Type + FK Model', NestedSerializer)
+data_wizard.register(Address)
+data_wizard.register('Address with Zip Code', AddressSerializer)

tests/media/addresses.xlsx

@@ -0,0 +1,43 @@
+from .base import BaseImportTestCase
+
+
+class SimpleTestCase(BaseImportTestCase):
+    def test_xlsx_zipcode_default(self):
+        # Use auto-generated serializer (created by registering model)
+        self.serializer_name = 'data_wizard.registry.AddressSerializer'
+        run = self.upload_file('addresses.xlsx')
+
+        # Import and verify results
+        self.create_identifier('zipcode', 'postal_code')
+        self.auto_import(run, expect_input_required=False)
+        self.assert_status(run, 2)
+        self.assert_ranges(run, [
+            "Data Column 'city -> city' at Rows 1-2, Column 0",
+            "Data Column 'zipcode -> postal_code' at Rows 1-2, Column 1",
+        ])
+
+        # Records imported, but with '.0' due to XLSX number parsing
+        self.assert_records(run, [
+            "Imported 'Minneapolis 55455.0' at row 1",
+            "Imported 'Chicago 60611.0' at row 2",
+        ])
+
+    def test_xlsx_zipcode_improved(self):
+        # Use custom serializer
+        self.serializer_name = 'tests.data_app.wizard.AddressSerializer'
+        run = self.upload_file('addresses.xlsx')
+
+        # Import and verify results
+        self.create_identifier('zipcode', 'postal_code')
+        self.auto_import(run, expect_input_required=False)
+        self.assert_status(run, 2)
+        self.assert_ranges(run, [
+            "Data Column 'city -> city' at Rows 1-2, Column 0",
+            "Data Column 'zipcode -> postal_code' at Rows 1-2, Column 1",
+        ])
+
+        # With a custom serializer, the '.0' can be avoided
+        self.assert_records(run, [
+            "Imported 'Minneapolis 55455' at row 1",
+            "Imported 'Chicago 60611' at row 2",
+        ])