X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FReaction%2FUI%2FView.pm;h=bdd04a2a56c4daa17b692c7baa123f74a6d8101d;hb=7b5e71adcc00ae151a7908c2cddcd7323408efc7;hp=468790b44bf57e1eefa7c622bd9992f16f7823b5;hpb=d8c7a86e24da1f2d809373e8cc15984a6fc407c4;p=catagits%2FReaction.git

diff --git a/lib/Reaction/UI/View.pm b/lib/Reaction/UI/View.pm
index 468790b..bdd04a2 100644
--- a/lib/Reaction/UI/View.pm
+++ b/lib/Reaction/UI/View.pm
@@ -5,158 +5,231 @@ use Reaction::Class;
 # declaring dependencies
 use Reaction::UI::LayoutSet;
 use Reaction::UI::RenderingContext;
+use aliased 'Reaction::UI::Skin';
+use aliased 'Path::Class::Dir';
 
-class View which {
+use namespace::clean -except => [ qw(meta) ];
 
-  has '_layout_set_cache'   => (is => 'ro', default => sub { {} });
-  has '_widget_class_cache' => (is => 'ro', default => sub { {} });
 
-  has 'app' => (is => 'ro', required => 1);
+has '_widget_cache' => (is => 'ro', default => sub { {} });
 
-  has 'skin_name' => (is => 'ro', required => 1);
+has '_layout_set_cache' => (is => 'ro', default => sub { {} });
 
-  has 'layout_set_class' => (is => 'ro', lazy_build => 1);
+has 'app' => (is => 'ro', required => 1);
 
-  has 'rendering_context_class' => (is => 'ro', lazy_build => 1);
+has 'skin_name' => (is => 'ro', required => 1, default => 'default');
 
-  implements '_build_layout_set_class' => as {
-    my ($self) = @_;
-    return $self->find_related_class('LayoutSet');
-  };
+has 'skin' => (
+  is => 'ro', lazy_build => 1,
+  handles => [ qw(create_layout_set search_path_for_type) ]
+);
 
-  implements '_build_rendering_context_class' => as {
-    my ($self) = @_;
-    return $self->find_related_class('RenderingContext');
-  };
+has 'layout_set_class' => (is => 'ro', lazy_build => 1);
 
-  implements 'COMPONENT' => as {
-    my ($class, $app, $args) = @_;
-    return $class->new(%{$args||{}}, app => $app);
-  };
+has 'rendering_context_class' => (is => 'ro', lazy_build => 1);
 
-  sub BUILD{
-    my $self = shift;
-    my $skin_name = $self->skin_name;
-    #XXX i guess we will add the path to installed reaction templates here
-    my $skin_path = $self->app->path_to('share','skin',$skin_name);
-    confess("'${skin_path}' is not a valid path for skin '${skin_name}'")
-      unless -d $skin_path;
-  }
+# default view doesn't localize
+sub localize {
+  my($self, $value) = @_;
+  return $value;
+}
 
-  implements 'render_window' => as {
-    my ($self, $window) = @_;
-    my $root_vp = $window->focus_stack->vp_head;
-    $self->render_viewport(undef, $root_vp);
-  };
-
-  implements 'render_viewport' => as {
-    my ($self, $outer_rctx, $vp) = @_;
-    my $layout_set = $self->layout_set_for($vp);
-    my $rctx = $self->create_rendering_context(
-      layouts => $layout_set,
-      outer => $outer_rctx,
-    );
-    my $widget = $self->widget_for($vp, $layout_set);
-    $widget->render($rctx);
-  };
-
-  implements 'widget_for' => as {
-    my ($self, $vp, $layout_set) = @_;
-    return $self->widget_class_for($layout_set)
-                ->new(
-                    view => $self, viewport => $vp, layout_set => $layout_set
-                  );
-  };
-
-  implements 'widget_class_for' => as {
-    my ($self, $layout_set) = @_;
-    my $base = $self->blessed;
-    my $tail = $layout_set->widget_type;
-    my $lset_name = $layout_set->name;
-    # eventually more stuff will go here i guess?
-    my $app_name = ref $self->app || $self->app;
-    my $cache = $self->_widget_class_cache;
-    return $cache->{ $lset_name } if exists $cache->{ $lset_name };
-
-    my @search_path = ($base, $app_name, 'Reaction::UI');
-    my @haystack    = map { join '::', $_, 'Widget', $tail } @search_path;
-    for my $class (@haystack){
-      #here we should throw if exits and error instead of eating the error
-      #only next when !exists
-      eval { Class::MOP::load_class($class) };
-      #$@ ? next : return  $class;
-      $@ ? next : return $cache->{ $lset_name } = $class;
-    }
-    confess "Couldn't load widget '$tail': tried: @haystack";
-  };
-
-  implements 'layout_set_for' => as {
-    my ($self, $vp) = @_;
-    #print STDERR "Getting layoutset for VP ".(ref($vp) || "SC:".$vp)."\n";
-    my $lset_name = eval { $vp->layout };
-    confess "Couldn't call layout method on \$vp arg ${vp}: $@" if $@;
-    unless (length($lset_name)) {
-      my $vp_class = ref($vp) || $vp;
-      my ($last) = ($vp_class =~ /.*(?:::ViewPort::)(.+?)$/);
-      my @fragments = split('::', $last);
-      $_ = join("_", split(/(?=[A-Z])/, $_)) for @fragments;
-      $lset_name = lc(join('/', @fragments));
-      #print STDERR "--- $vp_class is rendered as $lset_name\n";
-    }
-    my $cache = $self->_layout_set_cache;
-    return $cache->{$lset_name} ||= $self->create_layout_set($lset_name);
-  };
-
-  implements 'create_layout_set' => as {
-    my ($self, $name) = @_;
-    return $self->layout_set_class->new(
-             $self->layout_set_args_for($name),
-           );
-  };
-
-  implements 'find_related_class' => as {
-    my ($self, $rel) = @_;
-    my $own_class = ref($self) || $self;
-    confess View." is abstract, you must subclass it" if $own_class eq View;
-    foreach my $super ($own_class->meta->class_precedence_list) {
-      next if $super eq View;
-      if ($super =~ /::View::/) {
-        (my $class = $super) =~ s/::View::/::${rel}::/;
-        if (eval { Class::MOP::load_class($class) }) {
-          return $class;
-        }
+sub _build_layout_set_class {
+  my ($self) = @_;
+  return $self->find_related_class('LayoutSet');
+};
+sub _build_rendering_context_class {
+  my ($self) = @_;
+  return $self->find_related_class('RenderingContext');
+};
+sub _build_skin {
+  my ($self) = @_;
+  Skin->new(
+    name => $self->skin_name, view => $self,
+    # path_to returns a File, not a Dir. Thanks, Catalyst.
+    skin_base_dir => Dir->new($self->app->path_to('share', 'skin')),
+  );
+};
+sub COMPONENT {
+  my ($class, $app, $args) = @_;
+  return $class->new(%{$args||{}}, app => $app);
+};
+sub render_window {
+  my ($self, $window) = @_;
+  my $root_vp = $window->focus_stack->vp_head;
+  my $rctx = $self->create_rendering_context;
+  my ($widget, $args) = $self->render_viewport_args($root_vp);
+  $widget->render(widget => $rctx, $args);
+};
+sub render_viewport_args {
+  my ($self, $vp) = @_;
+  my $layout_set = $self->layout_set_for($vp);
+  my $widget = $self->widget_for($vp, $layout_set);
+  return ($widget, { viewport => $vp });
+};
+sub widget_for {
+  my ($self, $vp, $layout_set) = @_;
+  return
+    $self->_widget_cache->{$layout_set->name}
+      ||= $layout_set->widget_class
+                     ->new(
+                         view => $self, layout_set => $layout_set
+                       );
+};
+sub layout_set_for {
+  my ($self, $vp) = @_;
+  my $lset_name = eval { $vp->layout };
+  confess "Couldn't call layout method on \$vp arg ${vp}: $@" if $@;
+  $lset_name = $self->layout_set_name_from_viewport( blessed($vp) )
+    unless (length($lset_name));
+  my $cache = $self->_layout_set_cache;
+  return $cache->{$lset_name} ||= $self->create_layout_set($lset_name);
+};
+
+#XXX if it ever comes to it: this could be memoized. not bothering yet.
+sub layout_set_name_from_viewport {
+  my ($self, $class) = @_;
+  my ($last) = ($class =~ /.*(?:::ViewPort::)(.+?)$/);
+  #split when a non-uppercase letter meets an uppercase or when an
+  #uppercase letter is followed by another uppercase and then a non-uppercase
+  #FooBar = foo_bar; Foo_Bar = foo_bar; FOOBar = foo_bar; FooBAR = foo_bar
+  my @fragments = map {
+    join("_", split(/(?:(?<=[A-Z])(?=[A-Z][^_A-Z])|(?<=[^_A-Z])(?=[A-Z]))/, $_))
+  } split('::', $last);
+  return lc(join('/', @fragments));
+};
+sub layout_set_file_extension {
+  confess View." is abstract, you must subclass it";
+};
+sub find_related_class {
+  my ($self, $rel) = @_;
+  my $own_class = ref($self) || $self;
+  confess View." is abstract, you must subclass it" if $own_class eq View;
+  foreach my $super ($own_class->meta->class_precedence_list) {
+    next if $super eq View;
+    if ($super =~ /::View::/) {
+      (my $class = $super) =~ s/::View::/::${rel}::/;
+      if (eval { Class::MOP::load_class($class) }) {
+        return $class;
       }
     }
-    confess "Unable to find related ${rel} class for ${own_class}";
-  };
-
-  implements 'layout_set_args_for' => as {
-    my ($self, $name) = @_;
-    return (name => $name, search_path => $self->layout_search_path);
-  };
-
-  implements 'layout_search_path' => as {
-    my ($self) = @_;
-    return $self->search_path_for_type('layout');
-  };
-
-  implements 'search_path_for_type' => as {
-    my ($self, $type) = @_;
-    return [ $self->app->path_to('share','skin',$self->skin_name,$type) ];
-  };
-
-  implements 'create_rendering_context' => as {
-    my ($self, @args) = @_;
-    return $self->rendering_context_class->new(
-             $self->rendering_context_args_for(@args),
-             @args,
-           );
-  };
-
-  implements 'rendering_context_args_for' => as {
-    return ();
-  };
-
+  }
+  confess "Unable to find related ${rel} class for ${own_class}";
+};
+sub create_rendering_context {
+  my ($self, @args) = @_;
+  return $self->rendering_context_class->new(
+           $self->rendering_context_args_for(@args),
+           @args,
+         );
+};
+sub rendering_context_args_for {
+  return ();
+};
+sub layout_set_args_for {
+  return ();
 };
 
+__PACKAGE__->meta->make_immutable;
+
+=pod
+
+=head1 NAME
+
+Reaction::UI::View - Render the UI.
+
+=head1 SYNOPSIS
+
+  package MyApp::View::TT;
+  use base 'Reaction::UI::View::TT';
+
+  __PACKAGE__->config(
+    skin_name => 'MyApp',
+  );
+
+  ## In the Window class:
+  $res->body($self->view->render_window($self));
+
+=head1 DESCRIPTION
+
+Render the viewports in the current window using the chosen skin and
+layoutset, via the matching widgets.
+
+See also:
+
+=over
+
+=item L<Reaction::UI::Controller::Root>
+=item L<Reaction::UI::ViewPort>
+=item L<Reaction::UI::Window>
+=item L<Reaction::UI::LayoutSet>
+=item L<Reaction::UI::Widget>
+
+=back
+
+=head1 ATTRIBUTES
+
+=head2 app
+
+=over
+
+=item Arguments: $app?
+
+=back
+
+The application L<Catalyst> class. This is set at
+L<Catalyst/COMPONENT> time for you.
+
+=head2 skin_name
+
+=over
+
+=item Arguments: $skinname?
+
+=back
+
+The name of the skin to use to render the pages. This should be the
+name of a subdirectory under the F<share/skin> in your application
+directory. The default skin name is C<default>, the default skin is
+provided with Reaction.
+
+See also: L<Reaction::UI::Skin>
+
+=head2 skin
+
+=over
+
+=item Arguments: $skin?
+
+=back
+
+A L<Reaction::UI::Skin> object based on the L</skin_name>. It will be
+created for you if not provided.
+
+=head2 layout_set_class
+
+The class of the L<Reaction::UI::LayoutSet> used to layout the
+view. Defaults to searching down the precedence tree of the View class
+looking for a class of the same name with C<View> replaced with
+C<LayoutSet>.
+
+=head2 rendering_context_class
+
+The class of the L<Reaction::UI::RenderingContext> used to layout the
+view. Defaults to searching down the precedence tree of the View class
+looking for a class of the same name with C<View> replaced with
+C<RenderingContext>.
+
+=head1 METHODS
+
+=head1 AUTHORS
+
+See L<Reaction::Class> for authors.
+
+=head1 LICENSE
+
+See L<Reaction::Class> for the license.
+
+=cut
+
 1;