Changeset 7172 for main/waeup.sirp/trunk/src/waeup

Timestamp:

22 Nov 2011, 17:39:35 (13 years ago)

Author:

Henrik Bettermann

Message:

Rename UserContainer? to UsersContainer? to be in line with ApplicantsContainer?, StudentsContainer?, HostelsCointainer?, PaymentsContainer?. In other words, a userscontainer contains users and it's not the container of a user. This is not really necessary in terms of English grammar but it helps to confuse container types.

Location:

main/waeup.sirp/trunk/src/waeup/sirp

Files:

• app.py (modified) (2 diffs)
• app.txt (modified) (1 diff)
• authentication.py (modified) (1 diff)
• authentication.txt (modified) (1 diff)
• browser/breadcrumbs.py (modified) (1 diff)
• browser/breadcrumbs.txt (modified) (1 diff)
• browser/interfaces.py (modified) (1 diff)
• browser/pages.py (modified) (3 diffs)
• browser/templates/userscontainerpage.pt (moved) (moved from main/waeup.sirp/trunk/src/waeup/sirp/browser/templates/usercontainerpage.pt)
• browser/viewlets.py (modified) (2 diffs)
• interfaces.py (modified) (1 diff)
• userscontainer.py (moved) (moved from main/waeup.sirp/trunk/src/waeup/sirp/usercontainer.py) (1 diff)
• userscontainer.txt (moved) (moved from main/waeup.sirp/trunk/src/waeup/sirp/usercontainer.txt) (1 diff)

main/waeup.sirp/trunk/src/waeup/sirp/app.py

@@ -10 +10 @@
 from waeup.sirp.interfaces import (
     IUniversity, IWAeUPSIRPPluggable, IObjectUpgradeEvent, )
-from waeup.sirp.usercontainer import UserContainer
+from waeup.sirp.userscontainer import UsersContainer
 from waeup.sirp.utils.logger import Logger
 from waeup.sirp.utils.helpers import attrs_to_fields
