lib/Reaction/UI/ViewPort/Action.pm

   1 package Reaction::UI::ViewPort::Action;
   2
   3 use Reaction::Class;
   4
   5 use aliased 'Reaction::UI::ViewPort::Object';
   6
   7 BEGIN { *DEBUG_EVENTS = \&Reaction::UI::ViewPort::DEBUG_EVENTS; }
   8
   9 use aliased 'Reaction::UI::ViewPort::Field::Mutable::Text';
  10 use aliased 'Reaction::UI::ViewPort::Field::Mutable::Array';
  11 use aliased 'Reaction::UI::ViewPort::Field::Mutable::String';
  12 use aliased 'Reaction::UI::ViewPort::Field::Mutable::Number';
  13 use aliased 'Reaction::UI::ViewPort::Field::Mutable::Integer';
  14 use aliased 'Reaction::UI::ViewPort::Field::Mutable::Boolean';
  15 use aliased 'Reaction::UI::ViewPort::Field::Mutable::Password';
  16 use aliased 'Reaction::UI::ViewPort::Field::Mutable::DateTime';
  17 use aliased 'Reaction::UI::ViewPort::Field::Mutable::ChooseOne';
  18 use aliased 'Reaction::UI::ViewPort::Field::Mutable::ChooseMany';
  19
  20 use aliased 'Reaction::UI::ViewPort::Field::Mutable::File';
  21 #use aliased 'Reaction::UI::ViewPort::Field::Mutable::TimeRange';
  22
  23 class Action is Object, which {
  24   has model  => (is => 'ro', isa => 'Reaction::InterfaceModel::Action', required => 1);
  25   #has '+model' => (isa => 'Reaction::InterfaceModel::Action');
  26
  27   has next_action       => (is => 'rw', isa => 'ArrayRef');
  28   has on_apply_callback => (is => 'rw', isa => 'CodeRef');
  29
  30   has ok_label           => (is => 'rw', isa => 'Str', lazy_build => 1);
  31   has apply_label        => (is => 'rw', isa => 'Str', lazy_build => 1);
  32   has close_label        => (is => 'rw', isa => 'Str', lazy_fail  => 1);
  33   has close_label_close  => (is => 'rw', isa => 'Str', lazy_build => 1);
  34   has close_label_cancel => (is => 'rw', isa => 'Str', lazy_build => 1);
  35
  36   has changed => (is => 'rw', isa => 'Int', reader => 'is_changed', default => sub{0});
  37
  38   implements BUILD => as{
  39     my $self = shift;
  40     $self->close_label($self->close_label_close);
  41   };
  42
  43   implements _build_ok_label           => as{ 'ok'     };
  44   implements _build_apply_label        => as{ 'apply'  };
  45   implements _build_close_label_close  => as{ 'close'  };
  46   implements _build_close_label_cancel => as{ 'cancel' };
  47
  48   implements can_apply => as {
  49     my ($self) = @_;
  50     foreach my $field ( @{ $self->fields } ) {
  51       if ($field->needs_sync) {
  52         if (DEBUG_EVENTS) {
  53           $self->ctx->log->debug(
  54             "Failing out of can_apply on ${\ref($self)} at ${\$self->location}"
  55             ." because field for ${\$field->attribute->name} needs sync"
  56           );
  57         }
  58       }
  59       # if e.g. a datetime field has an invalid value that can't be re-assembled
  60       # into a datetime object, the action may be in a consistent state but
  61       # not synchronized from the fields; in this case, we must not apply
  62     }
  63     if (DEBUG_EVENTS) {
  64       my $ret = $self->model->can_apply;
  65       $self->ctx->log->debug(
  66         "model can_apply returned ${ret}"
  67         ." on ${\ref($self)} at ${\$self->location}"
  68       );
  69       return $ret;
  70     }
  71     return $self->model->can_apply;
  72   };
  73
  74   implements do_apply => as {
  75     shift->model->do_apply;
  76   };
  77
  78   implements ok => as {
  79     my $self = shift;
  80     $self->close(@_) if $self->apply(@_);
  81   };
  82
  83   implements apply => as {
  84     my $self = shift;
  85     if ($self->can_apply && (my $result = $self->do_apply)) {
  86       $self->changed(0);
  87       $self->close_label($self->close_label_close);
  88       $self->on_apply_callback->($self => $result) if $self->has_on_apply_callback;
  89       return 1;
  90     } else {
  91       $self->changed(1);
  92       $self->close_label($self->close_label_cancel);
  93       return 0;
  94     }
  95   };
  96
  97   implements close => as {
  98     my $self = shift;
  99     my ($controller, $name, @args) = @{$self->next_action};
 100     $controller->pop_viewport;
 101     $controller->$name($self->ctx, @args);
 102   };
 103
 104   implements can_close => as { 1 };
 105
 106   override accept_events => sub {
 107     (($_[0]->has_next_action ? ('ok', 'close') : ()), 'apply', super());
 108   }; # can't do a close-type operation if there's nowhere to go afterwards
 109
 110   after apply_child_events => sub {
 111     # interrupt here because fields will have been updated
 112     my ($self) = @_;
 113     $self->sync_action_from_fields;
 114   };
 115
 116   implements sync_action_from_fields => as {
 117     my ($self) = @_;
 118     foreach my $field (@{$self->fields}) {
 119       $field->sync_to_action; # get the field to populate the $action if possible
 120     }
 121     $self->model->sync_all;
 122     foreach my $field (@{$self->fields}) {
 123       $field->sync_from_action; # get errors from $action if applicable
 124     }
 125   };
 126
 127
 128   implements _build_fields_for_type_Num => as {
 129     my ($self, $attr, $args) = @_;
 130     $self->_build_simple_field(attribute => $attr, class => Number, %$args);
 131   };
 132
 133   implements _build_fields_for_type_Int => as {
 134     my ($self, $attr, $args) = @_;
 135     $self->_build_simple_field(attribute => $attr, class => Integer, %$args);
 136   };
 137
 138   implements _build_fields_for_type_Bool => as {
 139     my ($self,  $attr, $args) = @_;
 140     $self->_build_simple_field(attribute => $attr, class => Boolean, %$args);
 141   };
 142
 143   implements _build_fields_for_type_Reaction_Types_Core_SimpleStr => as {
 144     my ($self, $attr, $args) = @_;
 145     $self->_build_simple_field(attribute => $attr, class => String, %$args);
 146   };
 147
 148   implements _build_fields_for_type_File => as {
 149     my ($self, $attr, $args) = @_;
 150     $self->_build_simple_field(attribute => $attr, class => File, %$args);
 151   };
 152
 153   implements _build_fields_for_type_Str => as {
 154     my ($self, $attr, $args) = @_;
 155     if ($attr->has_valid_values) { # There's probably a better way to do this
 156       $self->_build_simple_field(attribute => $attr, class => ChooseOne, %$args);
 157     } else {
 158       $self->_build_simple_field(attribute => $attr, class => Text, %$args);
 159     }
 160   };
 161
 162   implements _build_fields_for_type_Reaction_Types_Core_Password => as {
 163     my ($self, $attr, $args) = @_;
 164     $self->_build_simple_field(attribute => $attr, class => Password, %$args);
 165   };
 166
 167   implements _build_fields_for_type_Reaction_Types_DateTime_DateTime => as {
 168     my ($self, $attr, $args) = @_;
 169     $self->_build_simple_field(attribute => $attr, class => DateTime, %$args);
 170   };
 171
 172   implements _build_fields_for_type_Enum => as {
 173     my ($self, $attr, $args) = @_;
 174       $self->_build_simple_field(attribute => $attr, class => ChooseOne, %$args);
 175   };
 176
 177   #this needs to be fixed. somehow. beats the shit our of me. really.
 178   #implements build_fields_for_type_Reaction_InterfaceModel_Object => as {
 179   implements _build_fields_for_type_DBIx_Class_Row => as {
 180     my ($self, $attr, $args) = @_;
 181     $self->_build_simple_field(attribute => $attr, class => ChooseOne, %$args);
 182   };
 183
 184   implements _build_fields_for_type_ArrayRef => as {
 185     my ($self, $attr, $args) = @_;
 186     if ($attr->has_valid_values) {
 187       $self->_build_simple_field(attribute => $attr, class => ChooseMany,  %$args);
 188     } else {
 189       $self->_build_simple_field
 190         (
 191          attribute => $attr,
 192          class     => Array,
 193          layout    => 'field/mutable/hidden_array',
 194          %$args);
 195     }
 196   };
 197
 198   #implements _build_fields_for_type_DateTime_Spanset => as {
 199   #  my ($self, $attr, $args) = @_;
 200   #    $self->_build_simple_field(attribute => $attr, class => TimeRange,  %$args);
 201   #};
 202
 203 };
 204
 205   1;
 206
 207 =head1 NAME
 208
 209 Reaction::UI::ViewPort::Action
 210
 211 =head1 SYNOPSIS
 212
 213   use aliased 'Reaction::UI::ViewPort::Action';
 214
 215   $self->push_viewport(Action,
 216     layout => 'register',
 217     model => $action,
 218     next_action => [ $self, 'redirect_to', 'accounts', $c->req->captures ],
 219     ctx => $c,
 220     field_order => [
 221       qw / contact_title company_name email address1 address2 address3
 222            city country post_code telephone mobile fax/ ],
 223   );
 224
 225 =head1 DESCRIPTION
 226
 227 This subclass of L<Reaction::UI::ViewPort::Object> is used for rendering a
 228 collection of C<Reaction::UI::ViewPort::Field::Mutable::*> objects for user editing.
 229
 230 =head1 ATTRIBUTES
 231
 232 =head2 model
 233
 234 L<Reaction::InterfaceModel::Action>
 235
 236 =head2 ok_label
 237
 238 Default: 'ok'
 239
 240 =head2 apply_label
 241
 242 Default: 'apply'
 243
 244 =head2 close_label_close
 245
 246 Default: 'close'
 247
 248 =head2 close_label_cancel
 249
 250 This label is only shown when C<changed> is true.
 251
 252 Default: 'cancel'
 253
 254 =head2 fields
 255
 256 =head2 can_apply
 257
 258 =head2 can_close
 259
 260 =head2 changed
 261
 262 Returns true if a field has been edited.
 263
 264 =head2 next_action
 265
 266 =head2 on_apply_callback
 267
 268 CodeRef.
 269
 270 =head1 METHODS
 271
 272 =head2 ok
 273
 274 Calls C<apply>, and then C<close> if successful.
 275
 276 =head2 close
 277
 278 Pop viewport and proceed to C<next_action>.
 279
 280 =head2 apply
 281
 282 Attempt to save changes and update C<changed> attribute if required.
 283
 284 =head1 SEE ALSO
 285
 286 L<Reaction::UI::ViewPort::Object>
 287
 288 L<Reaction::UI::ViewPort>
 289
 290 L<Reaction::InterfaceModel::Action>
 291
 292 =head1 AUTHORS
 293
 294 See L<Reaction::Class> for authors.
 295
 296 =head1 LICENSE
 297
 298 See L<Reaction::Class> for the license.
 299
 300 =cut