django-rubble 0.2.0__py3-none-any.whl

django_rubble/admin/stamped_admin.py

@@ -0,0 +1,12 @@
+from django.contrib import admin  # type: ignore[import-untyped]
+
+
+class StampedAdmin(admin.ModelAdmin):
+    """A ModelAdmin that sets the created_by and modified_by fields of a StampedModel
+    instance to the user that created or modified the instance."""
+
+    def save_model(self, request, obj, form, change):
+        if not change:
+            obj.created_by = request.user
+        obj.modified_by = request.user
+        super().save_model(request, obj, form, change)

django_rubble/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class UtilsConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "django_rubble"
+    verbose_name = "Django Rubble"

django_rubble/fields/auto_fields.py

@@ -0,0 +1,30 @@
+from django.conf import settings
+from django.db import models
+
+AUTH_USER_MODEL = getattr(settings, "AUTH_USER_MODEL", "auth.User")
+
+
+class AutoCreatedByField(models.ForeignKey):
+    """A ForeignKey to the user model that is not editable and has a related name
+    of '+'.
+    """
+
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault("editable", False)
+        kwargs.setdefault("related_name", "+")
+        kwargs.setdefault("to", AUTH_USER_MODEL)
+        kwargs.setdefault("on_delete", models.PROTECT)
+        super().__init__(*args, **kwargs)
+
+
+class AutoModifiedByField(models.ForeignKey):
+    """A ForeignKey to the user model that is not editable and has a related name
+    of '+'.
+    """
+
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault("editable", False)
+        kwargs.setdefault("related_name", "+")
+        kwargs.setdefault("to", AUTH_USER_MODEL)
+        kwargs.setdefault("on_delete", models.PROTECT)
+        super().__init__(*args, **kwargs)

django_rubble/fields/db_fields.py

@@ -0,0 +1,52 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from django_rubble.forms.db_forms import (
+    SimplePercentageField as SimplePercentageFormField,
+)
+
+
+class SimplePercentageField(models.DecimalField):
+    """Enter and display percentages out of 100 but store them out of 1
+    in db as decimals
+
+    Because this is based on `models.DecimalField`, `decimal_places` applies to what is
+    stored in the db (/1), not what is shown or typed in (/100). With that said, add two
+    (2) to whatever is desired in the form for proper validation.
+    """
+
+    description = _(
+        "percentage (max {max_digits} digits; {decimal_places} decimal places"
+    )
+    log_name = "models.PercentageField"
+
+    def __init__(
+        self,
+        verbose_name=None,
+        name=None,
+        max_digits=None,
+        decimal_places=None,
+        **kwargs,
+    ):
+        if decimal_places is not None:
+            self.humanize_decimal_places = int(decimal_places) - 2
+        else:
+            self.humanize_decimal_places = None
+
+        kwargs.update(
+            {
+                "max_digits": max_digits,
+                "decimal_places": decimal_places,
+            }
+        )
+
+        super().__init__(verbose_name, name, **kwargs)
+
+    def formfield(self, **kwargs):
+        defaults = {"form_class": SimplePercentageFormField}
+        kwargs.update(
+            decimal_places=self.decimal_places - 2,
+        )
+        defaults.update(kwargs)
+
+        return super().formfield(**defaults)

django_rubble/forms/db_forms.py

@@ -0,0 +1,57 @@
+from django import forms
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+from django_rubble.utils.numbers import Percent, is_number
+
+
+class SimplePercentageField(forms.DecimalField):
+    def __init__(
+        self,
+        *,
+        max_value=None,
+        min_value=None,
+        max_digits=None,
+        decimal_places=None,
+        **kwargs,
+    ):
+        if "widget" not in kwargs:
+            step = 10 ** (-1 * decimal_places)
+            kwargs["widget"] = forms.NumberInput(
+                attrs={"class": "percent", "step": step}
+            )
+        self.max_digits, self.decimal_places = max_digits, decimal_places
+        super().__init__(max_value=max_value, min_value=min_value, **kwargs)
+
+    def to_python(self, value):
+        val = super().to_python(value)
+
+        if isinstance(val, Percent):
+            return val.value
+
+        if is_number(val):
+            new_val = Percent.fromform(val)
+
+            return new_val.value
+
+        rtype = type(val)
+        raise ValidationError(
+            _("Invalid value type: %(rtype)s"),
+            code="invalid",
+            params={"rtype": rtype},
+        )
+
+    def prepare_value(self, value):
+        val = super().prepare_value(value)
+
+        if isinstance(val, Percent):
+            return val.per_hundred
+        if is_number(val):
+            if isinstance(val, str):
+                new_val = Percent.fromform(val)
+
+                return new_val.per_hundred
+
+            return Percent(val).per_hundred
+
+        return val

