medialog.boardfile 1.0

Boardfile content type

.. contents::

.. Medialog Boardfile
-----

– Content type for uploading of documents that needs to be approved by
many persons.
- The workflow is called "Multiapprove workflow"
– After installing you can set the group that can approve in
/portal_workflow (default to "Reviewers")
– Reviewer is also added to portal_catalog index, so it is possible to
make a smart folder showing only objects the current user has not approved
- Content that nobody has looked at for a certain time automatically
gets published if nobody has "rejected" it.
– You will have to add clockserver after [instance] in your buildout,
something like:

zope-conf-additional =
<clock-server>
method /mysite/@@tick
period 120
host localhost
user admin
password mypassword
</clock-server>

Please note, this product is still in the making



Espen Moe-Nilssen <espen at medialog dot no>, author
Change history
**************

Changelog
=========

1.0 (2010-06-06)
----------------

_ Alfa version
- Created recipe with ZopeSkel
�Added content type "Boardfile"
- Added browser views
�Added workflow "multiapprove workflow" so all "Reviewers" can "approve"
or "reject" the boardfile
�Added time based trasaction... the "Boardfile" gets published after "n"
days if none of the "Reviewers" has "rejected" it.
- Added "Boardfile_listing" view.
Warning: This will give you an error if you use it on a folder
containing something else than "Boardfiles", so it is in "skins" dir and not in ues.

To do:
=======
�Change time to "creation date", it should take 20 days from creation,
not from "last transaction in history".
�Far to much code in "browser"... could need some help here.
�Time before the transaction is now about 14 minutes (for testing), will
change to 20 days.



[Espen Moe-Nilssen]

Detailed Documentation
**********************

Introduction
============

This is a full-blown functional test. The emphasis here is on testing what
the user may input and see, and the system is largely tested as a black box.
We use PloneTestCase to set up this test as well, so we have a full
Plone site
to play with. We *can* inspect the state of the portal, e.g. using
self.portal and self.folder, but it is often frowned upon since you are not
treating the system as a black box. Also, if you, for example, log in or set
roles using calls like self.setRoles(), these are not reflected in the test
browser, which runs as a separate session.

Being a doctest, we can tell a story here.

First, we must perform some setup. We use the testbrowser that is shipped
with Five, as this provides proper Zope 2 integration. Most of the
documentation, though, is in the underlying zope.testbrower package.

>>> from Products.Five.testbrowser import Browser
>>> browser = Browser()
>>> portal_url = self.portal.absolute_url()

The following is useful when writing and debugging testbrowser tests. It
lets
us see all error messages in the error_log.

>>> self.portal.error_log._ignored_exceptions = ()

With that in place, we can go to the portal front page and log in. We will
do this using the default user from PloneTestCase:

>>> from Products.PloneTestCase.setup import portal_owner, default_password

>>> browser.open(portal_url)

We have the login portlet, so let's use that.

>>> browser.getControl(name='__ac_name').value = portal_owner
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()

Here, we set the value of the fields on the login form and then simulate a
submit click.

We then test that we are still on the portal front page:

>>> browser.url == portal_url
True

And we ensure that we get the friendly logged-in message:

>>> "You are now logged in" in browser.contents
True


-*- extra stuff goes here -*-
The Boardfile content type
===============================

In this section we are tesing the Boardfile content type by performing
basic operations like adding, updadating and deleting Boardfile content
items.

Adding a new Boardfile content item
--------------------------------

We use the 'Add new' menu to add a new content item.

>>> browser.getLink('Add new').click()

Then we select the type of item we want to add. In this case we select
'Boardfile' and click the 'Add' button to get to the add form.

>>> browser.getControl('Boardfile').click()
>>> browser.getControl(name='form.button.Add').click()
>>> 'Boardfile' in browser.contents
True

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'Boardfile Sample'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

And we are done! We added a new 'Boardfile' content item to the portal.

Updating an existing Boardfile content item
---------------------------------------

Let's click on the 'edit' tab and update the object attribute values.

>>> browser.getLink('Edit').click()
>>> browser.getControl(name='title').value = 'New Boardfile Sample'
>>> browser.getControl('Save').click()

We check that the changes were applied.

>>> 'Changes saved' in browser.contents
True
>>> 'New Boardfile Sample' in browser.contents
True

Removing a/an Boardfile content item
--------------------------------

If we go to the home page, we can see a tab with the 'New Boardfile
Sample' title in the global navigation tabs.

>>> browser.open(portal_url)
>>> 'New Boardfile Sample' in browser.contents
True

Now we are going to delete the 'New Boardfile Sample' object. First we
go to the contents tab and select the 'New Boardfile Sample' for
deletion.

>>> browser.getLink('Contents').click()
>>> browser.getControl('New Boardfile Sample').click()

We click on the 'Delete' button.

>>> browser.getControl('Delete').click()
>>> 'Item(s) deleted' in browser.contents
True

So, if we go back to the home page, there is no longer a 'New Boardfile
Sample' tab.

>>> browser.open(portal_url)
>>> 'New Boardfile Sample' in browser.contents
False

Adding a new Boardfile content item as contributor
------------------------------------------------

Not only site managers are allowed to add Boardfile content items, but
also site contributors.

Let's logout and then login as 'contributor', a portal member that has the
contributor role assigned.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url)
>>> browser.getControl(name='__ac_name').value = 'contributor'
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()
>>> browser.open(portal_url)

We use the 'Add new' menu to add a new content item.

>>> browser.getLink('Add new').click()

We select 'Boardfile' and click the 'Add' button to get to the add form.

>>> browser.getControl('Boardfile').click()
>>> browser.getControl(name='form.button.Add').click()
>>> 'Boardfile' in browser.contents
True

Now we fill the form and submit it.

>>> browser.getControl(name='title').value = 'Boardfile Sample'
>>> browser.getControl('Save').click()
>>> 'Changes saved' in browser.contents
True

Done! We added a new Boardfile content item logged in as contributor.

Finally, let's login back as manager.

>>> browser.getLink('Log out').click()
>>> browser.open(portal_url)
>>> browser.getControl(name='__ac_name').value = portal_owner
>>> browser.getControl(name='__ac_password').value = default_password
>>> browser.getControl(name='submit').click()
>>> browser.open(portal_url)




Contributors
************

Espen Moe-Nilssen, Author


Download
********