bug #52: make the status list more coherent+ add automatic status for items containing tasks

doc/database/pod-upgrade-0.1.0_to_0.2.0.sql

@@ -0,0 +1,10 @@
+
+--
+-- Remove useless status
+--
+UPDATE pod_nodes SET node_status='information' WHERE node_status='immortal';
+UPDATE pod_nodes SET node_status='inprogress' WHERE node_status='actiontodo';
+UPDATE pod_nodes SET node_status='inprogress' WHERE node_status='hot';
+UPDATE pod_nodes SET node_status='actiontodo' WHERE node_status='actiontodo';
+UPDATE pod_nodes SET node_status='closed' WHERE node_status='archived';
+

pboard/pboard/controllers/root.py

@@ -123,13 +123,13 @@ class RootController(BaseController):
         loApiController = pld.PODUserFilteredApiController(loCurrentUser.user_id)
 
         # loRootNodeList   = pbm.DBSession.query(pbmd.PBNode).filter(pbmd.PBNode.parent_id==None).order_by(pbmd.PBNode.node_order).all()
-        loRootNodeList = loApiController.buildTreeListForMenu()
+        loRootNodeList = loApiController.buildTreeListForMenu(pbmd.PBNodeStatus.getVisibleIdsList())
         liNodeId         = int(node)
         
         loCurrentNode    = None
         loNodeStatusList = None
         try:
-          loNodeStatusList = pbmd.PBNodeStatus.getList()
+          loNodeStatusList = pbmd.PBNodeStatus.getChoosableList()
           loCurrentNode    = loApiController.getNode(liNodeId)
         except Exception as e:
           flash(_('Document not found'), 'error')

pboard/pboard/lib/dbapi.py

@@ -95,10 +95,10 @@ class PODUserFilteredApiController(object):
     return DBSession.query(pbmd.PBNode).options(joinedload_all("_lAllChildren")).filter(pbmd.PBNode.owner_id.in_(liOwnerIdList)).filter(pbmd.PBNode.node_status==psNodeStatus).order_by(pbmd.PBNode.updated_at).limit(piMaxNodeNb).all()
 
 
-  def buildTreeListForMenu(self):
+  def buildTreeListForMenu(self, plViewableStatusId):
     liOwnerIdList = self._getUserIdListForFiltering()
     
-    loNodeList = pbm.DBSession.query(pbmd.PBNode).filter(pbmd.PBNode.owner_id.in_(liOwnerIdList)).filter(pbmd.PBNode.node_type==pbmd.PBNodeType.Data).order_by(pbmd.PBNode.parent_tree_path).order_by(pbmd.PBNode.node_order).order_by(pbmd.PBNode.node_id).all()
+    loNodeList = pbm.DBSession.query(pbmd.PBNode).filter(pbmd.PBNode.owner_id.in_(liOwnerIdList)).filter(pbmd.PBNode.node_type==pbmd.PBNodeType.Data).filter(pbmd.PBNode.node_status.in_(plViewableStatusId)).order_by(pbmd.PBNode.parent_tree_path).order_by(pbmd.PBNode.node_order).order_by(pbmd.PBNode.node_id).all()
     loTreeList = []
     loTmpDict = {}
     for loNode in loNodeList:
@@ -112,7 +112,7 @@ class PODUserFilteredApiController(object):
         # The following line may raise an exception
         # We suppose that the parent node has already been added
         # this *should* be the case, but the code does not check it
-        if loNode.parent_id in loTmpDict.keys():
+        if loNode.parent_id not in loTmpDict.keys():
           loTmpDict[loNode.parent_id] = self.getNode(loNode.parent_id)
         loTmpDict[loNode.parent_id].appendStaticChild(loNode)
   

pboard/pboard/lib/helpers.py

@@ -5,6 +5,7 @@
 #from webhelpers import date, feedgenerator, html, number, misc, text
 from markupsafe import Markup
 from datetime import datetime
+from tg.i18n import ugettext as _, lazy_ugettext as l_
 
 def current_year():
   now = datetime.now()
