oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactored Survey ExpressionEngine tag() util into tag() setter and tagged() accessor.

Browse source 
Updated i18n to reflect the fact that min/max/step are used for all numeric types, not just slider.

Also updated textCols/Rows i18n.
This commit is contained in:
Patrick Donelan 2009-05-06 05:53:10 +00:00
parent 494efe1cf1
commit f3ed30d939
6 changed files with 98 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/upgrades/packages-7.7.6/root_import_survey_default-answer-edit.wgpkg Normal file
View file

Binary file not shown.

BIN
docs/upgrades/packages-7.7.6/root_import_survey_default-questions.wgpkg Normal file
View file

Binary file not shown.

58
lib/WebGUI/Asset/Wobject/Survey/ExpressionEngine.pm
View file

@ -171,50 +171,67 @@ sub answeredX {
=head2 tag ($name, [$value]) =head2 tag ($name, [$value])
Mutator utility sub that gives expressions access to tag response values (and optionally set them). Utility sub that allows expressions to tag data
=head3 $name =head3 $name
Name of tag whose value is returned. Name of tag to set
=head3 $value (optional) =head3 $value (optional)
If provided, the tag is set to this value. Value of tag to set. Defaults to 1 (boolean true flag).
=cut =cut
sub tag { sub tag {
my ($name, $value) = @_; my ($name, $value) = @_;
if (defined $value) { $value = 1 if !defined $value;
$session->log->debug("Setting tag [$name] to [$value]"); $session->log->debug("Setting tag [$name] to [$value]");
$tags->{$name} = $value; $tags->{$name} = $value;
} else {
$value = $tags->{$name};
$session->log->debug("tag($name) resolves to [$value]");
}
return $value;
} }
=head2 tagX =head2 tagged ($name)
Same as L<tag>, except that first argument is an asset spec (assetId or url), which must resolve Utility sub that gives expressions access to tagged data
to a valid survey instance. The sub is applied to the most recent completed response for the user
on the survey instance given by asset_spec.
Note that it doesn't really make sense to try to set a tag on an external asset, so this sub =head3 $name
is only an accessor.
Name of tag whose value is returned.
=cut =cut
sub tagX { sub tagged {
my ($name) = @_;
if (@_ == 2) {
my $args = join ',', @_;
$session->log->warn("Two arguments passed to tagged($args). Did you mean tag($args)?");
}
my $value = $tags->{$name};
$session->log->debug("tagged($name) resolves to [$value]");
return $value;
}
=head2 taggedX
Same as L<tagged>, except that first argument is an asset spec (assetId or url), which must resolve
to a valid survey instance. The sub is applied to the most recent completed response for the user
on the survey instance given by asset_spec.
=cut
sub taggedX {
my ( $asset_spec, $name ) = @_; my ( $asset_spec, $name ) = @_;
if (@_ == 3) {
my $args = join ',', @_;
$session->log->warn("Three arguments passed to taggedX($args). Did you mean tag($args)?");
}
# See if $otherInstances already contains the external survey # See if $otherInstances already contains the external survey
if (my $other_instance = $otherInstances->{$asset_spec}) { if (my $other_instance = $otherInstances->{$asset_spec}) {
my $tags = $other_instance->{tags}; my $tags = $other_instance->{tags};
my $value = $tags->{$name}; my $value = $tags->{$name};
$session->log->debug("tagX($asset_spec, $name) returns [$value]"); $session->log->debug("taggedX($asset_spec, $name) returns [$value]");
return $value; return $value;
} else { } else {
# Throw an exception, triggering run() to resolve the external reference and re-run # Throw an exception, triggering run() to resolve the external reference and re-run
@ -362,7 +379,8 @@ sub run {
$compartment->share('&answered'); $compartment->share('&answered');
$compartment->share('&answeredX'); $compartment->share('&answeredX');
$compartment->share('&tag'); $compartment->share('&tag');
$compartment->share('&tagX'); $compartment->share('&tagged');
$compartment->share('&taggedX');
$compartment->share('&jump'); $compartment->share('&jump');
$compartment->share('&avg'); $compartment->share('&avg');

82
lib/WebGUI/i18n/English/Asset_Survey.pm
View file

@ -281,23 +281,23 @@ our $I18N = {
lastUpdated => 1224686319 lastUpdated => 1224686319
}, },
'cols description' => { 'cols description' => {
message => q|The number of columns used for the comment TextArea input field.|, message => q|The number of columns used for the input field (for TextArea question types).|,
context => q|Description of the 'cols' field, used as hoverhelp in the edit question dialog.|, context => q|Description of the 'cols' field, used as hoverhelp in the edit question dialog.|,
lastUpdated => 0 lastUpdated => 1241588599
}, },
'comment rows' => { 'comment rows' => {
message => q|Comment Rows:|, message => q|Comment Rows:|,
lastUpdated => 1224686319 lastUpdated => 1224686319
}, },
'rows description' => { 'rows description' => {
message => q|The number of rows shown for the comment TextArea input field.|, message => q|The number of rows used for the input field (for TextArea question types).|,
context => q|Description of the 'rows' field, used as hoverhelp in the edit question dialog.|, context => q|Description of the 'rows' field, used as hoverhelp in the edit question dialog.|,
lastUpdated => 0 lastUpdated => 1241588599
},
'maximum number of answers' => {
message => q|Maximum number of answers:|,
lastUpdated => 1224686319
}, },
'maximum number of answers' => {
message => q|Maximum number of answers:|,
lastUpdated => 1224686319
},
'maximum number of answers description' => { 'maximum number of answers description' => {
message => q|Enter the maximum number of answers.|, message => q|Enter the maximum number of answers.|,
context => q|Description of the 'maximum number of answers' field, used as hoverhelp in the edit question dialog.|, context => q|Description of the 'maximum number of answers' field, used as hoverhelp in the edit question dialog.|,
@ -393,41 +393,41 @@ our $I18N = {
lastUpdated => 1224686319 lastUpdated => 1224686319
}, },
'min label' => { 'min label' => {
message => q|Slider Min|, message => q|Min|,
lastUpdated => 1224686319 lastUpdated => 1241588065
}, },
'min description' => { 'min description' => {
message => q|The minimum value of this answer for slider type questions.|, message => q|The minimum numeric value allowed for this answer (for numeric question types such as Number and Slider). Keep this field empty if you do not want to enforce a minimum value. |,
context => q|Description of the 'min' field, used as hoverhelp in the edit answer dialog.|, context => q|Description of the 'min' field, used as hoverhelp in the edit answer dialog.|,
lastUpdated => 0 lastUpdated => 1241588065
}, },
'max label' => { 'max label' => {
message => q|Slider Max|, message => q|Max|,
lastUpdated => 1224686319 lastUpdated => 1241588065
}, },
'max description' => { 'max description' => {
message => q|The maximum value of this answer for slider type questions.|, message => q|The maximum numeric value allowed for this answer (for Number and Slider type questions). Keep this field empty if you do not want to enforce a maximum value. |,
context => q|Description of the 'max' field, used as hoverhelp in the edit answer dialog.|, context => q|Description of the 'max' field, used as hoverhelp in the edit answer dialog.|,
lastUpdated => 0 lastUpdated => 1241588065
}, },
'step label' => { 'step label' => {
message => q|Slider Step|, message => q|Step|,
lastUpdated => 1224686319 lastUpdated => 1241588065
}, },
'step description' => { 'step description' => {
message => q|The step value of this answer for slider type questions.|, message => q|The step value, that is, the numeric interval to allow between values (for Number and Slider type questions). Keep this field empty if you do not want to enforce a step value. |,
context => q|Description of the 'step' field, used as hoverhelp in the edit answer dialog.|, context => q|Description of the 'step' field, used as hoverhelp in the edit answer dialog.|,
lastUpdated => 0 lastUpdated => 0
}, },
'verbatim label' => { 'verbatim label' => {
message => q|Verbatim|, message => q|Verbatim|,
lastUpdated => 1224686319 lastUpdated => 1224686319
}, },
'verbatim description' => { 'verbatim description' => {
message => q|Set to yes to add an extra text input to the answer, where the user can enter a single line of text. Typically used to permit a free-text 'other' response.|, message => q|Set to yes to add an extra text input to the answer, where the user can enter a single line of text. Typically used to permit a free-text 'other' response.|,
context => q|Description of the 'verbatim' field, used as hoverhelp in the edit answer dialog.|, context => q|Description of the 'verbatim' field, used as hoverhelp in the edit answer dialog.|,
lastUpdated => 0 lastUpdated => 0
}, },
'answer score' => { 'answer score' => {
message => q|Answer score:|, message => q|Answer score:|,
lastUpdated => 1239251986 lastUpdated => 1239251986
@ -1358,13 +1358,23 @@ section/answer.|,
'textCols' => { 'textCols' => {
message => q|The number of columns for TextArea questions.|, message => q|The number of columns for TextArea questions.|,
context => q|Description of a template variable for a template Help page.|, context => q|Description of a template variable for a template Help page.|,
lastUpdated => 0, lastUpdated => 1241588599,
},
'textCols label' => {
message => q|TextArea Columns|,
lastUpdated => 1241588599
}, },
'textRows' => { 'textRows' => {
message => q|The number of rows for TextArea questions.|, message => q|The number of rows for TextArea questions.|,
context => q|Description of a template variable for a template Help page.|, context => q|Description of a template variable for a template Help page.|,
lastUpdated => 0, lastUpdated => 1241588599,
},
'textRows label' => {
message => q|TextArea Rows|,
lastUpdated => 1241588599
}, },
'answers' => { 'answers' => {

21
t/Asset/Wobject/Survey/ExpressionEngine.t
View file

@ -22,7 +22,7 @@ my $session = WebGUI::Test->session;
#---------------------------------------------------------------------------- #----------------------------------------------------------------------------
# Tests # Tests
my $tests = 49; my $tests = 50;
plan tests => $tests + 1; plan tests => $tests + 1;
#---------------------------------------------------------------------------- #----------------------------------------------------------------------------
@ -141,19 +141,24 @@ SKIP: {
'..but can be changed' '..but can be changed'
); );
cmp_deeply( cmp_deeply(
$e->run( $session, q{ tag(b,1) }, { values => \%values, tags => { a => 1 } } ), $e->run( $session, q{ tag(b) }, { values => \%values, tags => { a => 1 } } ),
{ jump => undef, tags => { a => 1, b => 1 } }, { jump => undef, tags => { a => 1, b => 1 } },
'..and new values can be set' '..and new values can be set (defaults to 1)'
); );
cmp_deeply( cmp_deeply(
$e->run( $session, q{ jump{ tag(a) == 'abc' } target }, { values => \%values, tags => { a => 'abc' } } ), $e->run( $session, q{ jump{ tagged(a) } target }, { values => \%values, tags => { a => 1 } } ),
{ jump => 'target', tags => { a => 1 } },
'..flag can be checked with tagged()'
);
cmp_deeply(
$e->run( $session, q{ jump{ tagged(a) eq 'abc' } target }, { values => \%values, tags => { a => 'abc' } } ),
{ jump => 'target', tags => { a => 'abc' } }, { jump => 'target', tags => { a => 'abc' } },
'..tag value resolved by tag() with single arg' '..and any sort of tagged data returned'
); );
cmp_deeply( cmp_deeply(
$e->run( $session, q{ tag(a,xyz); jump{ tag(a) == 'xyz' } target }, { values => {a => 'def'}, tags => { a => 'abc' } } ), $e->run( $session, q{ tag(a,xyz); jump{ tagged(a) eq 'xyz' } target }, { values => {a => 'def'}, tags => { a => 'abc' } } ),
{ jump => 'target', tags => { a => 'xyz' } }, { jump => 'target', tags => { a => 'xyz' } },
'..overwritten tag value can be used too everything else' '..overwritten tag data can be used too'
); );
# Create a test user # Create a test user
@ -207,7 +212,7 @@ SKIP: {
{ jump => 'target', tags => {} }, 'external score resolves ok too' ); { jump => 'target', tags => {} }, 'external score resolves ok too' );
cmp_deeply( $e->run( $session, qq{jump {scoreX('$url', ext_s0) == 200} target}, {userId => $user->userId} ), cmp_deeply( $e->run( $session, qq{jump {scoreX('$url', ext_s0) == 200} target}, {userId => $user->userId} ),
{ jump => 'target', tags => {} }, 'external score section totals work too' ); { jump => 'target', tags => {} }, 'external score section totals work too' );
cmp_deeply( $e->run( $session, qq{jump {tagX('$url', ext_tag) == 199} target}, {userId => $user->userId} ), cmp_deeply( $e->run( $session, qq{jump {taggedX('$url', ext_tag, 1) == 199} target}, {userId => $user->userId} ),
{ jump => 'target', tags => {} }, 'external tag lookups work too' ); { jump => 'target', tags => {} }, 'external tag lookups work too' );
} }

2
t/Asset/Wobject/Survey/ResponseJSON.t
View file

@ -440,7 +440,7 @@ $rJSON->nextResponse(2); # pretend we just finished s0q2
cmp_deeply($rJSON->tags, {}, 'No tag data'); cmp_deeply($rJSON->tags, {}, 'No tag data');
$rJSON->processExpression('tag(a,100)'); $rJSON->processExpression('tag(a,100)');
cmp_deeply($rJSON->tags, { a => 100 }, 'Tag data set'); cmp_deeply($rJSON->tags, { a => 100 }, 'Tag data set');
$rJSON->processExpression('tag(b,50); jump {tag(a) + tag(b) == 150} s1'); $rJSON->processExpression('tag(b,50); jump {tagged(a) + tagged(b) == 150} s1');
cmp_deeply($rJSON->tags, { a => 100, b => 50 }, 'Tag data cumulative'); cmp_deeply($rJSON->tags, { a => 100, b => 50 }, 'Tag data cumulative');
is($rJSON->nextResponse, 3, '..and is useful for jump expressions'); is($rJSON->nextResponse, 3, '..and is useful for jump expressions');