[Checkins] SVN: Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/ added a readme

[Christian Klinger]

Log message for revision 105814:
  added a readme

Changed:
  A   Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/README.txt
  A   Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/ftests/test_readme.py

-=-
Added: Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/README.txt
===================================================================
--- Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/README.txt	                        (rev 0)
+++ Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/README.txt	2009-11-18 09:59:30 UTC (rev 105814)
@@ -0,0 +1,54 @@
+===============
+megrok.resource
+===============
+
+After many discussions on the mailinglist, on irc and the sprint in cologne
+i started to work on a first prototype of megrok.resource.
+
+megrok.resource is a combination of these packages:
+
+ - hurry.resource
+ - hurry.zoperesource
+ - grokcore.view.ResourceDirectory
+ - z3c.hashedresource (if our zope.app.publisher >= 3.8.2)
+
+
+How does it work:
+=================
+
+Setup
+-----
+
+  >>> from zope.app.testing.functional import getRootFolder
+  >>> from zope.app.component.site import SiteManagerContainer 
+  >>> from zope.app.component.site import LocalSiteManager
+  >>> from zope.app.component.hooks import setSite
+
+  >>> class Application(SiteManagerContainer):
+  ...     pass
+
+  >>> root = getRootFolder()
+  >>> root['myapp'] = Application()
+
+Our application has to be a Site to access the right url for the inclusions
+
+  >>> root['myapp'].setSiteManager(LocalSiteManager(root['myapp']))
+  >>> setSite(root['myapp'])
+  >>> root['myapp']
+  <Application object at ...>
+
+Let's start with a Library. A Library is in the context of megrok.resource
+a ResourceDirectory which holds a kind of different ResourceInclusions
+
+  >>> from megrok.resource import Library, inclusion, include
+  >>> import grokcore.view as view 
+  >>> import grokcore.component as grok 
+
+  >>> class MyStylesA(Library):
+  ...    view.path('cssttt')
+  ...    grok.name('mystyles')
+  ...
+  ...    inclusion(name='myjs', file='a.js')  
+
+  >>> grok.testing.grok_component('MyStylesA', MyStylesA)
+

Added: Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/ftests/test_readme.py
===================================================================
--- Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/ftests/test_readme.py	                        (rev 0)
+++ Sandbox/cklinger/megrok.resource/trunk/src/megrok/resource/ftests/test_readme.py	2009-11-18 09:59:30 UTC (rev 105814)
@@ -0,0 +1,16 @@
+import unittest
+from zope.testing import doctest
+from zope.app.testing import functional
+from megrok.resource.ftests import FunctionalLayer
+
+
+def test_suite():
+    readme = functional.FunctionalDocFileSuite(
+        '../README.txt',
+        optionflags=(doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE),
+        )
+    readme.layer = FunctionalLayer
+    suite = unittest.TestSuite()
+    suite.addTest(readme)
+    return suite
+