Changeset 21 for trunk

Timestamp:

08/12/05 00:02:20 (7 years ago)

Author:

mj

Message:

Refactoring time again:

• Completely get rid of key domains collections. Instead, rely on registration of domains as named utilities. This way domains can be mixed local and global, and can have local overrides. Much better setup all round

• Simplify the Domain interface somewhat. Title and description can be supplied by Dublin Core instead.

• Remove a now redundant key lookup error exception

• Provide a simple persistent domain with tests

Location:

trunk/src/chronolog

Files:

• interfaces.py (modified) (9 diffs)
• keys/browser/configure.zcml (modified) (1 diff)
• keys/configure.zcml (modified) (2 diffs)
• keys/domainscollection.py (deleted)
• keys/simpledomain.py (added)
• keys/tests.py (added)

trunk/src/chronolog/interfaces.py

@@ -52 +52 @@
 
 
-class TimeLogKeyLookupError(LookupError):
-    """A key could not be found for a given id"""
-
-
 class ITimeLogKeyDomain(IEnumerableMapping):
     """A key domain
     
-    A key domain is the source where keys are obtained, like principals or
-    projects. ITimeLogKeys are keyed on their id, and their domain property
-    should be set to the id of this domain.
+    A key domain is the source where keys are obtained, like 'principals' or
+    'projects'. ITimeLogKeys are keyed on their id. Domains are looked up as
+    named utilities.
     
     """
@@ -67 +63 @@
         title=_(u'Id'),
         description=_(u'The identifier of the domain.'),
-        required=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 ITimeLogKeyDomainsCollection(IEnumerableMapping):
-    """A utility providing a collection of ITimeLogKeyDomians
-
-    ITimeLogKeyDomains are keyed on their id.
-    
-    """
+        required=True,
+        readonly=True)
 
 
@@ -98 +77 @@
     allowed to delete it.
     
-    .. note::
-       All keys **must** be from obtainable from the domains collection 
-       available as utility.
-
     """
     keys = Set(
@@ -143 +118 @@
         None can be discarded from the store completely.
 
-        .. note::
-           All keys on entries **must** be from obtainable from the domains 
-           collection available as utility.
-
         """
 
@@ -166 +137 @@
         ((A, B, D),)
  
-        .. note::
-           All keys **must** be from obtainable from the domains collection 
-           available as utility.
-         
         """
 
@@ -184 +151 @@
         eligable, but a log entry against (A, B, C) is.
 
-        .. note::
-           All keys **must** be from obtainable from the domains collection 
-           available as utility.
-
         """
 
@@ -204 +167 @@
         logged. Never terminates.
 
-        .. note::
-           All keys **must** be from obtainable from the domains collection 
-           available as utility.
-
         """
 
@@ -225 +184 @@
         limited by the start_date and end_date.
 
-        .. note::
-           All keys **must** be from obtainable from the domains collection 
-           available as utility.
-
     """
 
@@ -236 +191 @@
 
     A timesheet is a view on a ITimeLogStore for a given time period and keys.
-
-    .. note::
-       All keys **must** be from obtainable from the domains collection 
-       available as utility.
 
     """

trunk/src/chronolog/keys/browser/configure.zcml

@@ -3 +3 @@
     xmlns="http://namespaces.zope.org/browser">
 
-<!-- key domains collection -->
+<!-- simple key domain -->
 <tool
-    interface="chronolog.interfaces.ITimeLogKeyDomainsCollection"
-    title="TimeLog Key Domains Collection"
+    interface="chronolog.interfaces.ITimeLogKeyDomain"
+    title="TimeLog Key Domain"
     description="TimeLog entries are logged against a set of keys coming
-                 from various domains. The domains are looked up in a domains
-                 collection"
-    unique="True"
+                 from various domains. These domains are looked up as named
+                 utilities."
     />
     
 <addMenuItem
-    title="TimeLog Key Domains Collection"
+    title="TimeLog Simple Key Domain"
     description="TimeLog entries are logged against a set of keys coming
-                 from various domains. The domains are looked up in a domains
-                 collection"
-    class="..domainscollection.LocalKeyDomainsCollection"
+                 from various domains. This is a simple persistent domain."
+    class="..simpledomain.SimpleKeyDomain"
     permission="zope.ManageContent"
     />
 
-
 </configure>

trunk/src/chronolog/keys/configure.zcml

@@ -2 +2 @@
    xmlns="http://namespaces.zope.org/zope">
    
-<localUtility class=".domainscollection.LocalKeyDomainsCollection">
+<localUtility class=".simpledomain.SimpleKeyDomain">
   <implements
       interface="zope.app.container.interfaces.IContainerNamesContainer"
@@ -14 +14 @@
       interface="zope.app.container.interfaces.IWriteContainer"
       />
-  <factory id="chronolog.keys.domainscollection" />
 </localUtility>
 
 <adapter
-    for=".domainscollection.ILocalTimeLogKeyDomainsCollection"
+    for=".simpledomain.ILocalTimeLogKeyDomain"
     provides="zope.app.container.interfaces.INameChooser"
     factory="..common.IdAttributeNameChooser"