Upload New Supporting Document (#1391)

* Add PacketFile
* Add upload document form and handler
* List uploaded documents in the supporting docs block
* Add diff count to missing Document Categories

Ref #1331

opentech/apply/activity/messaging.py

@@ -742,6 +742,7 @@ class DjangoMessagesAdapter(AdapterBase):
         MESSAGES.BATCH_REVIEWERS_UPDATED: 'batch_reviewers_updated',
         MESSAGES.BATCH_TRANSITION: 'batch_transition',
         MESSAGES.BATCH_DETERMINATION_OUTCOME: 'batch_determinations',
+        MESSAGES.UPLOAD_DOCUMENT: 'Successfully uploaded document "{title}"',
     }
 
     def batch_reviewers_updated(self, added, sources, **kwargs):

opentech/apply/activity/migrations/0037_add_upload_document.py

+# Generated by Django 2.0.13 on 2019-08-08 10:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('activity', '0036_add_reject_project'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='event',
+            name='type',
+            field=models.CharField(choices=[('UPDATE_LEAD', 'Update Lead'), ('BATCH_UPDATE_LEAD', 'Batch Update Lead'), ('EDIT', 'Edit'), ('APPLICANT_EDIT', 'Applicant Edit'), ('NEW_SUBMISSION', 'New Submission'), ('SCREENING', 'Screening'), ('TRANSITION', 'Transition'), ('BATCH_TRANSITION', 'Batch Transition'), ('DETERMINATION_OUTCOME', 'Determination Outcome'), ('BATCH_DETERMINATION_OUTCOME', 'Batch Determination Outcome'), ('INVITED_TO_PROPOSAL', 'Invited To Proposal'), ('REVIEWERS_UPDATED', 'Reviewers Updated'), ('BATCH_REVIEWERS_UPDATED', 'Batch Reviewers Updated'), ('PARTNERS_UPDATED', 'Partners Updated'), ('PARTNERS_UPDATED_PARTNER', 'Partners Updated Partner'), ('READY_FOR_REVIEW', 'Ready For Review'), ('BATCH_READY_FOR_REVIEW', 'Batch Ready For Review'), ('NEW_REVIEW', 'New Review'), ('COMMENT', 'Comment'), ('PROPOSAL_SUBMITTED', 'Proposal Submitted'), ('OPENED_SEALED', 'Opened Sealed Submission'), ('REVIEW_OPINION', 'Review Opinion'), ('DELETE_SUBMISSION', 'Delete Submission'), ('DELETE_REVIEW', 'Delete Review'), ('CREATED_PROJECT', 'Created Project'), ('UPDATE_PROJECT_LEAD', 'Update Project Lead'), ('EDIT_REVIEW', 'Edit Review'), ('SEND_FOR_APPROVAL', 'Send for Approval'), ('APPROVE_PROJECT', 'Project was Approved'), ('REJECT_PROJECT', 'Project was Rejected'), ('UPLOAD_DOCUMENT', 'Document was Uploaded to Project')], max_length=50),
+        ),
+    ]

opentech/apply/activity/migrations/0038_auto_20190808_1142.py

