collective / collective.polls

A content type, workflow, and portlet for conducting online polls, for anonymous and logged-in users

collective.polls

Table of Contents

• Life, the Universe, and Everything
• Mostly Harmless
  • Known issues
• Don't Panic
  • Installation
  • Features
  • Workflow description
• Not entirely unlike

Life, the Universe, and Everything

A content type, workflow and portlet for conducting online polls, for anonymous and logged-in users.

Mostly Harmless

Got an idea? Found a bug? Let us know by opening a support ticket.

Known issues

See the complete list of bugs on GitHub.

Don't Panic

Installation

To enable this product in a buildout-based installation:

1. Edit your buildout.cfg and add collective.polls to the list of eggs to install:

   [buildout]
   ...
   eggs =
       collective.polls
   

After updating the configuration you need to run ''bin/buildout'', which will take care of updating your system.

Go to the 'Site Setup' page in a Plone site and click on the 'Add-ons' link.

Check the box next to ''collective.polls'' and click the 'Activate' button.

Features

• Polls can be opened for anonymous users to vote
• If an open poll is allowed for anonymous but is inside a private folder, nobody can vote. Therefore the poll's parent folder needs to be published before opening the poll in order for this field to take effect
• Voting can take place either in the object or in a voting portlet;
• The voting portlet can show the latest open poll or ab specific open poll and closed polls
• Users can see partial results of the poll
• Results can be shown using a bar chart, a pie chart, or just by number of votes
• Polls can have relations with other content in the site

Workflow description

The workflow associated with polls has the following states: 'Private', 'Pending review', 'Open' and 'Closed'.

• Polls are created in 'Private' state; only Owner, Manager, Editor or Site Administrator roles can modify them.
• When a poll is in 'Private' state it can be sent to 'Pending review' or directly to 'Open' state, if the user has the proper role (Reviewer, Manager or Site Administrator).
• When a poll is in 'Pending review' state it can be edited by Manager, Editor, Reviewer or Site Administrator roles.
• A poll in 'Pending review' state can be sent to 'Open' state, with "Review portal content" permission, or to Private, with "Request review" permission.
• When the poll is 'Open' users can only vote; nobody can modify the poll in any way.
• An 'Open' poll can be sent to 'Private' or 'Closed' state by Reviewer, Manager or Site Administrator roles.
• When an 'Open' poll is sent to 'Private', all votes are removed to avoid data manipulation.
• When a poll is in 'Closed' state nobody can modify it, nor can anyone vote on it; a closed poll can always be reopened by usera with proper permissions.

Not entirely unlike

Plone PoPoll

A very old an unmaintained product, PoPoll includes a poll tool that allows member or anonymous to vote for one or more answers. A portlet is provided. It can be configured to display the last poll, or the first poll of a folder. After the vote statistics screens are shown.

collective.polls's Issues

The pie chart is not shown in the voting portlet

If you create a poll that is supposed to show results using a pie chart, it shows a pie chart in the poll page, but it shows a bar chart in the voting portlet.

Bad calculated portlet height

The height of the polls portlets is calculated dynamically over the js. But the portlets are always too height.

Give some love to the result pages

We need to make the result pages look better.

Replace current visualization machinery with a new one

We are currently using a custom JS for creating the visualizations; yes, it is small, but it is not maintained by anyone else, it is not responsive and it is not interactive.

We need to fix that.

'Allow anonymous' field should be optional

There are some use cases, like private extranets, where having the field "allow anonymous" is pointless. Thus, this field should be removed from the default schema and included as a separate (activated by default) behavior.
This way, the current functionality remains as it is, and the field can be removed if needed.

AttributeError: available

Seems that, when there are no active polls, the portlet raises an error:

Traceback (most recent call last):
  File "/home/hvelarde/plone-py2.6/eggs/plone.portlets-2.0.2-py2.6.egg/plone/portlets/manager.py", line 117, in _lazyLoadPortlets
    isAvailable = renderer.available
AttributeError: available

Poll results get confused

User creates poll1, receives votes and closes poll.
User then creates poll2, receives votes and closes this poll too.
When you go to the page where poll1 has been created to see the results you find the votes for both polls are shown.

Using Plone 4.1.4, Dexterity 1.2.1 and Polls 1.0.

Make release 1.0 (Release Candidate)

