Remove hardcoded states from Problem model.

We keep the internal states hardcoded, plus the core open (confirmed)
and closed ones, but the remainder are moved to the database.

4 files changed, 97 insertions, 40 deletions

diff --git a/perllib/FixMyStreet/DB/Result/Problem.pm b/perllib/FixMyStreet/DB/Result/Problem.pm
index a74a04828..fcffc1e97 100644
--- a/perllib/FixMyStreet/DB/Result/Problem.pm
+++ b/perllib/FixMyStreet/DB/Result/Problem.pm
@@ -220,15 +220,8 @@ HASHREF.
 =cut
 
 sub open_states {
-    my $states = {
-        'confirmed'        => 1,
-        'investigating'    => 1,
-        'in progress'      => 1,
-        'planned'          => 1,
-        'action scheduled' => 1,
-    };
-
-    return wantarray ? keys %{$states} : $states;
+    my @states = map { $_->label } @{FixMyStreet::DB->resultset("State")->open};
+    return wantarray ? @states : { map { $_ => 1 } @states };
 }
 
 =head2
@@ -242,13 +235,9 @@ HASHREF.
 =cut
 
 sub fixed_states {
-    my $states = {
-        'fixed'           => 1,
-        'fixed - user'    => 1,
-        'fixed - council' => 1,
-    };
-
-    return wantarray ? keys %{ $states } : $states;
+    my @states = map { $_->label } @{FixMyStreet::DB->resultset("State")->fixed};
+    push @states, 'fixed - user', 'fixed - council' if @states;
+    return wantarray ? @states : { map { $_ => 1 } @states };
 }
 
 =head2
@@ -262,18 +251,10 @@ HASHREF.
 =cut
 
 sub closed_states {
-    my $states = {
-        'closed'                      => 1,
-        'unable to fix'               => 1,
-        'not responsible'             => 1,
-        'duplicate'                   => 1,
-        'internal referral'           => 1,
-    };
-
-    return wantarray ? keys %{$states} : $states;
+    my @states = map { $_->label } @{FixMyStreet::DB->resultset("State")->closed};
+    return wantarray ? @states : { map { $_ => 1 } @states };
 }
 
-
 =head2
 
     @states = FixMyStreet::DB::Problem::all_states();
@@ -289,21 +270,10 @@ sub all_states {
         'hidden'                      => 1,
         'partial'                     => 1,
         'unconfirmed'                 => 1,
-        'confirmed'                   => 1,
-        'investigating'               => 1,
-        'in progress'                 => 1,
-        'planned'                     => 1,
-        'action scheduled'            => 1,
-        'fixed'                       => 1,
         'fixed - council'             => 1,
         'fixed - user'                => 1,
-        'unable to fix'               => 1,
-        'not responsible'             => 1,
-        'duplicate'                   => 1,
-        'closed'                      => 1,
-        'internal referral'           => 1,
     };
-
+    map { $states->{$_->label} = 1 } @{FixMyStreet::DB->resultset("State")->states};
     return wantarray ? keys %{$states} : $states;
 }
 
diff --git a/perllib/FixMyStreet/DB/Result/State.pm b/perllib/FixMyStreet/DB/Result/State.pm
index 6a689d595..b8a35d42b 100644
--- a/perllib/FixMyStreet/DB/Result/State.pm
+++ b/perllib/FixMyStreet/DB/Result/State.pm
@@ -33,6 +33,16 @@ __PACKAGE__->add_unique_constraint("state_name_key", ["name"]);
 # Created by DBIx::Class::Schema::Loader v0.07035 @ 2017-08-22 15:17:43
 # DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:dvtAOpeYqEF9T3otHHgLqw
 
+use Moo;
+use namespace::clean;
+
+with 'FixMyStreet::Roles::Translatable';
+
+sub msgstr {
+    my $self = shift;
+    my $lang = $self->result_source->schema->lang;
+    return $self->name unless $lang && $self->translated->{name}{$lang};
+    return $self->translated->{name}{$lang}{msgstr};
+}
 
