codeforamerica/intake

View on GitHub
intake/services/edit_form_service.py

Summary

Maintainability
A
1 hr
Test Coverage
from formation import fields as F
from formation.field_types import MultiValueField
from formation.fields import get_field_index
from formation.form_base import Form
from formation.forms import county_form_selector


EDITABLE_FIELDS = {
    F.ContactPreferences,
    F.FirstName,
    F.MiddleName,
    F.LastName,
    F.Aliases,
    F.PhoneNumberField,
    F.AlternatePhoneNumberField,
    F.AddressField,
    F.DriverLicenseOrIDNumber,
    F.EmailField,
    F.DateOfBirthField,
    F.SocialSecurityNumberField,
}


SENSITIVE_FIELD_LABELS = (
    F.SocialSecurityNumberField().get_display_label(),
    F.DriverLicenseOrIDNumber().get_display_label(),
)


def get_edit_form_class_for_user_and_submission(user, submission):
    # get all orgs for submissison
    all_county_slugs = submission.organizations.values_list(
        'county__slug', flat=True)
    # get combined form spec for all orgs
    all_county_form_spec = county_form_selector.get_combined_form_spec(
        counties=all_county_slugs)
    county_field_set = all_county_form_spec.fields

    if not user.is_staff:
        user_county_slug = user.profile.organization.county.slug
        user_county_spec = county_form_selector.get_combined_form_spec(
            counties=[user_county_slug])
        county_field_set = user_county_spec.fields

    form_field_set = county_field_set & EDITABLE_FIELDS
    form_fields = sorted(list(form_field_set), key=get_field_index)
    # get union of required fields from all form specs
    # this, intersected with form_fields, is the set of required fields for
    # our form
    required_fields = list(
        all_county_form_spec.required_fields & form_field_set)
    parent_classes = (Form,)
    class_attributes = dict(
        fields=form_fields,
        required_fields=required_fields,
        validators=list(all_county_form_spec.validators))
    return type('CombinedEditForm', parent_classes, class_attributes)


def get_changed_data_from_form(form):
    """Returns a dictionary with keys of all changed fields
    and values that are a dict with 'before' and 'after' keys
    values of 'before' and 'after' are display values
    for example:
        {
            'First name': {
                'before': 'George',
                'after': 'Jorge'
            },
            'Date of birth': {
                'before': 'February/6/1791',
                'after': '2/6/1791'}
            }
        }
    Expects fields prefixed with 'existing_' in order to make that comparison
    """
    changes = {}
    existing_data_form = form.__class__(
        form.raw_input_data, prefix='existing_', validate=True,
        skip_validation_parse_only=True)
    for field in form.iter_fields():
        after = field.get_display_value()
        existing_data_field = existing_data_form.fields[field.context_key]
        before = existing_data_field.get_display_value()
        if before != after:
            changes[field.get_display_label()] = {
                'before': before,
                'after': after}
    return changes