Please wait for me to show me the whole process.

ajax load of partial results on portlet

the partial results of a poll must be loaded using ajax instead of loading the whole page to keep voter in context.

polls may be opened and closed automatically in the future

we need to implement open and close dates for polls, the same way you can publish and expire items on other Plone content types.

How to override the current default view of an IPoll ?

In my current project I just want to override the default_view.

This addon use grok and do not use any browser layer.
The only solution I have found is to copy/paste the code of the view and make it a normal view (inherits from BrowserView) and declare the new one in zcml. This is really weird, is there any other way to proceed ?

anonymous voters can not vote again on a reopened poll

an anonymous voter that has already voted on a poll that was retired, edited and reopened can not vote again on the poll; this is related with #33.

Only manager should decide if poll is open to anonymous

Enhancement. Poll creation should be available to those with lower permissions, but, the decision to open polls to anonymous should be made at, say, manager level only.

Related to issue 46

a poll must have at least 2 options to vote on

right now you can open a poll with no options at all; this is because of #30.

Default values for checkboxes

Anonymous voting and show partial results should have the checkbox as true by default

Insufficient Privileges

Users with Contributor, Editor, Owner or Reader role cannot access/view a poll after it has been sent to revision; we need to fix Access contents information and View permissions on pending state.

Provide a results view that shows only numbers

Add a "just numbers" option to the graph drop down

Fix workflow transition name

The workflow transition that activates the Open state must be renamed from "publish" to "open"; we need a upgrade step to update the security settings.

increase test coverage

the package has less than 75% of test coverage; we need to increase that at least to 90%.

Improvement: Reopen Poll

When a poll is closed none can reopen it. Sometimes it's necessary.

The number of votes is not shown when using a pie chart

When the user selects to display the results of a poll using a pie chart, the number of votes is not shown.

remove unnecesary code in portlet

When a new field is added to a portlet it should be added as class attribute. In this way the existing instance don't need to be updated and there is no need of add extra logic for every new field.

With that, could be possible to remove some hacks in the code added in the commit 682e95b

Poll results could be shown using votes or percentage

Add a field to tell if the results are going to be shown as the number of votes or as a percentage on each answer.

Permission: Anonymous can't vote

Even if the field "Allow Anonymous" is checked, anonymous can't vote.

pie char is not shown when only one option has votes

This seems to be an issue with gRaphaël. We need to either fix it or find a workaround.

Update portlet at end of poll

After a poll has been closed the poll page states "Results" but the portlet remains as "Partial results".

Using Plone 4.1.4, Dexterity 1.2.1 and Polls 1.0.

Refactor visualization of poll results

When we created this package we made a mistake on its design that is pretty clear now: visualization of poll results should be handled by different views and not by a poll field.

Right now this creates a problem: if a user wants to change the visualization, let's say from pie to bars, she should have to retract the poll and lose all the votes already casted; that's wrong.

We need to refactor the whole visualization machinery to make it easier to modify and extend and we need to provide an upgrade step to migrate all polls already created on a site.

We should think on how to implement this on porltets also as asked in #65.

Allow site admin to be able to send back the poll

After the poll gets published, allow the site admin to send it back to private state.

Only Site Manager and Site Admin are allowed, not owner nor any other role

Pie Chart not showing if only one option has votes

Steps to reproduce:

1. Add a poll
2. Choose "Pie Chart" under the "Graph" drop down
3. Add a couple of possible answers
4. Save and open the poll
5. Vote for just 1 of the options (you can vote several times but making sure just one of the options has votes)

Result:

Pie chart is not showing

Expected result:

Pie chart showing just one option with 100% coverage

The user is redirected to poll page after voting on the portlet

When voting on a portlet, the user is redirected to the poll page instead of staying on the current page and showing partial results on the portlet.

Modify polls workflow

the workflow should have the following states: Private, Pending review, Open, Closed

1. poll are created in Private state; only Owner, Manager, Editor, or Site Administrator can modify it
2. when the poll is Pending review, it can be edited by a Manager, Reviewer or Site Administrator
3. a poll in Pending review can be send to Open, with "Review portal content" permission, or to Private, with "Request review"
4. when the poll is Open, people can only vote, they can not modify the poll in any way
5. an Open poll can only be sent to Closed state by Manager or Site Administrator
6. when the poll is Closed nobody can edit anything, neither vote
7. there is no way to reopen a poll