-# You can replace this text with custom code or comments, and it will be preserved on regeneration
 1;
diff --git a/perllib/FixMyStreet/DB/ResultSet/State.pm b/perllib/FixMyStreet/DB/ResultSet/State.pm
new file mode 100644
index 000000000..03bbb5e3b
--- /dev/null
+++ b/perllib/FixMyStreet/DB/ResultSet/State.pm
@@ -0,0 +1,77 @@
+package FixMyStreet::DB::ResultSet::State;
+use base 'DBIx::Class::ResultSet';
+
+use strict;
+use warnings;
+use Memcached;
+
+sub _hardcoded_states {
+    my $rs = shift;
+    my $open = $rs->new({ id => -1, label => 'confirmed', type => 'open', name => _("Open") });
+    my $closed = $rs->new({ id => -2, label => 'closed', type => 'closed', name => _("Closed") });
+    return ($open, $closed);
+}
+
+# As states will change rarely, and then only through the admin,
+# we cache these in the package on first use, and clear on update.
+
+sub clear {
+    Memcached::set('states', '');
+}
+
+sub states {
+    my $rs = shift;
+
+    my $states = Memcached::get('states');
+    if ($states && !FixMyStreet->test_mode) {
+        # Need to reattach schema
+        $states->[0]->result_source->schema( $rs->result_source->schema ) if $states->[0];
+        return $states;
+    }
+
+    # Pick up and cache any translations
+    my $q = $rs->result_source->schema->resultset("Translation")->search({
+        tbl => 'state',
+        col => 'name',
+    });
+    my %trans;
+    $trans{$_->object_id}{$_->lang} = { id => $_->id, msgstr => $_->msgstr } foreach $q->all;
+
+    my @states = ($rs->_hardcoded_states, $rs->search(undef, { order_by => 'label' })->all);
+    $_->translated->{name} = $trans{$_->id} || {} foreach @states;
+    $states = \@states;
+    Memcached::set('states', $states);
+    return $states;
+}
+
+# Some functions to provide filters on the above data
+
+sub open { [ $_[0]->_filter(sub { $_->type eq 'open' }) ] }
+sub closed { [ $_[0]->_filter(sub { $_->type eq 'closed' }) ] }
+sub fixed { [ $_[0]->_filter(sub { $_->type eq 'fixed' }) ] }
+
+# We sometimes have only a state label to display, no associated object.
+# This function can be used to return that label's display name.
+
+sub display {
+    my ($rs, $label) = @_;
+    my $unchanging = {
+        unconfirmed => _("Unconfirmed"),
+        hidden => _("Hidden"),
+        partial => _("Partial"),
+        'fixed - council' => _("Fixed - Council"),
+        'fixed - user' => _("Fixed - User"),
+    };
+    return $unchanging->{$label} if $unchanging->{$label};
+    my ($state) = $rs->_filter(sub { $_->label eq $label });
+    return $label unless $state;
+    return $state->msgstr;
+}
+
+sub _filter {
+    my ($rs, $fn) = @_;
+    my $states = $rs->states;
+    grep &$fn, @$states;
+}
+
+1;
diff --git a/perllib/FixMyStreet/TestAppProve.pm b/perllib/FixMyStreet/TestAppProve.pm
index f6e09fbe9..7a387547d 100644
--- a/perllib/FixMyStreet/TestAppProve.pm
+++ b/perllib/FixMyStreet/TestAppProve.pm
@@ -75,7 +75,7 @@ sub run {
         $SIG{__WARN__} =
           sub { print STDERR @_ if $_[0] !~ m/NOTICE:  CREATE TABLE/; };
         $dbh->do( path('db/schema.sql')->slurp ) or die $!;
-        $dbh->do( path('db/alert_types.sql')->slurp ) or die $!;
+        $dbh->do( path('db/fixture.sql')->slurp ) or die $!;
         $dbh->do( path('db/generate_secret.sql')->slurp ) or die $!;
         $SIG{__WARN__} = $tmpwarn;