+# Generated by Django 2.0.13 on 2019-08-08 10:42
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('activity', '0037_add_upload_document'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='event',
+            name='type',
+            field=models.CharField(choices=[('UPDATE_LEAD', 'Update Lead'), ('BATCH_UPDATE_LEAD', 'Batch Update Lead'), ('EDIT', 'Edit'), ('APPLICANT_EDIT', 'Applicant Edit'), ('NEW_SUBMISSION', 'New Submission'), ('SCREENING', 'Screening'), ('TRANSITION', 'Transition'), ('BATCH_TRANSITION', 'Batch Transition'), ('DETERMINATION_OUTCOME', 'Determination Outcome'), ('BATCH_DETERMINATION_OUTCOME', 'Batch Determination Outcome'), ('INVITED_TO_PROPOSAL', 'Invited To Proposal'), ('REVIEWERS_UPDATED', 'Reviewers Updated'), ('BATCH_REVIEWERS_UPDATED', 'Batch Reviewers Updated'), ('PARTNERS_UPDATED', 'Partners Updated'), ('PARTNERS_UPDATED_PARTNER', 'Partners Updated Partner'), ('READY_FOR_REVIEW', 'Ready For Review'), ('BATCH_READY_FOR_REVIEW', 'Batch Ready For Review'), ('NEW_REVIEW', 'New Review'), ('COMMENT', 'Comment'), ('PROPOSAL_SUBMITTED', 'Proposal Submitted'), ('OPENED_SEALED', 'Opened Sealed Submission'), ('REVIEW_OPINION', 'Review Opinion'), ('DELETE_SUBMISSION', 'Delete Submission'), ('DELETE_REVIEW', 'Delete Review'), ('CREATED_PROJECT', 'Created Project'), ('UPDATE_PROJECT_LEAD', 'Update Project Lead'), ('EDIT_REVIEW', 'Edit Review'), ('SEND_FOR_APPROVAL', 'Send for Approval'), ('APPROVE_PROJECT', 'Project was Approved'), ('REQUEST_PROJECT_CHANGE', 'Project change requested'), ('UPLOAD_DOCUMENT', 'Document was Uploaded to Project')], max_length=50),
+        ),
+    ]

opentech/apply/activity/options.py

@@ -32,6 +32,7 @@ class MESSAGES(Enum):
     SEND_FOR_APPROVAL = 'Send for Approval'
     APPROVE_PROJECT = 'Project was Approved'
     REQUEST_PROJECT_CHANGE = 'Project change requested'
+    UPLOAD_DOCUMENT = 'Document was Uploaded to Project'
 
     @classmethod
     def choices(cls):

opentech/apply/funds/templates/funds/includes/delegated_form_base.html

 {% load util_tags %}
-<form class="form {{extra_classes}}" method="post" id="{{ form.name }}">
+<form class="form {{extra_classes}}" method="post" id="{{ form.name }}" enctype="multipart/form-data">
     {% csrf_token %}
     <div class="form__item">
         {{ form }}

opentech/apply/projects/forms.py

@@ -5,7 +5,7 @@ from addressfield.fields import AddressField
 from opentech.apply.funds.models import ApplicationSubmission
 from opentech.apply.users.groups import STAFF_GROUP_NAME
 
-from .models import COMMITTED, Approval, Project
+from .models import COMMITTED, Approval, PacketFile, Project
 
 
 class CreateProjectForm(forms.Form):
@@ -96,6 +96,16 @@ class SetPendingForm(forms.ModelForm):
         return super().save(*args, **kwargs)
 
 
+class UploadDocumentForm(forms.ModelForm):
+    class Meta:
+        fields = ['title', 'category', 'document']
+        model = PacketFile
+        widgets = {'title': forms.TextInput()}
+
+    def __init__(self, user=None, instance=None, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+
 class UpdateProjectLeadForm(forms.ModelForm):
     class Meta:
         fields = ['lead']

opentech/apply/projects/migrations/0011_add_packet_file.py

+# Generated by Django 2.0.13 on 2019-08-07 15:50
+
+from django.db import migrations, models
+import django.db.models.deletion
+import opentech.apply.projects.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('application_projects', '0010_add_related_names_to_approval_fks'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='PacketFile',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.TextField()),
+                ('document', models.FileField(upload_to=opentech.apply.projects.models.document_path)),
+                ('category', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='packet_files', to='application_projects.DocumentCategory')),
+                ('project', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='packet_files', to='application_projects.Project')),
+            ],
+        ),
+    ]

opentech/apply/projects/models.py

+import collections
 import decimal
 
 from django.conf import settings
@@ -22,6 +23,21 @@ class Approval(models.Model):
         return f'Approval of "{self.project.title}" by {self.by}'
 
 
