Improvements for SoberReport

.gitignore

@@ -10,4 +10,4 @@
 .tox
 build
 dist
-venv
+docs

.pytest_cache/README.md

@@ -0,0 +1,8 @@
+# pytest cache directory #
+
+This directory contains data from the pytest's cache plugin,
+which provides the `--lf` and `--ff` options, as well as the `cache` fixture.
+
+**Do not** commit this to version control.
+
+See [the docs](https://docs.pytest.org/en/latest/cache.html) for more information.

.pytest_cache/v/cache/nodeids

@@ -0,0 +1,6 @@
+[
+  "tests/test_base.py::test_basemodel",
+  "tests/test_decorators.py::test_inheritance",
+  "tests/test_decorators.py::test_reference",
+  "tests/test_decorators.py::test_crossreference"
+]

Pipfile

@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+flask-sqlangelo = {editable = true, path = ".", extras = ["test"]}
+
+[dev-packages]
+
+[requires]
+python_version = "3.6"

README.rst

@@ -1,7 +1,7 @@
 SQLAngelo
 #######
 
-    SQLAlchemy with defaults and sugar.
+    Flask SQLAlchemy with convenience and sugar.
 
 Documentation
 ===============

setup.cfg

@@ -0,0 +1,7 @@
+[aliases]
+test=pytest
+
+[tool:pytest]
+testpaths=tests
+addopts=--doctest-modules
+

sqlangelo/__init__.py

@@ -1,5 +1,6 @@
 """ Wrapper around Flask-SQLAlchemy and friends """
 from flask_sqlalchemy import SQLAlchemy
+from . import decorators, mixins, types
 
 class SQLAngelo(SQLAlchemy):
 
@@ -20,7 +21,17 @@ def __init__(self, app, db_uri, debug=False):  # noqa: C901
         # connect tot database
         app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False  # suppress warning
         app.config['SQLALCHEMY_DATABASE_URI'] = db_uri
-        super(SQLAngelo, self).__init__(app)
+        super(SQLAngelo, self).__init__(app, session_options={
+            'expire_on_commit': False  # as per https://gist.github.com/krak3n/9fa1268ee0a92a67f71a
+        })
 
         # create basemodel
         self.BaseModel = base.get_base_model(self)
+        self.decorators = decorators
+        self.mixins = mixins
+        self.types = types
+
+    def init(self):
+        ''' (re)create the database '''
+        self.drop_all()
+        self.create_all()

sqlangelo/base.py

@@ -1,4 +1,4 @@
-from .mixins import CRUDMixin, NamingMixin, inflect_engine
+from .mixins import CRUD, Naming, inflect_engine
 
 
 def log(msg):
@@ -8,7 +8,7 @@ def log(msg):
 
 def get_base_model(db):  # noqa: C901
 
-    class BaseModel(db.Model, CRUDMixin, NamingMixin):
+    class BaseModel(db.Model, CRUD, Naming):
         """ used as super model for all other models
 
         :var id: every model should have a unique id
@@ -131,6 +131,7 @@ def add_cross_reference(cls, peer_cls, names=None, x_names=None, x_cls=None):
             setattr(cls, x_names[0],
                     db.relationship(
                         peer_cls.__name__,
+                        lazy='dynamic',
                         secondary=x_cls.__tablename__,
                         backref=db.backref(x_names[1], lazy='dynamic'),
                         **kwargs))

sqlangelo/mixins.py

@@ -5,7 +5,7 @@
 inflect_engine = inflect.engine()
 
 
-class NamingMixin(object):
+class Naming(object):
     """ Provide some convenient names for models. """
 
     @classmethod
@@ -23,7 +23,7 @@ def get_plural(cls):
         return inflect_engine.plural(cls.get_api())
 
 
-class IntrospectionMixin(object):
+class Introspection(object):
     """ access to meta data about a model
 
     Available as app.db.Introspectionmixin
@@ -74,7 +74,7 @@ def to_dict(self, remove=''):
         return {c: getattr(self, c) for c in self.columns(remove=remove)}
 
 
-class CRUDMixin(object):
+class CRUD(object):
     """ provide Create, Read, Update and Delete (CRUD) methods
 
     Available as app.db.CRUDmixin.
@@ -136,8 +136,6 @@ def update(self, commit=True, report=True, **kwargs):
             self.report('Updating %s "%s": %s' % (self.__class__.__name__,
                                                         self,
                                                         pformat(kwargs)))
-        log('UPDATE %s' % self)
-        log('   %s' % kwargs)
         self.before_update(kwargs)
         for attr, value in kwargs.items():
             setattr(self, attr, value)
@@ -211,7 +209,7 @@ def bulk_insert(cls, new_records):
         cls.commit()
 
 
-class OperationsMixin(object):
+class Operations(object):
 
     @classmethod
     def get(cls, id):

tests/models.py

@@ -9,29 +9,23 @@
 ########################################
 
 
-class BaseModel(db.BaseModel, mixins.CRUDMixin):
-    __abstract__ = True
-
-########################################
-
-
-class Group(BaseModel):
+class Group(db.BaseModel):
     abbr = db.Column(db.Unicode(6), nullable=False)
 
     def __str__(self):
         return self.abbr
 
 
 @decorators.add_cross_reference(Group)
-@decorators.make_polymorphic_top(BaseModel, 'User Employee')
+@decorators.make_polymorphic_top(db.BaseModel, 'User Employee')
 class User(object):
     email = db.Column(db.Unicode(30), nullable=False)
 
     def __str__(self):
         return '%s (%s)' % (self.email, ', '.join([str(g) for g in self.groups]))
 
 
-class Company(BaseModel):
+class Company(db.BaseModel):
     name = db.Column(db.Unicode(30), nullable=False)
 
     def __str__(self):

tests/test_base.py

@@ -1,6 +1,6 @@
-from tests import models
+from tests.models import db
 
 
 def test_basemodel():
-    assert models.BaseModel.__abstract__
-    assert hasattr(models.BaseModel, 'id')
+    assert db.BaseModel.__abstract__
+    assert hasattr(db.BaseModel, 'id')

tox.ini

@@ -0,0 +1,11 @@
+# Tox (https://tox.readthedocs.io/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+# envlist = py27, py35
+envlist = py27
+
+[testenv]
+commands = {envpython} setup.py test