django_rubble/models/stamped_models.py

@@ -0,0 +1,22 @@
+from model_utils.models import TimeStampedModel  # type: ignore[import-untyped]
+
+from django_rubble.fields.auto_fields import AutoCreatedByField, AutoModifiedByField
+
+
+class StampedModel(TimeStampedModel):
+    """A model that has created_by and modified_by fields that are automatically
+    set to the user that created or modified the instance."""
+
+    created_by = AutoCreatedByField()
+    modified_by = AutoModifiedByField()
+
+    class Meta:
+        abstract = True
+
+    def save(self, *args, **kwargs):
+        update_fields = kwargs.get("update_fields", None)
+        if update_fields is not None:
+            if "modified_by" not in update_fields:
+                kwargs["update_fields"] = set(update_fields) | {"modified_by"}
+
+        return super().save(*args, **kwargs)

django_rubble/utils/default_funcs.py

@@ -0,0 +1,8 @@
+from datetime import date
+
+from django.utils import timezone
+
+
+def django_today() -> date:
+    """Return the current date in the timezone of the Django settings."""
+    return timezone.now().date()

django_rubble/utils/numbers.py

@@ -0,0 +1,102 @@
+from decimal import Decimal
+from typing import Any
+
+from pydantic import BaseModel
+
+
+def is_number(s: Any):
+    """Check if a value can be coerced into a number type."""
+    if s is None:
+        return False
+    try:
+        float(s)
+    except ValueError:
+        return False
+    else:
+        return True
+
+
+def ratio_to_whole(ratio: Decimal | float | str) -> Decimal:
+    return Decimal(str(ratio)) * Decimal("100")
+
+
+def whole_to_ratio(whole: Decimal | float | str) -> Decimal:
+    return Decimal(str(whole)) * Decimal("0.01")
+
+
+def trim_trailing_zeros(value: float | Decimal | str) -> Decimal:
+    """Remove trailing zeros from a decimal value."""
+    if isinstance(value, Decimal):
+        _, _, exponent = value.as_tuple()
+    else:
+        _, _, exponent = Decimal(str(value)).as_tuple()
+
+    if not isinstance(exponent, int):
+        msg = "Exponent must be an integer"
+        raise TypeError(msg)
+
+    if exponent < 0:
+        new_str = str(value).rstrip("0")
+        return Decimal(new_str)
+
+    return Decimal(value)
+
+
+def set_zero(value: float | Decimal | str) -> Decimal:
+    """Set a value to a true Decimal zero if it is zero."""
+    decimal_from_string = Decimal(str(value))
+
+    _, decimal_digits, _ = decimal_from_string.as_tuple()
+
+    if len(decimal_digits) == 1 and decimal_digits[0] == 0:
+        return Decimal()
+
+    return decimal_from_string
+
+
+class Percent(BaseModel):
+    value: Decimal | float | str
+    per_hundred: Decimal | float | str | None = None
+    decimal_places: int | None = None
+    has_decimal_places: bool | None = None
+
+    def model_post_init(self, __context: Any) -> None:
+        new_value = trim_trailing_zeros(self.value)
+        per_hundred_dec = trim_trailing_zeros(ratio_to_whole(self.value))
+
+        if self.decimal_places is not None:
+            new_value = round(new_value, self.decimal_places + 2)
+            per_hundred_dec = round(per_hundred_dec, self.decimal_places)
+            self.has_decimal_places = True
+        else:
+            self.has_decimal_places = False
+
+        self.value = set_zero(new_value)
+        self.per_hundred = set_zero(per_hundred_dec)
+
+        super().model_post_init(__context)
+
+    @classmethod
+    def fromform(cls, val: Decimal, field_decimal_places: int | None = None):
+        """Create Percent from human-entry (out of 100)"""
+        ratio_decimal = whole_to_ratio(val)
+        return cls(value=ratio_decimal, decimal_places=field_decimal_places)
+
+    def __mul__(self, other):
+        """Multiply using the ratio (out of 1) instead of human-readable out of 100"""
+        return self.value.__mul__(other)
+
+    def __float__(self):
+        return float(self.value)
+
+    def as_tuple(self):
+        return self.value.as_tuple()
+
+    def is_finite(self):
+        return self.value.is_finite()
+
+    def __repr__(self) -> str:
+        return f"Percentage('{self.value}', '{self.per_hundred}%')"
+
+    def __str__(self):
+        return f"{self.per_hundred}%"

django_rubble/utils/strings.py

