Enable HoursInPlaceEditor functionality for reports

[Jason Winnebeck]

Enable the HoursInPlaceEditor to work with custom reports.

The request handler only injects the javascript into the custom query pages. This is probably because the script, as is, doesn't work for report pages, for three reasons:

1. The column for the ticket numbers has class "ticket" whereas in query it has class "id". The class is "ticket" in reports regardless of whether or not the report's columnname is "id" or "ticket"
2. The HTML generated for the ticket column in the report module has a lot of extra whitespace added. The script assumes that the column's text is like "#123", with no spaces, and that all of the characters in the string after the first form a number.
3. The path to the xmlrpc is not correct when in a report page.

I fixed these three issues with the patch below. A disclaimer: I program Java, C#, C++, and a little Python out of necessity for Trac but I've never done JavaScript or JQuery, so there's probably better ways to do it. Also, a lot of whitespace changed so the changes below look like more than they are. Only the top portion of the script changed.

estimationtools/hoursinplaceeditor.py

@@ -28 +28 @@
         return handler
 
     def post_process_request(self, req, template, data, content_type):
-        if (req.path_info.startswith('/query')
+        if (req.path_info.startswith('/query') or req.path_info.startswith('/report')
             and req.perm.has_permission('TICKET_MODIFY')
             and req.perm.has_permission('XML_RPC')):
             # add_script(req, 'estimationtools/jquery-1.2.3.min.js')

estimationtools/templates/edithours.html

@@ -2 +2 @@
       xmlns:xi="http://www.w3.org/2001/XInclude"
       xmlns:py="http://genshi.edgewall.org/" py:strip="">
 $(document).ready(function() {
-    ids = $('td.id').each(function(i) {
-       var id = $(this).text().substr(1);
-       var estimationField = '$data.field';
+    var reportMethod = $('td.ticket'); //used in Trac reports
+    var queryMethod = $('td.id');      //used in custom queries
 
-          var estimationCell = $('td.' + estimationField).eq(i);
+    var xmlrpcPath = null;
+    var elements   = null;
 
-          estimationCell.editable(function(value, settings) {
-         var currentElement = this;
-         $.ajax({
-           type: 'POST',
-           url: 'xmlrpc',
-           data: '<methodCall><methodName>ticket.update</methodName>' +
-                  '<params><param><value><int>' + id + '</int></value></param>' +
-                  '<param><value><string></string></value></param>' +
-                  '<param><value><struct><member><name>' + estimationField + '</name>' +
-                  '<value><string>' + value + '</string></value></member></struct></value></param>' +
-                  '</params></methodCall>',
-           contentType: 'text/xml',
-           success: function(){
-             $(currentElement).text(value);
+    if ( reportMethod.length != 0 ) {
+      elements   = reportMethod;
+      xmlrpcPath = '../xmlrpc';
+    } else if ( queryMethod.length != 0 ) {
+      elements   = queryMethod;
+      xmlrpcPath = 'xmlrpc';
+    }
+    if ( elements != null ) {
+      ids = elements.each(function(i) {
+        var id = jQuery.trim($(this).text()).substr(1);
+        var estimationField = '$data.field';
+
+        var estimationCell = $('td.' + estimationField).eq(i);
+
+        estimationCell.editable(function(value, settings) {
+          var currentElement = this;
+          $.ajax({
+            type: 'POST',
+            url: xmlrpcPath,
+            data: '<methodCall><methodName>ticket.update</methodName>' +
+                       '<params><param><value><int>' + id + '</int></value></param>' +
+                       '<param><value><string></string></value></param>' +
+                       '<param><value><struct><member><name>' + estimationField + '</name>' +
+                       '<value><string>' + value + '</string></value></member></struct></value></param>' +
+                       '</params></methodCall>',
+            contentType: 'text/xml',
+            success: function(){
+              $(currentElement).text(value);
            }
          });
          return('Saving...');
        }, {
-                data : jQuery.trim(estimationCell.text()),
-                tooltip   : 'Click to edit...',
-                placeholder: '',
-                onblur : 'submit',
-                select : 'true',
-                style : 'inherit',
-                width     : 60
+        data : jQuery.trim(estimationCell.text()),
+        tooltip   : 'Click to edit...',
+        placeholder: '',
+        onblur : 'submit',
+        select : 'true',
+        style : 'inherit',
+        width     : 60
        });
     });
+    }
  });
- </script>
-
- No newline at end of file
+</script>
+

What I did is check to see whether we have "td.ticket" (for reports) or "td.id" fields (for query), then modify the behavior appropriately. I trimmed the ticket string so that the old "substr(1)" method will work regardless. If I knew how to do regular expressions in JavaScript, I would have done it that way. Also, I don't know if the closures that I used (using var xmlrpcPath in the calling code and the anonymous function) is safe/proper style.

I'm currently using this script in my 0.11.2 Trac, because we need to work with a report that is not possible with the "custom query" system.

This ticket is similar to a previously closed ticket I found, #4003.

[Jason Winnebeck]

Another note on this -- the script is processed using Genshi but however the processor is used is enforcing that the resulting document is a properly formed XML fragment. That means I couldn't use code like x > 0. Instead I had to say x != 0. I'm not sure how to work Genshi to resolve this issue. I think the "manual" XML-RPC AJAX call in the script works because Genshi is interpreting the code as an arbitrary XML fragment with text data between each of the elements, and it just "happens to work."

[Jason Winnebeck]

Sorry for another ticket spam, but I just wanted to note that in the report's SQL, you must name the value column joined from the ticket_custom table the same name as the estimation_field parameter in the configuration.

For example, my field is called hours_remaining, and I have used the combination of this plugin, MasterTicketsPlugin, and a new ticket type "PBI" to simulate a PBI/SBI list as used in the Scrum agile development process. This list can be used for standup meetings.

SELECT p.value AS __color__,
       'PBI ' || parent.id || ': ' || parent.summary || ' (' ||
         (SELECT SUM(hours.value) FROM mastertickets mt
          LEFT JOIN ticket_custom hours ON mt.source = hours.ticket AND
                                           hours.name = 'hours_remaining'
          WHERE mt.dest=parent.id) ||
         ' hours)' AS __group__,
       t.id AS ticket,
       t.summary as summary,
       t.component as component,
       t.type AS type, 
       t.owner AS owner,
       t.status AS status,
       t.time AS created,
       t.changetime AS _changetime,
       t.description AS _description,
       t.reporter AS _reporter,
       t.priority AS _priority,
       hours.value AS hours_remaining
FROM ticket t
INNER JOIN enum p ON t.priority = p.name AND p.type = 'priority'
INNER JOIN mastertickets parentId ON t.id = parentId.source
INNER JOIN ticket parent ON parentId.dest = parent.id
LEFT JOIN ticket_custom hours ON t.id = hours.ticket AND hours.name = 'hours_remaining'
WHERE parent.status <> 'closed' AND t.type <> 'PBI'
ORDER BY t.milestone, p.value, t.time

The important parts are the LEFT JOIN ticket_custom... and the hours.value AS hours_remaining. If you don't do that, the script won't work and will not give any indication that anything went wrong, or that it even tried to do something.

[Joachim Hoessler]

(In [5360]) Applied patch by Jason Winnebeck to enable HoursInPlaceEditor functionality in reports. This closes #4549

[Joachim Hoessler]

Thanks for the patch!