falkolab.resource 1.0.3

Alternative extensible resource implementation.

falkolab.resource components
============================

This is set of components for extensible resources

>>> from zope import component, interface
>>> from falkolab.resource import interfaces, resourcetypes

>>> import falkolab.resource
>>> import os, os.path

>>> import tempfile
>>> scriptFileName = tempfile.mktemp('script.js')
>>> open(scriptFileName, 'w').write('script data')
>>> imageFileName = tempfile.mktemp('image.jpg')
>>> open(imageFileName, 'w').write('jpg image data')
>>> ptFileName = tempfile.mktemp('template.pt')
>>> open(ptFileName, 'w').write('zope page template')

Now we can register resources:

>>> from zope.configuration import xmlconfig
>>> import falkolab.resource
>>> import zope.app.zcmlfiles

>>> context = xmlconfig.file('configure.zcml', zope.app.zcmlfiles, execute=True)
>>> context = xmlconfig.file('configure.zcml', zope.app.schema, context=context, execute=True)
>>> context = xmlconfig.file('meta.zcml', falkolab.resource, context=context, execute=True)
>>> context = xmlconfig.file('configure.zcml', falkolab.resource, context=context, execute=True)

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="resource.js"
... src="%s" />
... </configure>
... """ % scriptFileName, context=context, execute=True)

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="image-resource"
... src="%s" />
... </configure>
... """ % imageFileName, context=context, execute=True)

Check if adapters are regitered:

>>> from zope.publisher.browser import TestRequest
>>> request = TestRequest()
>>> response = request.response

>>> resource = component.getAdapter(
... request, interface.Interface, name='resource.js')

>>> resource
<falkolab.resource.resourcetypes.FileResource object at ...>

>>> isinstance(resource.context, resourcetypes.File)
True

>>> resource = component.getAdapter(
... request, interface.Interface, name='image-resource')

>>> resource
<falkolab.resource.resourcetypes.FileResource object at ...>

>>> isinstance(resource.context, resourcetypes.Image)
True

We can specify resource type explicitly

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="image2-resource"
... type="image"
... src="%s" />
... </configure>
... """ % scriptFileName, context=context, execute=True)

>>> resource = component.getAdapter(
... request, interface.Interface, name='image2-resource')

>>> isinstance(resource.context, resourcetypes.Image)
True


Custom resource types
---------------------

We can implement custom resource type. All you need is to define a class
that implement interface IResourceFactory.

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
... <resourceType
... name="custom"
... factory="falkolab.resource.tests.CustomFileResourceFactory" />
... </configure>
... """, context=context, execute=True)

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="custom-resource"
... type="custom"
... src="%s" />
... </configure>
... """ %scriptFileName, context=context, execute=True)

>>> resource = component.getAdapter(
... request, interface.Interface, name='custom-resource')

>>> resource
<falkolab.resource.tests.CustomResource object at ...>


Type substitution
-----------------

We can substitute earlier registered type:

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
... <resourceType
... name="zpt"
... mask="*.pt"
... factory="falkolab.resource.tests.CustomFileResourceFactory" />
... </configure>
... """, context=context, execute=True)

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="pt-resource"
... src="%s" />
... </configure>
... """ %ptFileName, context=context, execute=True)

>>> resource = component.getAdapter(
... request, interface.Interface, name='pt-resource')

>>> resource
<falkolab.resource.tests.CustomResource object at ...>

>>> os.unlink(scriptFileName)
>>> os.unlink(imageFileName)
>>> os.unlink(ptFileName)


ZRT resource
------------

File names for ZRT resources must match one of following mask: *.zrt.css *.zrt.js *.zrt
Or you must set type attribute: type="zrt"

>>> zrtFileName = tempfile.mktemp('style.zrt.css')
>>> open(zrtFileName, 'w').write('''\
... /* zrt-replace: "foo" "bar" */
... foo foo foo foo foo''')

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="zpt-resource"
... src="%s" />
... </configure>
... """ %zrtFileName, context=context, execute=True)

>>> resource = component.getAdapter(
... request, interface.Interface, name='zpt-resource')

>>> resource
<falkolab.resource.zrt.zrtresourcetype.ZRTResource object at ...>

>>> print resource.GET()
bar bar bar bar bar

>>> os.unlink(zrtFileName)