I think this should be pretty straightforward.

comments?

Uncaught TypeError: Object # has no method 'test'

Voting on a portlet which is configured to display partial results fails with a Javascript error when running the related AJAX code. Vote is accepted but a loading spinner goes on forever so results can only be seen after manually refreshing the page.

Uncaught TypeError: Object # has no method 'test' +resource+plone.app.jquery.js:2

Tested on a Plone 4.2.3 instance on Chrome 23 e Firefox 19a2 (OSX).

Portlet: link back to poll page

It would be a nice enhancement for the portlet to have a link to take the user back to the location where the poll was created. User could then see the additional description text.

TypeError: __init__() got an unexpected keyword argument 'portlet_style'

When I want to save the voting portlet, I got this error message.

Traceback (innermost last):
Module ZPublisher.Publish, line 126, in publish
Module ZPublisher.mapply, line 77, in mapply
Module ZPublisher.Publish, line 46, in call_object
Module plone.app.portlets.browser.formhelper, line 53, in call
Module zope.formlib.form, line 795, in call
Module five.formlib.formbase, line 50, in update
Module zope.formlib.form, line 776, in update
Module zope.formlib.form, line 620, in success
Module plone.app.portlets.browser.formhelper, line 70, in handle_save_action
Module zope.formlib.form, line 901, in createAndAdd
Module collective.polls.portlet.voteportlet, line 179, in create
TypeError: init() got an unexpected keyword argument 'portlet_style'

display total number of votes on a poll

we should display the total number of votes casted on a poll somewhere in its view and in the portlet.

Anonymous users can not vote on an open poll

Steps to reproduce the problem:

1. Create a poll allowing anonymous votes and partial results
2. Vote as a registered user
3. Access as anonymous
4. Partial results are shown and you can not vote.

clear votes on an open poll that is sent back to revision

if an open poll has errors and it has to be sent back to revision, votes must be cleared to avoid poll manipulation.

Poll: Field "Allow anonymous" disappeared

When the poll is in private state and try to edit it, the field "Allow anonymous" disappeared.

Anonymous voting doesn't work at root level

If the poll was created at root level with the "allow anonymous" checkbox as true, anonymous users are not allowed to cast votes to it, even if the polla, and the site (poll parent) is visible by anonymous users.

returned status message:
"Anonymous user won't be able to vote, you forgot to publish the parent folder, you must sent back the poll to private state, publish the parent folder and open the poll again"

activation message

I'm curious why when I go to Site Setup -> Add-ons and activate collective.polls I end up with this message in the browser:

Installed Products
====================
collective.polls:ok:

This isn't what I would expect; it should redirect the browser back to the Add-ons page.

Implement link to poll in portlet

Portlet editors should be able to decide whether they want the portlet title linking back to the current poll object.

That helps a lot in accessing the displayed poll for edition. If this use case is too narrow we could at least automatically provide the hyperlink to those who can actually edit that poll.

show latest closed poll on portlet

if no open poll is available and the portlet is configured to show the latest open poll, we can show the results of latest closed poll.

Poll results are not shown to anonymous after voting

An anonymous user has to refresh the page after voting because the results are not shown automatically.

replace datagridfield with a new widget

datagridfield really sucks; we need to create a new widget to replace it on the poll.

Bug: Duplicated votes

I installed collective.theme.iwaters + collective.polls and when an anonymous votes is counting 2 votes and displaying 2 times the results in the portlet and view.

Implement data visualization options to Voting Portlet

Portlet creators should be able to choose whether to display votes with numbers, bars or pies - and even not displaying any information about votes at all.

This could be a radio selection list with the default option being inheriting from the choice made on the poll which is actually displayed.

/cc @agnogueira

missing submit button

In the Polls Dexterity Control panel "Fields tab" there is no submit button to save any amendments to the form.

Using Plone 4.1.4, Dexterity 1.2.1 and Polls 1.0.

Implement show_total for the portlet

A boolean to inform the display of the total votes on the poll.

Poll results could be shown also using a bar graph

Add a configuration field to select if the results are going to be shown using plain numbers or a bar graph.

write upgrade step from rc1 to 1.0

I think we need to fix permissions and workflow states.