Metadata-Version: 1.0
Name: cornerstone.soup
Version: 1.0b2
Summary: Container for queryable Records.
Home-page: http://dev.plone.org/collective/browser/cornerstone.soup
Author: BlueDynamics Alliance
Author-email: dev@bluedynamics.com
License: BSD
Description: Overview
        ========
        
        cornerstone.soup provides a container for persistent records which are
        queryable. The code is tested with Plone3.3 but should work with any Zope2.10+
        application, as long as the appropriate utilities are provided via persistent
        local components.
        
        
        Usage
        =====
        
        Subclass the Soup object and give it an appropriate id::
        
        >>> from cornerstone.soup import Soup
        >>> class MySoup(Soup):
        ...     id = u'mysoup'
        
        
        We have to provide a Catalog Factory for our soup::
        
        >>> from zope.interface import implements
        >>> from zope.catalog.catalog import Catalog
        >>> from zope.catalog.field import FieldIndex
        >>> from cornerstone.soup.interfaces import ICatalogFactory
        >>> class MyCatalogFactory(object):
        ...     implements(ICatalogFactory)
        ...
        ...     def __call__(self):
        ...         catalog = Catalog()
        ...         catalog[u'name'] = FieldIndex(field_name='name',
        ...                                       field_callable=False)
        ...         return catalog
        
        
        Now, 3 things have to be registered under the same name:
        
        * the catalog factory for this soup
        * the specific soup
        * a five.intid.intid.OFSIntIds object
        
        
        Register the ``ICatalogFactory`` as utility via ZCML::
        
        <utility
        name="mysoup"
        factory=".mymodule.MyCatalogFactory"
        provides="cornerstone.soup.interfaces.ICatalogFactory"
        />
        
        
        The ``IIntIds`` and ``ISoup`` utilities are registered as local components.
        
        In Plone you can easily register you local components via GenericSetup.
        Therefor you have to provide a file named ``componentregistry.xml`` in your
        profile directory, which looks similar to this::
        
        <utilities>
        <utility
        name="mysoup"
        factory="mymodule.MySoup"
        interface="cornerstone.soup.interfaces.ISoup"
        />
        <utility
        name="mysoup"
        factory="five.intid.intid.OFSIntIds"
        interface="zope.app.intid.interfaces.IIntIds"
        />
        </utilities>
        
        
        After including cornerstone.soup and your module in your instance and after
        applying the GS profile, you can query the soup utility::
        
        >>> from zope.component import getUtility
        >>> from cornerstone.soup.interfaces import ISoup
        >>> soup = getUtility(ISoup, name=u'mysoup')
        
        
        A Soup can only contain ``Records``. A Record is a simple persistent object
        which accepts any keyword arguments on ``__init__`` time. This arguments are
        used as Record properties. Be aware that the rules to persist to the ZODB
        applies here::
        
        >>> from cornerstone.soup import Record
        
        >>> rec = Record(name=u'rec1')
        >>> soup.add(rec)
        >>> rec = Record(name=u'rec2')
        >>> soup.add(rec)
        
        >>> soup.query(name=u'rec1')
        [<Record at /.../record-0>]
        
        >>> soup.query(name=u'rec2')
        [<Record at /.../record-1>]
        
        
        You can modify records already contained in Soup. If an attribute used for
        indexing was modified, you have to reindex this record::
        
        >>> rec.data['name'] = u'rec1'
        >>> soup.reindex([rec])
        >>> soup.query(name=u'rec1')
        [<Record at /.../record-0>, <Record at /.../record-1>]
        
        
        You can rebuild the whole catalog as well, this is i.e. useful if you added
        indexes to your CatalogFactory and want to apply these changes to your
        existent Soup::
        
        >>> soup.rebuild()
        
        
        Deleting records from the soup is implemented via the ``__delitem__``
        function::
        
        >>> del soup[rec]
        >>> soup.query(name=u'rec1')
        [<Record at /.../record-0>]
        
        
        TODO
        ====
        
        * fix the tests. I have to take a closer look on how to setup a test ZODB and
        an appropriate local component registry to make the soup work properly
        inside the test environment.
        
        
        Changes
        =======
        
        * 1.0b2
        - change namechoosing of records. Use ``uuid.uuid4()`` 2009-10-01 - rnix
        - add ``lazy`` function for querying huge results 2009-10-01 - rnix
        - yield query result instead of collect in a list 2009-09-29 - rnix
        
        * 1.0b1
        - initial work - rnix, jensens
        
        
        Contributors
        ============
        
        * Robert Niederreiter <rnix@squarewave.at>
        * Jens Klein <jens@bluedynamics.com>
        
        
        License
        =======
        
        Copyright (c) 2008-2009, BlueDynamics Alliance, Austria
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
        * Neither the name of the BlueDynamics Alliance nor the
        names of its contributors may be used to endorse or promote products
        derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY BlueDynamics Alliance ''AS IS'' AND ANY
        EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL BlueDynamics Alliance BE LIABLE FOR ANY
        DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
        ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
        SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Keywords: container data record catalog
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Zope2
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
