vnccollab.common 1.0.6

vnccollab.common
================

Overview
--------

vnccollab.common is a support package for vnccollab.* add-ons. It offers the
following features:

* A convenience memoizer class based on last time access.
* Keyword Search.
* Simple Vocabulary Factory.
* A convenience base class for deferred portlets.

TimeCacheKey
------------

TimeCacheKey is a helper class to add volatile cache based on last time access. You can use it in the following way: ::

>>> from plone.memoize import ram
>>> from vnccollab.common.cache import TimeCacheKey
>>> CACHE_TIME = 15 * 60 # 15 minutes
>>> cache = TimeCacheKey(CACHE_TIME)
>>> ram(cache)
>>> def sum(a, b): return a + b
...


Keyword Search
--------------

A keyword search is a special kind of search that takes place when a keyword
suffixed by ``:`` is present in the search string. This package offers a
``search`` view with keyword search.

Currently, there are two keywords defined:

- ``type:`` keyword: The search returns only object of the types specified
in the query.
- ``user:`` keyword: The search returns only objects created by the user
specified in the query.

Simple Vocabulary Factory
-------------------------

``SimpleVocabularyFactory`` is a convenience class for the creation of
vocabularies based in a list of tuples: ::

>>> from vnccollab.common.vocabularies import SimpleVocabularyFactory
>>> semaphore = [('r', 'Red'), ('y', 'Yellow'), ('g', 'Green')]
>>> semaphoreVocabulary = SimpleVocabularyFactory(semaphore)

Deferred Portlet
----------------

``DeferredRenderer`` is a convenience class for the creation of deferred
portlets. It extends ``plone.app.portlets.portlets.base.DeferredRendered``
and adds easy access to the portlet metadata. This class is intended to
be used by other vnccollab packages.


Changelog
=========

1.0.6 - July 02, 2014
------------------

- Adds portlet migration functions.
[JOse Dinuncio]

- Cleans setup.py [11080].
[Jose Dinuncio]


1.0.5 - April 11, 2014
----------------------

- Adds common icon images [10960].
[Cesar Gonzalez]

- Force css override for dynatree [10936].
[Cesar Gonzalez]

- Fixes cssregistry order. Upgrade step 1102 [10936].
[Cesar Gonzalez]

1.0.4 - April 02, 2014
----------------------

- Add unit tests [10656].
[Marcin Staniszczak]

- Adds README documentation.
[Jose Dinuncio]

1.0.3 - March 07, 2014
----------------------

- Fixes tests.
[Jose Dinuncio]

- Improves speed in user search [10169].
[Jose Dinuncio].

- Adds version.txt.
[Jose Dinuncio]

1.0.2 - December 06, 2013
-------------------------

- Adds lost hotfix.
[Jose Dinuncio]

1.0.1 - November 20, 2013
-------------------------

- Adds missing images of dynatree jquery plugin. Adds main.js resource [9049].
[Cesar Gonzalez]

- Adds dynatree jquery plugin. Upgrade step 1100.
[Cesar Gonzalez]

- Adds vocabualry utility.
[Jose DInuncio]

- Add more js scripts for stream and casts.
[Vitaliy Podoba]

1.0.0 - October 24, 2013
------------------------

- Add jquery selection field js plugin.
[Vitaliy Podoba]

- Adds search keywords.
[Jose Dinuncio]

- Adds custom event for portlet loading complete.
[Cesar Gonzalez]

- Attach portlet buttons when deferred porlets are complete
[Cesar Gonzalez]

- Initial release.