Changeset 29

Timestamp:

08/14/05 12:43:59 (6 years ago)

Author:

mj

Message:

Change my mind: domains should have a title and desc anyway. The persistant version can use DC just like the simple key class can.

Location:

trunk/src/chronolog

Files:

• interfaces.py (modified) (1 diff)
• keys/simpledomain.py (modified) (4 diffs)
• keys/tests.py (modified) (3 diffs)

trunk/src/chronolog/interfaces.py

@@ -66 +66 @@
         readonly=True)
 
+    title = TextLine(
+        title=_(u'Title'),
+        description=_(u'The domain title for UI display'),
+        required=False)
+    
+    description = Text(
+        title=_(u'Description'),
+        description=_(u'A detailed description of the domain.'),
+        required=False)
+
 
 class ITimeLogEntry(Interface):

trunk/src/chronolog/keys/simpledomain.py

@@ -17 +17 @@
 from zope.interface import implements
 
+from zope.app.annotation.interfaces import IAttributeAnnotatable
 from zope.app.container.interfaces import IContainer
 from zope.app.container.btree import BTreeContainer
@@ -22 +23 @@
 from zope.app.component.interfaces.registration import IRegisterable
 from zope.app.component.interfaces.registration import IRegistered
+from zope.app.dublincore.interfaces import IZopeDublinCore
 
 from chronolog.interfaces import ITimeLogKeyDomain
@@ -34 +36 @@
 
 class SimpleKeyDomain(BTreeContainer):
-    """Persistent local utility domain"""
+    """Persistent local utility domain
+
+    title and description are implemented in terms of their Dublin Core
+    counterparts. This ensures that we can implement the interface without
+    then having conflicting UI:
     
-    implements(ITimeLogKeyDomain, IContainerTimeLogKeyDomain, IRegisterable)
+     >>> from chronolog.keys.simpledomain import SimpleKeyDomain
+     >>> domain = SimpleKeyDomain()
+
+    Title and description are really Dublin Core fields:
+    
+     >>> domain.title = u'Foo title'
+     >>> domain.description = u'Foo description'
+     >>> from zope.app.dublincore.interfaces import IZopeDublinCore
+     >>> IZopeDublinCore(domain).title
+     u'Foo title'
+     >>> IZopeDublinCore(domain).description
+     u'Foo description'
+     
+    This, of course, also works the other way around:
+    
+     >>> IZopeDublinCore(domain).title = u'Bar title'
+     >>> IZopeDublinCore(domain).description = u'Bar description'
+     >>> domain.title
+     u'Bar title'
+     >>> domain.description
+     u'Bar description'
+
+    The id is defined as the first name under which we where registered.
+    So if a SimpleKeyDomain is registered under the name 'foo', the id
+    attribute should reflect that:
+        
+     >>> from chronolog.interfaces import ITimeLogKeyDomain
+     >>> from zope.app import zapi
+     >>> domain = zapi.getUtility(ITimeLogKeyDomain, u'foo')
+     >>> domain.id
+     u'foo'
+        
+    Of course, if it was registered nameless, the id should reflect that too:
+        
+     >>> domain = zapi.getUtility(ITimeLogKeyDomain)
+     >>> domain.id
+     u''
+        
+    """
+    
+    implements(ITimeLogKeyDomain, IContainerTimeLogKeyDomain, IRegisterable,
+               IAttributeAnnotatable)
     
     def getId(self):
-        """Return the id of the domain.
-        
-        The name is defined as the first name under which we where registered.
-        So if a SimpleKeyDomain is registered under the name 'foo', the id
-        attribute should reflect that:
-        
-         >>> from chronolog.interfaces import ITimeLogKeyDomain
-         >>> from zope.app import zapi
-         >>> domain = zapi.getUtility(ITimeLogKeyDomain, u'foo')
-         >>> domain.id
-         u'foo'
-        
-        Of course, if it was registered nameless, the id should reflect that
-        too:
-        
-         >>> domain = zapi.getUtility(ITimeLogKeyDomain)
-         >>> domain.id
-         u''
-        
+        """Return the id of the domain
         """
         registrations = IRegistered(self).registrations()
@@ -63 +92 @@
             return ''
         return registrations[0].name
+    id = property(getId)
 
-    id = property(getId)
+    def getTitle(self): return IZopeDublinCore(self).title
+    def setTitle(self, title): IZopeDublinCore(self).title = title
+    title = property(getTitle, setTitle)
+    
+    def getDesc(self): return IZopeDublinCore(self).description
+    def setDesc(self, desc): IZopeDublinCore(self).description = desc
+    description = property(getDesc, setDesc)
+    

trunk/src/chronolog/keys/tests.py

@@ -21 +21 @@
 
 from zope.interface import implements
+from zope.app.annotation.interfaces import IAnnotations
+from zope.app.annotation.interfaces import IAttributeAnnotatable
+from zope.app.annotation.attribute import AttributeAnnotations
 from zope.app.component.interfaces.registration import IRegistered
+from zope.app.dublincore.annotatableadapter import ZDCAnnotatableAdapter
+from zope.app.dublincore.interfaces import IWriteZopeDublinCore
 
 
@@ -47 +52 @@
     ztapi.provideAdapter(ITimeLogKeyDomain, IRegistered, 
                          DummyRegisteredAdapter)
+    ztapi.provideAdapter(IAttributeAnnotatable, IAnnotations, 
+                         AttributeAnnotations)
+    ztapi.provideAdapter(IAttributeAnnotatable, IWriteZopeDublinCore, 
+                         ZDCAnnotatableAdapter)
     
     namelessDomain = SimpleKeyDomain()
@@ -57 +66 @@
 
 def simpleSetUp(test):
-    from zope.app.annotation.interfaces import IAnnotations
-    from zope.app.annotation.interfaces import IAttributeAnnotatable
-    from zope.app.annotation.attribute import AttributeAnnotations
-    from zope.app.dublincore.annotatableadapter import ZDCAnnotatableAdapter
-    from zope.app.dublincore.interfaces import IWriteZopeDublinCore
-
     placelesssetup.setUp(test)
     ztapi.provideAdapter(IAttributeAnnotatable, IAnnotations,