refactoring comment_ids

tracim/models/context_models.py

@@ -555,10 +555,14 @@ class RevisionInContext(object):
             return None
 
     @property
-    def comments_ids(self) -> typing.List[int]:
+    def comment_ids(self) -> typing.List[int]:
+        """
+        Get list of ids of all current revision related comments
+        :return: list of comments ids
+        """
         comments = self.revision.node.get_comments()
         # INFO - G.M - 2018-06-177 - Get comments more recent than revision.
-        revisions_comments = [
+        revision_comments = [
             comment for comment in comments
             if comment.created > self.revision.updated
         ]
@@ -566,19 +570,18 @@ class RevisionInContext(object):
             # INFO - G.M - 2018-06-177 - if there is a revision more recent
             # than current remove comments from theses rev (comments older
             # than next_revision.)
-            revisions_comments = [
-                comment for comment in revisions_comments
+            revision_comments = [
+                comment for comment in revision_comments
                 if comment.created < self.next_revision.updated
             ]
         sorted_revision_comments = sorted(
-            revisions_comments,
+            revision_comments,
             key=lambda revision: revision.created
         )
-        comments_id = [
-            comments.content_id
-            for comments in sorted_revision_comments
-        ]
-        return comments_id
+        comment_ids = []
+        for comment in sorted_revision_comments:
+            comment_ids.append(comment.content_id)
+        return comment_ids
 
     # Context-related
     @property

tracim/tests/functional/test_contents.py

@@ -215,7 +215,7 @@ class TestHtmlDocuments(FunctionalTest):
         assert revision['revision_id'] == 6
         assert revision['sub_content_types']
         # TODO - G.M - 2018-06-173 - Test with real comments
-        assert revision['comments_ids'] == []
+        assert revision['comment_ids'] == []
         # TODO - G.M - 2018-06-173 - check date format
         assert revision['created']
         assert revision['author']
@@ -236,7 +236,7 @@ class TestHtmlDocuments(FunctionalTest):
         assert revision['revision_id'] == 7
         assert revision['sub_content_types']
         # TODO - G.M - 2018-06-173 - Test with real comments
-        assert revision['comments_ids'] == []
+        assert revision['comment_ids'] == []
         # TODO - G.M - 2018-06-173 - check date format
         assert revision['created']
         assert revision['author']
@@ -257,7 +257,7 @@ class TestHtmlDocuments(FunctionalTest):
         assert revision['revision_id'] == 27
         assert revision['sub_content_types']
         # TODO - G.M - 2018-06-173 - Test with real comments
-        assert revision['comments_ids'] == []
+        assert revision['comment_ids'] == []
         # TODO - G.M - 2018-06-173 - check date format
         assert revision['created']
         assert revision['author']
@@ -475,7 +475,7 @@ class TestThreads(FunctionalTest):
         assert revision['workspace_id'] == 2
         assert revision['revision_id'] == 8
         assert revision['sub_content_types']
-        assert revision['comments_ids'] == [18, 19, 20]
+        assert revision['comment_ids'] == [18, 19, 20]
         # TODO - G.M - 2018-06-173 - check date format
         assert revision['created']
         assert revision['author']
@@ -495,7 +495,7 @@ class TestThreads(FunctionalTest):
         assert revision['workspace_id'] == 2
         assert revision['revision_id'] == 26
         assert revision['sub_content_types']
-        assert revision['comments_ids'] == []
+        assert revision['comment_ids'] == []
         # TODO - G.M - 2018-06-173 - check date format
         assert revision['created']
         assert revision['author']

tracim/views/core_api/schemas.py

@@ -423,7 +423,7 @@ class HtmlDocumentContentSchema(ContentSchema):
 
 
 class RevisionSchema(ContentDigestSchema):
-    comments_ids = marshmallow.fields.List(marshmallow.fields.Int(example=4))
+    comment_ids = marshmallow.fields.List(marshmallow.fields.Int(example=4))
     revision_id = marshmallow.fields.Int(example=12)
     created = marshmallow.fields.DateTime(
         format='%Y-%m-%dT%H:%M:%SZ',