Group categories on new report form

Ensures ‘Other’ group is last in the list, if it exists.

3 files changed, 36 insertions, 9 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
index bfe8c04fc..7519434c4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@
         - Add Expand map toggle to more mobile maps.
         - Add functionality to have per-body /reports page.
         - Cobrands can disable sending of moderation emails. #1910
+        - Open311 category group support. #1923
     - Front end improvements:
         - SVG assets for core elements like button icons and map controls #1888
         - Remove unneeded 2x PNG fallback images.
diff --git a/perllib/FixMyStreet/App/Controller/Report/New.pm b/perllib/FixMyStreet/App/Controller/Report/New.pm
index 7f1de3ed4..f63b0af1e 100644
--- a/perllib/FixMyStreet/App/Controller/Report/New.pm
+++ b/perllib/FixMyStreet/App/Controller/Report/New.pm
@@ -664,7 +664,7 @@ sub setup_categories_and_bodies : Private {
         $bodies_to_list{ $contact->body_id } = $contact->body;
 
         unless ( $seen{$contact->category} ) {
-            push @category_options, { name => $contact->category, value => $contact->category_display };
+            push @category_options, { name => $contact->category, value => $contact->category_display, group => $contact->get_extra_metadata('group') || '' };
 
             my $metas = $contact->get_metadata_for_input;
             $category_extras{$contact->category} = $metas if @$metas;
@@ -682,9 +682,9 @@ sub setup_categories_and_bodies : Private {
     if (@category_options) {
         # If there's an Other category present, put it at the bottom
         @category_options = (
-            { name => _('-- Pick a category --'), value => _('-- Pick a category --') },
+            { name => _('-- Pick a category --'), value => _('-- Pick a category --'), group => '' },
             grep { $_->{name} ne _('Other') } @category_options );
-        push @category_options, { name => _('Other'), value => $seen{_('Other')} } if $seen{_('Other')};
+        push @category_options, { name => _('Other'), value => $seen{_('Other')}, group => _('Other') } if $seen{_('Other')};
     }
 
     $c->cobrand->call_hook(munge_category_list => \@category_options, \@contacts, \%category_extras);
@@ -705,6 +705,18 @@ sub setup_categories_and_bodies : Private {
 
     $c->stash->{missing_details_bodies} = \@missing_details_bodies;
     $c->stash->{missing_details_body_names} = \@missing_details_body_names;
+
+    my %category_groups = ();
+    for my $category (@category_options) {
+        push @{$category_groups{$category->{group}}}, $category;
+    }
+
+    my @category_groups = ();
+    for my $group ( grep { $_ ne _('Other') } sort keys %category_groups ) {
+        push @category_groups, { name => $group, categories => $category_groups{$group} };
+    }
+    push @category_groups, { name => _('Other'), categories => $category_groups{_('Other')} } if ($category_groups{_('Other')});
+    $c->stash->{category_groups}  = \@category_groups;
 }
 
 sub setup_report_extra_fields : Private {
diff --git a/templates/web/base/report/new/category.html b/templates/web/base/report/new/category.html
index 16f6113f2..01e0f81a6 100644
--- a/templates/web/base/report/new/category.html
+++ b/templates/web/base/report/new/category.html
@@ -1,4 +1,10 @@
-[% IF category_options.size ~%]
+[% IF category_options.size OR category_groups.size ~%]
+    [%~ BLOCK category_option ~%]
+    [% cat_op_lc = cat_op.name | lower =%]
+    <option value='[% cat_op.name | html %]'[% ' selected' IF report.category == cat_op.name || category_lc == cat_op_lc || (category_options.size == 2 AND loop.last) ~%]
+    >[% IF loop.first %][% cat_op.value %][% ELSE %][% cat_op.value | html %][% END %]</option>
+    [%~ END ~%]
+
     [% IF category;
         category_lc = category | lower;
        END; ~%]
@@ -10,10 +16,18 @@
       data-role="[% c.user.has_body_permission_to('planned_reports') ? 'inspector' : 'user'  %]" data-body="[% c.user.from_body.name %]" data-prefill="[% c.cobrand.prefill_report_fields_for_inspector %]"
     [%~ END ~%]
     >
-        [%~ FOREACH cat_op IN category_options ~%]
-        [% cat_op_lc = cat_op.name | lower =%]
-        <option value='[% cat_op.name | html %]'[% ' selected' IF report.category == cat_op.name || category_lc == cat_op_lc || (category_options.size == 2 AND loop.last) ~%]
-        >[% IF loop.first %][% cat_op.value %][% ELSE %][% cat_op.value | html %][% END %]</option>
-        [%~ END =%]
+        [%~ IF category_groups.size ~%]
+            [%~ FOREACH group IN category_groups ~%]
+                [% IF group.name %]<optgroup label="[% group.name %]">[% END %]
+                [%~ FOREACH cat_op IN group.categories ~%]
+                    [% INCLUDE category_option %]
+                [%~ END ~%]
+                [% IF group.name %]</optgroup>[% END %]
+            [%~ END =%]
+        [%~ ELSE ~%]
+            [%~ FOREACH cat_op IN category_options ~%]
+                [% INCLUDE category_option %]
+            [%~ END =%]
+        [%~ END ~%]
     </select>
 [%~ END ~%]