- mega example cleanup

- added READMEs to all examples in each __init__.py and added to sphinx documentation
- added versioning example
- removed vertical/vertical.py, the dictlikes are more straightforward

1 files changed, 248 insertions, 0 deletions

diff --git a/examples/versioning/test_versioning.py b/examples/versioning/test_versioning.py
new file mode 100644
index 000000000..1a72a0659
--- /dev/null
+++ b/examples/versioning/test_versioning.py
@@ -0,0 +1,248 @@
+from sqlalchemy.ext.declarative import declarative_base
+from history_meta import VersionedMeta, VersionedListener
+from sqlalchemy import create_engine, Column, Integer, String, ForeignKey
+from sqlalchemy.orm import clear_mappers, compile_mappers, sessionmaker, deferred
+from sqlalchemy.test.testing import TestBase, eq_
+from sqlalchemy.test.entities import ComparableEntity
+
+def setup():
+    global engine
+    engine = create_engine('sqlite://', echo=True)
+    
+class TestVersioning(TestBase):
+    def setup(self):
+        global Base, Session
+        Base = declarative_base(metaclass=VersionedMeta, bind=engine)
+        Session = sessionmaker(extension=VersionedListener())
+        
+    def teardown(self):
+        clear_mappers()
+        Base.metadata.drop_all()
+    
+    def create_tables(self):
+        Base.metadata.create_all()
+        
+    def test_plain(self):
+        class SomeClass(Base, ComparableEntity):
+            __tablename__ = 'sometable'
+            
+            id = Column(Integer, primary_key=True)
+            name = Column(String(50))
+        
+        self.create_tables()
+        sess = Session()
+        sc = SomeClass(name='sc1')
+        sess.add(sc)
+        sess.commit()
+        
+        sc.name = 'sc1modified'
+        sess.commit()
+        
+        assert sc.version == 2
+        
+        SomeClassHistory = SomeClass.__history_mapper__.class_
+        
+        eq_(
+            sess.query(SomeClassHistory).filter(SomeClassHistory.version == 1).all(),
+            [SomeClassHistory(version=1, name='sc1')]
+        )
+
+        sc.name = 'sc1modified2'
+
+        eq_(
+            sess.query(SomeClassHistory).order_by(SomeClassHistory.version).all(),
+            [
+                SomeClassHistory(version=1, name='sc1'),
+                SomeClassHistory(version=2, name='sc1modified')
+            ]
+        )
+
+        assert sc.version == 3
+        
+        sess.commit()
+
+        sc.name = 'temp'
+        sc.name = 'sc1modified2'
+
+        sess.commit()
+
+        eq_(
+            sess.query(SomeClassHistory).order_by(SomeClassHistory.version).all(),
+            [
+                SomeClassHistory(version=1, name='sc1'),
+                SomeClassHistory(version=2, name='sc1modified')
+            ]
+        )
+        
+        sess.delete(sc)
+        sess.commit()
+
+        eq_(
+            sess.query(SomeClassHistory).order_by(SomeClassHistory.version).all(),
+            [
+                SomeClassHistory(version=1, name='sc1'),
+                SomeClassHistory(version=2, name='sc1modified'),
+                SomeClassHistory(version=3, name='sc1modified2')
+            ]
+        )
+
+
+
+
+    def test_deferred(self):
+        """test versioning of unloaded, deferred columns."""
+        
+        class SomeClass(Base, ComparableEntity):
+            __tablename__ = 'sometable'
+
+            id = Column(Integer, primary_key=True)
+            name = Column(String(50))
+            data = deferred(Column(String(25)))
+            
+        self.create_tables()
+        sess = Session()
+        sc = SomeClass(name='sc1', data='somedata')
+        sess.add(sc)
+        sess.commit()
+        sess.close()
+        
+        sc = sess.query(SomeClass).first()
+        assert 'data' not in sc.__dict__
+        
+        sc.name = 'sc1modified'
+        sess.commit()
+
+        assert sc.version == 2
+
+        SomeClassHistory = SomeClass.__history_mapper__.class_
+
+        eq_(
+            sess.query(SomeClassHistory).filter(SomeClassHistory.version == 1).all(),
+            [SomeClassHistory(version=1, name='sc1', data='somedata')]
+        )
+        
+        
+    def test_joined_inheritance(self):
+        class BaseClass(Base, ComparableEntity):
+            __tablename__ = 'basetable'
+
+            id = Column(Integer, primary_key=True)
+            name = Column(String(50))
+            type = Column(String(20))
+            
+            __mapper_args__ = {'polymorphic_on':type, 'polymorphic_identity':'base'}
+            
+        class SubClassSeparatePk(BaseClass):
+            __tablename__ = 'subtable1'
+
+            id = Column(Integer, primary_key=True)
+            base_id = Column(Integer, ForeignKey('basetable.id'))
+            subdata1 = Column(String(50))
+
+            __mapper_args__ = {'polymorphic_identity':'sep'}
+
+        class SubClassSamePk(BaseClass):
+            __tablename__ = 'subtable2'
+
+            id = Column(Integer, ForeignKey('basetable.id'), primary_key=True)
+            subdata2 = Column(String(50))
+
+            __mapper_args__ = {'polymorphic_identity':'same'}
+
+        self.create_tables()
+        sess = Session()
+
+        sep1 = SubClassSeparatePk(name='sep1', subdata1='sep1subdata')
+        base1 = BaseClass(name='base1')
+        same1 = SubClassSamePk(name='same1', subdata2='same1subdata')
+        sess.add_all([sep1, base1, same1])
+        sess.commit()
+        
+        base1.name = 'base1mod'
+        same1.subdata2 = 'same1subdatamod'
+        sep1.name ='sep1mod'
+        sess.commit()
+
+        BaseClassHistory = BaseClass.__history_mapper__.class_
+        SubClassSeparatePkHistory = SubClassSeparatePk.__history_mapper__.class_
+        SubClassSamePkHistory = SubClassSamePk.__history_mapper__.class_
+        eq_(
+            sess.query(BaseClassHistory).order_by(BaseClassHistory.id).all(),
+            [
+                SubClassSeparatePkHistory(id=1, name=u'sep1', type=u'sep', version=1), 
+                BaseClassHistory(id=2, name=u'base1', type=u'base', version=1), 
+                SubClassSamePkHistory(id=3, name=u'same1', type=u'same', version=1)            
+            ]
+        )
+        
+        same1.subdata2 = 'same1subdatamod2'
+
+        eq_(
+            sess.query(BaseClassHistory).order_by(BaseClassHistory.id, BaseClassHistory.version).all(),
+            [
+                SubClassSeparatePkHistory(id=1, name=u'sep1', type=u'sep', version=1), 
+                BaseClassHistory(id=2, name=u'base1', type=u'base', version=1), 
+                SubClassSamePkHistory(id=3, name=u'same1', type=u'same', version=1), 
+                SubClassSamePkHistory(id=3, name=u'same1', type=u'same', version=2)            
+            ]
+        )
+
+        base1.name = 'base1mod2'
+        eq_(
+            sess.query(BaseClassHistory).order_by(BaseClassHistory.id, BaseClassHistory.version).all(),
+            [
+                SubClassSeparatePkHistory(id=1, name=u'sep1', type=u'sep', version=1), 
+                BaseClassHistory(id=2, name=u'base1', type=u'base', version=1), 
+                BaseClassHistory(id=2, name=u'base1mod', type=u'base', version=2), 
+                SubClassSamePkHistory(id=3, name=u'same1', type=u'same', version=1), 
+                SubClassSamePkHistory(id=3, name=u'same1', type=u'same', version=2)            
+            ]
+        )
+
+    def test_single_inheritance(self):
+        class BaseClass(Base, ComparableEntity):
+            __tablename__ = 'basetable'
+
+            id = Column(Integer, primary_key=True)
+            name = Column(String(50))
+            type = Column(String(50))
+            __mapper_args__ = {'polymorphic_on':type, 'polymorphic_identity':'base'}
+            
+        class SubClass(BaseClass):
+
+            subname = Column(String(50))
+            __mapper_args__ = {'polymorphic_identity':'sub'}
+
+        self.create_tables()
+        sess = Session()
+
+        b1 = BaseClass(name='b1')
+        sc = SubClass(name='s1', subname='sc1')
+        
+        sess.add_all([b1, sc])
+        
+        sess.commit()
+        
+        b1.name='b1modified'
+
+        BaseClassHistory = BaseClass.__history_mapper__.class_
+        SubClassHistory = SubClass.__history_mapper__.class_
+        
+        eq_(
+            sess.query(BaseClassHistory).order_by(BaseClassHistory.id, BaseClassHistory.version).all(),
+            [BaseClassHistory(id=1, name=u'b1', type=u'base', version=1)]
+        )
+        
+        sc.name ='s1modified'
+        b1.name='b1modified2'
+
+        eq_(
+            sess.query(BaseClassHistory).order_by(BaseClassHistory.id, BaseClassHistory.version).all(),
+            [
+                BaseClassHistory(id=1, name=u'b1', type=u'base', version=1),
+                BaseClassHistory(id=1, name=u'b1modified', type=u'base', version=2),
+                SubClassHistory(id=2, name=u's1', type=u'sub', version=1)
+            ]
+        )
+        
+