@@ -37 +37 @@
         the like.
         """
-        self['users'] = UserContainer()
+        self['users'] = UsersContainer()
         self['datacenter'] = DataCenter()
         self['students'] = StudentsContainer()

main/waeup.sirp/trunk/src/waeup/sirp/app.txt

@@ -65 +65 @@
 
   >>> myuniversity['users']
-  <waeup.sirp.usercontainer.UserContainer object at 0x...>
+  <waeup.sirp.userscontainer.UsersContainer object at 0x...>
 
   >>> myuniversity['datacenter']

main/waeup.sirp/trunk/src/waeup/sirp/authentication.py

@@ -153 +153 @@
     def getAccount(self, login):
         # ... look up the account object and return it ...
-        usercontainer = self.getUserContainer()
-        if usercontainer is None:
+        userscontainer = self.getUsersContainer()
+        if userscontainer is None:
             return
-        return usercontainer.get(login, None)
+        return userscontainer.get(login, None)
 
     def addAccount(self, account):
-        usercontainer = self.getUserContainer()
-        if usercontainer is None:
+        userscontainer = self.getUsersContainer()
+        if userscontainer is None:
             return
         # XXX: complain if name already exists...
-        usercontainer.addAccount(account)
+        userscontainer.addAccount(account)
 
     def addUser(self, name, password, title=None, description=None):
-        usercontainer = self.getUserContainer()
-        if usercontainer is None:
+        userscontainer = self.getUsersContainer()
+        if userscontainer is None:
             return
-        usercontainer.addUser(name, password, title, description)
-
-    def getUserContainer(self):
+        userscontainer.addUser(name, password, title, description)
+
+    def getUsersContainer(self):
         site = grok.getSite()
         return site['users']

main/waeup.sirp/trunk/src/waeup/sirp/authentication.txt

@@ -40 +40 @@
   >>> root['app']['users'].addAccount(alice)
 
-See ``users.txt`` for details about the UserContainer we use here.
+See ``users.txt`` for details about the UsersContainer we use here.
 
 Users and local roles

main/waeup.sirp/trunk/src/waeup/sirp/browser/breadcrumbs.py

@@ -124 +124 @@
         return 'Session %s' % session_string
 
-class UserContainerBreadcrumb(Breadcrumb):
+class UsersContainerBreadcrumb(Breadcrumb):
     """A breadcrumb for user containers.
     """
-    grok.context(interfaces.IUserContainer)
+    grok.context(interfaces.IUsersContainer)
     title = u'Portal Users'
     parent_viewname = 'administration'

main/waeup.sirp/trunk/src/waeup/sirp/browser/breadcrumbs.txt

@@ -120 +120 @@
     [<...breadcrumbs.UniversityBreadcrumb object at 0x...>,
      <...breadcrumbs.AdministrationBreadcrumb object at 0x...>,
-     <...breadcrumbs.UserContainerBreadcrumb object at 0x...>]
+     <...breadcrumbs.UsersContainerBreadcrumb object at 0x...>]
 
 

main/waeup.sirp/trunk/src/waeup/sirp/browser/interfaces.py

@@ -4 +4 @@
 from zope.interface import Interface, Attribute
 from waeup.sirp.interfaces import (
-    IWAeUPObject, IUniversity, IUserContainer, IDataCenter)
+    IWAeUPObject, IUniversity, IUsersContainer, IDataCenter)
 from waeup.sirp.university.interfaces import (
     IFacultyContainer, IFaculty, IFacultyAdd, IDepartment, IDepartmentAdd, 

main/waeup.sirp/trunk/src/waeup/sirp/browser/pages.py

@@ -32 +32 @@
 from waeup.sirp.browser.resources import warning, datepicker, tabs, datatable
 from waeup.sirp.interfaces import(
-    IWAeUPObject, IUserContainer, IUserAccount, IDataCenter,
+    IWAeUPObject, IUsersContainer, IUserAccount, IDataCenter,
     IWAeUPXMLImporter, IWAeUPXMLExporter, IBatchProcessor,
     ILocalRolesAssignable, DuplicationError, IConfigurationContainer,
@@ -245 +245 @@
 #
 
-class UserContainerPage(WAeUPPage):
+class UsersContainerPage(WAeUPPage):
     """Overview page for all local users.
     """
     grok.require('waeup.manageUsers')
-    grok.context(IUserContainer)
+    grok.context(IUsersContainer)
     grok.name('index')
     title = 'Portal Users'
@@ -262 +262 @@
 class AddUserFormPage(WAeUPAddFormPage):
     grok.require('waeup.manageUsers')
-    grok.context(IUserContainer)
+    grok.context(IUsersContainer)
     grok.name('add')
     grok.template('usereditformpage')

main/waeup.sirp/trunk/src/waeup/sirp/browser/viewlets.py

@@ -10 +10 @@
 from waeup.sirp.browser.pages import (
     UniversityPage, FacultyContainerPage, DatacenterPage, FacultyPage,
-    DepartmentPage, CoursePage, CertificatePage, CertificateCoursePage, UserContainerPage)
+    DepartmentPage, CoursePage, CertificatePage, CertificateCoursePage, UsersContainerPage)
 from waeup.sirp.browser.interfaces import (
     IFacultyContainer, IFaculty, IDepartment, ICourse, ICertificate,
-    ICertificateCourse, IBreadcrumbContainer, IUniversity, IUserContainer)
+    ICertificateCourse, IBreadcrumbContainer, IUniversity, IUsersContainer)
 from waeup.sirp.interfaces import (IWAeUPObject, IWAeUPXMLExporter,
                                    IWAeUPXMLImporter, IDataCenter)
@@ -422 +422 @@
 class AddUserActionButton(AddActionButton):
     grok.require('waeup.manageUsers')
-    grok.context(IUserContainer)
-    grok.view(UserContainerPage)
+    grok.context(IUsersContainer)
+    grok.view(UsersContainerPage)
     text = 'Add user'
 

main/waeup.sirp/trunk/src/waeup/sirp/interfaces.py

@@ -202 +202 @@
 
 
-class IUserContainer(IWAeUPObject):
+class IUsersContainer(IWAeUPObject):
     """A container for users (principals).
 

main/waeup.sirp/trunk/src/waeup/sirp/userscontainer.py

@@ -1 @@
-"""User container for the WAeUP portal.
+"""Users container for the WAeUP portal.
 """
 import grok
 from zope.event import notify
 from waeup.sirp.authentication import Account
-from waeup.sirp.interfaces import IUserContainer
+from waeup.sirp.interfaces import IUsersContainer
 
-class UserContainer(grok.Container):
+class UsersContainer(grok.Container):
     """A container for principals.
 
     See interfaces.py and users.txt for extensive description.
     """
-    grok.implements(IUserContainer)
+    grok.implements(IUsersContainer)
     grok.require('waeup.manageUsers')
 

main/waeup.sirp/trunk/src/waeup/sirp/userscontainer.txt

@@ -14 +14 @@
 us:
 
-    >>> from waeup.sirp.usercontainer import UserContainer
-    >>> myusers = UserContainer()
+    >>> from waeup.sirp.userscontainer import UsersContainer
+    >>> myusers = UsersContainer()
 
 We can add users, just by passing a name, a password, and (optionally)