refactoring (#423)

* refactoring

.dockerignore

@@ -44,12 +44,11 @@ backups/
 .init/
 
 # Testing / linting / coverage reports
-.cache
+.cache/
 .coverage_html/
 .hypothesis/
-.mypy_cache/
 .nox/
-.pytest_cache/
+.pyre/
 .selenium/
 .tox/
 htmlcov/

.github/actions/setup/action.yml

@@ -41,7 +41,7 @@ runs:
       shell: bash
     # Install and configure Poetry.
     - name: Install and configure Poetry
-      uses: snok/[email protected].4
+      uses: snok/[email protected].6
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true

.github/workflows/delivery.yml

@@ -106,7 +106,7 @@ jobs:
       shell: bash
     # Install and configure Poetry.
     - name: Install and configure Poetry
-      uses: snok/[email protected].4
+      uses: snok/[email protected].6
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true

.github/workflows/integration.yml

@@ -103,7 +103,7 @@ jobs:
       shell: bash
     # Install and configure Poetry.
     - name: Install and configure Poetry
-      uses: snok/[email protected].4
+      uses: snok/[email protected].6
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true
@@ -202,7 +202,7 @@ jobs:
       shell: bash
     # Install and configure Poetry.
     - name: Install and configure Poetry
-      uses: snok/[email protected].4
+      uses: snok/[email protected].6
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true
@@ -282,7 +282,7 @@ jobs:
       shell: bash
     # Install and configure Poetry.
     - name: Install and configure Poetry
-      uses: snok/[email protected].4
+      uses: snok/[email protected].6
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true
@@ -357,7 +357,7 @@ jobs:
       shell: bash
     # Install and configure Poetry.
     - name: Install and configure Poetry
-      uses: snok/[email protected].4
+      uses: snok/[email protected].6
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true

.github/workflows/seed.yml

@@ -68,7 +68,7 @@ jobs:
       shell: bash
     # Install and configure Poetry.
     - name: Install and configure Poetry
-      uses: snok/[email protected].4
+      uses: snok/[email protected].6
       with:
         virtualenvs-create: true
         virtualenvs-in-project: true

.gitignore

@@ -66,10 +66,9 @@ backups/
 .cache
 .coverage_html/
 .hypothesis/
-.mypy_cache/
 .nox/
-.pytest_cache/
 .pytype/
+.pyre/
 .selenium/
 .tox/
 htmlcov/

.pyre_configuration

@@ -0,0 +1,11 @@
+{
+  "source_directories": [
+    "."
+  ],
+  "exclude": [
+    ".*\/node_modules\/.*",
+    ".*\/.venv\/.*",
+    ".*\/.cache\/.*"
+  ],
+  "taint_models_path": ".venv/lib"
+}

.vscode/cspell.json

@@ -8,6 +8,7 @@
         "Bennion",
         "braintree",
         "buildx",
+        "crontabschedule",
         "CSRF",
         "ctype",
         "dbbackup",
@@ -26,6 +27,7 @@
         "ghcr",
         "graphiql",
         "graphviz",
+        "grappelli",
         "iframe",
         "iglob",
         "Imgur",
@@ -68,6 +70,7 @@
         "stylelint",
         "testcafe",
         "tinymce",
+        "uncachable",
         "unstaged",
         "venv",
         "virtualenvs",

.vscode/settings.json

@@ -66,7 +66,6 @@
     "python.linting.banditEnabled": false,
     "python.linting.banditPath": "${workspaceFolder}/.venv/bin/bandit",
     "python.linting.lintOnSave": false,
-    "python.linting.mypyEnabled": true,
     "python.linting.mypyPath": "${workspaceFolder}/.venv/bin/mypy",
     "python.linting.pycodestylePath": "${workspaceFolder}/.venv/bin/pycodestyle",
     "python.linting.pydocstylePath": "${workspaceFolder}/.venv/bin/pydocstyle",

.watchmanconfig

@@ -0,0 +1 @@
+{}

apps/admin/__init__.py

@@ -1,9 +1,4 @@
 """Admin app for ModularHistory."""
 
-from .inlines import (
-    GenericStackedInline,
-    GenericTabularInline,
-    StackedInline,
-    TabularInline,
-)
+from .inlines import StackedInline, TabularInline
 from .model_admin import ModelAdmin, admin_site

apps/admin/admin_menu.py

@@ -9,6 +9,7 @@
 
 from admin_tools.menu import Menu, items
 from django.apps import apps
+from django.conf import settings
 from django.urls import reverse
 from django.utils.translation import ugettext_lazy as _
 
@@ -56,6 +57,7 @@ def __init__(self, **kwargs):
                 title='Applications',
                 exclude=[
                     'allauth.*',
+                    'admin_honeypot.*',
                     'rest_framework.*',
                     'defender.*',
                     'django_celery_*',
@@ -73,7 +75,10 @@ def _menu_items(self):
             for model_cls in models:
                 model_name = model_cls.__name__
                 children.append(
-                    items.MenuItem(model_name, f'/admin/{app}/{model_name.lower()}/')
+                    items.MenuItem(
+                        model_name,
+                        f'/{settings.ADMIN_URL_PREFIX}/{app}/{model_name.lower()}/',
+                    )
                 )
             menu_items.append(items.MenuItem(app, children=children))
         return menu_items

apps/admin/inlines.py

@@ -1,63 +1,28 @@
-from typing import TYPE_CHECKING, List, Optional
+from typing import TYPE_CHECKING
 
-from nested_admin.nested import (
-    NestedGenericStackedInline,
-    NestedGenericTabularInline,
-    NestedStackedInline,
-    NestedTabularInline,
-)
+# from django.contrib.admin import StackedInline as BaseStackedInline
+# from django.contrib.admin import TabularInline as BaseTabularInline
+from nested_admin.nested import NestedStackedInline, NestedTabularInline
 
 from apps.admin.model_admin import FORM_FIELD_OVERRIDES
 
 if TYPE_CHECKING:
     from core.models.model import Model
 
 
-class GenericTabularInline(NestedGenericTabularInline):
-    """Tabular inline admin for generically related objects."""
-
-    formfield_overrides = FORM_FIELD_OVERRIDES
-
-
-class GenericStackedInline(NestedGenericStackedInline):
-    """Stacked inline admin for generically related objects."""
-
-    formfield_overrides = FORM_FIELD_OVERRIDES
-
-
 class StackedInline(NestedStackedInline):
     """Inline admin with fields stacked vertically."""
 
     formfield_overrides = FORM_FIELD_OVERRIDES
 
-    def get_fields(self, request, model_instance=None) -> List[str]:
-        """Return reordered fields to be displayed in the admin."""
-        fields = super().get_fields(request, model_instance)
-        return reorder_fields(fields)
-
 
 class TabularInline(NestedTabularInline):
     """Inline admin with fields laid out horizontally."""
 
     formfield_overrides = FORM_FIELD_OVERRIDES
 
-    def get_extra(self, request, model_instance: Optional['Model'] = None, **kwargs):
+    def get_extra(self, request, *args, **kwargs):
         """Return the number of extra/blank rows to display."""
         if len(self.get_queryset(request)):
             return 0
         return 1
-
-    def get_fields(self, request, model_instance=None) -> List[str]:
-        """Return reordered fields to be displayed in the admin."""
-        fields = super().get_fields(request, model_instance)
-        return reorder_fields(fields)
-
-
-def reorder_fields(fields) -> List[str]:
-    """Return a reordered list of fields to display in the admin."""
-    ordered_fields = ('page_number', 'end_page_number', 'notes', 'position')
-    for field_name in ordered_fields:
-        if field_name in fields:
-            fields.remove(field_name)
-            fields.append(field_name)
-    return fields

apps/admin/model_admin.py

@@ -4,6 +4,7 @@
 from aenum import Constant
 from django.conf import settings
 from django.contrib.admin import ListFilter
+from django.contrib.admin import ModelAdmin as BaseModelAdmin
 from django.contrib.contenttypes.models import ContentType
 from django.contrib.postgres.search import SearchQuery, SearchRank, SearchVector
 from django.contrib.sites.models import Site
@@ -16,8 +17,11 @@
     PeriodicTask,
     SolarSchedule,
 )
-from django_celery_results.admin import TaskResult, TaskResultAdmin
-from nested_admin import NestedModelAdmin, NestedPolymorphicInlineSupportMixin
+from django_celery_results.admin import TaskResultAdmin
+from django_celery_results.models import TaskResult
+from nested_admin.nested import NestedModelAdmin
+from nested_admin.polymorphic import NestedPolymorphicInlineSupportMixin
+from polymorphic.admin import PolymorphicInlineSupportMixin
 from sass_processor.processor import sass_processor
 
 from apps.admin.admin_site import admin_site
@@ -46,13 +50,8 @@
     ADMIN_CSS = 'styles/admin.css'
 
 
-class ModelAdmin(NestedPolymorphicInlineSupportMixin, NestedModelAdmin):
-    """
-    Base admin class for ModularHistory's models.
-
-    Uses the NestedPolymorphicInlineSupportMixin as instructed in
-    https://django-nested-admin.readthedocs.io/en/latest/integrations.html.
-    """
+class ModelAdmin(PolymorphicInlineSupportMixin, BaseModelAdmin):
+    """Base admin class for ModularHistory's models."""
 
     model: Type[Model]
 
@@ -138,6 +137,27 @@ def get_search_results(
             queryset = queryset.exclude(pk=pk)
         return queryset, use_distinct
 
+    def save_form(self, request, form, change):
+        """
+        Given a ModelForm return an unsaved instance. ``change`` is True if
+        the object is being changed, and False if it's being added.
+        """
+        print(f'>>>>>>save_form>>>>>')
+        return super().save_form(request, form, change)
+
+    def save_model(self, request, obj, form, change):
+        """
+        Given a model instance save it to the database.
+        """
+        print(f'>>>>>>after save_model>>>>> {getattr(obj, "summary", None)}')
+        obj.save()
+        print(f'>>>>>>after save_model>>>>> {getattr(obj, "summary", None)}')
+        obj.refresh_from_db()
+        print(f'>>>>>>after refresh_from_db>>>>> {getattr(obj, "summary", None)}')
+        from time import sleep
+
+        sleep(5)
+
 
 class ContentTypeFields(Constant):
     """Field names of the ContentType model."""

apps/entities/admin/entities.py

@@ -55,7 +55,7 @@ class EntityAdmin(SearchableModelAdmin):
         EntityTypeFilter,
     ]
     ordering = ['name', 'birth_date']
-    readonly_fields = ['pretty_cache']
+    readonly_fields = SearchableModelAdmin.readonly_fields + ['title', 'slug']
     search_fields = ['name', 'aliases']
 
 

apps/entities/migrations/0004_auto_20210524_0113.py

@@ -0,0 +1,29 @@
+# Generated by Django 3.1.11 on 2021-05-24 01:13
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('entities', '0003_auto_20210521_1334'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='entityimage',
+            name='position',
+            field=models.PositiveSmallIntegerField(blank=True, default=0, null=True),
+        ),
+        migrations.AlterField(
+            model_name='entity',
+            name='title',
+            field=models.CharField(
+                blank=True,
+                help_text='The title can be used for the detail page header and title tag, SERP result card header, etc. It should be a noun phrase!',
+                max_length=120,
+                null=True,
+                verbose_name='title',
+            ),
+        ),
+    ]

apps/entities/models/entity_image.py

@@ -1,13 +1,13 @@
 from django.db import models
 
-from core.models.model import Model
+from core.models.positioned_relation import PositionedRelation
 
 NAME_MAX_LENGTH: int = 100
 
 TRUNCATED_DESCRIPTION_LENGTH: int = 1200
 
 
-class EntityImage(Model):
+class EntityImage(PositionedRelation):
     """An association of an image with an entity."""
 
     entity = models.ForeignKey(

apps/images/migrations/0003_auto_20210524_0113.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.1.11 on 2021-05-24 01:13
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('images', '0002_auto_20210522_1558'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='image',
+            name='title',
+            field=models.CharField(
+                blank=True,
+                help_text='The title can be used for the detail page header and title tag, SERP result card header, etc. It should be a noun phrase!',
+                max_length=120,
+                null=True,
+                verbose_name='title',
+            ),
+        ),
+    ]