report_generators.py

from __future__ import annotations

import datetime

from django.db.models import Sum, Count
from django.utils.translation import gettext_lazy as _

from slick_reporting.fields import ComputationField, PercentageToTotalBalance
from slick_reporting.generator import ReportGenerator
from .models import (
    Client,
    SimpleSales,
    Product,
    SalesWithFlag,
    SalesProductWithCustomID,
    ComplexSales,
    SimpleSales2,
)
from .models import OrderLine


class GenericGenerator(ReportGenerator):
    report_model = OrderLine
    date_field = "order__date_placed"

    # here is the meat and potatos of the report,
    # we group the sales per client , we display columns slug and title (of the `base_model` defied above
    # and we add the magic field `__balance__` we compute the client balance.
    group_by = "client"
    columns = ["slug", "name"]


class GeneratorWithAttrAsColumn(GenericGenerator):
    group_by = "client"

    columns = ["get_data", "slug", "name"]

    def get_data(self, obj):
        return obj["name"]

    get_data.verbose_name = "My Verbose Name"


class CrosstabOnClient(GenericGenerator):
    group_by = "product"
    columns = ["name", "__total_quantity__"]
    crosstab_field = "client"
    # crosstab_columns = ['__total_quantity__']
    crosstab_columns = [ComputationField.create(Sum, "quantity", name="value__sum", verbose_name=_("Sales"))]


class CrosstabTimeSeries(GenericGenerator):
    group_by = "product"
    columns = ["name", "__total_quantity__"]
    # crosstab_field = "client"
    # crosstab_columns = [
    #     ComputationField.create(
    #         Sum, "quantity", name="value__sum", verbose_name=_("Sales")
    #     )
    # ]
    # crosstab_compute_remainder = False

    # time_series_pattern = "monthly"
    # time_series_columns = ["__total_quantity__"]


class CrosstabOnField(ReportGenerator):
    report_model = ComplexSales
    date_field = "doc_date"

    group_by = "product"
    columns = ["name"]
    crosstab_field = "flag"
    crosstab_ids = ["sales", "sales-return"]

    crosstab_columns = [ComputationField.create(Sum, "quantity", name="value__sum", verbose_name=_("Sales"))]


class CrosstabCustomQueryset(ReportGenerator):
    report_model = ComplexSales
    date_field = "doc_date"

    group_by = "product"
    columns = ["name"]
    crosstab_field = "flag"
    # crosstab_ids = ["sales", "sales-return"]

    crosstab_ids_custom_filters = [
        (None, dict(flag="sales")),
        (None, dict(flag="sales-return")),
    ]

    crosstab_columns = [ComputationField.create(Sum, "quantity", name="value__sum", verbose_name=_("Sales"))]


class CrosstabOnTraversingField(ReportGenerator):
    report_model = ComplexSales
    date_field = "doc_date"

    group_by = "product"
    columns = ["name"]

    crosstab_field = "client__sex"
    crosstab_ids = ["FEMALE", "MALE", "OTHER"]

    crosstab_columns = [ComputationField.create(Sum, "quantity", name="value__sum", verbose_name=_("Sales"))]


class ClientTotalBalance(ReportGenerator):
    report_model = SimpleSales
    # date_field = "doc_date"
    group_by = "client"
    columns = [
        "slug",
        "name",
        "__balance__",
        ComputationField.create(Sum, "value", name="__total__", verbose_name=_("Sales")),
    ]


class TotalBalanceWithQueryset(ReportGenerator):
    report_model = SimpleSales
    queryset = SimpleSales.objects.filter(product_id=0)
    date_field = "doc_date"
    group_by = "client"
    columns = ["slug", "name", "__balance__", "__total__"]


class ClientTotalBalance2(ReportGenerator):
    report_model = SimpleSales2
    date_field = "doc_date"
    group_by = "client"
    columns = ["slug", "name", "__balance__", "__total__"]


class GroupByCharField(ReportGenerator):
    report_model = SalesWithFlag
    date_field = "doc_date"
    group_by = "flag"
    columns = ["flag", "__balance__", ComputationField.create(Sum, "quantity")]


class GroupByCharFieldPlusTimeSeries(ReportGenerator):
    report_model = SalesWithFlag
    date_field = "doc_date"
    group_by = "flag"
    columns = ["flag", ComputationField.create(Sum, "quantity")]

    time_series_pattern = "monthly"
    time_series_columns = [ComputationField.create(Sum, "quantity")]


class ClientTotalBalancesOrdered(ClientTotalBalance):
    report_slug = None
    default_order_by = "__balance__"


class ClientTotalBalancesOrderedDESC(ClientTotalBalance):
    report_slug = None
    default_order_by = "-__balance__"


class ProductTotalSales(ReportGenerator):
    report_model = SimpleSales
    date_field = "doc_date"
    group_by = "product"
    columns = [
        "slug",
        "name",
        "__balance__",
        "__balance_quantity__",
        "get_object_sku",
        "average_value",
    ]

    def get_object_sku(self, obj: dict, row: dict) -> any:
        """
        :param obj: obj is the current row of the grouped by model , or the current row of the queryset
        :param row: the current report row values in a dictionary
        :return:
        """
        return obj["sku"].upper()

    get_object_sku.verbose_name = "SKU ALL CAPS"

    def average_value(self, obj, data):
        return data["__balance__"] / data["__balance_quantity__"]

    average_value.verbose_name = "Average Value"


class ProductTotalSalesProductWithCustomID(ReportGenerator):
    report_model = SalesProductWithCustomID
    date_field = "doc_date"
    group_by = "product"
    columns = ["slug", "name", "__balance__", "__balance_quantity__"]


