General Wiki Announcements box should not be shown when user has not set their email

[Ryan J Ollos]

The General Wiki Announcements box should not be shown when the user has not set their email.

Screen capture of Announcer panel when email has not been set:

Screen capture of Announcer panel after email has been set:

[Ryan J Ollos]

The patch​ is simple. After the patch we see:

I can think of two options to improve on the behavior following the patch:

• Hide the Announcer panel when there are no boxes present.
• Show a message to indicate that the user needs to set an email to reveal preference boxes.

[Ryan J Ollos]

t10675-r12359-2.patch​ causes the following message to be displayed when there are no preference boxes to display (e.g. when the email address has not been set):

I prefer the way the patch is currently implemented, but a variation of the patch would show the following:

Some considerations:

• Later on, when distributors other than email exist, we'll have to change the 'email' not in req.session logic to extend to other distributors. Since that will require major changes to the codebase, it doesn't seem like we need to address that at the moment.
• It appears that it would make sense to also show a similar message when there are no subscribers listed under the Subscription panel, and that some of the existing notify rules should first be checking that the email has been set for user anonymous. That could also be addressed in a follow-on ticket.

[Ryan J Ollos]

t10675-r12359-3.patch​ implements a functional test harness, and adds functional tests for the two issues addressed in this ticket. I attempted to use as much of Trac's existing functional test infrastructure as possible, which leaves a TODO since I'm not sure yet how inject a derived instance of FunctionalTester into the FunctionalTestSuite class. I suspect we will need to move towards overriding the setUp and tearDown methods of FunctionalTestSuite (which is what the XmlRpcPlugin and AccountManagerPlugin have done - those are the only two plugins on trac-hacks that I can find which have implemented functional tests).

Since the implementation makes use of FunctionalTestEnvironment.post_create, the tests can only be run under Trac 0.11.5dev or later. There is a check in the code to disable the functional tests when the minimum version of Trac is not met. I don't think the version restriction will significantly hinder development, but let's discuss if you think this will be an issue.

[Ryan J Ollos]

All the work that I have planned for this ticket has been posted, so this ticket just needs review of the 3 patches.

[Ryan J Ollos]

Please upgrade to Trac 1.2, which has integrated the core of AnnouncerPlugin. Please raise the issue on the ​trac:MailingList if you encounter the issue with Trac 1.2.