diff --git a/docs/gotcha.txt b/docs/gotcha.txt index 454e42307..bdb2eedc9 100644 --- a/docs/gotcha.txt +++ b/docs/gotcha.txt @@ -13,10 +13,13 @@ save you many hours of grief. code, chances are you'll need to update it to make it work with WebGUI 8. - * WebGUI now requires the following modules - - Moose - - CHI - - Facebook::Graph + * As part of the migration to Template::Toolkit, we will be changing template + variables from using dots to underscores. All templates using that namespace were + automatically upgraded to use the new variables. + + In this version, these templates were updated: + Account Macro template + Admin Toggle Macro template 7.9.8 -------------------------------------------------------------------- diff --git a/docs/templates.txt b/docs/templates.txt new file mode 100644 index 000000000..7aecc94c4 --- /dev/null +++ b/docs/templates.txt @@ -0,0 +1,14 @@ +This is a running list of template changes made during upgrades. If you have copied the default +templates, you will need to apply these changes manually to your copies. + +7.8.0 + + * Account Macro template variables renamed: + account.url => account_url + account.text => account_text + + * AdminToggle Macro template variables renamed: + toggle.url => toggle_url + toggle.text => toggle_text + + diff --git a/lib/WebGUI/Help/Macro_AdminToggle.pm b/lib/WebGUI/Help/Macro_AdminToggle.pm index 67164c6b4..54dc9b9de 100644 --- a/lib/WebGUI/Help/Macro_AdminToggle.pm +++ b/lib/WebGUI/Help/Macro_AdminToggle.pm @@ -6,7 +6,16 @@ our $HELP = { 'admin toggle' => { title => 'admin toggle title', body => '', - variables => [ { 'name' => 'toggle.url' }, { 'name' => 'toggle.text' } ], + variables => [ + { + name => 'toggle_url', + description => 'toggle.url', + }, + { + name => 'toggle_text', + description => 'toggle.text', + }, + ], fields => [], related => [] }, diff --git a/lib/WebGUI/Help/Macro_a_account.pm b/lib/WebGUI/Help/Macro_a_account.pm index f38d70e6a..ab215bbaf 100644 --- a/lib/WebGUI/Help/Macro_a_account.pm +++ b/lib/WebGUI/Help/Macro_a_account.pm @@ -7,7 +7,16 @@ our $HELP = { title => 'account title', body => '', fields => [], - variables => [ { 'name' => 'account.url' }, { 'name' => 'account.text' } ], + variables => [ + { + name => 'account_url', + description => 'account.url', + }, + { + name => 'account_text', + description => 'account.text', + } + ], related => [] }, diff --git a/lib/WebGUI/Macro/AdminToggle.pm b/lib/WebGUI/Macro/AdminToggle.pm index 9597b2b75..bb1cd518a 100644 --- a/lib/WebGUI/Macro/AdminToggle.pm +++ b/lib/WebGUI/Macro/AdminToggle.pm @@ -51,12 +51,12 @@ sub process { my ($turnOn, $templateName) = @_; my $i18n = WebGUI::International->new($session,'Macro_AdminToggle'); my %var; - $var{'toggle.text'} = $turnOn || $i18n->get(516); + $var{'toggle_text'} = $turnOn || $i18n->get(516); if ($session->var->isAdminOn) { - $var{'toggle.url'} = '#' + $var{'toggle_url'} = '#' } else { - $var{'toggle.url'} = $session->url->page('op=admin'); + $var{'toggle_url'} = $session->url->page('op=admin'); } my $template = $templateName ? WebGUI::Asset::Template->newByUrl($session, $templateName) : WebGUI::Asset::Template->newById($session, "PBtmpl0000000000000036"); diff --git a/lib/WebGUI/Macro/a_account.pm b/lib/WebGUI/Macro/a_account.pm index 3f6821318..1f63d879f 100644 --- a/lib/WebGUI/Macro/a_account.pm +++ b/lib/WebGUI/Macro/a_account.pm @@ -44,8 +44,8 @@ sub process { my @param = @_; return $session->url->page("op=auth;method=init") if ($param[0] eq "linkonly"); my $i18n = WebGUI::International->new($session,'Macro_a_account'); - $var{'account.url'} = $session->url->page('op=auth;method=init'); - $var{'account.text'} = $param[0] || $i18n->get(46); + $var{'account_url'} = $session->url->page('op=auth;method=init'); + $var{'account_text'} = $param[0] || $i18n->get(46); if ($param[1]) { return WebGUI::Asset::Template->newByUrl($session, $param[1])->process(\%var); } else { diff --git a/share/upgrades/7.9.13-8.0.0/zzz_renameAccountMacroTemplateVariables.pl b/share/upgrades/7.9.13-8.0.0/zzz_renameAccountMacroTemplateVariables.pl new file mode 100644 index 000000000..f58a12fc1 --- /dev/null +++ b/share/upgrades/7.9.13-8.0.0/zzz_renameAccountMacroTemplateVariables.pl @@ -0,0 +1,20 @@ + +use WebGUI::Upgrade::Script; + +start_step "Rename Account Macro template variables"; + +my $sth = session->db->read( q|SELECT assetId, revisionDate FROM template where namespace="Macro/a_account"| ); +ASSET: while ( my ($assetId, $revisionDate) = $sth->array ) { + my $asset = eval { WebGUI::Asset->newById( session, $assetId, $revisionDate ); }; + next ASSET if Exception::Class->caught; + my $template = $asset->get('template'); + $template =~ s/account\.url/account_url/msg; + $template =~ s/account\.text/account_text/msg; + $asset->update({ + template => $template, + }); +} + + +done; + diff --git a/share/upgrades/7.9.13-8.0.0/zzz_renameAdminToggleMacroTemplateVariables.pl b/share/upgrades/7.9.13-8.0.0/zzz_renameAdminToggleMacroTemplateVariables.pl new file mode 100644 index 000000000..2fb06f3e0 --- /dev/null +++ b/share/upgrades/7.9.13-8.0.0/zzz_renameAdminToggleMacroTemplateVariables.pl @@ -0,0 +1,20 @@ + +use WebGUI::Upgrade::Script; + +start_step "Rename AdminToggle Macro template variables"; + +my $sth = session->db->read( q|SELECT assetId, revisionDate FROM template where namespace="Macro/AdminToggle"| ); +ASSET: while ( my ($assetId, $revisionDate) = $sth->array ) { + my $asset = eval { WebGUI::Asset->newById( session, $assetId, $revisionDate ); }; + next ASSET if Exception::Class->caught; + my $template = $asset->get('template'); + $template =~ s/toggle\.url/toggle_url/msg; + $template =~ s/toggle\.text/toggle_text/msg; + $asset->update({ + template => $template, + }); +} + + +done; + diff --git a/t/Macro/AdminToggle.t b/t/Macro/AdminToggle.t index 35f39513f..e6efb6b24 100644 --- a/t/Macro/AdminToggle.t +++ b/t/Macro/AdminToggle.t @@ -102,7 +102,7 @@ sub addTemplate { className => 'WebGUI::Asset::Template', url => 'admintoggle-test', namespace => 'Macro/AdminToggle', - template => "HREF=\nLABEL=", + template => "HREF=\nLABEL=", id => 'AdminToggleTemplate--Z', usePacked => 0, }; diff --git a/t/Macro/a_account.t b/t/Macro/a_account.t index 29c63f7f9..2db2cded0 100644 --- a/t/Macro/a_account.t +++ b/t/Macro/a_account.t @@ -90,7 +90,7 @@ sub addTemplate { className => 'WebGUI::Asset::Template', url => 'a_account-test', namespace => 'Macro/a_account', - template => "HREF=\nLABEL=", + template => "HREF=\nLABEL=", id => 'testTemplatea_account1', usePacked => 1, };