280770 - Bugzilla::Constants should be available to templates

Status: RESOLVED FIXED

(Bugzilla :: Bugzilla-General, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

Bugzilla::Constants should be available to templates so that they can use them
for conditional processing without us having to duplicate the set of constants
or individually include them in the variables hash.

Comment 1

[Myk Melez [:myk] [@mykmelez]]

Attachment: patch v1: exposes constants to templates

It's a small patch that does something simple, but it has to do some
complicated symbol table lookups, hence the density.  Still, a very cool way to
give us constants in TT, and I would think it would be right up your alley
bbaetz.

Comment 2

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 173164 [details] [diff] [review]
patch v1: exposes constants to templates

Mark, can you review this dense but short enhancement to our templating code?

Comment 3

[Marc Schumann [:Wurblzap]]

Comment on attachment 173164 [details] [diff] [review]
patch v1: exposes constants to templates

This is really useful.

Unfortunately, array constants are mishandled -- for them, the hash contains
the number of their entries. I would have expected a reference to the array,
right?

Comment 4

[Myk Melez [:myk] [@mykmelez]]

Attachment: patch v2: works for array constants

>Unfortunately, array constants are mishandled -- for them, the hash contains
>the number of their entries. I would have expected a reference to the array,
>right?

Right.	This patch fixes that.

Comment 5

[Marc Schumann [:Wurblzap]]

Comment on attachment 173321 [details] [diff] [review]
patch v2: works for array constants

This is good.
Do we want a note in Constants.pm saying that there shouldn't be any functions
added? (The file name doesn't really invite anybody to add a function, but...)

Comment 6

[Myk Melez [:myk] [@mykmelez]]

Attachment: 2nd patch: improves robustness of previous patch

Thanks Marc!

Checking in Bugzilla/Template.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Template.pm,v  <--	Template.pm
new revision: 1.20; previous revision: 1.19
done

>Do we want a note in Constants.pm saying that there shouldn't be any functions

>added? (The file name doesn't really invite anybody to add a function, but...)


I was thinking about it, and I started to add a note in a followup patch, but
then I realized a better approach would be to traverse the @EXPORT and
@EXPORT_OK arrays instead of the whole symbol table.  Then we'd only get the
symbols the Constants module wanted to make available, which should all be
constants, and there's no danger of someone adding an internal function to
Constants.pm that we end up reflecting into the template object.

So here's a followup patch with that fix.

Comment 7

[Myk Melez [:myk] [@mykmelez]]

Thanks Marc!

Bugzilla/Template.pm
Checking in Bugzilla/Template.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Template.pm,v  <--  Template.pm
new revision: 1.21; previous revision: 1.20
done