From 150632e9c544a32806eca01e748ae901a7963d7c Mon Sep 17 00:00:00 2001 From: Gabriel Augendre Date: Mon, 25 Apr 2022 18:37:26 +0200 Subject: [PATCH] Refactor price with database queries and start reports --- src/checkout/settings.py | 1 + src/common/templates/common/navbar.html | 3 + src/purchase/admin.py | 27 +++++-- src/purchase/layout.py | 2 +- src/purchase/models.py | 81 +++++++++---------- .../templates/purchase/basket_form.html | 4 +- .../templates/purchase/basket_list.html | 3 +- src/purchase/templates/purchase/reports.html | 19 +++++ .../purchase/{ => snippets}/basket_item.html | 0 .../purchase/snippets/report_products.html | 18 +++++ src/purchase/templatetags/__init__.py | 0 src/purchase/templatetags/purchase.py | 10 +++ src/purchase/urls.py | 2 + src/purchase/views/__init__.py | 3 + src/purchase/{views.py => views/basket.py} | 11 +-- src/purchase/views/reports.py | 20 +++++ src/purchase/views/utils.py | 5 ++ 17 files changed, 152 insertions(+), 57 deletions(-) create mode 100644 src/purchase/templates/purchase/reports.html rename src/purchase/templates/purchase/{ => snippets}/basket_item.html (100%) create mode 100644 src/purchase/templates/purchase/snippets/report_products.html create mode 100644 src/purchase/templatetags/__init__.py create mode 100644 src/purchase/templatetags/purchase.py create mode 100644 src/purchase/views/__init__.py rename src/purchase/{views.py => views/basket.py} (86%) create mode 100644 src/purchase/views/reports.py create mode 100644 src/purchase/views/utils.py diff --git a/src/checkout/settings.py b/src/checkout/settings.py index c0a8a5a..d468963 100644 --- a/src/checkout/settings.py +++ b/src/checkout/settings.py @@ -86,6 +86,7 @@ INSTALLED_APPS = [ "purchase", "crispy_forms", "crispy_bootstrap5", + "django_extensions", ] MIDDLEWARE = [ diff --git a/src/common/templates/common/navbar.html b/src/common/templates/common/navbar.html index cc00577..7e4989e 100644 --- a/src/common/templates/common/navbar.html +++ b/src/common/templates/common/navbar.html @@ -15,6 +15,9 @@
  • Baskets
    • +
  • + Reports +
    • {% endif %} {% if user.is_staff %}
  • diff --git a/src/purchase/admin.py b/src/purchase/admin.py index a7e1735..e345748 100644 --- a/src/purchase/admin.py +++ b/src/purchase/admin.py @@ -2,6 +2,7 @@ from django.contrib import admin from django.contrib.admin import register from purchase.models import Basket, BasketItem, PaymentMethod, Product +from purchase.templatetags.purchase import currency @register(Product) @@ -10,14 +11,17 @@ class ProductAdmin(admin.ModelAdmin): list_editable = ["display_order"] search_fields = ["name"] + def get_queryset(self, request): + return super().get_queryset(request).with_sold().with_turnover() + def unit_price(self, instance: Product): - return instance.unit_price_display + return currency(instance.unit_price_cents) def sold(self, instance: Product): return instance.sold def turnover(self, instance: Product): - return instance.turnover_display + return currency(instance.turnover) @register(PaymentMethod) @@ -25,8 +29,11 @@ class PaymentMethodAdmin(admin.ModelAdmin): list_display = ["name", "turnover"] search_fields = ["name"] + def get_queryset(self, request): + return super().get_queryset(request).with_turnover() + def turnover(self, instance: Product): - return instance.turnover_display + return currency(instance.turnover) class BasketItemInline(admin.TabularInline): @@ -35,18 +42,24 @@ class BasketItemInline(admin.TabularInline): extra = 0 readonly_fields = ["price"] + def get_queryset(self, request): + return super().get_queryset(request).priced() + def price(self, instance) -> str: - return instance.price_display + return currency(instance.price) @register(Basket) class BasketAdmin(admin.ModelAdmin): list_display = ["id", "payment_method", "created_at", "price"] - fields = ["created_at", "payment_method"] + fields = ["created_at", "payment_method", "price"] list_filter = ["payment_method"] date_hierarchy = "created_at" - readonly_fields = ["created_at"] + readonly_fields = ["created_at", "price"] inlines = [BasketItemInline] + def get_queryset(self, request): + return super().get_queryset(request).priced() + def price(self, instance) -> str: - return instance.price_display + return currency(instance.price) diff --git a/src/purchase/layout.py b/src/purchase/layout.py index 625138c..1911950 100644 --- a/src/purchase/layout.py +++ b/src/purchase/layout.py @@ -2,7 +2,7 @@ from crispy_forms.layout import Field class BasketItemField(Field): - template = "purchase/basket_item.html" + template = "purchase/snippets/basket_item.html" def __init__(self, *args, product, **kwargs): super().__init__(*args, **kwargs) diff --git a/src/purchase/models.py b/src/purchase/models.py index a9f3f69..bf40393 100644 --- a/src/purchase/models.py +++ b/src/purchase/models.py @@ -1,4 +1,5 @@ from django.db import models +from django.db.models import Count, F, Sum from django.urls import reverse from PIL import Image, ImageOps @@ -11,53 +12,53 @@ class Model(models.Model): abstract = True +class PaymentMethodQuerySet(models.QuerySet): + def with_turnover(self): + return self.annotate( + turnover=Sum( + F("baskets__items__quantity") + * F("baskets__items__product__unit_price_cents") + ) + ) + + class PaymentMethod(Model): name = models.CharField(max_length=50, unique=True) + objects = PaymentMethodQuerySet.as_manager() + def __str__(self): return self.name - @property - def turnover(self) -> int: - return sum(basket.price for basket in self.baskets.all()) - - @property - def turnover_display(self) -> str: - return f"{self.turnover / 100}€" - def default_product_display_order(): return Product.objects.last().display_order + 1 +class ProductQuerySet(models.QuerySet): + def with_turnover(self): + return self.annotate( + turnover=Sum(F("basket_items__quantity") * F("unit_price_cents")) + ) + + def with_sold(self): + return self.annotate(sold=Sum("basket_items__quantity")) + + class Product(Model): name = models.CharField(max_length=250, unique=True) image = models.ImageField(null=True, blank=True) unit_price_cents = models.PositiveIntegerField() display_order = models.PositiveIntegerField(default=default_product_display_order) + objects = ProductQuerySet.as_manager() + class Meta: ordering = ["display_order", "name"] def __str__(self): return self.name - @property - def unit_price_display(self) -> str: - return f"{self.unit_price_cents / 100}€" - - @property - def turnover(self) -> int: - return sum(items.price for items in self.basket_items.all()) - - @property - def turnover_display(self) -> str: - return f"{self.turnover / 100}€" - - @property - def sold(self): - return sum(items.quantity for items in self.basket_items.all()) - def save(self, *args, **kwargs): super().save() with Image.open(self.image.path) as img: @@ -92,6 +93,13 @@ class Product(Model): img.save(self.image.path) +class BasketQuerySet(models.QuerySet): + def priced(self): + return self.annotate( + price=Sum(F("items__quantity") * F("items__product__unit_price_cents")) + ) + + class Basket(Model): payment_method = models.ForeignKey( to=PaymentMethod, @@ -101,22 +109,20 @@ class Basket(Model): blank=True, ) + objects = BasketQuerySet.as_manager() + def __str__(self): return f"Panier #{self.id}" - @property - def price(self) -> int: - return sum(item.price for item in self.items.all()) - - @property - def price_display(self) -> str: - price = self.price / 100 - return f"{price}€" - def get_absolute_url(self): return reverse("purchase:update", args=(self.pk,)) +class BasketItemQuerySet(models.QuerySet): + def priced(self): + return self.annotate(price=F("quantity") * F("product__unit_price_cents")) + + class BasketItem(Model): product = models.ForeignKey( to=Product, on_delete=models.PROTECT, related_name="basket_items" @@ -126,11 +132,4 @@ class BasketItem(Model): ) quantity = models.PositiveIntegerField() - @property - def price(self) -> int: - return self.product.unit_price_cents * self.quantity - - @property - def price_display(self) -> str: - price = self.price / 100 - return f"{price}€" + objects = BasketItemQuerySet.as_manager() diff --git a/src/purchase/templates/purchase/basket_form.html b/src/purchase/templates/purchase/basket_form.html index 1c6a268..c18b503 100644 --- a/src/purchase/templates/purchase/basket_form.html +++ b/src/purchase/templates/purchase/basket_form.html @@ -1,5 +1,5 @@ {% extends "common/base.html" %} -{% load crispy_forms_tags %} +{% load crispy_forms_tags purchase %} {% block content %} {% if object %}

    {{ object }}

    @@ -9,7 +9,7 @@ {% crispy form %} {% if object %}
    - Price: {{ object.price_display }} + Price: {{ object.price|currency }}
    New {% endif %} diff --git a/src/purchase/templates/purchase/basket_list.html b/src/purchase/templates/purchase/basket_list.html index a29d38b..042d1ea 100644 --- a/src/purchase/templates/purchase/basket_list.html +++ b/src/purchase/templates/purchase/basket_list.html @@ -1,4 +1,5 @@ {% extends "common/base.html" %} +{% load purchase %} {% block content %}

    Baskets

    @@ -9,7 +10,7 @@
    Basket #{{ basket.id }}

    {{ basket.items.count }} items
    - {{ basket.price_display }}
    + {{ basket.price|currency }}
    {{ basket.payment_method }}

    {% if perms.purchase.change_basket %} diff --git a/src/purchase/templates/purchase/reports.html b/src/purchase/templates/purchase/reports.html new file mode 100644 index 0000000..fbf22a9 --- /dev/null +++ b/src/purchase/templates/purchase/reports.html @@ -0,0 +1,19 @@ +{% extends "common/base.html" %} +{% load purchase %} + +{% block content %} +

    Reports

    +

    Total turnover

    +
      +
    • + {{ total|currency }} +
      • +
    +

    Turnover by day

    + +

    Products

    + {% include "purchase/snippets/report_products.html" %} +

    Turnover by product by day

    +

    Turnover by payment method

    +

    Turnover by payment method by day

    +{% endblock %} diff --git a/src/purchase/templates/purchase/basket_item.html b/src/purchase/templates/purchase/snippets/basket_item.html similarity index 100% rename from src/purchase/templates/purchase/basket_item.html rename to src/purchase/templates/purchase/snippets/basket_item.html diff --git a/src/purchase/templates/purchase/snippets/report_products.html b/src/purchase/templates/purchase/snippets/report_products.html new file mode 100644 index 0000000..6661525 --- /dev/null +++ b/src/purchase/templates/purchase/snippets/report_products.html @@ -0,0 +1,18 @@ +{% load purchase %} + + + + + + + + + {% for product in products %} + + + + + + {% endfor %} + +
    ProductSoldTurnover
    {{ product }}{{ product.sold }}{{ product.turnover|currency }}
    diff --git a/src/purchase/templatetags/__init__.py b/src/purchase/templatetags/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/purchase/templatetags/purchase.py b/src/purchase/templatetags/purchase.py new file mode 100644 index 0000000..4d5266a --- /dev/null +++ b/src/purchase/templatetags/purchase.py @@ -0,0 +1,10 @@ +from django import template + +register = template.Library() + + +@register.filter +def currency(value): + if isinstance(value, int) or isinstance(value, float): + return f"{value/100:.2f}€" + return value diff --git a/src/purchase/urls.py b/src/purchase/urls.py index 622298e..e7531d8 100644 --- a/src/purchase/urls.py +++ b/src/purchase/urls.py @@ -6,6 +6,7 @@ from purchase.views import ( NewBasketView, UpdateBasketView, ) +from purchase.views.reports import ReportsView app_name = "purchase" urlpatterns = [ @@ -13,4 +14,5 @@ urlpatterns = [ path("new/", NewBasketView.as_view(), name="new"), path("/update/", UpdateBasketView.as_view(), name="update"), path("/delete/", DeleteBasketView.as_view(), name="delete"), + path("reports/", ReportsView.as_view(), name="reports"), ] diff --git a/src/purchase/views/__init__.py b/src/purchase/views/__init__.py new file mode 100644 index 0000000..2758c31 --- /dev/null +++ b/src/purchase/views/__init__.py @@ -0,0 +1,3 @@ +from .basket import DeleteBasketView, ListBasketsView, NewBasketView, UpdateBasketView + +__all__ = ["NewBasketView", "UpdateBasketView", "DeleteBasketView", "ListBasketsView"] diff --git a/src/purchase/views.py b/src/purchase/views/basket.py similarity index 86% rename from src/purchase/views.py rename to src/purchase/views/basket.py index b356ac0..41ab5b8 100644 --- a/src/purchase/views.py +++ b/src/purchase/views/basket.py @@ -1,14 +1,10 @@ -from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin from django.contrib.messages.views import SuccessMessageMixin from django.urls import reverse from django.views.generic import CreateView, DeleteView, ListView, UpdateView from purchase.forms import BasketForm from purchase.models import Basket - - -class ProtectedViewsMixin(PermissionRequiredMixin, LoginRequiredMixin): - pass +from purchase.views.utils import ProtectedViewsMixin class NewBasketView(ProtectedViewsMixin, SuccessMessageMixin, CreateView): @@ -17,6 +13,8 @@ class NewBasketView(ProtectedViewsMixin, SuccessMessageMixin, CreateView): form_class = BasketForm success_message = "Successfully created basket." + queryset = Basket.objects.priced() + def get_success_url(self): if self.request.user.has_perm("purchase.change_basket"): return super().get_success_url() @@ -29,6 +27,7 @@ class UpdateBasketView(ProtectedViewsMixin, SuccessMessageMixin, UpdateView): model = Basket form_class = BasketForm success_message = "Successfully updated basket." + queryset = Basket.objects.priced() class ListBasketsView(ProtectedViewsMixin, ListView): @@ -36,12 +35,14 @@ class ListBasketsView(ProtectedViewsMixin, ListView): model = Basket context_object_name = "baskets" ordering = "-id" + queryset = Basket.objects.priced() class DeleteBasketView(ProtectedViewsMixin, SuccessMessageMixin, DeleteView): permission_required = ["purchase.delete_basket"] model = Basket success_message = "Basket successfully deleted." + queryset = Basket.objects.priced() def get_success_url(self): return reverse("purchase:list") diff --git a/src/purchase/views/reports.py b/src/purchase/views/reports.py new file mode 100644 index 0000000..a0f62d0 --- /dev/null +++ b/src/purchase/views/reports.py @@ -0,0 +1,20 @@ +from django.db.models import Sum +from django.views.generic import TemplateView + +from purchase.models import Basket, PaymentMethod, Product + + +class ReportsView(TemplateView): + template_name = "purchase/reports.html" + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context.update( + { + "total": Basket.objects.priced().aggregate(total=Sum("price"))["total"], + "by_day": {}, + "products": Product.objects.with_turnover().with_sold(), + "payment_methods": PaymentMethod.objects.with_turnover(), + } + ) + return context diff --git a/src/purchase/views/utils.py b/src/purchase/views/utils.py new file mode 100644 index 0000000..e12c2f7 --- /dev/null +++ b/src/purchase/views/utils.py @@ -0,0 +1,5 @@ +from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin + + +class ProtectedViewsMixin(PermissionRequiredMixin, LoginRequiredMixin): + pass