# HG changeset patch
# User Sylvain Thénault <sylvain.thenault@logilab.fr>
# Date 1284019684 -7200
# Node ID a0c4441e6ddf06595449350b595a1d3db38d9026
# Parent  2a1f8cabbe6a9efdf187a65c3782a71f705788f2
[rset] add test for #1251252, actually fixed in rql; fix docstring and add comments in rset.related_entity to make things clearer

diff -r 2a1f8cabbe6a -r a0c4441e6ddf rset.py
--- a/rset.py	Thu Sep 09 10:07:56 2010 +0200
+++ b/rset.py	Thu Sep 09 10:08:04 2010 +0200
@@ -588,11 +588,20 @@
 
     @cached
     def related_entity(self, row, col):
-        """try to get the related entity to extract format information if any"""
+        """given an cell of the result set, try to return a (entity, relation
+        name) tuple to which this cell is linked.
+
+        This is especially useful when the cell is an attribute of an entity,
+        to get the entity to which this attribute belongs to.
+        """
         rqlst = self.syntax_tree()
+        # UNION query, we've first to find a 'pivot' column to use to get the
+        # actual query from which the row is coming
         etype, locate_query_col = self._locate_query_params(rqlst, row, col)
-        # UNION query, find the subquery from which this entity has been found
+        # now find the query from which this entity has been found. Returned
+        # select node may be a subquery with different column indexes.
         select = rqlst.locate_subquery(locate_query_col, etype, self.args)[0]
+        # then get the index of root query's col in the subquery
         col = rqlst.subquery_selection_index(select, col)
         if col is None:
             # XXX unexpected, should fix subquery_selection_index ?
diff -r 2a1f8cabbe6a -r a0c4441e6ddf test/unittest_rset.py
--- a/test/unittest_rset.py	Thu Sep 09 10:07:56 2010 +0200
+++ b/test/unittest_rset.py	Thu Sep 09 10:08:04 2010 +0200
@@ -368,6 +368,14 @@
                             'WITH B,T BEING (Any B,T WHERE B is Bookmark, B title T)')
         rset.related_entity(0, 2)
 
+    def test_related_entity_subquery_outerjoin(self):
+        rset = self.execute('Any X,S,L WHERE X in_state S '
+                            'WITH X, L BEING (Any X,MAX(L) GROUPBY X '
+                            'WHERE X is CWUser, T? wf_info_for X, T creation_date L)')
+        self.assertEquals(len(rset), 2)
+        rset.related_entity(0, 1)
+        rset.related_entity(0, 2)
+
     def test_entities(self):
         rset = self.execute('Any U,G WHERE U in_group G')
         # make sure we have at least one element