Merge pull request doccano#318 from CatalystCode/enhancement/collaborative-annotation

Enhancement/Add option to share annotations across users

Author: Hironsan

app/api/migrations/0004_project_collaborative_annotation.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.1.7 on 2019-08-01 18:12
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0003_support_sql_server'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='project',
+            name='collaborative_annotation',
+            field=models.BooleanField(default=False),
+        ),
+    ]

app/api/models.py

@@ -28,6 +28,7 @@ class Project(PolymorphicModel):
     users = models.ManyToManyField(User, related_name='projects')
     project_type = models.CharField(max_length=30, choices=PROJECT_CHOICES)
     randomize_document_order = models.BooleanField(default=False)
+    collaborative_annotation = models.BooleanField(default=False)
 
     def get_absolute_url(self):
         return reverse('upload', args=[self.id])

app/api/serializers.py

@@ -62,7 +62,7 @@ def get_annotations(self, instance):
         model = project.get_annotation_class()
         serializer = project.get_annotation_serializer()
         annotations = model.objects.filter(document=instance.id)
-        if request:
+        if request and not project.collaborative_annotation:
             annotations = annotations.filter(user=request.user)
         serializer = serializer(annotations, many=True)
         return serializer.data
@@ -82,7 +82,7 @@ class ProjectSerializer(serializers.ModelSerializer):
     class Meta:
         model = Project
         fields = ('id', 'name', 'description', 'guideline', 'users', 'project_type', 'image', 'updated_at',
-                  'randomize_document_order')
+                  'randomize_document_order', 'collaborative_annotation')
         read_only_fields = ('image', 'updated_at')
 
 

app/api/tests/test_api.py

@@ -491,6 +491,10 @@ def setUpTestData(cls):
         cls.post_data = {'start_offset': 0, 'end_offset': 1, 'label': main_project_label.id}
         cls.num_entity_of_project_member = SequenceAnnotation.objects.filter(document=main_project_doc,
                                                                              user=project_member).count()
+        cls.num_entity_of_another_project_member = SequenceAnnotation.objects.filter(
+            document=main_project_doc,
+            user=another_project_member).count()
+        cls.main_project = main_project
 
     def test_returns_annotations_to_project_member(self):
         self.client.login(username=self.project_member_name,
@@ -510,6 +514,15 @@ def test_do_not_return_annotations_of_another_project_member(self):
         response = self.client.get(self.url, format='json')
         self.assertEqual(len(response.data), self.num_entity_of_project_member)
 
+    def test_returns_annotations_of_another_project_member_if_collaborative_project(self):
+        self._patch_project(self.main_project, 'collaborative_annotation', True)
+
+        self.client.login(username=self.project_member_name,
+                          password=self.project_member_pass)
+        response = self.client.get(self.url, format='json')
+        self.assertEqual(len(response.data),
+                         self.num_entity_of_project_member + self.num_entity_of_another_project_member)
+
     def test_allows_project_member_to_create_annotation(self):
         self.client.login(username=self.project_member_name,
                           password=self.project_member_pass)
@@ -522,6 +535,17 @@ def test_disallows_non_project_member_to_create_annotation(self):
         response = self.client.post(self.url, format='json', data=self.post_data)
         self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
 
+    def _patch_project(self, project, attribute, value):
+        old_value = getattr(project, attribute, None)
+        setattr(project, attribute, value)
+        project.save()
+
+        def cleanup_project():
+            setattr(project, attribute, old_value)
+            project.save()
+
+        self.addCleanup(cleanup_project)
+
 
 class TestAnnotationDetailAPI(APITestCase):
 

app/api/views.py

@@ -162,9 +162,12 @@ def get_serializer_class(self):
     def get_queryset(self):
         project = get_object_or_404(Project, pk=self.kwargs['project_id'])
         model = project.get_annotation_class()
-        self.queryset = model.objects.filter(document=self.kwargs['doc_id'],
-                                             user=self.request.user)
-        return self.queryset
+
+        queryset = model.objects.filter(document=self.kwargs['doc_id'])
+        if not project.collaborative_annotation:
+            queryset = queryset.filter(user=self.request.user)
+
+        return queryset
 
     def create(self, request, *args, **kwargs):
         request.data['document'] = self.kwargs['doc_id']

app/server/static/components/projects.vue

@@ -53,6 +53,17 @@
               )
               | Randomize document order per user
 
+          div.field
+            label.checkbox
+              input(
+                v-model="collaborativeAnnotation"
+                name="collaborative_annotation"
+                type="checkbox"
+                style="margin-right: 0.25em;"
+                required
+              )
+              | Share annotations across all users
+
         footer.modal-card-foot.pt20.pb20.pr20.pl20.has-background-white-ter
           button.button.is-primary(v-on:click="create()") Create
           button.button(v-on:click="isActive = !isActive") Cancel
@@ -140,6 +151,7 @@ export default {
     username: '',
     isSuperuser: false,
     randomizeDocumentOrder: false,
+    collaborativeAnnotation: false,
   }),
 
   computed: {
@@ -192,6 +204,7 @@ export default {
         description: this.description,
         project_type: this.projectType,
         randomize_document_order: this.randomizeDocumentOrder,
+        collaborative_annotation: this.collaborativeAnnotation,
         guideline: 'Please write annotation guideline.',
         resourcetype: this.resourceType(),
       };