@@ -15,3 +16,26 @@ def icon(icon_name, white=False):
         return Markup('<i class="icon-%s icon-white"></i>' % icon_name)
     else:
         return Markup('<i class="icon-%s"></i>' % icon_name)
+
+
+def getExplanationAboutStatus(psStatusId, psCurrentStatusId):
+  lsMsg = ""
+  if psStatusId==psCurrentStatusId:
+    return _("This is the current status.")
+  else:
+    if psStatusId=='information':
+      return _("The item is a normal document, like a howto or a text document.")
+    if psStatusId=='automatic':
+      return _("The item will be automatically computed as \"in progress\" or \"done\" according to its children status.")
+    if psStatusId=='new':
+      return _("No action done on the item.")
+    if psStatusId=='inprogress':
+      return _("The item is being worked on.")
+    if psStatusId=='standby':
+      return _("Waiting for some external actions.")
+    if psStatusId=='done':
+      return _("The work associated with the item is finished.")
+    if psStatusId=='closed':
+      return _("Close the item if you want not to see it anymore. The data won't be deleted")
+    if psStatusId=='deleted':
+      return _("This status tells that the item has been deleted.")

pboard/pboard/model/data.py

@@ -5,14 +5,16 @@ import re
 import datetime as datetimeroot
 from datetime import datetime
 from hashlib import sha256
-__all__ = ['User', 'Group', 'Permission']
 
 from sqlalchemy import Table, ForeignKey, Column, Sequence
 from sqlalchemy.types import Unicode, Integer, DateTime, Text, LargeBinary
 from sqlalchemy.orm import relation, synonym, relationship
 from sqlalchemy.orm import backref
+import sqlalchemy.orm as sqlao
 from sqlalchemy import orm as sqlao
 
+from tg.i18n import ugettext as _, lazy_ugettext as l_
+
 import tg
 from pboard.model import DeclarativeBase, metadata, DBSession
 
@@ -92,29 +94,52 @@ class PBNodeStatusItem(object):
 class PBNodeStatus(object):
     
   StatusList = dict()