class ProductTotalSalesWithPercentage(ReportGenerator):
    report_model = SimpleSales
    date_field = "doc_date"
    group_by = "client"
    columns = [
        "slug",
        "name",
        "__balance__",
        "__balance_quantity__",
        PercentageToTotalBalance,
    ]


class ClientList(ReportGenerator):
    report_model = SimpleSales

    group_by = "client"
    columns = ["slug", "name"]


class ProductClientSales(ReportGenerator):
    report_model = SimpleSales

    report_slug = "client_sales_of_products"
    report_title = _("Client net sales for each product")
    must_exist_filter = "client_id"
    header_report = ClientList

    group_by = "product"
    columns = ["slug", "name", "__balance_quantity__", "__balance__", "get_data"]

    def get_data(self, obj):
        return ""


class ProductSalesMonthlySeries(ReportGenerator):
    base_model = Product
    report_model = SimpleSales
    report_title = _("Product Sales Monthly")

    group_by = "product"
    columns = ["slug", "name"]
    time_series_pattern = ("monthly",)
    time_series_columns = ["__balance_quantity__", "__balance__"]

    chart_settings = [
        {
            "id": "movement_column",
            "name": _("comparison - column"),
            "settings": {
                "chart_type": "column",
                "name": _("{product} Avg. purchase price "),
                "sub_title": _("{date_verbose}"),
                "y_sources": ["__balance__"],
                "series_names": [_("Avg. purchase price")],
            },
        },
        {
            "id": "movement_line",
            "name": _("comparison - line"),
            "settings": {
                "chart_type": "line",
                "name": _("{product} Avg. purchase price "),
                "sub_title": _("{date_verbose}"),
                "y_sources": ["__balance__"],
                "series_names": [_("Avg. purchase price")],
            },
        },
    ]


class TimeSeriesCustomDates(ReportGenerator):
    report_model = SimpleSales
    report_title = _("Product Sales Monthly")
    date_field = "doc_date"
    # group_by = 'product'
    # columns = ['slug', 'name']
    time_series_pattern = "custom"
    time_series_columns = ["__total__"]
    time_series_custom_dates = [
        (datetime.date(2020, 1, 1), datetime.date(2020, 1, 17)),
        (datetime.date(2020, 4, 17), datetime.date(2020, 5, 1)),
        (datetime.date(2020, 8, 8), datetime.date(2020, 9, 9)),
    ]


class TimeSeriesWithOutGroupBy(ReportGenerator):
    report_model = SimpleSales
    report_title = _("Product Sales Monthly")
    date_field = "doc_date"
    # group_by = 'product'
    # columns = ['slug', 'name']
    time_series_pattern = "monthly"
    time_series_columns = ["__total__"]


class ClientReportMixin:
    base_model = Client
    report_model = SimpleSales


class ClientSalesMonthlySeries(ReportGenerator):
    report_model = SimpleSales
    date_field = "doc_date"

    group_by = "client"
    columns = ["slug", "name"]
    time_series_pattern = "monthly"
    time_series_columns = ["__debit__", "__credit__", "__balance__", "__total__"]


class CountField(ComputationField):
    calculation_field = "id"
    calculation_method = Count
    verbose_name = _("Count")
    name = "count__id"


class TestCountField(ReportGenerator):
    report_model = ComplexSales

    group_by = "product"
    columns = ["slug", "name", CountField]
    date_field = "doc_date"


#


class ClientDetailedStatement(ReportGenerator):
    report_model = SimpleSales
    date_field = "doc_date"
    group_by = None
    columns = ["slug", "doc_date", "product__name", "quantity", "price", "value"]


class ClientDetailedStatement2(ReportGenerator):
    report_title = _("client statement")
    base_model = Client
    report_model = SimpleSales

    header_report = ClientList
    must_exist_filter = "client_id"

    form_settings = {
        "group_by": "",
        "group_columns": [
            "slug",
            "doc_date",
            "doc_type",
            "product__title",
            "quantity",
            "price",
            "value",
        ],
    }
    group_by = None
    columns = [
        "slug",
        "doc_date",
        "doc_type",
        "product__title",
        "quantity",
        "price",
        "value",
    ]


class ProductClientSalesMatrix(ReportGenerator):
    report_model = SimpleSales
    date_field = "doc_date"

    group_by = "product"
    columns = ["slug", "name"]

    crosstab_field = "client"
    crosstab_columns = ["__total__"]


class ProductClientSalesMatrixToFieldSet(ReportGenerator):
    report_model = SimpleSales2
    date_field = "doc_date"

    group_by = "product"
    columns = ["slug", "name"]

    crosstab_field = "client"
    crosstab_columns = ["__total__"]


class ProductClientSalesMatrix2(ReportGenerator):
    report_model = SimpleSales
    date_field = "doc_date"

    group_by = "product"
    columns = ["slug", "name"]

    crosstab_field = "client"
    crosstab_columns = [ComputationField.create(Sum, "value", name="value__sum", verbose_name=_("Sales"))]


class ProductClientSalesMatrixwSimpleSales2(ReportGenerator):
    report_model = SimpleSales2
    date_field = "doc_date"

    group_by = "product"
    columns = ["slug", "name"]

    crosstab_field = "client"
    crosstab_columns = [ComputationField.create(Sum, "value", name="value__sum", verbose_name=_("Sales"))]


class GeneratorClassWithAttrsAs(ReportGenerator):
    columns = ["get_icon", "slug", "name"]


class ClientTotalBalancesWithShowEmptyFalse(ClientTotalBalance):
    report_slug = None
    default_order_by = "-__balance__"
    show_empty_records = False