+def document_path(instance, filename):
+    return f'projects/{instance.project_id}/supporting_documents/{filename}'
+
+
+class PacketFile(models.Model):
+    category = models.ForeignKey("DocumentCategory", null=True, on_delete=models.CASCADE, related_name="packet_files")
+    project = models.ForeignKey("Project", on_delete=models.CASCADE, related_name="packet_files")
+
+    title = models.TextField()
+    document = models.FileField(upload_to=document_path)
+
+    def __str__(self):
+        return f'Project file: {self.title}'
+
+
 COMMITTED = 'committed'
 CONTRACTING = 'contracting'
 PROJECT_STATUS_CHOICES = [
@@ -129,6 +145,24 @@ class Project(models.Model):
         correct_state = self.status == COMMITTED and not self.is_locked
         return correct_state and self.user_has_updated_details
 
+    def get_missing_document_categories(self):
+        """
+        Get the number of documents required to meet each DocumentCategorys minimum
+        """
+        # Count the number of documents in each category currently
+        existing_categories = DocumentCategory.objects.filter(packet_files__project=self)
+        counter = collections.Counter(existing_categories)
+
+        # Find the difference between the current count and recommended count
+        for category in DocumentCategory.objects.all():
+            current_count = counter[category]
+            difference = category.recommended_minimum - current_count
+            if difference > 0:
+                yield {
+                    'category': category,
+                    'difference': difference,
+                }
+
 
 class DocumentCategory(models.Model):
     name = models.CharField(max_length=254)

opentech/apply/projects/templates/application_projects/includes/supporting_documents.html

@@ -56,36 +56,30 @@
                     Every project should include the following documents:
                 </p>
                 <ul>
-                    {% for category in remaining_document_categories %}
-                        <li>{{ category.name }} ({{ category.recommended_minimum }})</li>
+                    {% for missing in remaining_document_categories %}
+                        <li>{{ missing.category.name }} ({{ missing.difference }})</li>
                     {% endfor %}
                 </ul>
             </div>
             {% endif %}
-            <!-- Example document list
-                <ul class="docs-block__document-list">
-                    <li class="docs-block__document">
-                        <div class="docs-block__document-inner">
-                            <p class="docs-block__document-info"><b>This is a document title</b></p>
-                            <p class="docs-block__document-info">This is a document type</p>
-                        </div>
-                        <div class="docs-block__document-inner">
-                            <a class="docs-block__document-link" href="#">Download</a>
-                            <a class="docs-block__document-link" href="#">Remove</a>
-                        </div>
-                    </li>
-                    <li class="docs-block__document">
-                        <div class="docs-block__document-inner">
-                            <p class="docs-block__document-info"><b>This is a document title</b></p>
-                            <p class="docs-block__document-info">This is a document type</p>
-                        </div>
-                        <div class="docs-block__document-inner">
-                            <a class="docs-block__document-link" href="#">Download</a>
-                            <a class="docs-block__document-link" href="#">Remove</a>
-                        </div>
-                    </li>
-                </ul>
-            -->
+
+            {% if object.packet_files.exists %}
+            <ul class="docs-block__document-list">
+                {% for document in object.packet_files.all %}
+                <li class="docs-block__document">
+                    <div class="docs-block__document-inner">
+                        <p class="docs-block__document-info"><b>{{ document.title }}</b></p>
+                        <p class="docs-block__document-info">{{ document.category.name }}</p>
+                    </div>
+                    <div class="docs-block__document-inner">
+                        <a class="docs-block__document-link" href="{{ document.document.url }}">Download</a>
+                        <a class="docs-block__document-link" href="#">Remove</a>
+                    </div>
+                </li>
+                {% endfor %}
+            </ul>
+            {% endif %}
+
         </li>
     </ul>
     <div class="docs-block__buttons">
@@ -103,12 +97,5 @@
 
 <div class="modal" id="upload-supporting-doc">
     <h4 class="modal__header-bar">Upload a new document</h4>
-    <div class="wrapper--outer-space-medium">
-        <label for="upload-document">Choose a document to upload:</label>
-        <input type="file" id="upload-document">
-    </div>
-    <div class="modal__buttons">
-        <button class="button button--primary button--submit" type="submit" name="submit">Upload</button>
-        <button data-fancybox-close class="button button--submit button--white">Cancel</button>
-    </div>
+    {% include 'funds/includes/delegated_form_base.html' with form=document_form value='Upload'%}
 </div>

opentech/apply/projects/tests/factories.py

@@ -5,7 +5,8 @@ import factory
 from django.utils import timezone
 
 from opentech.apply.funds.tests.factories import ApplicationSubmissionFactory
-from opentech.apply.projects.models import Project
+from opentech.apply.projects.models import (DocumentCategory, PacketFile,
+                                            Project)
 from opentech.apply.users.tests.factories import UserFactory
 
 ADDRESS = {
@@ -34,6 +35,14 @@ def address_to_form_data():
     }
 
 
+class DocumentCategoryFactory(factory.DjangoModelFactory):
+    name = factory.Sequence('name {}'.format)
+    recommended_minimum = 1
+
+    class Meta:
+        model = DocumentCategory
+
+
 class ProjectFactory(factory.DjangoModelFactory):
     submission = factory.SubFactory(ApplicationSubmissionFactory)
     user = factory.SubFactory(UserFactory)
@@ -49,3 +58,14 @@ class ProjectFactory(factory.DjangoModelFactory):
 
     class Meta:
         model = Project
+
+
+class PacketFileFactory(factory.DjangoModelFactory):
+    category = factory.SubFactory(DocumentCategoryFactory)
+    project = factory.SubFactory(ProjectFactory)
+
+    title = factory.Sequence('name {}'.format)
+    document = factory.django.FileField()
+
+    class Meta:
+        model = PacketFile

opentech/apply/projects/tests/test_models.py

@@ -3,6 +3,8 @@ from django.test import TestCase
 from opentech.apply.funds.tests.factories import ApplicationSubmissionFactory
 
 from ..models import Project
+from .factories import (DocumentCategoryFactory, PacketFileFactory,
+                        ProjectFactory)
 
 
 class TestProjectModel(TestCase):
@@ -14,3 +16,46 @@ class TestProjectModel(TestCase):
         self.assertEquals(project.submission, submission)
         self.assertEquals(project.title, submission.title)
         self.assertEquals(project.user, submission.user)
+
+    def test_get_missing_document_categories_with_enough_documents(self):
+        project = ProjectFactory()
+        category = DocumentCategoryFactory(recommended_minimum=1)
+        PacketFileFactory(project=project, category=category)
+
+        self.assertEqual(project.packet_files.count(), 1)
+
+        missing = list(project.get_missing_document_categories())
+
+        self.assertEqual(len(missing), 0)
+
+    def test_get_missing_document_categories_with_no_documents(self):
+        project = ProjectFactory()
+        category = DocumentCategoryFactory(recommended_minimum=1)
+
+        self.assertEqual(project.packet_files.count(), 0)
+
+        missing = list(project.get_missing_document_categories())
+
+        self.assertEqual(len(missing), 1)
+        self.assertEqual(missing[0]['category'], category)
+        self.assertEqual(missing[0]['difference'], 1)
+
+    def test_get_missing_document_categories_with_some_documents(self):
+        project = ProjectFactory()
+
+        category1 = DocumentCategoryFactory(recommended_minimum=5)
+        PacketFileFactory(project=project, category=category1)
+        PacketFileFactory(project=project, category=category1)
+
+        category2 = DocumentCategoryFactory(recommended_minimum=3)
+        PacketFileFactory(project=project, category=category2)
+
+        self.assertEqual(project.packet_files.count(), 3)
+
+        missing = list(project.get_missing_document_categories())
+
+        self.assertEqual(len(missing), 2)
+        self.assertEqual(missing[0]['category'], category1)
+        self.assertEqual(missing[0]['difference'], 3)
+        self.assertEqual(missing[1]['category'], category2)
+        self.assertEqual(missing[1]['difference'], 2)

opentech/apply/projects/tests/test_views.py

+from io import BytesIO
+
 from django.test import RequestFactory, TestCase
 
 from opentech.apply.users.tests.factories import (ReviewerFactory,
@@ -8,7 +10,7 @@ from opentech.apply.utils.testing.tests import BaseViewTestCase
 
 from ..forms import SetPendingForm
 from ..views import ProjectDetailView
-from .factories import ProjectFactory
+from .factories import DocumentCategoryFactory, ProjectFactory
 
 
 class TestCreateApprovalView(BaseViewTestCase):
@@ -104,3 +106,31 @@ class TestSendForApprovalView(BaseViewTestCase):
 
         self.assertTrue(project.is_locked)
         self.assertEqual(project.status, 'committed')
+
+
+class TestUploadDocumentView(BaseViewTestCase):
+    base_view_name = 'detail'
+    url_name = 'funds:projects:{}'
+    user_factory = StaffFactory
+
+    def get_kwargs(self, instance):
+        return {'pk': instance.id}
+
+    def test_upload_document(self):
+        category = DocumentCategoryFactory()
+        project = ProjectFactory()
+
+        test_doc = BytesIO(b'somebinarydata')
+        test_doc.name = 'document.pdf'
+
+        response = self.post_page(project, {
+            'form-submitted-document_form': '',
+            'title': 'test document',
+            'category': category.id,
+            'document': test_doc,
+        })
+        self.assertEqual(response.status_code, 200)
+
+        project.refresh_from_db()
+
+        self.assertEqual(project.packet_files.count(), 1)

opentech/apply/projects/views.py

@@ -12,8 +12,8 @@ from opentech.apply.utils.views import (DelegateableView, DelegatedViewMixin,
                                         ViewDispatcher)
 
 from .forms import (CreateApprovalForm, ProjectEditForm, RejectionForm,
-                    SetPendingForm, UpdateProjectLeadForm)
-from .models import CONTRACTING, Approval, DocumentCategory, Project
+                    SetPendingForm, UpdateProjectLeadForm, UploadDocumentForm)
+from .models import CONTRACTING, Approval, Project
 
 
 @method_decorator(staff_required, name='dispatch')
@@ -106,6 +106,28 @@ class UpdateLeadView(DelegatedViewMixin, UpdateView):
         return response
 
 
+@method_decorator(staff_required, name='dispatch')
+class UploadDocumentView(DelegatedViewMixin, CreateView):
+    context_name = 'document_form'
+    form_class = UploadDocumentForm
+    model = Project
+
+    def form_valid(self, form):
+        project = self.kwargs['object']
+        form.instance.project = project
+        response = super().form_valid(form)
+
+        messenger(
+            MESSAGES.UPLOAD_DOCUMENT,
+            request=self.request,
+            user=self.request.user,
+            source=project,
+            title=form.instance.title
+        )
+
+        return response
+
+
 class AdminProjectDetailView(ActivityContextMixin, DelegateableView, DetailView):
     form_views = [
         CommentFormView,
@@ -113,6 +135,7 @@ class AdminProjectDetailView(ActivityContextMixin, DelegateableView, DetailView)
         RejectionView,
         SendForApprovalView,
         UpdateLeadView,
+        UploadDocumentView,
     ]
     model = Project
     template_name_suffix = '_admin_detail'
@@ -120,7 +143,7 @@ class AdminProjectDetailView(ActivityContextMixin, DelegateableView, DetailView)
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         context['approvals'] = self.object.approvals.distinct('by')
-        context['remaining_document_categories'] = DocumentCategory.objects.all()
+        context['remaining_document_categories'] = self.object.get_missing_document_categories()
         return context