-  StatusList['immortal']   = PBNodeStatusItem('immortal',   'Information',         'normal',    'fa fa-info-circle',        'pod-status-grey-light')
-  StatusList['new']        = PBNodeStatusItem('new',        'New',                 'open',      'fa fa-lightbulb-o',        'btn-success')
-  StatusList['inprogress'] = PBNodeStatusItem('inprogress', 'In progress',         'open',      'fa fa-gears fa-inverse',   'btn-info')
-  StatusList['actiontodo'] = PBNodeStatusItem('actiontodo', 'Action to do',        'open',      'fa fa-spinner fa-inverse', 'btn-info')
-  StatusList['standby']    = PBNodeStatusItem('standby',    'Waiting for news',    'open',      'fa fa-spinner fa-inverse', 'btn-warning')
-  StatusList['hot']        = PBNodeStatusItem('hot',        'Hot',                 'open',      'fa fa-warning fa-inverse', 'btn-danger')
-  StatusList['done']       = PBNodeStatusItem('done',       'Done',                'closed',    'fa fa-check-square-o',     'pod-status-grey-light')
-  StatusList['closed']     = PBNodeStatusItem('closed',     'Closed',              'closed',    'fa fa-lightbulb-o',        'pod-status-grey-middle')
-  StatusList['archived']   = PBNodeStatusItem('archived',   'Archived',            'invisible', 'fa fa-archive',            'pod-status-grey-dark')
-  StatusList['deleted']    = PBNodeStatusItem('deleted',    'Deleted',             'invisible', 'fa fa-trash-o',            'pod-status-grey-dark')
+  StatusList['information'] = PBNodeStatusItem('information', 'Information',         'normal', 'fa fa-info-circle',            'pod-status-grey-light')
+  StatusList['automatic']   = PBNodeStatusItem('automatic',   'Automatic',           'open',   'fa fa-flash',                  'pod-status-grey-light')
+  StatusList['new']         = PBNodeStatusItem('new',         'New',                 'open',   'fa fa-lightbulb-o fa-inverse', 'btn-success')
+  StatusList['inprogress']  = PBNodeStatusItem('inprogress',  'In progress',         'open',   'fa fa-gears fa-inverse',       'btn-info')
+  StatusList['standby']     = PBNodeStatusItem('standby',     'In standby',          'open',   'fa fa-spinner fa-inverse',     'btn-warning')
+  StatusList['done']        = PBNodeStatusItem('done',        'Done',                'closed', 'fa fa-check-square-o',         'pod-status-grey-light')
+  StatusList['closed']      = PBNodeStatusItem('closed',      'Closed',              'closed', 'fa fa-lightbulb-o',            'pod-status-grey-middle')
+  StatusList['deleted']     = PBNodeStatusItem('deleted',     'Deleted',             'closed', 'fa fa-trash-o',                'pod-status-grey-dark')
+
+  @classmethod
+  def getChoosableList(cls):
+    return [
+      PBNodeStatus.StatusList['information'],
+      PBNodeStatus.StatusList['automatic'],
+      PBNodeStatus.StatusList['new'],
+      PBNodeStatus.StatusList['inprogress'],
+      PBNodeStatus.StatusList['standby'],
+      PBNodeStatus.StatusList['done'],
+      PBNodeStatus.StatusList['closed'],
+    ]
+
+  @classmethod
+  def getVisibleIdsList(cls):
+    return ['information', 'automatic', 'new', 'inprogress', 'standby', 'done' ]
+
+  @classmethod
+  def getVisibleList(cls):
+    return [
+      PBNodeStatus.StatusList['information'],
+      PBNodeStatus.StatusList['automatic'],
+      PBNodeStatus.StatusList['new'],
+      PBNodeStatus.StatusList['inprogress'],
+      PBNodeStatus.StatusList['standby'],
+      PBNodeStatus.StatusList['done'],
+    ]
 
   @classmethod
   def getList(cls):
     return [
-      PBNodeStatus.StatusList['immortal'],
+      PBNodeStatus.StatusList['information'],
+      PBNodeStatus.StatusList['automatic'],
       PBNodeStatus.StatusList['new'],
-      PBNodeStatus.StatusList['actiontodo'],
       PBNodeStatus.StatusList['inprogress'],
       PBNodeStatus.StatusList['standby'],
-      PBNodeStatus.StatusList['hot'],
       PBNodeStatus.StatusList['done'],
       PBNodeStatus.StatusList['closed'],
-      PBNodeStatus.StatusList['archived'],
       PBNodeStatus.StatusList['deleted']
     ]
     
@@ -162,8 +187,8 @@ class PBNode(DeclarativeBase):
   parent_tree_path = Column(Unicode(255), unique=False, nullable=False, default='')
   owner_id         = Column(Integer, ForeignKey('pod_user.user_id'), nullable=True, default=None)
 
-  node_order  = Column(Integer, nullable=True, default=1)
-  node_type   = Column(Unicode(16), unique=False, nullable=False, default='data')
+  node_order   = Column(Integer, nullable=True, default=1)
+  node_type    = Column(Unicode(16), unique=False, nullable=False, default='data')
   node_status = Column(Unicode(16), unique=False, nullable=False, default='new')
 
   created_at = Column(DateTime, unique=False, nullable=False)
@@ -177,7 +202,7 @@ class PBNode(DeclarativeBase):
   
   data_file_name      = Column(Unicode(255),  unique=False, nullable=False, default='')
   data_file_mime_type = Column(Unicode(255),  unique=False, nullable=False, default='')
-  data_file_content   = Column(LargeBinary(), unique=False, nullable=False, default=None)
+  data_file_content   = sqlao.deferred(Column(LargeBinary(), unique=False, nullable=False, default=None))
 
 
   _oParent = relationship('PBNode', remote_side=[node_id], backref='_lAllChildren')
@@ -280,7 +305,19 @@ class PBNode(DeclarativeBase):
     return poDateTime.strftime(psDateTimeFormat)
 
   def getStatus(self):
