openguides-commits May 2012

openguides-commits@lists.openguides.org

1 participants
40 discussions

by svnadmin＠urchin.earth.li

Author: bob Date: 2012-05-05 10:45:05 +0100 (Sat, 05 May 2012) New Revision: 1381 Modified: trunk/Changes Log: Documented AUTOMATED_TESTING change to Build.PL in Changes Modified: trunk/Changes =================================================================== --- trunk/Changes 2012-05-05 09:00:29 UTC (rev 1380) +++ trunk/Changes 2012-05-05 09:45:05 UTC (rev 1381) @@ -21,6 +21,7 @@ Format params such as format=map work as before. Old-style URLs will automatically redirect to new-style ones. Added project metadata to Build.PL (#285). + Skip Build.PL questions if AUTOMATED_TESTING=1 (#291) Added a basic stylesheet, installed into the static_path directory. Fixed the JSON output for action=index (using a new dependency on Template::Plugin::JSON::Escape).

10 years, 10 months

r1380 - trunk

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-05 10:00:29 +0100 (Sat, 05 May 2012) New Revision: 1380 Modified: trunk/Build.PL trunk/Changes Log: Documented changes from [1378] and put correct Wiki::Toolkit version in prereqs. Modified: trunk/Build.PL =================================================================== --- trunk/Build.PL 2012-05-04 12:21:17 UTC (rev 1379) +++ trunk/Build.PL 2012-05-05 09:00:29 UTC (rev 1380) @@ -299,7 +299,7 @@ 'CGI' => '2.92', # avoid escapeHTML bug 'CGI::Carp' => 0, 'CGI::Cookie' => 0, - 'Wiki::Toolkit' => '0.77', + 'Wiki::Toolkit' => '0.80', 'Wiki::Toolkit::Feed::Atom' => 0, 'Wiki::Toolkit::Feed::RSS' => 0, 'Wiki::Toolkit::Formatter::UseMod' => 0, Modified: trunk/Changes =================================================================== --- trunk/Changes 2012-05-04 12:21:17 UTC (rev 1379) +++ trunk/Changes 2012-05-05 09:00:29 UTC (rev 1380) @@ -32,6 +32,8 @@ your wiki.conf). The preferences page now remembers what page the user got to it from, and sends them back there. + Fixed bug with recent changes display when minor edit suppressed (for + which we require version 0.80 of Wiki::Toolkit). 0.66 12 April 2012 All templates now have access to the "username" TT variable.

10 years, 10 months

r1379 - in trunk: lib t

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-04 13:21:17 +0100 (Fri, 04 May 2012) New Revision: 1379 Modified: trunk/lib/OpenGuides.pm trunk/t/47_navbar_placement.t trunk/t/49_custom_header.t trunk/t/53_show_index.t trunk/t/55_node_history.t trunk/t/82_stylesheet.t trunk/t/83_show_delete_to_admins_only.t trunk/t/84_navbar_admin.t trunk/t/90_css_category_locale_classes.t trunk/t/95_multiple_index.t Log: Omit HTTP headers in various tests in order to avoid HTML parser warnings from Test::HTML::Content (fixes #284). Modified: trunk/lib/OpenGuides.pm =================================================================== --- trunk/lib/OpenGuides.pm 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/lib/OpenGuides.pm 2012-05-04 12:21:17 UTC (rev 1379) @@ -156,6 +156,13 @@ return_output => 1, ); + # Return output as a string with HTTP headers omitted (for tests). + $guide->display_node( + id => "Calthorpe Arms", + return_output => 1, + noheaders => 1, + ); + # Or return the hash of variables that will be passed to the template # (not including those set additionally by OpenGuides::Template). $guide->display_node( @@ -176,6 +183,9 @@ (At the moment, C<return_tt_vars> acts as if the C<intercept_redirect> parameter was passed.) +The C<noheaders> parameter only takes effect if C<return_output> is true +and C<intercept_redirect> is false or omitted. + If you have specified the C<host_checker_module> option in your C<wiki.conf>, this method will attempt to call the <blacklisted_host> method of that module to determine whether the host requesting the node @@ -191,6 +201,8 @@ my ($self, %args) = @_; my $return_output = $args{return_output} || 0; my $intercept_redirect = $args{intercept_redirect}; + my $noheaders = ( $return_output && !$intercept_redirect + && $args{noheaders} ); my $version = $args{version}; my $id = $args{id} || $self->config->home_name; my $wiki = $self->wiki; @@ -212,12 +224,13 @@ if ( $is_blacklisted ) { my $output = OpenGuides::Template->output( - wiki => $self->wiki, - config => $config, - template => "blacklisted_host.tt", - vars => { - not_editable => 1, - }, + wiki => $self->wiki, + config => $config, + template => "blacklisted_host.tt", + vars => { + not_editable => 1, + }, + noheaders => $noheaders, ); return $output if $return_output; print $output; @@ -262,7 +275,7 @@ latitude => $metadata{latitude}[0], config => $config); if ($args{format} && $args{format} eq 'raw') { - print "Content-Type: text/plain\n\n"; + print "Content-Type: text/plain\n\n" unless $noheaders; print $node_data{content}; return 0; } @@ -364,20 +377,22 @@ } return %tt_vars if $args{return_tt_vars}; my $output = $self->process_template( - id => $id, - template => "home_node.tt", - tt_vars => \%tt_vars, - http_status => $http_status + id => $id, + template => "home_node.tt", + tt_vars => \%tt_vars, + http_status => $http_status, + noheaders => $noheaders, ); return $output if $return_output; print $output; } else { return %tt_vars if $args{return_tt_vars}; my $output = $self->process_template( - id => $id, - template => "node.tt", - tt_vars => \%tt_vars, - http_status => $http_status + id => $id, + template => "node.tt", + tt_vars => \%tt_vars, + http_status => $http_status, + noheaders => $noheaders, ); return $output if $return_output; print $output; @@ -644,6 +659,8 @@ Displays a form that lets the user view and set their preferences. The C<return_output> and C<return_tt_vars> parameters can be used to return the output or template variables, instead of printing the output to STDOUT. +The C<noheaders> parameter can also be used in conjunction with +C<return_output>, if you wish to omit all HTTP headers. =cut @@ -931,6 +948,13 @@ return_output => 1, ); + # Return output as a string with HTTP headers omitted (for tests). + $guide->show_index( + cat => "pubs", + return_output => 1, + noheaders => 1, + ); + # Or return the template variables (again, useful for writing tests). $guide->show_index( cat => "pubs", @@ -948,10 +972,14 @@ redirect is required, this method will fake the redirect and return the output/variables that will actually end up being viewed by the user. If instead you want to see the HTTP headers that will be printed in order to -perform the redirect, pass the C<intercept_redirect> parameter as well. The -C<intercept_redirect> parameter has no effect if no redirect is required, or -if the C<return_output>/C<return_tt_vars> parameter is omitted. +perform the redirect, pass the C<intercept_redirect> parameter as well. +The C<intercept_redirect> parameter has no effect if no redirect is required, +or if the C<return_output>/C<return_tt_vars> parameter is omitted. + +The C<noheaders> parameter only takes effect if C<return_output> is true +and C<intercept_redirect> is false or omitted. + =cut sub show_index { @@ -1181,6 +1209,10 @@ tt_vars => \%tt_vars, ); + if ( $args{return_output} && !$args{intercept_redirect} ) { + $conf{noheaders} = $args{noheaders}; + } + my $output = $self->process_template( %conf ); return $output if $args{return_output}; print $output; @@ -2464,7 +2496,8 @@ template => $args{template}, vars => $args{tt_vars}, cookies => $args{cookies}, - http_status => $args{http_status} + http_status => $args{http_status}, + noheaders => $args{noheaders}, ); if ( $args{content_type} ) { $output_conf{content_type} = $args{content_type}; Modified: trunk/t/47_navbar_placement.t =================================================================== --- trunk/t/47_navbar_placement.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/47_navbar_placement.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -24,7 +24,7 @@ my ( $config, $guide, $wiki, $cookie, $output ); # Clear out the database from any previous runs. - OpenGuides::Test::refresh_db(); +OpenGuides::Test::refresh_db(); # Make a guide. $config = OpenGuides::Test->make_basic_config; @@ -37,29 +37,17 @@ ); # Make sure navbar shows up on node display. -$output = $guide->display_node( - id => "Red Lion", - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( "Red Lion" ); Test::HTML::Content::tag_ok( $output, "div", { id => "navbar" }, "navbar included on node display" ); $config->content_above_navbar_in_html( 0 ); -$output = $guide->display_node( - id => "Red Lion", - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( "Red Lion" ); Test::HTML::Content::tag_ok( $output, "div", { id => "navbar" }, "...ditto if content_above_navbar_in_html set to 0" ); $config->content_above_navbar_in_html( 1 ); -$output = $guide->display_node( - id => "Red Lion", - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( "Red Lion" ); Test::HTML::Content::tag_ok( $output, "div", { id => "navbar" }, "...ditto if content_above_navbar_in_html set to 1" ); @@ -67,29 +55,17 @@ $config = OpenGuides::Test->make_basic_config; # get a fresh config $guide = OpenGuides->new( config => $config ); # make sure the guide sees it $config->navbar_on_home_page( 1 ); -$output = $guide->display_node( - id => $config->home_name, - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( $config->home_name ); Test::HTML::Content::tag_ok( $output, "div", { id => "navbar" }, "navbar included on home node when navbar_on_home_page switched on" ); $config->content_above_navbar_in_html( 0 ); -$output = $guide->display_node( - id => $config->home_name, - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( $config->home_name ); Test::HTML::Content::tag_ok( $output, "div", { id => "navbar" }, "...ditto if content_above_navbar_in_html set to 0" ); $config->content_above_navbar_in_html( 1 ); -$output = $guide->display_node( - id => $config->home_name, - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( $config->home_name ); Test::HTML::Content::tag_ok( $output, "div", { id => "navbar" }, "...ditto if content_above_navbar_in_html set to 1" ); @@ -97,29 +73,17 @@ $config = OpenGuides::Test->make_basic_config; # get a fresh config $guide = OpenGuides->new( config => $config ); # make sure the guide sees it $config->navbar_on_home_page( 0 ); -$output = $guide->display_node( - id => $config->home_name, - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( $config->home_name ); Test::HTML::Content::no_tag( $output, "div", { id => "navbar" }, "navbar excluded from home node when navbar_on_home_page switched off" ); $config->content_above_navbar_in_html( 0 ); -$output = $guide->display_node( - id => $config->home_name, - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( $config->home_name ); Test::HTML::Content::no_tag( $output, "div", { id => "navbar" }, "...ditto if content_above_navbar_in_html set to 0" ); $config->content_above_navbar_in_html( 1 ); -$output = $guide->display_node( - id => $config->home_name, - return_output => 1, - ); -$output =~ s/^Content-Type.*[\r\n]+//m; +$output = display_node( $config->home_name ); Test::HTML::Content::no_tag( $output, "div", { id => "navbar" }, "...ditto if content_above_navbar_in_html set to 1" ); @@ -149,3 +113,9 @@ Test::HTML::Content::tag_ok( $output, "div", { id => "navbar" }, "...ditto if content_above_navbar_in_html set to 1" ); +sub display_node { + return $guide->display_node( id => shift, + return_output => 1, + noheaders => 1, + ); +} Modified: trunk/t/49_custom_header.t =================================================================== --- trunk/t/49_custom_header.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/49_custom_header.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -52,6 +52,7 @@ my $output = $guide->display_node( id => $config->home_name, return_output => 1, + noheaders => 1, ); $output =~ s/^Content-Type.*[\r\n]+//m; Test::HTML::Content::tag_ok( $output, "meta", { name => "foo" }, Modified: trunk/t/53_show_index.t =================================================================== --- trunk/t/53_show_index.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/53_show_index.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -59,6 +59,7 @@ $guide->show_index( cat => "Alpha", return_output => 1, + noheaders => 1, ); }; is( $@, "", "->show_index doesn't die" ); @@ -205,6 +206,13 @@ SKIP: { skip "Test::HTML::Content not available", 1 unless $thc; + # Do this again to get a version without headers, so T::H::C doesn't whine. + $output = $guide->show_index( + return_output => 1, + loc => "assam", + format => "map", + noheaders => 1, + ); Test::HTML::Content::link_ok( $output, "http://example.com/wiki.cgi?action=index;loc=assam", "We have a link to the non-map version" ); Modified: trunk/t/55_node_history.t =================================================================== --- trunk/t/55_node_history.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/55_node_history.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -31,6 +31,7 @@ id => "South Croydon Station", version => 1, return_output => 1, + noheaders => 1, ); like( $output, qr'South_Croydon_Station', "node param escaped properly in links in historic view" ); Modified: trunk/t/82_stylesheet.t =================================================================== --- trunk/t/82_stylesheet.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/82_stylesheet.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -31,7 +31,8 @@ # Display it, and make sure we get the openguides-base.css in there. $config->static_url( "http://example.org/static/" ); -my $output = $guide->display_node( id => "Red Lion", return_output => 1 ); +my $output = $guide->display_node( id => "Red Lion", return_output => 1, + noheaders => 1 ); Test::HTML::Content::tag_ok( $output, "link", { rel => "stylesheet", href => "http://example.org/static/openguides-base.css" }, @@ -39,7 +40,8 @@ # Make sure the guide's own stylesheet overrides this though. $config->stylesheet_url( "http://example.com/styles.css" ); -$output = $guide->display_node( id => "Red Lion", return_output => 1 ); +$output = $guide->display_node( id => "Red Lion", return_output => 1, + noheaders => 1 ); Test::HTML::Content::no_tag( $output, "link", { rel => "stylesheet", href => "openguides-base.css" }, "...but not when one is provided" ); Modified: trunk/t/83_show_delete_to_admins_only.t =================================================================== --- trunk/t/83_show_delete_to_admins_only.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/83_show_delete_to_admins_only.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -6,7 +6,6 @@ use OpenGuides::Config; use OpenGuides::CGI; - eval { require DBD::SQLite; }; if ( $@ ) { plan skip_all => "DBD::SQLite not installed - no database to test with"; @@ -43,20 +42,19 @@ ); } - plan tests => 4; my ( $config, $guide, $wiki, $output ); # Clear out the database from any previous runs. - OpenGuides::Test::refresh_db(); +OpenGuides::Test::refresh_db(); +# Make a guide +$config = OpenGuides::Test->make_basic_config; +$config->enable_page_deletion( 1 ); +$guide = OpenGuides->new( config => $config ); - # Make a guide - $config = OpenGuides::Test->make_basic_config; -$config->enable_page_deletion( 1 ); - $guide = OpenGuides->new( config => $config ); - # set is_admin to 1 +# set is_admin to 1 my $cookie = OpenGuides::CGI->make_prefs_cookie( config => $config, username => "bob", @@ -75,23 +73,25 @@ node => "Test Page", ); - $output = $guide->display_node( - return_output => 1, - id => "Test Page", - ); +$output = $guide->display_node( + return_output => 1, + noheaders => 1, + id => "Test Page", + ); + # check delete link is shown in footer - Test::HTML::Content::tag_ok( $output, "div", { id => "footer_delete_link" }, - "delete link in footer for admin" ); +Test::HTML::Content::tag_ok( $output, "div", { id => "footer_delete_link" }, + "delete link in footer for admin" ); - $output = $guide->list_all_versions( - return_output => 1, - id => "Test Page", - ); - like( $output, qr/version=1;action=delete/, - "delete links on history page"); +$output = $guide->list_all_versions( + return_output => 1, + id => "Test Page", + ); +like( $output, qr/version=1;action=delete/, + "delete links on history page" ); # set is_admin to 0 - $cookie = OpenGuides::CGI->make_prefs_cookie( +$cookie = OpenGuides::CGI->make_prefs_cookie( config => $config, username => "bob", include_geocache_link => 1, @@ -105,16 +105,18 @@ ); $ENV{HTTP_COOKIE} = $cookie; - $output = $guide->display_node( - return_output => 1, - id => "Test Page", - ); +$output = $guide->display_node( + return_output => 1, + noheaders => 1, + id => "Test Page", + ); + # check that the delete link in footer isnt shown - Test::HTML::Content::no_tag( $output, "div", { id => "footer_delete_link" }, - "delete link in footer not shown"); - $output = $guide->list_all_versions( - return_output => 1, - id => "Test Page", - ); - unlike( $output, qr/version=1;action=delete/, - "no delete links on history page"); +Test::HTML::Content::no_tag( $output, "div", { id => "footer_delete_link" }, + "delete link in footer not shown"); +$output = $guide->list_all_versions( + return_output => 1, + id => "Test Page", + ); +unlike( $output, qr/version=1;action=delete/, + "no delete links on history page"); Modified: trunk/t/84_navbar_admin.t =================================================================== --- trunk/t/84_navbar_admin.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/84_navbar_admin.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -6,7 +6,6 @@ use OpenGuides::Config; use OpenGuides::CGI; - eval { require DBD::SQLite; }; if ( $@ ) { plan skip_all => "DBD::SQLite not installed - no database to test with"; @@ -43,19 +42,18 @@ ); } - plan tests => 2; my ( $config, $guide, $wiki, $output ); # Clear out the database from any previous runs. - OpenGuides::Test::refresh_db(); +OpenGuides::Test::refresh_db(); +# Make a guide +$config = OpenGuides::Test->make_basic_config; +$guide = OpenGuides->new( config => $config ); - # Make a guide - $config = OpenGuides::Test->make_basic_config; - $guide = OpenGuides->new( config => $config ); - # set is_admin to 1 +# set is_admin to 1 my $cookie = OpenGuides::CGI->make_prefs_cookie( config => $config, username => "bob", @@ -74,15 +72,18 @@ node => "Test Page", ); - $output = $guide->display_node( - return_output => 1, - id => "Test Page", - ); +$output = $guide->display_node( + return_output => 1, + noheaders => 1, + id => "Test Page", + ); + # check navbar_admin div is shown. - Test::HTML::Content::tag_ok( $output, "div", { id => "navbar_admin" }, - "admin section displayed in navbar" ); +Test::HTML::Content::tag_ok( $output, "div", { id => "navbar_admin" }, + "admin section displayed in navbar" ); + # set is_admin to 0 - $cookie = OpenGuides::CGI->make_prefs_cookie( +$cookie = OpenGuides::CGI->make_prefs_cookie( config => $config, username => "bob", include_geocache_link => 1, @@ -96,10 +97,12 @@ ); $ENV{HTTP_COOKIE} = $cookie; - $output = $guide->display_node( - return_output => 1, - id => "Test Page", - ); +$output = $guide->display_node( + return_output => 1, + noheaders => 1, + id => "Test Page", + ); + # check that the navbar_admin div isnt shown - Test::HTML::Content::no_tag( $output, "div", { id => "navbar_admin" }, - "navbar not shown"); +Test::HTML::Content::no_tag( $output, "div", { id => "navbar_admin" }, + "navbar not shown" ); Modified: trunk/t/90_css_category_locale_classes.t =================================================================== --- trunk/t/90_css_category_locale_classes.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/90_css_category_locale_classes.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -34,7 +34,8 @@ return_output => 1, ); -my $output = $guide->display_node( id => "Crown", return_output => 1 ); +my $output = $guide->display_node( id => "Crown", return_output => 1, + noheaders => 1 ); Test::HTML::Content::tag_ok( $output, "div", { id => "content", class => "cat_pubs loc_cornmarket" }, "Node in one locale and one category has CSS classes for both." ); @@ -47,7 +48,8 @@ locales => "Magdalen Street", return_output => 1, ); -$output = $guide->display_node( id => "Debenhams", return_output => 1 ); +$output = $guide->display_node( id => "Debenhams", return_output => 1, + noheaders => 1 ); Test::HTML::Content::tag_ok( $output, "div", { id => "content", class => "cat_baby_changing loc_magdalen_street" }, "...and spaces in locale/category names are replaced by underscores." ); Modified: trunk/t/95_multiple_index.t =================================================================== --- trunk/t/95_multiple_index.t 2012-05-04 10:31:33 UTC (rev 1378) +++ trunk/t/95_multiple_index.t 2012-05-04 12:21:17 UTC (rev 1379) @@ -54,7 +54,8 @@ my %tt_vars = $guide->show_index( cat => "pubs", return_tt_vars => 1 ); is( scalar @{$tt_vars{nodes}}, 2, "Right number of nodes returned in pure category search" ); -my $output = $guide->show_index( cat => "pubs", return_output => 1 ); +my $output = $guide->show_index( cat => "pubs", return_output => 1, + noheaders => 1 ); Test::HTML::Content::title_ok( $output, "Index of Category Pubs - Test", "...and page title is correct" ); Test::HTML::Content::link_ok( $output, $config->script_name . "?Category_Pubs", @@ -63,7 +64,8 @@ %tt_vars = $guide->show_index( loc => "waddon", return_tt_vars => 1 ); is( scalar @{$tt_vars{nodes}}, 2, "Right number of nodes returned in pure locale search" ); -$output = $guide->show_index( loc => "waddon", return_output => 1 ); +$output = $guide->show_index( loc => "waddon", return_output => 1, + noheaders => 1 ); Test::HTML::Content::title_ok( $output, "Index of Locale Waddon - Test", "...and page title is correct" ); Test::HTML::Content::link_ok( $output, $config->script_name . "?Locale_Waddon", @@ -74,7 +76,7 @@ is( scalar @{$tt_vars{nodes}}, 1, "Right number of nodes returned in category+locale search" ); $output = $guide->show_index( cat => "pubs", loc => "waddon", - return_output => 1 ); + return_output => 1, noheaders => 1 ); Test::HTML::Content::title_ok( $output, "Index of Category Pubs and Locale Waddon - Test", "...and page title is correct" ); @@ -90,7 +92,7 @@ is( scalar @{$tt_vars{nodes}}, 1, "Right number of nodes returned in category+locale search with map" ); $output = $guide->show_index( cat => "pubs", loc => "waddon", format => "map", - return_output => 1 ); + return_output => 1, noheaders => 1 ); Test::HTML::Content::title_ok( $output, "Map of Category Pubs and Locale Waddon - Test", "...and page title is correct" ); @@ -108,11 +110,9 @@ # Test the JSON version. $output = $guide->show_index( cat => "pubs", loc => "waddon", format => "json", - return_output => 1 ); + return_output => 1, noheaders => 1 ); unlike( $output, qr/error/i, "JSON format invocation doesn't cause error." ); -# Need to strip out the Content-Type: header or the decoder gets confused. -$output =~ s/^Content-Type:.*\n//s; my $parsed = eval { local $SIG{__WARN__} = sub { die $_[0]; }; decode_json( $output );

10 years, 10 months

r1378 - in trunk: lib t

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-04 11:31:33 +0100 (Fri, 04 May 2012) New Revision: 1378 Modified: trunk/lib/OpenGuides.pm trunk/t/86_recent_changes.t trunk/t/87_more_recent_changes.t trunk/t/88_recent_changes_overtime.t Log: Made recent changes work properly when minor edits not shown (fixes #270). Modified: trunk/lib/OpenGuides.pm =================================================================== --- trunk/lib/OpenGuides.pm 2012-05-02 18:24:58 UTC (rev 1377) +++ trunk/lib/OpenGuides.pm 2012-05-04 10:31:33 UTC (rev 1378) @@ -694,8 +694,10 @@ my $id = $args{id} || $self->config->home_name; my $return_output = $args{return_output} || 0; my (%tt_vars, %recent_changes); + # NB the $q stuff below should be removed - we should _always_ do this via + # an argument to the method. my $q = CGI->new; - my $since = $q->param("since"); + my $since = $args{since} || $q->param("since"); if ( $since ) { $tt_vars{since} = $since; my $t = localtime($since); # overloaded by Time::Piece @@ -703,60 +705,31 @@ my %criteria = ( since => $since ); $criteria{metadata_was} = { edit_type => "Normal edit" } unless $minor_edits; - my @rc = $self->{wiki}->list_recent_changes( %criteria ); - - my $base_url = $config->script_name . '?'; - - @rc = map { - { - name => CGI->escapeHTML($_->{name}), - last_modified => CGI->escapeHTML($_->{last_modified}), - version => CGI->escapeHTML($_->{version}), - comment => OpenGuides::Utils::parse_change_comment( - CGI->escapeHTML($_->{metadata}{comment}[0]), - $base_url, - ), - username => CGI->escapeHTML($_->{metadata}{username}[0]), - host => CGI->escapeHTML($_->{metadata}{host}[0]), - username_param => CGI->escape($_->{metadata}{username}[0]), - edit_type => CGI->escapeHTML($_->{metadata}{edit_type}[0]), - url => $base_url - . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name})), - } - } @rc; + my @rc = $self->_get_recent_changes( + config => $config, criteria => \%criteria ); if ( scalar @rc ) { $recent_changes{since} = \@rc; } } else { + # Look at day, week, fortnight, month separately, but make sure things + # don't appear in e.g. "week" if we've already seen them in "day". + my %seen; for my $days ( [0, 1], [1, 7], [7, 14], [14, 30] ) { my %criteria = ( between_days => $days ); $criteria{metadata_was} = { edit_type => "Normal edit" } unless $minor_edits; - my @rc = $self->{wiki}->list_recent_changes( %criteria ); - - my $base_url = $config->script_name . '?'; - - @rc = map { - { - name => CGI->escapeHTML($_->{name}), - last_modified => CGI->escapeHTML($_->{last_modified}), - version => CGI->escapeHTML($_->{version}), - comment => OpenGuides::Utils::parse_change_comment( - CGI->escapeHTML($_->{metadata}{comment}[0]), - $base_url, - ), - username => CGI->escapeHTML($_->{metadata}{username}[0]), - host => CGI->escapeHTML($_->{metadata}{host}[0]), - username_param => CGI->escape($_->{metadata}{username}[0]), - edit_type => CGI->escapeHTML($_->{metadata}{edit_type}[0]), - url => $base_url - . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name})), + my @rc = $self->_get_recent_changes( + config => $config, criteria => \%criteria ); + my @filtered; + foreach my $node ( @rc ) { + next if $seen{$node->{name}}; + $seen{$node->{name}}++; + push @filtered, $node; + } + if ( scalar @filtered ) { + $recent_changes{$days->[1]} = \@filtered; + } } - } @rc; - if ( scalar @rc ) { - $recent_changes{$days->[1]} = \@rc; - } - } } $tt_vars{not_editable} = 1; $tt_vars{recent_changes} = \%recent_changes; @@ -777,6 +750,49 @@ print $output; } +sub _get_recent_changes { + my ( $self, %args ) = @_; + my $wiki = $self->wiki; + my $formatter = $wiki->formatter; + my $config = $self->config; + my %criteria = %{ $args{criteria} }; + + my @rc = $wiki->list_recent_changes( %criteria ); + my $base_url = $config->script_name . '?'; + + # If using metadata_was then we need to pick out just the most recent + # versions. + if ( $criteria{metadata_was} ) { + my %seen; + my @filtered; + foreach my $node ( @rc ) { + next if $seen{$node->{name}}; + $seen{$node->{name}}++; + push @filtered, $node; + } + @rc = @filtered; + } + + @rc = map { + { + name => CGI->escapeHTML($_->{name}), + last_modified => CGI->escapeHTML($_->{last_modified}), + version => CGI->escapeHTML($_->{version}), + comment => OpenGuides::Utils::parse_change_comment( + CGI->escapeHTML($_->{metadata}{comment}[0]), + $base_url, + ), + username => CGI->escapeHTML($_->{metadata}{username}[0]), + host => CGI->escapeHTML($_->{metadata}{host}[0]), + username_param => CGI->escape($_->{metadata}{username}[0]), + edit_type => CGI->escapeHTML($_->{metadata}{edit_type}[0]), + url => $base_url + . CGI->escape($formatter->node_name_to_node_param($_->{name})), + } + } @rc; + return @rc; +} + =item B<display_diffs> $guide->display_diffs( Modified: trunk/t/86_recent_changes.t =================================================================== --- trunk/t/86_recent_changes.t 2012-05-02 18:24:58 UTC (rev 1377) +++ trunk/t/86_recent_changes.t 2012-05-04 10:31:33 UTC (rev 1378) @@ -1,170 +1,130 @@ use strict; -use Wiki::Toolkit::Setup::SQLite; -use OpenGuides::Config; use OpenGuides; -use OpenGuides::Feed; -use OpenGuides::Utils; use OpenGuides::Test; use Test::More; -use OpenGuides::CGI; +use Time::Piece; +use Time::Seconds; +use Wiki::Toolkit::Store::Database; - eval { require DBD::SQLite; }; if ( $@ ) { my ($error) = $@ =~ /^(.*?)\n/; plan skip_all => "DBD::SQLite could not be used - no database to test with. ($error)"; } -eval { require Wiki::Toolkit::Search::Plucene; }; -if ( $@ ) { - plan skip_all => "Plucene not installed"; -} +plan tests => 16; - -plan tests => 14; - OpenGuides::Test::refresh_db(); - -my $config = OpenGuides::Config->new( - vars => { - dbtype => "sqlite", - dbname => "t/node.db", - indexing_directory => "t/indexes", - script_name => "wiki.cgi", - script_url => "http://example.com/", - site_name => "Test Site", - template_path => "./templates", - home_name => "Home", - use_plucene => 1 - } -); - -# Basic sanity check first. -my $wiki = OpenGuides::Utils->make_wiki_object( config => $config ); - -my $feed = OpenGuides::Feed->new( wiki => $wiki, - config => $config ); - - -# Write the first version +my $config = OpenGuides::Test->make_basic_config; my $guide = OpenGuides->new( config => $config ); - -# Set up CGI parameters ready for a node write. -my $q = OpenGuides::Test->make_cgi_object( - content => "foo", - username => "bob", - comment => "First edit", - node_image => "image", - edit_type => "Normal edit", -); +my $wiki = $guide->wiki; -my $output = $guide->commit_node( - return_output => 1, - id => "Wombats", - cgi_obj => $q, - ); +# Set things up so that we have the following nodes and edit types. All +# nodes added 11 days ago. +# - Red Lion, edited 9 days ago (normal), 3 days ago (normal) and today (minor) +# - Blue Lion, edited 7 days ago (minor), 5 days ago (normal) & today (minor) +setup_pages(); -# Check we have it -ok( $wiki->node_exists( "Wombats" ), "Wombats written" ); +# Check all went in OK. +my %red = $wiki->retrieve_node( "Red Lion" ); +my %blue = $wiki->retrieve_node( "Blue Lion" ); +ok( $wiki->node_exists( "Red Lion" ), "Red Lion written." ); +ok( $wiki->node_exists( "Blue Lion" ), "Blue Lion written." ); +is( $red{version}, 4, "Correct Red version." ); +is( $blue{version}, 4, "Correct Blue version." ); -my %node = $wiki->retrieve_node("Wombats"); -is( $node{version}, 1, "First version" ); +# Check recent changes output when minor edits switched on. +my $cookie = OpenGuides::CGI->make_prefs_cookie( config => $config, + show_minor_edits_in_rc => 1 ); +$ENV{HTTP_COOKIE} = $cookie; +# First check default display. +my %tt_vars = $guide->display_recent_changes( return_tt_vars => 1 ); +my @nodes = extract_nodes( %tt_vars ); +my @names_vers = sort map { "$_->{name} (v$_->{version})" } @nodes; +is_deeply( \@names_vers, [ "Blue Lion (v4)", "Red Lion (v4)" ], + "With minor edits: nodes returned only once however many times changed." ); +diag( "Found: " . join( ", ", @names_vers ) ); -# Now write a second version of it -$q->param( -name => "edit_type", -value => "Normal edit" ); -$q->param( -name => "checksum", -value => $node{checksum} ); -$q->param( -name => "comment", -value => "Second edit" ); -$output = $guide->commit_node( - return_output => 1, - id => "Wombats", - cgi_obj => $q, - ); +# Should see the same thing for past 10 days. +my $now = localtime; # overloaded by Time::Piece +my $tendays = $now - ( ONE_DAY * 10 ); +%tt_vars = $guide->display_recent_changes( return_tt_vars => 1, + since => $tendays->epoch ); +@nodes = extract_nodes( %tt_vars ); +@names_vers = sort map { "$_->{name} (v$_->{version})" } @nodes; +is_deeply( \@names_vers, [ "Blue Lion (v4)", "Red Lion (v4)" ], + "...same result when looking at past 10 days" ); +diag( "Found: " . join( ", ", @names_vers ) ); -# Check it's as expected -%node = $wiki->retrieve_node("Wombats"); -is( $node{version}, 2, "First version" ); -is( $node{metadata}->{edit_type}[0], "Normal edit", "Right edit type" ); +# Check last day (both nodes edited minorly today, should show up). +my $yesterday = $now - ONE_DAY; +%tt_vars = $guide->display_recent_changes( return_tt_vars => 1, + since => $yesterday->epoch ); +@nodes = extract_nodes( %tt_vars ); +@names_vers = sort map { "$_->{name} (v$_->{version})" } @nodes; +is_deeply( \@names_vers, [ "Blue Lion (v4)", "Red Lion (v4)" ], + "...and both nodes included when we look at past day." ); +diag( "Found: " . join( ", ", @names_vers ) ); -# Now try to commit some invalid data, and make sure we get an edit form back -$q = OpenGuides::Test->make_cgi_object( - content => "foo", - os_x => "fooooo", - username => "bob", - comment => "bar", - node_image => "image", - edit_type => "Minor tidying" -); +# Check last 4 days (again, both should show up since this is minor edits, +# but they should only show up once). +my $fourdays = $now - ( ONE_DAY * 4 ); +%tt_vars = $guide->display_recent_changes( return_tt_vars => 1, + since => $fourdays->epoch ); +@nodes = extract_nodes( %tt_vars ); +@names_vers = sort map { "$_->{name} (v$_->{version})" } @nodes; +is_deeply( \@names_vers, [ "Blue Lion (v4)", "Red Lion (v4)" ], + "...and past 4 days" ); +diag( "Found: " . join( ", ", @names_vers ) ); -$output = $guide->commit_node( - return_output => 1, - id => "Wombats again", - cgi_obj => $q, - ); - -like( $output, qr/Your input was invalid/, - "Edit form displayed and invalid input message shown if invalid input" ); - -like( $output, qr/os_x must be integer/, - "Edit form displayed and os_x integer message displayed" ); - -my @nodes = $wiki->list_recent_changes( days => 1 ); - is( scalar @nodes, 1, - "By default each node returned only once however many times changed" ); - @nodes = $wiki->list_recent_changes( days => 1, include_all_changes => 1 ); - is( scalar @nodes, 2, - "...returned more than once when 'include_all_changes' set" ); - -# when minor_edits = 1 - -my $cookie = OpenGuides::CGI->make_prefs_cookie( - config => $config, - username => "bob", - include_geocache_link => 1, - preview_above_edit_box => 1, - omit_help_links => 1, - show_minor_edits_in_rc => 1, - default_edit_type => "tidying", - cookie_expires => "never", - track_recent_changes_views => 1, - is_admin => 1, -); -$output = $guide->display_recent_changes( return_output => 1 ); - -unlike ($output, qr/First edit/, "showing a page edit twice when show minor edits enabled. "); - - -# set show_minor_edits to 0. - $cookie = OpenGuides::CGI->make_prefs_cookie( - config => $config, - username => "bob", - include_geocache_link => 1, - preview_above_edit_box => 1, - omit_help_links => 1, - show_minor_edits_in_rc => 0, - default_edit_type => "tidying", - cookie_expires => "never", - track_recent_changes_views => 1, - is_admin => 1, -); +# Now test with minor edits switched off. +$cookie = OpenGuides::CGI->make_prefs_cookie( config => $config, + show_minor_edits_in_rc => 0 ); $ENV{HTTP_COOKIE} = $cookie; +# First check default display. +%tt_vars = $guide->display_recent_changes( return_tt_vars => 1 ); +@nodes = extract_nodes( %tt_vars ); +@names_vers = sort map { "$_->{name} (v$_->{version})" } @nodes; +is_deeply( \@names_vers, [ "Blue Lion (v3)", "Red Lion (v3)" ], + "Without minor edits: node returned only once however many times changed." ); +diag( "Found: " . join( ", ", @names_vers ) ); +# Should see the same thing for past 10 days. +%tt_vars = $guide->display_recent_changes( return_tt_vars => 1, + since => $tendays->epoch ); +@nodes = extract_nodes( %tt_vars ); +@names_vers = sort map { "$_->{name} (v$_->{version})" } @nodes; +is_deeply( \@names_vers, [ "Blue Lion (v3)", "Red Lion (v3)" ], + "...same result when looking at past 10 days" ); +diag( "Found: " . join( ", ", @names_vers ) ); -$output = $guide->display_recent_changes( return_output => 1 ); +# Check last day (last normal edit 3 days ago - nothing should show up). +%tt_vars = $guide->display_recent_changes( return_tt_vars => 1, + since => $yesterday->epoch ); +@nodes = extract_nodes( %tt_vars ); +@names_vers = sort map { "$_->{name} (v$_->{version})" } @nodes; +ok( scalar @nodes == 0, + "...and nothing returned when no recent normal edits." ); +diag( "Found: " . join( ", ", @names_vers ) ); -TODO: { - local $TODO = "http://dev.openguides.org/ticket/270"; - unlike ($output, qr/First edit/, "showing a page edit twice when not showing minor edits"); -} +# Check last 4 days (should only see one normal edit, for Red Lion). +%tt_vars = $guide->display_recent_changes( return_tt_vars => 1, + since => $fourdays->epoch ); +@nodes = extract_nodes( %tt_vars ); +@names_vers = sort map { "$_->{name} (v$_->{version})" } @nodes; +is_deeply( \@names_vers, [ "Red Lion (v3)" ], + "...and only normally-edited nodes returned for past 4 days" ); +diag( "Found: " . join( ", ", @names_vers ) ); # Now write a node that will Auto Create a locale, and check the # Recent Changes output with minor edits and admin links switched on. # We can't use OG::Test->write_data() for this, because it calls # make_cgi_object(), which overwrites REMOTE_ADDR (and we want to test # output of IP address). -$q = OpenGuides::Test->make_cgi_object(); +my $q = OpenGuides::Test->make_cgi_object(); $q->param( -name => "username", -value => "Anonymous" ); $q->param( -name => "locales", -value => "London" ); my $test_host = "198.51.100.255"; @@ -172,7 +132,7 @@ $guide->commit_node( id => "A Pub", cgi_obj => $q, return_output => 1 ); $ENV{HTTP_COOKIE} = OpenGuides::CGI->make_prefs_cookie( config => $config, show_minor_edits_in_rc => 1, is_admin => 1 ); -$output = $guide->display_recent_changes( return_output => 1 ); +my $output = $guide->display_recent_changes( return_output => 1 ); like( $output, qr|Auto\s+Create|, "Auto Create stuff shown on Recent Changes." ); unlike( $output, qr|host=;action=userstats|, @@ -190,3 +150,76 @@ like( $output, qr|$test_host|, "...also when admin links switched off" ); +sub setup_pages { + # We write directly to the database because that way we can fake the pages + # having been written in the past. Copied from test 062 in Wiki::Toolkit. + my $dbh = $wiki->store->dbh; + my $content_sth = $dbh->prepare( "INSERT INTO content + (node_id,version,text,modified) + VALUES (?,?,?,?)"); + my $node_sth = $dbh->prepare( "INSERT INTO node + (id,name,version,text,modified) + VALUES (?,?,?,?,?)"); + my $md_sth = $dbh->prepare( "INSERT INTO metadata + (node_id,version,metadata_type,metadata_value) + VALUES (?,?,?,?)"); + + # Red Lion first. + $node_sth->execute( 10, "Red Lion", 3, "red 2", + get_timestamp( days => 3 ) ) + or die $dbh->errstr; + $content_sth->execute( 10, 3, "red 3", get_timestamp( days => 3 ) ) + or die $dbh->errstr; + $content_sth->execute( 10, 2, "red 2", get_timestamp( days => 9 ) ) + or die $dbh->errstr; + $content_sth->execute( 10, 1, "red 1", get_timestamp( days => 11 ) ) + or die $dbh->errstr; + $md_sth->execute( 10, 3, "edit_type", "Normal edit" ); + $md_sth->execute( 10, 2, "edit_type", "Normal edit" ); + $md_sth->execute( 10, 1, "edit_type", "Normal edit" ); + $md_sth->execute( 10, 3, "comment", "Third red edit." ); + $md_sth->execute( 10, 2, "comment", "Second red edit." ); + $md_sth->execute( 10, 1, "comment", "First red edit." ); + + # Now write it as per usual. + OpenGuides::Test->write_data( guide => $guide, node => "Red Lion", + content => "red 4", edit_type => "Minor tidying", + comment => "Fourth red edit.", return_output => 1 ); + + # Now Blue Lion. + $node_sth->execute( 20, "Blue Lion", 3, "blue 3", + get_timestamp( days => 5 ) ) + or die $dbh->errstr; + $content_sth->execute( 20, 3, "blue 3", get_timestamp( days => 5 ) ) + or die $dbh->errstr; + $content_sth->execute( 20, 2, "blue 2", get_timestamp( days => 7 ) ) + or die $dbh->errstr; + $content_sth->execute( 20, 1, "blue 1", get_timestamp( days => 11 ) ) + or die $dbh->errstr; + $md_sth->execute( 20, 3, "edit_type", "Normal edit" ); + $md_sth->execute( 20, 2, "edit_type", "Minor tidying" ); + $md_sth->execute( 20, 1, "edit_type", "Normal edit" ); + $md_sth->execute( 20, 3, "comment", "Third blue edit." ); + $md_sth->execute( 20, 2, "comment", "Second blue edit." ); + $md_sth->execute( 20, 1, "comment", "First blue edit." ); + + # Now write it as per usual. + OpenGuides::Test->write_data( guide => $guide, node => "Blue Lion", + content => "blue 4", edit_type => "Minor tidying", + comment => "Fourth blue edit.", return_output => 1); +} + +sub get_timestamp { + my %args = @_; + my $days = $args{days}; + my $now = localtime; # overloaded by Time::Piece + my $time = $now - ( $days * ONE_DAY ); + return Wiki::Toolkit::Store::Database->_get_timestamp( $time ); +} + +sub extract_nodes { + my %tt_vars = @_; + my %rc = %{$tt_vars{recent_changes} }; + return @{ $rc{1} || [] }, @{ $rc{7} || [] }, @{ $rc{14} || [] }, + @{ $rc{since} || [] }; +} Modified: trunk/t/87_more_recent_changes.t =================================================================== --- trunk/t/87_more_recent_changes.t 2012-05-02 18:24:58 UTC (rev 1377) +++ trunk/t/87_more_recent_changes.t 2012-05-04 10:31:33 UTC (rev 1378) @@ -149,12 +149,8 @@ ); $ENV{HTTP_COOKIE} = $cookie; - -TODO: { - local $TODO = "http://dev.openguides.org/ticket/270"; $output = $guide->display_recent_changes( return_output => 1 ); like ($output, qr/<td class="recentchanges_node_name">/, "expecting a table defintion for an edit"); like ($output, qr/Second edit/, "expecting at least one edit"); unlike ($output, qr/First edit/, "showing a page edit twice when not showing minor edits"); unlike ($output, qr/Third edit/, "showing a page edit twice when not showing minor edits"); -} Modified: trunk/t/88_recent_changes_overtime.t =================================================================== --- trunk/t/88_recent_changes_overtime.t 2012-05-02 18:24:58 UTC (rev 1377) +++ trunk/t/88_recent_changes_overtime.t 2012-05-04 10:31:33 UTC (rev 1378) @@ -153,10 +153,7 @@ $output = $guide->display_recent_changes( return_output => 1 ); # check recent changes renders properly like ($output, qr/24 hours/, "pages changed in the last 24 hours"); -TODO: { - local $TODO = "http://dev.openguides.org/ticket/270"; unlike ($output, qr/Echidnas rock/, "not showing multiple edits"); -} like ($output, qr/last week/, "edits in the last week"); like ($output, qr/last fortnight/, "edits in the last fornight"); unlike ($output, qr/last 30 days/, "no edits in the last 30 days");

10 years, 10 months

r1377 - in trunk: . lib t templates

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-02 19:24:58 +0100 (Wed, 02 May 2012) New Revision: 1377 Modified: trunk/Changes trunk/lib/OpenGuides.pm trunk/preferences.cgi trunk/t/59_preferences.t trunk/templates/preferences.tt Log: Made the prefs page return the user to the place they came from (fixes #94). Still need to move this from preferences.cgi into OpenGuides.pm and write some tests for it. Modified: trunk/Changes =================================================================== --- trunk/Changes 2012-05-02 17:10:39 UTC (rev 1376) +++ trunk/Changes 2012-05-02 18:24:58 UTC (rev 1377) @@ -30,6 +30,8 @@ Website truncation on node display is now a little more intelligent (you can still tweak this by setting website_link_max_chars in your wiki.conf). + The preferences page now remembers what page the user got to it from, + and sends them back there. 0.66 12 April 2012 All templates now have access to the "username" TT variable. Modified: trunk/lib/OpenGuides.pm =================================================================== --- trunk/lib/OpenGuides.pm 2012-05-02 17:10:39 UTC (rev 1376) +++ trunk/lib/OpenGuides.pm 2012-05-02 18:24:58 UTC (rev 1377) @@ -652,15 +652,25 @@ my $config = $self->config; my $wiki = $self->wiki; + my $from = $ENV{HTTP_REFERER} || ""; + my $url_base = $config->script_url . $config->script_name; + if ( $from !~ /^$url_base/ ) { + $from = ""; + } + + my %tt_vars = ( + not_editable => 1, + show_form => 1, + not_deletable => 1, + return_to_url => $from, + ); + return %tt_vars if $args{return_tt_vars}; + my $output = OpenGuides::Template->output( wiki => $wiki, config => $config, template => "preferences.tt", - vars => { - not_editable => 1, - show_form => 1, - not_deletable => 1, - }, + vars => \%tt_vars, noheaders => $args{noheaders}, ); return $output if $args{return_output}; Modified: trunk/preferences.cgi =================================================================== --- trunk/preferences.cgi 2012-05-02 17:10:39 UTC (rev 1376) +++ trunk/preferences.cgi 2012-05-02 18:24:58 UTC (rev 1377) @@ -57,6 +57,7 @@ not_editable => 1, not_deletable => 1, username => $prefs{username}, + return_to_url => $cgi->param( "return_to_url" ) || "", } ); } Modified: trunk/t/59_preferences.t =================================================================== --- trunk/t/59_preferences.t 2012-05-02 17:10:39 UTC (rev 1376) +++ trunk/t/59_preferences.t 2012-05-02 18:24:58 UTC (rev 1377) @@ -17,7 +17,7 @@ exit 0; } -plan tests => 12; +plan tests => 17; OpenGuides::Test::refresh_db(); @@ -25,6 +25,34 @@ my $guide = OpenGuides->new( config => $config ); my $wiki = $guide->wiki; +# Make sure "return_to" TT var is set iff referrer domain is correct. +$config->script_url( "http://example.com/" ); +$config->script_name( "wiki.cgi" ); +my $good_return_to = "http://example.com/wiki.cgi?Test_Page"; +my $evil_return_to = "http://example.org/naughty-script"; + +$ENV{HTTP_REFERER} = $good_return_to; +my %tt_vars = $guide->display_prefs_form( return_tt_vars => 1 ); +is( $tt_vars{return_to_url}, $good_return_to, + "Return URL set when referrer matches script URL/name" ); +my $output = $guide->display_prefs_form( return_output => 1, noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, + "input", { type => "hidden", name => "return_to_url" }, + "...corresponding hidden input is there in the form" ); +Test::HTML::Content::tag_ok( $output, + "input", { type => "hidden", name => "return_to_url", + value => $good_return_to }, + "...with correct value" ); + +$ENV{HTTP_REFERER} = $evil_return_to; +%tt_vars = $guide->display_prefs_form( return_tt_vars => 1 ); +ok( !$tt_vars{return_to_url}, + "Return URL not set when referrer doesn't match script URL/name" ); +$output = $guide->display_prefs_form( return_output => 1, noheaders => 1 ); +Test::HTML::Content::no_tag( $output, + "input", { type => "hidden", name => "return_to_url" }, + "...and no corresponding hidden input in form" ); + # If we have a google API key and node maps are enabled, we should see the # checkbox for this pref. $config->gmaps_api_key( "This is not a real API key." ); @@ -35,7 +63,7 @@ display_google_maps => 1, ); $ENV{HTTP_COOKIE} = $cookie; -my $output = $guide->display_prefs_form( return_output => 1, noheaders => 1 ); +$output = $guide->display_prefs_form( return_output => 1, noheaders => 1 ); Test::HTML::Content::tag_ok( $output, "input", { type => "checkbox", name => "display_google_maps" }, "Node map preference checkbox shown when we have a GMaps API key." ); Modified: trunk/templates/preferences.tt =================================================================== --- trunk/templates/preferences.tt 2012-05-02 17:10:39 UTC (rev 1376) +++ trunk/templates/preferences.tt 2012-05-02 18:24:58 UTC (rev 1377) @@ -121,6 +121,10 @@ <input type="submit" value="Set it" class="form_button" /> <input type="hidden" name="action" value="set_preferences"> + [% IF return_to_url %] + <input type="hidden" name="return_to_url" + value="[% return_to_url | html %]" /> + [% END %] </form> [% ELSE %] @@ -192,7 +196,7 @@ </p> <ul> - <li><a href="[% full_cgi_url %]">Return to [% site_name %]</a></li> + <li><a href="[% IF return_to_url %][% return_to_url | html %][% ELSE %][% full_cgi_url %][% END %]">Return to [% site_name %]</a></li> <li><a href="preferences.cgi">Change preferences</a></li> </ul>

10 years, 10 months

r1376 - in trunk: . lib t

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-02 18:10:39 +0100 (Wed, 02 May 2012) New Revision: 1376 Modified: trunk/lib/OpenGuides.pm trunk/preferences.cgi trunk/t/58_navbar_common_locales_categories.t trunk/t/59_preferences.t Log: Moved preferences form display from preferences.cgi into OpenGuides.pm Modified: trunk/lib/OpenGuides.pm =================================================================== --- trunk/lib/OpenGuides.pm 2012-05-02 16:04:06 UTC (rev 1375) +++ trunk/lib/OpenGuides.pm 2012-05-02 17:10:39 UTC (rev 1376) @@ -637,6 +637,36 @@ } } +=item B<display_prefs_form> + + $guide->display_prefs_form; + +Displays a form that lets the user view and set their preferences. The +C<return_output> and C<return_tt_vars> parameters can be used to return +the output or template variables, instead of printing the output to STDOUT. + +=cut + +sub display_prefs_form { + my ($self, %args) = @_; + my $config = $self->config; + my $wiki = $self->wiki; + + my $output = OpenGuides::Template->output( + wiki => $wiki, + config => $config, + template => "preferences.tt", + vars => { + not_editable => 1, + show_form => 1, + not_deletable => 1, + }, + noheaders => $args{noheaders}, + ); + return $output if $args{return_output}; + print $output; +} + =item B<display_recent_changes> $guide->display_recent_changes; Modified: trunk/preferences.cgi =================================================================== --- trunk/preferences.cgi 2012-05-02 16:04:06 UTC (rev 1375) +++ trunk/preferences.cgi 2012-05-02 17:10:39 UTC (rev 1376) @@ -4,6 +4,7 @@ use strict; use sigtrap die => 'normal-signals'; use CGI; +use OpenGuides; use OpenGuides::Config; use OpenGuides::CGI; use OpenGuides::JSON; @@ -12,7 +13,8 @@ my $config_file = $ENV{OPENGUIDES_CONFIG_FILE} || "wiki.conf"; my $config = OpenGuides::Config->new( file => $config_file ); -my $wiki = OpenGuides::Utils->make_wiki_object( config => $config ); +my $guide = OpenGuides->new( config => $config ); +my $wiki = $guide->wiki; my $cgi = CGI->new(); my $action = $cgi->param('action') || ''; my $format = $cgi->param('format') || ''; @@ -25,7 +27,7 @@ print "Content-type: text/javascript\n\n"; print $json_writer->make_prefs_json(); } else { - show_form(); + $guide->display_prefs_form; } sub set_preferences { @@ -58,16 +60,3 @@ } ); } - -sub show_form { - print OpenGuides::Template->output( - wiki => $wiki, - config => $config, - template => "preferences.tt", - vars => { - not_editable => 1, - show_form => 1, - not_deletable => 1, - } - ); -} Modified: trunk/t/58_navbar_common_locales_categories.t =================================================================== --- trunk/t/58_navbar_common_locales_categories.t 2012-05-02 16:04:06 UTC (rev 1375) +++ trunk/t/58_navbar_common_locales_categories.t 2012-05-02 17:10:39 UTC (rev 1376) @@ -26,18 +26,8 @@ } sub get_preferences { - my ($guide) = @_; - - return OpenGuides::Template->output( - wiki => $guide->wiki, - config => $guide->config, - template => "preferences.tt", - noheaders => 1, - vars => { - not_editable => 1, - show_form => 1 - }, - ); + my $guide = shift; + return $guide->display_prefs_form( return_output => 1, noheaders => 1 ); } my %pages = ( Modified: trunk/t/59_preferences.t =================================================================== --- trunk/t/59_preferences.t 2012-05-02 16:04:06 UTC (rev 1375) +++ trunk/t/59_preferences.t 2012-05-02 17:10:39 UTC (rev 1376) @@ -35,13 +35,15 @@ display_google_maps => 1, ); $ENV{HTTP_COOKIE} = $cookie; -Test::HTML::Content::tag_ok( get_output($wiki, $config), +my $output = $guide->display_prefs_form( return_output => 1, noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, "input", { type => "checkbox", name => "display_google_maps" }, "Node map preference checkbox shown when we have a GMaps API key." ); # But not if the node map is globally disabled $config->show_gmap_in_node_display( 0 ); -Test::HTML::Content::no_tag( get_output($wiki, $config), +$output = $guide->display_prefs_form( return_output => 1, noheaders => 1 ); +Test::HTML::Content::no_tag( $output, "input", { type => "checkbox", name => "display_google_maps" }, "...but not when node maps are globally disabled." ); @@ -55,12 +57,14 @@ display_google_maps => 1, ); $ENV{HTTP_COOKIE} = $cookie; -Test::HTML::Content::tag_ok( get_output($wiki, $config), +$output = $guide->display_prefs_form( return_output => 1, noheaders => 1 ); +Test::HTML::Content::tag_ok( $output, "input", { type => "checkbox", name => "display_google_maps" }, "Node map preference checkbox shown when we're using Leaflet." ); $config->show_gmap_in_node_display( 0 ); -Test::HTML::Content::no_tag( get_output($wiki, $config), +$output = $guide->display_prefs_form( return_output => 1, noheaders => 1 ); +Test::HTML::Content::no_tag( $output, "input", { type => "checkbox", name => "display_google_maps" }, "...but not when node maps are globally disabled." ); @@ -68,7 +72,7 @@ my $json_writer = OpenGuides::JSON->new( wiki => $wiki, config => $config ); delete $ENV{HTTP_COOKIE}; -my $output = eval { +$output = eval { $json_writer->make_prefs_json(); }; ok( !$@, "->make_prefs_json() doesn't die when no cookie set." ); @@ -116,19 +120,3 @@ if ( $@ ) { warn "# Warning was: $@"; } is( $parsed->{username}, "Kake", "...and the correct username is included in the output" ); - -sub get_output { - my ($wiki, $config) = @_; - - return OpenGuides::Template->output( - wiki => $wiki, - config => $config, - template => "preferences.tt", - noheaders => 1, - vars => { - not_editable => 1, - show_form => 1 - }, - ); -} -

10 years, 10 months

r1375 - in trunk: . templates

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-02 17:04:06 +0100 (Wed, 02 May 2012) New Revision: 1375 Added: trunk/templates/edit_form_preview.tt Modified: trunk/Build.PL trunk/MANIFEST trunk/README.CSS trunk/templates/edit_form.tt trunk/templates/edit_form_actions.tt Log: Added a few more CSS hooks to the edit form, also added anchor link to jump from preview to form (fixes #202). Modified: trunk/Build.PL =================================================================== --- trunk/Build.PL 2012-05-02 13:39:43 UTC (rev 1374) +++ trunk/Build.PL 2012-05-02 16:04:06 UTC (rev 1375) @@ -393,6 +393,7 @@ "metadata.tt", "edit_form.tt", "edit_form_actions.tt", + "edit_form_preview.tt", "error.tt", "footer.tt", "header.tt", Modified: trunk/MANIFEST =================================================================== --- trunk/MANIFEST 2012-05-02 13:39:43 UTC (rev 1374) +++ trunk/MANIFEST 2012-05-02 16:04:06 UTC (rev 1375) @@ -42,6 +42,7 @@ templates/display_metadata.tt templates/edit_form.tt templates/edit_form_actions.tt +templates/edit_form_preview.tt templates/error.tt templates/footer.tt templates/header.tt Modified: trunk/README.CSS =================================================================== --- trunk/README.CSS 2012-05-02 13:39:43 UTC (rev 1374) +++ trunk/README.CSS 2012-05-02 16:04:06 UTC (rev 1375) @@ -36,7 +36,7 @@ Used in: edit_form_actions.tt Purpose: Contains a button for previewing an edit. div.cancel_edit - Used in: edit_form_actions.tt + Used in: edit_form_actions.tt, edit_form_preview.tt Purpose: Contains a link for cancelling an edit. div.commit_edit Used in: edit_form_actions.tt @@ -59,6 +59,11 @@ Used in: edit_form.tt node_image_fields.tt Purpose: Contains details of an edit conflict for a single type of data. +div.jump_to_edit_form + Used in: edit_form_preview.tt + Purpose: Contains a link to jump up or down the page to the edit form, + when previewing one's edits. + div.licence_and_moderation_notes Used in: edit_form.tt Purpose: Contains a description of the guide's licence and details of any @@ -82,6 +87,16 @@ Used in: navbar_*.tt Purpose: Defines an item in the navigation bar +div.preview + Used in: edit_form_preview.tt + Purpose: Container for use with #maincontent when the content is being + previewed while editing. + +div.preview_actions + Used in: edit_form_preview.tt + Purpose: Groups together links for cancelling an edit and for jumping + up/down the page to the edit form, when previewing one's edits. + div.warning_text Used in: edit_form.tt Purpose: Warns the user that there is an edit conflict Modified: trunk/templates/edit_form.tt =================================================================== --- trunk/templates/edit_form.tt 2012-05-02 13:39:43 UTC (rev 1374) +++ trunk/templates/edit_form.tt 2012-05-02 16:04:06 UTC (rev 1375) @@ -29,18 +29,10 @@ [% END %] [% IF preview_html AND preview_above_edit_box %] - <div id="maincontent"> - <h2>Preview</h2> - [% IF summary %] - <div id="summary">[% summary %]</div> - [% END %] - [% INCLUDE node_image.tt %] - [% INCLUDE display_metadata.tt %] - [% preview_html %] - </div> - <br clear="all" /> + [% INCLUDE edit_form_preview.tt %] [% END %] + <a name="edit_form_anchor"></a> <form id="edit_page_form" action="[% cgi_url %]" method="post" enctype="application/x-www-form-urlencoded"> @@ -412,16 +404,7 @@ </form> [% IF preview_html AND NOT preview_above_edit_box %] - <div id="maincontent"> - <h2>Preview</h2> - [% IF summary %] - <div id="summary">[% summary %]</div> - [% END %] - [% INCLUDE node_image.tt %] - [% INCLUDE display_metadata.tt %] - [% preview_html %] - </div> - <br clear="all" /> + [% INCLUDE edit_form_preview.tt %] [% END %] [% END %] [% INCLUDE footer.tt omit_footer_search_form = 1 %] Modified: trunk/templates/edit_form_actions.tt =================================================================== --- trunk/templates/edit_form_actions.tt 2012-05-02 13:39:43 UTC (rev 1374) +++ trunk/templates/edit_form_actions.tt 2012-05-02 16:04:06 UTC (rev 1375) @@ -4,7 +4,7 @@ class="form_button" /> </div> <div class="cancel_edit"> - (<a href="[% cgi_url %]?[% node_param %]">cancel edit</a>) + <a href="[% cgi_url %]?[% node_param %]">Cancel edit</a> </div> <div class="commit_edit"> [% IF moderate %] Added: trunk/templates/edit_form_preview.tt =================================================================== --- trunk/templates/edit_form_preview.tt (rev 0) +++ trunk/templates/edit_form_preview.tt 2012-05-02 16:04:06 UTC (rev 1375) @@ -0,0 +1,18 @@ +<div id="maincontent" class="preview"> + <h2>Preview</h2> + <div class="preview_actions"> + <div class="cancel_edit"> + <a href="[% cgi_url %]?[% node_param %]">Cancel edit</a> + </div> + <div class="jump_to_edit_form"> + <a href="#edit_form_anchor">Jump to edit form</a> + </div> + </div> + [% IF summary %] + <div id="summary">[% summary %]</div> + [% END %] + [% INCLUDE node_image.tt %] + [% INCLUDE display_metadata.tt %] + [% preview_html %] +</div> +<br clear="all" />

10 years, 10 months

r1374 - in trunk: lib/OpenGuides t

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-02 14:39:43 +0100 (Wed, 02 May 2012) New Revision: 1374 Modified: trunk/lib/OpenGuides/Template.pm trunk/t/68_bug_website_displayed.t Log: And strip trailing / from displayed websites when it's the only / in the URL. Modified: trunk/lib/OpenGuides/Template.pm =================================================================== --- trunk/lib/OpenGuides/Template.pm 2012-05-02 13:14:07 UTC (rev 1373) +++ trunk/lib/OpenGuides/Template.pm 2012-05-02 13:39:43 UTC (rev 1374) @@ -366,11 +366,17 @@ my $website = $args{metadata} ? $metadata{website}[0] : $q->param("website"); + # Do truncation for website name display. Max length of field is set in + # conf file (website_link_max_chars). Leading http:// and www. if present + # is stripped; trailing / is also stripped if it's the only / in the URL. my $formatted_website_text = ""; if ( $website && $website ne "http://" && is_web_uri( $website ) ) { my $maxlen = $config->website_link_max_chars; my $trunc_website = $website; $trunc_website =~ s|http://(www.)?||; + if ( $trunc_website =~ tr|/|| == 1 ) { + $trunc_website =~ s|/$||; + } if ( length( $trunc_website ) > $maxlen ) { $trunc_website = substr( $trunc_website, 0, $maxlen - 3 ) . "..."; } Modified: trunk/t/68_bug_website_displayed.t =================================================================== --- trunk/t/68_bug_website_displayed.t 2012-05-02 13:14:07 UTC (rev 1373) +++ trunk/t/68_bug_website_displayed.t 2012-05-02 13:39:43 UTC (rev 1374) @@ -11,7 +11,7 @@ plan skip_all => "DBD::SQLite could not be used - no database to test with ($error)"; } -plan tests => 6; +plan tests => 7; OpenGuides::Test::refresh_db(); @@ -24,12 +24,16 @@ "A busy main-line station that actually exists.", undef, { website => "http://www.example.com/foo" } ) or die "Couldn't write node"; +$guide->wiki->write_node( "West Croydon Station", + "Another main-line station that actually exists.", undef, + { website => "http://www.example.com/bar/" } ) + or die "Couldn't write node"; $config->website_link_max_chars( 20 ); my %tt_vars = $guide->display_node( id => "South Croydon Station", return_tt_vars => 1 ); is( $tt_vars{formatted_website_text}, - '<a href="http://example.com/">example.com/</a>', + '<a href="http://example.com/">example.com</a>', "Website correctly displayed when no need for truncation," ); %tt_vars = $guide->display_node( id => "East Croydon Station", @@ -38,6 +42,12 @@ '<a href="http://www.example.com/foo">example.com/foo</a>', "Website correctly truncated when there's a leading www" ); +%tt_vars = $guide->display_node( id => "West Croydon Station", + return_tt_vars => 1 ); +is( $tt_vars{formatted_website_text}, + '<a href="http://www.example.com/bar/">example.com/bar/</a>', + "Trailing slash not stripped unless it's immediately after domain name" ); + %tt_vars = $guide->display_node( id => "North Croydon Station", return_tt_vars => 1 ); is( $tt_vars{formatted_website_text},

10 years, 10 months

r1373 - in trunk: lib/OpenGuides t

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-02 14:14:07 +0100 (Wed, 02 May 2012) New Revision: 1373 Modified: trunk/lib/OpenGuides/Template.pm trunk/t/68_bug_website_displayed.t Log: Also strip the http:// and any leading www. from the truncated website display text. Modified: trunk/lib/OpenGuides/Template.pm =================================================================== --- trunk/lib/OpenGuides/Template.pm 2012-05-02 11:18:32 UTC (rev 1372) +++ trunk/lib/OpenGuides/Template.pm 2012-05-02 13:14:07 UTC (rev 1373) @@ -370,8 +370,9 @@ if ( $website && $website ne "http://" && is_web_uri( $website ) ) { my $maxlen = $config->website_link_max_chars; my $trunc_website = $website; - if ( length( $website ) > $maxlen ) { - $trunc_website = substr( $website, 0, $maxlen - 3 ) . "..."; + $trunc_website =~ s|http://(www.)?||; + if ( length( $trunc_website ) > $maxlen ) { + $trunc_website = substr( $trunc_website, 0, $maxlen - 3 ) . "..."; } $formatted_website_text = '<a href="' . $website . '">' . $trunc_website . '</a>'; Modified: trunk/t/68_bug_website_displayed.t =================================================================== --- trunk/t/68_bug_website_displayed.t 2012-05-02 11:18:32 UTC (rev 1372) +++ trunk/t/68_bug_website_displayed.t 2012-05-02 13:14:07 UTC (rev 1373) @@ -11,51 +11,59 @@ plan skip_all => "DBD::SQLite could not be used - no database to test with ($error)"; } -plan tests => 5; +plan tests => 6; OpenGuides::Test::refresh_db(); my $config = OpenGuides::Test->make_basic_config; my $guide = OpenGuides->new( config => $config ); -$config->website_link_max_chars( 23 ); $guide->wiki->write_node( "South Croydon Station", "A sleepy main-line station in what is arguably the nicest part of Croydon.", undef, { website => "http://example.com/" } ) or die "Couldn't write node"; $guide->wiki->write_node( "North Croydon Station", "A busy main-line station in what is arguably the furthest North part of Croydon.", undef, { website => "http://longer.example.com/asdfasdf" } ) or die "Couldn't write node"; +$guide->wiki->write_node( "East Croydon Station", + "A busy main-line station that actually exists.", undef, + { website => "http://www.example.com/foo" } ) + or die "Couldn't write node"; -my $output = $guide->display_node( - id => "South Croydon Station", - return_output => 1, - ); -like( $output, qr#Website:</span> <span class="url"><a href="http://example.com/">http://example.com/</a>#, "website correctly displayed" ); +$config->website_link_max_chars( 20 ); +my %tt_vars = $guide->display_node( id => "South Croydon Station", + return_tt_vars => 1 ); +is( $tt_vars{formatted_website_text}, + '<a href="http://example.com/">example.com/</a>', + "Website correctly displayed when no need for truncation," ); -$output = $guide->display_node( - id => "North Croydon Station", - return_output => 1, - ); +%tt_vars = $guide->display_node( id => "East Croydon Station", + return_tt_vars => 1 ); +is( $tt_vars{formatted_website_text}, + '<a href="http://www.example.com/foo">example.com/foo</a>', + "Website correctly truncated when there's a leading www" ); -like( $output, qr#Website:</span> <span class="url"><a href="http://longer.example.com/asdfasdf">http://longer.exampl...</a>#, "website correctly truncated" ); +%tt_vars = $guide->display_node( id => "North Croydon Station", + return_tt_vars => 1 ); +is( $tt_vars{formatted_website_text}, + '<a href="http://longer.example.com/asdfasdf">longer.example.co...</a>', + "Website correctly truncated when much too long." ); # Make sure website isn't truncated unnecessarily, e.g. that we don't end up # just replacing the final three characters with the ellipsis. Our full URL -# has 34 characters. -$config->website_link_max_chars( 33 ); -my %tt_vars = $guide->display_node( id => "North Croydon Station", - return_tt_vars => 1 ); +# has 27 characters (not counting the http://). +$config->website_link_max_chars( 26 ); +%tt_vars = $guide->display_node( id => "North Croydon Station", + return_tt_vars => 1 ); is( $tt_vars{formatted_website_text}, - '<a href="http://longer.example.com/asdfasdf">http://longer.example.com/asdf...</a>', + '<a href="http://longer.example.com/asdfasdf">longer.example.com/asdf...</a>', "Website truncated correctly when 1 character longer than allowed." ); -$config->website_link_max_chars( 34 ); +$config->website_link_max_chars( 27 ); %tt_vars = $guide->display_node( id => "North Croydon Station", return_tt_vars => 1 ); is( $tt_vars{formatted_website_text}, - '<a href="http://longer.example.com/asdfasdf">http://longer.example.com/asdfasdf</a>', +'<a href="http://longer.example.com/asdfasdf">longer.example.com/asdfasdf</a>', "Website not truncated when exact length allowed." ); -$config->website_link_max_chars( 35 ); +$config->website_link_max_chars( 28 ); %tt_vars = $guide->display_node( id => "North Croydon Station", return_tt_vars => 1 ); is( $tt_vars{formatted_website_text}, - '<a href="http://longer.example.com/asdfasdf">http://longer.example.com/asdfasdf</a>', +'<a href="http://longer.example.com/asdfasdf">longer.example.com/asdfasdf</a>', "Website not truncated when 1 character shorter than allowed." ); -

10 years, 10 months

r1372 - in trunk: . lib/OpenGuides t

by svnadmin＠urchin.earth.li

Author: kake Date: 2012-05-02 12:18:32 +0100 (Wed, 02 May 2012) New Revision: 1372 Modified: trunk/Changes trunk/lib/OpenGuides/Config.pm trunk/lib/OpenGuides/Template.pm trunk/t/68_bug_website_displayed.t Log: Made website truncation a bit more intelligent. Modified: trunk/Changes =================================================================== --- trunk/Changes 2012-04-28 15:31:20 UTC (rev 1371) +++ trunk/Changes 2012-05-02 11:18:32 UTC (rev 1372) @@ -27,6 +27,9 @@ Added JSON output for the preferences page (#293). IP addresses no longer show on recent changes for people without the admin preference set. + Website truncation on node display is now a little more intelligent + (you can still tweak this by setting website_link_max_chars in + your wiki.conf). 0.66 12 April 2012 All templates now have access to the "username" TT variable. Modified: trunk/lib/OpenGuides/Config.pm =================================================================== --- trunk/lib/OpenGuides/Config.pm 2012-04-28 15:31:20 UTC (rev 1371) +++ trunk/lib/OpenGuides/Config.pm 2012-05-02 11:18:32 UTC (rev 1372) @@ -118,7 +118,7 @@ host_checker_module => "", static_path => "/usr/local/share/openguides/static", send_moderation_notifications => 1, - website_link_max_chars => 20, + website_link_max_chars => 25, read_only => 0, ); @@ -357,7 +357,7 @@ =item * moderate_whitelist -=item * website_link_max_chars (default: C<20>) +=item * website_link_max_chars (default: C<25>) =item * read_only Modified: trunk/lib/OpenGuides/Template.pm =================================================================== --- trunk/lib/OpenGuides/Template.pm 2012-04-28 15:31:20 UTC (rev 1371) +++ trunk/lib/OpenGuides/Template.pm 2012-05-02 11:18:32 UTC (rev 1372) @@ -368,10 +368,10 @@ : $q->param("website"); my $formatted_website_text = ""; if ( $website && $website ne "http://" && is_web_uri( $website ) ) { - my $trunc_website = substr( $website, 0, - $config->website_link_max_chars ); - unless ($website eq $trunc_website ) { - $trunc_website .= '...'; + my $maxlen = $config->website_link_max_chars; + my $trunc_website = $website; + if ( length( $website ) > $maxlen ) { + $trunc_website = substr( $website, 0, $maxlen - 3 ) . "..."; } $formatted_website_text = '<a href="' . $website . '">' . $trunc_website . '</a>'; Modified: trunk/t/68_bug_website_displayed.t =================================================================== --- trunk/t/68_bug_website_displayed.t 2012-04-28 15:31:20 UTC (rev 1371) +++ trunk/t/68_bug_website_displayed.t 2012-05-02 11:18:32 UTC (rev 1372) @@ -11,12 +11,13 @@ plan skip_all => "DBD::SQLite could not be used - no database to test with ($error)"; } -plan tests => 2; +plan tests => 5; - OpenGuides::Test::refresh_db(); +OpenGuides::Test::refresh_db(); my $config = OpenGuides::Test->make_basic_config; my $guide = OpenGuides->new( config => $config ); +$config->website_link_max_chars( 23 ); $guide->wiki->write_node( "South Croydon Station", "A sleepy main-line station in what is arguably the nicest part of Croydon.", undef, { website => "http://example.com/" } ) or die "Couldn't write node"; $guide->wiki->write_node( "North Croydon Station", "A busy main-line station in what is arguably the furthest North part of Croydon.", undef, { website => "http://longer.example.com/asdfasdf" } ) or die "Couldn't write node"; @@ -33,3 +34,28 @@ ); like( $output, qr#Website:</span> <span class="url"><a href="http://longer.example.com/asdfasdf">http://longer.exampl...</a>#, "website correctly truncated" ); + +# Make sure website isn't truncated unnecessarily, e.g. that we don't end up +# just replacing the final three characters with the ellipsis. Our full URL +# has 34 characters. +$config->website_link_max_chars( 33 ); +my %tt_vars = $guide->display_node( id => "North Croydon Station", + return_tt_vars => 1 ); +is( $tt_vars{formatted_website_text}, + '<a href="http://longer.example.com/asdfasdf">http://longer.example.com/asdf...</a>', + "Website truncated correctly when 1 character longer than allowed." ); + +$config->website_link_max_chars( 34 ); +%tt_vars = $guide->display_node( id => "North Croydon Station", + return_tt_vars => 1 ); +is( $tt_vars{formatted_website_text}, + '<a href="http://longer.example.com/asdfasdf">http://longer.example.com/asdfasdf</a>', + "Website not truncated when exact length allowed." ); + +$config->website_link_max_chars( 35 ); +%tt_vars = $guide->display_node( id => "North Croydon Station", + return_tt_vars => 1 ); +is( $tt_vars{formatted_website_text}, + '<a href="http://longer.example.com/asdfasdf">http://longer.example.com/asdfasdf</a>', + "Website not truncated when 1 character shorter than allowed." ); +

10 years, 10 months

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

openguides-commits May 2012