Refactor SoftDeletableModel, add github tests (#9)

* switch up objects.all_objects -> all_objects, add test project, setup base test

* add flake8, fix flake8 problems

* add ci workflow action

* add multiple django versions, cache them

* proper regex and file overwrite

* pull caching for now

* try to dump requirements after being sed'd

* output dir before sed

* pull extra quotes...

* appears only first command is run..

* explicit read requirements

* file output not happening ???

* things fixed -- re-enable caching to test that..

* remove cruft

* ready for merging

Author: ckcollab

.github/workflows/pythonpackage.yml

@@ -0,0 +1,44 @@
+name: django-ckc
+
+on:
+  push:
+    branches: [ '*' ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+        django-version: ['<2', '<3', '>=3']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Set up Django ${{ matrix.django-version }}
+      run: |
+        sed 's/Django==.*/Django==${{ matrix.django-version }}/' requirements.txt
+    - name: Cache pip
+      uses: actions/cache@v1
+      with:
+        path: ~/.cache/pip
+        # Look to see if there is a cache hit for the corresponding requirements file
+        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+          ${{ runner.os }}-
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8
+    - name: Test with pytest
+      run: |
+        pytest

README.md

@@ -3,7 +3,25 @@ django-ckc [<img src="https://ckcollab.com/assets/images/badges/badge.svg" alt="
 tools, utilities, etc. we use across projects @ ckc
 
 
-# distributing
+## installing
+
+```bash
+pip install django-ckc
+```
+
+```python
+# settings.py
+INSTALLED_APPS = (
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.staticfiles",
+    # ... add ckc
+    "ckc",
+)
+```
+
+## distributing
 
 ```bash
 $ ./setup.py sdist

ckc/models.py

@@ -5,14 +5,12 @@ class SoftDeleteModelManager(models.Manager):
     def get_queryset(self):
         return super().get_queryset().exclude(deleted=True)
 
-    def all_objects(self):
-        return super().get_queryset()
-
 
 class SoftDeletableModel(models.Model):
     deleted = models.BooleanField(default=False)
 
     objects = SoftDeleteModelManager()
+    all_objects = models.Manager()
 
     class Meta:
         abstract = True

requirements.txt

@@ -1 +1,6 @@
 twine==3.1.1
+Django==3.0.5
+pytest==5.4.1
+pytest-django==3.9.0
+pytest-pythonpath==0.7.3
+flake8==3.7.9

setup.cfg

@@ -25,7 +25,9 @@ per-file-ignores =
 
 
 [tool:pytest]
-addopts = --reuse-db --ds=settings.test
+addopts = --reuse-db
+DJANGO_SETTINGS_MODULE = testproject.settings
+python_paths = testproject
 python_files =
     tests/integration/*.py
     tests/functional/*.py
@@ -62,10 +64,10 @@ zip_safe: False
 ;install_requires =
 ;#  colorama
 
-[options.extras_require]
-tests =
-  pytest
-  flake8
+;[options.extras_require]
+;tests =
+;  pytest
+;  flake8
 
 ;[options.entry_points]
 ;console_scripts =

testproject/__init__.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

testproject/manage.py

@@ -0,0 +1,50 @@
+import os
+
+
+DEBUG = True
+
+BASE_DIR = os.path.dirname(__file__)
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
+    }
+}
+
+EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
+
+SECRET_KEY = "_"
+
+MIDDLEWARE = (
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+
+INSTALLED_APPS = (
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.staticfiles",
+
+    "ckc",
+
+    "testapp",
+)
+
+STATIC_URL = "/static/"
+
+ROOT_URLCONF = "urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "APP_DIRS": True
+    }
+]

testproject/settings.py

@@ -0,0 +1,7 @@
+from django.db import models
+
+from ckc.models import SoftDeletableModel
+
+
+class TestModel(SoftDeletableModel):
+    title = models.CharField(max_length=255, default="I'm a test!")