[Issue KoalixSwitzerland#174] continued with the development of the feature

Author: scaphilo

documentation/source/code_documentation.rst

@@ -1,9 +1,13 @@
-.. highlight:: rst
-
 Code Documentation
 ==================
 
-.. automodule:: koalixcrm.crm.reporting.task
-   :members:
+.. toctree::
+   :maxdepth: 2
 
+   code_documentation/project
+   code_documentation/task
+   code_documentation/work
+   code_documentation/estimation
+   code_documentation/agreement
+   code_documentation/resource
 

documentation/source/code_documentation/agreement.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Agreement
+---------
+
+.. automodule:: koalixcrm.crm.reporting.agreement
+   :members:
+

documentation/source/code_documentation/estimation.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Estimation
+----------
+
+.. automodule:: koalixcrm.crm.reporting.estimation
+   :members:
+

documentation/source/code_documentation/project.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Project
+-------
+
+.. automodule:: koalixcrm.crm.reporting.project
+   :members:
+

documentation/source/code_documentation/resource.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Resource
+--------
+
+.. automodule:: koalixcrm.crm.reporting.resource
+   :members:
+

documentation/source/code_documentation/task.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Task
+----
+
+.. automodule:: koalixcrm.crm.reporting.task
+   :members:
+

documentation/source/code_documentation/work.rst

@@ -0,0 +1,8 @@
+.. highlight:: rst
+
+Work
+----
+
+.. automodule:: koalixcrm.crm.reporting.work
+   :members:
+

koalixcrm/crm/documents/invoice.py

@@ -31,7 +31,7 @@ def link_to_invoice(self):
             return format_html("<a href='/admin/crm/invoice/%s' >%s</a>" % (str(self.id), str(self.description)))
         else:
             return "Not present"
-    link_to_invoice.short_description = _("Invoice");
+    link_to_invoice.short_description = _("Invoice")
 
     def create_from_reference(self, calling_model):
         self.create_sales_document(calling_model)
@@ -52,7 +52,7 @@ def register_invoice_in_accounting(self, request):
         if not self.is_complete_with_price():
             raise IncompleteInvoice(_("Complete invoice and run price recalculation. Price may not be Zero"))
         if len(activa_account) == 0:
-            raise OpenInterestAccountMissing(_("Please specify one open intrest account in the accounting"))
+            raise OpenInterestAccountMissing(_("Please specify one open interest account in the accounting"))
         for position in list(SalesDocumentPosition.objects.filter(sales_document=self.id)):
             profit_account = position.product.accounting_product_categorie.profitAccount
             dict_prices[profit_account] = position.last_calculated_price
@@ -103,7 +103,7 @@ class OptionInvoice(OptionSalesDocument):
     search_fields = OptionSalesDocument.search_fields
     fieldsets = OptionSalesDocument.fieldsets + (
         (_('Invoice specific'), {
-            'fields': ( 'payable_until', 'status', 'payment_bank_reference' )
+            'fields': ('payable_until', 'status', 'payment_bank_reference' )
         }),
     )
 

koalixcrm/crm/reporting/agreement.py

@@ -32,6 +32,27 @@ def calculated_costs(self):
         currency = self.task.project.default_currency
         return 0
 
+    def match_with_work(self, work):
+        """This method checks whether the provided work can be covered by the agreement.
+        the method checks whether the reported work corresponds with the resource and whether the
+        reported work was within the time-frame of the agreement.
+        The method returns False when the Agreement is not yet in status agreed
+
+        Args:
+          work (koalixcrm.crm.reporting.work.Work)
+
+        Returns:
+          True when no ValidationError was raised
+
+        Raises:
+          should not raise exceptions"""
+        matches = False
+        if self.status.is_agreed:
+            if (work.date >= self.date_from) and (work.date <= self.date_until):
+                if self.resource.id == work.human_resource.id:
+                    matches = True
+        return matches
+
     def __str__(self):
         return _("Agreement of Resource Consumption") + ": " + str(self.id)
 

koalixcrm/crm/reporting/task.py

@@ -329,40 +329,51 @@ def effective_costs(self, reporting_period=None):
         """
         agreements = Agreement.objects.filter(task=self)
         if reporting_period:
-            work_objects = Work.objects.filter(task=self.id,
-                                               reporting_period=reporting_period)
+            all_work_in_task = Work.objects.filter(task=self.id,
+                                                   reporting_period=reporting_period)
         else:
-            work_objects = Work.objects.filter(task=self.id)
-        sum_seconds = 0
-        effort_in_seconds = 0
+            all_work_in_task = Work.objects.filter(task=self.id)
         sum_costs = 0
+        work_with_agreement = list()
+        work_without_agreement = list()
+        work_calculated = list()
         human_resource_list = dict()
-        for work_object in work_objects:
-            effort_in_seconds += work_object.effort_seconds()
-            sum_seconds += effort_in_seconds
+        for work_object in all_work_in_task:
             if work_object.human_resource not in human_resource_list:
                 human_resource_list[work_object.human_resource] = dict()
             for agreement in agreements:
-                agreement_matches = True
-                """agreement.matches_with(work_object)"""
+                agreement_matches = agreement.match_with_work(work_object)
                 if agreement_matches:
+                    if work_object not in work_with_agreement:
+                        work_with_agreement.append(work_object)
                     if agreement not in human_resource_list.get(work_object.human_resource):
                         human_resource_list.get(work_object.human_resource)[agreement] = list()
                     human_resource_list.get(work_object.human_resource).get(agreement).append(work_object)
-        covered_work = list()
+            if work_object not in work_with_agreement:
+                work_without_agreement.append(work_object)
+
         for human_resource_dict in human_resource_list:
             agreement_list = Agreement.objects.filter(task=self, resource=human_resource_dict).order_by('costs__price')
             for agreement in agreement_list:
                 agreement_remaining_amount = agreement.amount
-                for work in human_resource_list[human_resource_dict].get(agreement):
-                    if work not in covered_work:
-                        if (agreement_remaining_amount - work.worked_hours) > 0:
-                            agreement_remaining_amount -= work.worked_hours
-                            sum_costs += work.worked_hours*agreement.costs.price.price
-                            covered_work.append(work)
-        for work in work_objects:
-            if work not in covered_work:
-                sum_costs += work.worked_hours*ResourcePrice.objects.get(work.human_resource).price
+                if human_resource_list[human_resource_dict].get(agreement):
+                    for work in human_resource_list[human_resource_dict].get(agreement):
+                        if work in work_with_agreement:
+                            if (agreement_remaining_amount - work.worked_hours) > 0:
+                                agreement_remaining_amount -= work.worked_hours
+                                sum_costs += work.worked_hours*agreement.costs.price
+                                work_calculated.append(work)
+        for work in all_work_in_task:
+            if work not in work_calculated:
+                if work not in work_without_agreement:
+                    work_without_agreement.append(work)
+        for work in work_without_agreement:
+            default_resource_price = ResourcePrice.objects.get(id=work.human_resource.id)
+            if default_resource_price:
+                sum_costs += work.worked_hours*default_resource_price.price
+            else:
+                sum_costs = "n/a"
+                break
         return sum_costs.__str__()
     effective_costs.short_description = _("Effective costs")
     effective_costs.tags = True

koalixcrm/crm/reporting/work.py

@@ -94,12 +94,10 @@ def __str__(self):
         return _("Work") + ": " + str(self.id) + " " + _("from Person") + ": " + str(self.human_resource.id)
 
     def check_working_hours(self):
-        """This method checks that the working hour is correctly proved either using the start_stop pattern
+        """This method checks that the working hour is correctly provided either using the start_stop pattern
         or by providing the worked_hours in total.
 
         Args:
-          cleaned_data (Dict):  The cleaned_data must contain the values form the form validation.
-          The django built in form validation must already have been passed
 
         Returns:
           True when no ValidationError was raised

requirements/base_requirements.txt

@@ -3,7 +3,7 @@ django-filebrowser==3.9.1
 lxml==3.8.0
 olefile==0.44
 Pillow==4.2.1
-psycopg2==2.7.3
+psycopg2-binary==2.7.3
 pytz==2017.2
 django-grappelli==2.10.1
 djangorestframework==3.7.7