-    return PBNodeStatus.getStatusItem(self.node_status)
+    loStatus = PBNodeStatus.getStatusItem(self.node_status)
+    if loStatus.status_id!='automatic':
+      return loStatus
+    else:
+      # Compute the status:
+      # - if at least one child is 'new' or 'in progress' or 'in standby' => status is inprogress
+      # - else if all status are 'done', 'closed' or 'deleted' => 'done'
+      lsRealStatusId = 'done'
+      for loChild in self.getChildren():
+        if loChild.getStatus().status_id in ('new', 'inprogress', 'standby'):
+          lsRealStatusId = 'inprogress'
+          break
+      return PBNodeStatus.getStatusItem(lsRealStatusId)
 
   def getTruncatedLabel(self, piCharNb):
     lsTruncatedLabel = ''

pboard/pboard/templates/document.mak

@@ -95,17 +95,24 @@ pod :: document ${current_node.getTruncatedLabel(40)} [#${current_node.node_id}
       </div>
     % endif
       <div class="btn-group">
-        <button class="btn">Status</button>
-        <a class="btn ${current_node.getStatus().css}" href="#"><i class="${current_node.getStatus().icon}"></i> ${current_node.getStatus().getLabel()}</a>
-        <a class="btn ${current_node.getStatus().css} dropdown-toggle" data-toggle="dropdown" href="#"><span class="caret"></span></a>
+        <button class="btn"  data-toggle="dropdown" href="#">${_("Change status")}</button>
+        <a class="btn dropdown-toggle" data-toggle="dropdown" href="#"><span class="caret"></span></a>
         <ul class="dropdown-menu">
-          % for node_status in node_status_list:
-            <li>
-              <a class="${node_status.css}" href="${tg.url('/api/edit_status?node_id=%i&node_status=%s'%(current_node.node_id, node_status.status_id))}">
-                <i class="${node_status.icon_id}"></i> ${node_status.label}
-              </a>
-            </li>
-          % endfor
+        % for node_status in node_status_list:
+          % if node_status.status_id==current_node.getStatus().status_id:
+          <li title="${h.getExplanationAboutStatus(node_status.status_id, current_node.getStatus().status_id)}">
+            <a class="${node_status.css}" href="#"  style="color: #999;">
+              <i class="${node_status.icon_id}"></i> ${node_status.label}
+            </a>
+          </li>
+          % else:
+          <li title="${h.getExplanationAboutStatus(node_status.status_id, current_node.getStatus().status_id)}">
+            <a class="${node_status.css}" href="${tg.url('/api/edit_status?node_id=%i&node_status=%s'%(current_node.node_id, node_status.status_id))}">
+              <i class="${node_status.icon_id}"></i> ${node_status.label}
+            </a>
+          </li>
+          % endif
+        % endfor
         </ul>
       </div>
       <div class="btn-group">
@@ -115,15 +122,18 @@ pod :: document ${current_node.getTruncatedLabel(40)} [#${current_node.node_id}
           ${node_treeview_for_set_parent_menu(current_node.node_id, root_node_list)}
         </ul>
 
-
-        <a href='${tg.url('/api/force_delete_node?node_id=%i'%(current_node.node_id))}' id='current-document-force-delete-button' class="btn" onclick="return confirm('${_('Delete current document?')}');"><i class="icon-g-remove"></i> ${_('Delete')}</a>
+        <a href='${tg.url('/api/edit_status?node_id=%i&node_status=%s'%(current_node.node_id, 'deleted'))}' id='current-document-force-delete-button' class="btn" onclick="return confirm('${_('Delete current document?')}');"><i class="fa fa-trash-o"></i> ${_('Delete')}</a>
+        
       </div>
 
       <div class="row">
         <div id='application-document-panel' class="span5">
           <p>
             <div id='current-document-content' class="">
-              <h3 id="current-document-title">#${current_node.node_id} - ${current_node.data_label}</h3>
+              <h3 id="current-document-title">#${current_node.node_id} - ${current_node.data_label}
+                <span class="label ${current_node.getStatus().css}" href="#">${current_node.getStatus().label}</a>
+              
+              </h3>
               ${current_node.getContentWithTags()|n}
             </div>
             <form style='display: none;' id="current-document-content-edit-form" method='post' action='${tg.url('/api/edit_label_and_content')}'>