Implement Site Tips (Closes #32)

Raku · Nov 21, 2015 · e2f4cbc · e2f4cbc
1 parent 70c9ef5
commit e2f4cbc
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 10 deletions.
diff --git a/Build.PL b/Build.PL
@@ -46,6 +46,7 @@ my $build = Module::Build->new(
           'Mojolicious::Plugin::AssetPack' => '0.68',
           'Mojolicious::Plugin::Bootstrap3' => '3.3505',
           'Moo' => '2.000002',
+          'namespace::clean' => '0.26',
           'POSIX' => 0,
           'Test::Mojo::Role::Debug' => '1.003003',
           'Test::Mojo::Role::ElementCounter' => '1.001005',

diff --git a/web/lib/ModulesPerl6.pm b/web/lib/ModulesPerl6.pm
@@ -7,8 +7,9 @@ use Mojo::Base 'Mojolicious';
 use FindBin; FindBin->again;
 use File::Spec::Functions qw/catfile/;
 use Mojo::Util qw/slurp/;
-use ModulesPerl6::Model::Dists;
 use ModulesPerl6::Model::BuildStats;
+use ModulesPerl6::Model::Dists;
+use ModulesPerl6::Model::SiteTips;
 
 sub startup {
     my $self = shift;
@@ -48,6 +49,9 @@ sub startup {
     $self->helper( build_stats => sub {
         state $stats = ModulesPerl6::Model::BuildStats->new;
     });
+    $self->helper( site_tips => sub {
+        state $tips = ModulesPerl6::Model::SiteTips->new;
+    });
     $self->helper( items_in => sub {
         my ( $c, $what ) = @_;
         return unless defined $what;

diff --git a/web/lib/ModulesPerl6/Model/SiteTips.pm b/web/lib/ModulesPerl6/Model/SiteTips.pm
@@ -9,23 +9,26 @@ use Mojo::Util               qw/trim/;
 use Moo;
 use namespace::clean;
 
-has _tips => ( is => 'rw' );
+has _tips => (
+    is      => 'lazy',
+    default => sub { shift->_load_tip_file },
+);
 
 has _tip_file => (
-    is       => 'ro',
+    is       => 'lazy',
     init_arg => 'tip_file',
     default  =>  sub {
         $ENV{MODULESPERL6_TIP_FILE}
             // catfile $FindBin::Bin, qw/.. site-tips.txt/;
     },
-    trigger => 1,
 );
 
-sub _trigger__tip_file {
-    my ( $self, $file ) = @_;
+sub _load_tip_file {
+    my $self = shift;
+    my $file = $self->_tip_file;
 
     open my $fh, '<', $file
-        or croak "Could not open site tips file for reading: $!";
+        or croak "Could not open site tips file [$file] for reading: $!";
 
     my @tips;
     while ( <$fh> ) {
@@ -34,7 +37,7 @@ sub _trigger__tip_file {
         push @tips, $_;
     }
 
-    $self->_tips( \@tips );
+    return \@tips;
 }
 
 sub tip {
@@ -65,7 +68,7 @@ This module is used to access site usage tips that are shown to users.
 
 =head1 TIP FILE FORMAT
 
-    # This is a comment and should be ignored, as are blank lines
+    # This is a comment and will be ignored, as are blank lines
 
     Tip 1
     Tip 2

diff --git a/web/site-tips.txt b/web/site-tips.txt
@@ -0,0 +1,10 @@
+# This is a comment and wil be ignored, as are blank lines
+# Each line represents a single tip
+# ********************************
+# ********************************
+# IMPORTANT: You MUST escape HTML...
+# ...that also means you can use HTML code in your tips
+# ********************************
+# ********************************
+You can link to a search query, like so: <a href="http://modules.perl6.org/#q=Test">http://modules.perl6.org/#q=Test</a>
+Go directly to a module's repository using <kbd>/repo/</kbd>: <a href="http://modules.perl6.org/repo/Pastebin::Gist">http://modules.perl6.org/repo/Pastebin::Gist</a>
diff --git a/web/t/02-app/01-home-page.t b/web/t/02-app/01-home-page.t
@@ -4,7 +4,7 @@ use strict;
 use warnings FATAL => 'all';
 use Test::Most;
 use Mojo::URL;
-use Test::Mojo::WithRoles qw/SubmitForm ElementCounter/;
+use Test::Mojo::WithRoles qw/SubmitForm  ElementCounter/;
 use t::Helper;
 
 my $db_file = t::Helper::setup_db_file;
@@ -76,6 +76,10 @@ $_->{travis_url} = Mojo::URL->new($_->{url})->host('travis-ci.org')
         ->status_is(302)
         ->header_is(Location => 'https://github.com/perl6/modules.perl6.org/')
     ;
+
+    $t->dive_reset->get_ok('/')->status_is(200)
+        ->text_like('#site_tip' => qr/^Tip \d\z/, 'Site tip has correct text');
+    ;
 }
 
 done_testing;
diff --git a/web/t/Helper.pm b/web/t/Helper.pm
@@ -7,6 +7,8 @@ use ModulesPerl6::Model::BuildStats;
 use File::Temp;
 
 sub setup_db_file {
+    $ENV{MODULESPERL6_TIP_FILE} = 't/01-models/03-site-tips-TEST-TIPS.txt';
+
     my $db_file = File::Temp->new( UNLINK => 0, SUFFIX => '.db' );
     $ENV{MODULESPERL6_DB_FILE} = $db_file;
 

diff --git a/web/templates/root/index.html.ep b/web/templates/root/index.html.ep
@@ -25,6 +25,10 @@
   </div>
 </header>
 
+<p id="site_tip" class="text-center">
+  <i class="glyphicon glyphicon-info-sign"></i> <%== site_tips->tip %>
+</p>
+
 <div class="panel panel-default">
   <div class="panel-heading">
     <h2 class="panel-title">Project List</h2>