@@ -0,0 +1,8 @@
+def sort_title(title: str) -> str:
+    """Sort a title by the first word, ignoring articles."""
+    articles = {"a", "an", "the"}
+
+    title = title.lower()
+
+    first, _, rest = title.partition(" ")
+    return f"{rest}, {first}" if first in articles else title

django_rubble/views/create_views.py

@@ -0,0 +1,19 @@
+from django.contrib.auth.mixins import LoginRequiredMixin
+from django.views.generic import CreateView, UpdateView
+
+
+class CreateStampedView(LoginRequiredMixin, CreateView):
+    """A view that creates a StampedModel instance."""
+
+    def form_valid(self, form):
+        form.instance.created_by = self.request.user
+        form.instance.modified_by = self.request.user
+        return super().form_valid(form)
+
+
+class UpdateStampedView(LoginRequiredMixin, UpdateView):
+    """A view that updates a StampedModel instance."""
+
+    def form_valid(self, form):
+        form.instance.modified_by = self.request.user
+        return super().form_valid(form)

django_rubble-0.2.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Wooster Technical Solutions
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_rubble-0.2.0.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: django-rubble
+Version: 0.2.0
+Summary: Extend django-model-utils and django-extensions.
+License: MIT
+Author: Karl Wooster
+Author-email: karl@woostertech.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: django (<=5.0)
+Requires-Dist: django-model-utils (>=4.5.1,<5.0.0)
+Requires-Dist: pydantic (>=2.7.1,<3.0.0)
+Description-Content-Type: text/markdown
+
+# django-rubble
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## Description
+
+Extend [django-model-utils](https://github.com/jazzband/django-model-utils) and [django-extensions](https://github.com/django-extensions/django-extensions).
+
+## Features
+
+- Feature 1
+- Feature 2
+- Feature 3
+
+## Installation
+
+1. Clone the repository: `git clone https://github.com/WoosterTech/django-rubble.git`
+2. Install the dependencies: `poetry install`
+
+## Usage
+
+Explain how to use your Django project, including any important commands or
+configurations.
+
+
+Contributions are welcome! Please follow the guidelines in
+[CONTRIBUTING.md](CONTRIBUTING.md).
+
+
+This project is licensed under the [MIT License](LICENSE).
+
+## Contact
+
+- Author: Karl Wooster
+- Email: <karl@woostertech.com>
+- Website: [woostertech.com](https://woostertech.com)
+
+## License
+
+MIT (see [License](LICENSE))
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+

django_rubble-0.2.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+django_rubble/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/admin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/admin/stamped_admin.py,sha256=db9nsMnARppGvMnGITUPc6JHNov1M28j6G7vFb8ge4s,484
+django_rubble/apps.py,sha256=ufyuWOn9JvNKfztgkIUe5JPKo3lr_GSOJ1N9oi2-E6k,192
+django_rubble/fields/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/fields/auto_fields.py,sha256=Ip2bZwucLa0f32vo1_mWw9ZGsUhRhrUJDqSfl297Eoo,1020
+django_rubble/fields/db_fields.py,sha256=xfVRwMBCz-ahFBrEs5Nl_xug9hlaDBgeyO3QfKFybyM,1579
+django_rubble/forms/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/forms/db_forms.py,sha256=AUJ4NM__bvBHvna7FCVWS7TK9slgCcNxEWfAP8pfmcQ,1623
+django_rubble/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/models/stamped_models.py,sha256=kVt0kGnwPE0YCwfefr4yjbU5CIxJV61XG1y17MNWqJ0,801
+django_rubble/tests.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/utils/default_funcs.py,sha256=g-D0PtzyC40iKYfuKhoLYPyujaGNOHDyLTySHNHTVvU,206
+django_rubble/utils/numbers.py,sha256=rk3MPd7nO34cc_5-Vy_zw760Z64wQauCATvcTGS11zk,3057
+django_rubble/utils/strings.py,sha256=qu8hwhBIuL-zigFr9GNRcsEX0w17NhQ1A9peaig0ado,270
+django_rubble/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_rubble/views/create_views.py,sha256=Vsh-QR6-Y3DpPpFtAgpDDfPS5JvqVf1De4_mQkaOwvM,668
+django_rubble-0.2.0.dist-info/LICENSE,sha256=pD8j7afuQxx-5Ldl9fOxjKzprfeOGnDDr6NF8emKbBo,1104
+django_rubble-0.2.0.dist-info/METADATA,sha256=ywzQiA6uB8mKXewkj5fBjgbnS7rFSjkNX7DrwTjdP0U,1603
+django_rubble-0.2.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+django_rubble-0.2.0.dist-info/RECORD,,

django_rubble-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.8.1
+Root-Is-Purelib: true
+Tag: py3-none-any