We can specify zrt commant with `property` subdirective. We also can cpecify
resource type if file extension is not match zrt resource mask.

>>> zrtFileName = tempfile.mktemp('style.css')
>>> open(zrtFileName, 'w').write('''\
... foo foo foo foo foo''')

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="zpt-resource-with-property"
... src="%s"
... type="zrt">
... <property
... name="zrt-commands"
... value='/* zrt-replace: "foo" "muu" */' />
... </resource>
... </configure>
... """ %zrtFileName, context=context, execute=True)

>>> resource = component.getAdapter(
... request, interface.Interface, name='zpt-resource-with-property')

>>> print resource.GET()
muu muu muu muu muu

>>> os.unlink(zrtFileName)


Directory resource
------------------

>>> dirName = tempfile.mkdtemp()
>>> os.mkdir(os.path.join(dirName, 'subfolder'))
>>> open(os.path.join(dirName, 'script.js'), 'w').write('script data')
>>> open(os.path.join(dirName, 'style.css'), 'w').write('style data')
>>> open(os.path.join(dirName, 'image.png'), 'w').write('png image data')

We can register resource directory and specify allowed resource types:

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="resdir"
... type="directory"
... src="%s" />
...
... </configure>
... """ %(dirName + '_'), context=context, execute=True)
Traceback (most recent call last):
...
ZopeXMLConfigurationError: ...
ConfigurationError: Directory ... does not exist

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="resdir"
... type="directory"
... src="%s" />
...
... </configure>
... """ %dirName, context=context, execute=True)


>>> dirResource = component.getAdapter(
... request, interface.Interface, name='resdir')
>>> dirResource
<falkolab.resource.resourcetypes.DirectoryResource object at ...>

>>> dirResource.browserDefault(request)
(<function empty at ...>, ())

>>> resource = None
>>> resource = dirResource.publishTraverse(request, 'style.css')

>>> resource
<falkolab.resource.resourcetypes.FileResource object at ...>

>>> isinstance(resource.context, resourcetypes.File)
True

>>> print resource.GET()
style data
>>> print dirResource['style.css'].GET()
style data

>>> dirResource['notpresent.css']
Traceback (most recent call last):
...
KeyError: 'notpresent.css'

>>> resource = None
>>> resource = dirResource.publishTraverse(request, 'notpresent.css')
Traceback (most recent call last):
...
NotFound: ...

>>> resource = dirResource.publishTraverse(request, 'image.png')
>>> resource
<falkolab.resource.resourcetypes.FileResource object at ...>

>>> isinstance(resource.context, resourcetypes.Image)
True

>>> print resource.GET()
png image data

>>> subdir = dirResource.publishTraverse(request, 'subfolder')
>>> subdir
<falkolab.resource.resourcetypes.DirectoryResource object at ...>

We can specify allowed resource types for directory:

>>> context = xmlconfig.string("""
... <configure
... xmlns="http://namespaces.falkolab.ru/zope"
... package="falkolab.resource">
...
... <resource
... name="resdir2"
... type="directory"
... src="%s">
... <property name="types" value="image" />
... </resource>
...
... </configure>
... """ %dirName, context=context, execute=True)

>>> dirResource = None
>>> dirResource = component.getAdapter(
... request, interface.Interface, name='resdir2')

>>> dirResource.types
[u'image']

>>> resource = dirResource.publishTraverse(request, 'style.css')
Traceback (most recent call last):
...
NotFound: ...

>>> resource = dirResource.publishTraverse(request, 'image.png')
>>> resource
<falkolab.resource.resourcetypes.FileResource object at ...>

>>> isinstance(resource.context, resourcetypes.Image)
True

>>> os.unlink(os.path.join(dirName, 'script.js'))
>>> os.unlink(os.path.join(dirName, 'style.css'))
>>> os.unlink(os.path.join(dirName, 'image.png'))
>>> os.rmdir(os.path.join(dirName, 'subfolder'))
>>> os.rmdir(dirName)

CHANGES
=======

1.0.3 (2009-08-21)
------------------
- Update tests
- Some minor fixes

1.0.2 (2009-03-13)
------------------

- BUGFIX: ZRT resource invalid property assignment

1.0.1 (2009-03-13)
------------------

- BUGFIX: Impossibile to register two same named resources for different layers
with same named property subdirectives

1.0.0 (2009-03-11)
------------------

- First release