Merge pull request #1402 from uktrade/company-address

Add company address fields

Author: marcofucci

changelog/company/address-fields.db

@@ -0,0 +1,16 @@
+The following fields where added:
+
+``"address_1" varchar(255)``
+
+``"address_2" varchar(255)``
+
+``"address_country_id" uuid``
+
+``"address_county" varchar(255)``
+
+``"address_postcode" varchar(255)``
+
+``"address_town" varchar(255)``
+
+The system will be migrated from using the ``registered_address_*`` and ``trading_address_*`` fields to ``address_*`` (main location for the business) and ``registered_address_*`` (official address) fields instead.
+However, you should not use the new address fields yet and migration steps will be communicated in future release notes.

datahub/company/admin/company.py

@@ -126,7 +126,21 @@ class CompanyAdmin(BaseModelAdminMixin, VersionAdmin):
         (
             'ADDRESS',
             {
+                'description': (
+                    'The address fields are in the process of being migrated. '
+                    'Address is the main location for this business '
+                    '(could be trading, registered or a different address) '
+                    'whilst registered address is the official address '
+                    '(e.g. from companies house).'
+                ),
                 'fields': (
+                    'address_1',
+                    'address_2',
+                    'address_town',
+                    'address_county',
+                    'address_postcode',
+                    'address_country',
+
                     'registered_address_1',
                     'registered_address_2',
                     'registered_address_town',

datahub/company/migrations/0062_add_address.py

@@ -0,0 +1,45 @@
+# Generated by Django 2.1.5 on 2019-01-21 12:31
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0021_delete_companyclassification'),
+        ('company', '0061_remove_alias_from_database'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='company',
+            name='address_1',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name='company',
+            name='address_2',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name='company',
+            name='address_country',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='company_address_country', to='metadata.Country'),
+        ),
+        migrations.AddField(
+            model_name='company',
+            name='address_county',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name='company',
+            name='address_postcode',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name='company',
+            name='address_town',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+    ]

datahub/company/models/company.py

@@ -168,6 +168,25 @@ class Company(ArchivableModel, BaseModel, CompanyAbstract):
         metadata_models.UKRegion, blank=True, null=True,
         on_delete=models.SET_NULL,
     )
+
+    # address is the main location for the business, it could be the trading address
+    # or the registered address or a completely different address
+    # TODO make address CharFields NOT NULL
+    address_1 = models.CharField(max_length=MAX_LENGTH, blank=True, null=True)
+    address_2 = models.CharField(max_length=MAX_LENGTH, blank=True, null=True)
+    address_town = models.CharField(max_length=MAX_LENGTH, blank=True, null=True)
+    address_county = models.CharField(max_length=MAX_LENGTH, blank=True, null=True)
+    address_country = models.ForeignKey(
+        metadata_models.Country,
+        blank=True,
+        null=True,
+        on_delete=models.PROTECT,
+        related_name='company_address_country',
+    )
+    address_postcode = models.CharField(max_length=MAX_LENGTH, blank=True, null=True, default='')
+
+    # will eventually become obsolete when the migration to solely address and registered
+    # address is completed
     trading_address_1 = models.CharField(max_length=MAX_LENGTH, blank=True, null=True)
     trading_address_2 = models.CharField(max_length=MAX_LENGTH, blank=True, null=True)
     trading_address_town = models.CharField(max_length=MAX_LENGTH, blank=True, null=True)
@@ -180,6 +199,7 @@ class Company(ArchivableModel, BaseModel, CompanyAbstract):
         related_name='company_trading_address_country',
     )
     trading_address_postcode = models.CharField(max_length=MAX_LENGTH, blank=True, null=True)
+
     headquarter_type = models.ForeignKey(
         metadata_models.HeadquarterType, blank=True, null=True,
         on_delete=models.SET_NULL,

datahub/company/serializers.py

@@ -275,6 +275,26 @@ class CompanySerializer(PermittedFieldsModelSerializer):
     have to enter company numbers for UK establishments manually.
     """
 
+    # TODO: delete after the migration to address and registered address is completed
+    ADDRESS_FIELDS_MAPPING = {
+        'trading': {
+            'address_1': 'trading_address_1',
+            'address_2': 'trading_address_2',
+            'address_town': 'trading_address_town',
+            'address_county': 'trading_address_county',
+            'address_postcode': 'trading_address_postcode',
+            'address_country': 'trading_address_country',
+        },
+        'registered': {
+            'address_1': 'registered_address_1',
+            'address_2': 'registered_address_2',
+            'address_town': 'registered_address_town',
+            'address_county': 'registered_address_county',
+            'address_postcode': 'registered_address_postcode',
+            'address_country': 'registered_address_country',
+        },
+    }
+
     default_error_messages = {
         'invalid_uk_establishment_number_prefix': ugettext_lazy(
             'This must be a valid UK establishment number, beginning with BR.',
@@ -382,8 +402,47 @@ def validate(self, data):
                     'headquarter_type': message,
                 })
 
+        self._populate_address_fields(combiner, data)
+
         return data
 
+    def _populate_address_fields(self, combiner, data):
+        """
+        Populates the address_* fields with the values from trading address or
+        registered address whichever is defined.
+
+        It's only triggered when any of the address fields are specified so that we don't
+        accidentally run this logic when changing any other field.
+        Doing this will allow us to implement a variant that updates the addresses
+        in a different way.
+
+        TODO: delete after the migration to address and registered address is completed
+        """
+        all_address_field_names = {
+            field
+            for mapping in self.ADDRESS_FIELDS_MAPPING.values()
+            for field in mapping.values()
+        }
+
+        # was any address field specified?
+        if not all_address_field_names & data.keys():
+            return
+
+        trading_fields_mapping = Company.TRADING_ADDRESS_VALIDATION_MAPPING
+
+        has_valid_trading_address = all(
+            combiner.get_value(field_name)
+            for field_name, rules in trading_fields_mapping.items()
+            if rules['required']
+        )
+
+        mapping_source = 'trading' if has_valid_trading_address else 'registered'
+
+        mapping = self.ADDRESS_FIELDS_MAPPING[mapping_source]
+        for target_field_name, source_field_name in mapping.items():
+            target_value = combiner.get_value(source_field_name)
+            data[target_field_name] = target_value
+
     def validate_headquarter_type(self, headquarter_type):
         """Raises an exception if company is a global hq and has subsidiaries."""
         if self.instance is None:

datahub/company/test/factories.py

@@ -41,12 +41,22 @@ class CompanyFactory(factory.django.DjangoModelFactory):
         factory.Faker('company'),
         factory.Faker('company'),
     ])
+
     registered_address_1 = factory.Sequence(lambda n: f'{n} Foo st.')
     registered_address_town = 'London'
+    registered_address_postcode = factory.Faker('postcode')
     registered_address_country_id = constants.Country.united_kingdom.value.id
+
     trading_address_1 = factory.Sequence(lambda x: f'{x} Fake Lane')
     trading_address_town = 'Woodside'
+    trading_address_postcode = factory.Faker('postcode')
     trading_address_country_id = constants.Country.united_kingdom.value.id
+
+    address_1 = factory.SelfAttribute('.trading_address_1')
+    address_town = factory.SelfAttribute('.trading_address_town')
+    address_postcode = factory.SelfAttribute('.trading_address_postcode')
+    address_country_id = factory.SelfAttribute('.trading_address_country_id')
+
     business_type_id = BusinessTypeConstant.private_limited_company.value.id
     sector_id = constants.Sector.aerospace_assembly_aircraft.value.id
     archived = False