1 """The application's model objects"""
2 import sqlalchemy as sa
3 from sqlalchemy import orm
5 from bluechips.model.user import User
6 from bluechips.model.expenditure import Expenditure
7 from bluechips.model.split import Split
8 from bluechips.model.subitem import Subitem
9 from bluechips.model.transfer import Transfer
10 from bluechips.model.tag import Tag
12 from bluechips.model import meta
13 from bluechips.model import types
15 from datetime import datetime
17 def init_model(engine):
18 """Call me before using any of the tables or classes in the model"""
20 sm = orm.sessionmaker(autoflush=True, bind=engine)
23 meta.Session = orm.scoped_session(sm)
25 ### Database Schemas ###
27 users = sa.Table('users', meta.metadata,
28 sa.Column('id', sa.types.Integer, primary_key=True),
29 sa.Column('username', sa.types.Unicode(32), nullable=False),
30 sa.Column('name', sa.types.Unicode(64)),
31 sa.Column('resident', sa.types.Boolean, default=True),
32 sa.Column('email', sa.types.Unicode(64)),
33 sa.Column('password', sa.types.Unicode(64)),
36 expenditures = sa.Table('expenditures', meta.metadata,
37 sa.Column('id', sa.types.Integer, primary_key=True),
38 sa.Column('spender_id', sa.types.Integer,
39 sa.ForeignKey('users.id'), nullable=False),
40 sa.Column('amount', types.DBCurrency, nullable=False),
41 sa.Column('description', sa.types.Text),
42 sa.Column('date', sa.types.Date, default=datetime.now),
43 sa.Column('entered_time', sa.types.DateTime,
44 default=datetime.utcnow)
47 splits = sa.Table('splits', meta.metadata,
48 sa.Column('id', sa.types.Integer, primary_key=True),
49 sa.Column('expenditure_id', sa.types.Integer,
50 sa.ForeignKey('expenditures.id'), nullable=False),
51 sa.Column('user_id', sa.types.Integer,
52 sa.ForeignKey('users.id'), nullable=False),
53 sa.Column('share_text', sa.Text, nullable=False),
54 sa.Column('share', types.DBCurrency, nullable=False)
57 tags = sa.Table('tags', meta.metadata,
58 sa.Column('id', sa.types.Integer, primary_key=True),
59 sa.Column('expenditure_id', sa.types.Integer,
60 sa.ForeignKey('expenditures.id'), nullable=False),
61 sa.Column('tag', sa.Text, nullable=False))
64 subitems = sa.Table('subitems', meta.metadata,
65 sa.Column('id', sa.types.Integer, primary_key=True),
66 sa.Column('expenditure_id', sa.types.Integer,
67 sa.ForeignKey('expenditures.id'), nullable=False),
68 sa.Column('user_id', sa.types.Integer,
69 sa.ForeignKey('users.id'), nullable=False),
70 sa.Column('amount', types.DBCurrency, nullable=False)
73 transfers = sa.Table('transfers', meta.metadata,
74 sa.Column('id', sa.types.Integer, primary_key=True),
75 sa.Column('debtor_id', sa.types.Integer,
76 sa.ForeignKey('users.id'), nullable=False),
77 sa.Column('creditor_id', sa.types.Integer,
78 sa.ForeignKey('users.id'), nullable=False),
79 sa.Column('amount', types.DBCurrency, nullable=False),
80 sa.Column('description', sa.Text, default=None),
81 sa.Column('date', sa.types.Date, default=datetime.now),
82 sa.Column('entered_time', sa.types.DateTime,
83 default=datetime.utcnow)
86 ### DB/Class Mapping ###
88 orm.mapper(User, users,
90 'expenditures': orm.relation(Expenditure,
94 orm.mapper(Expenditure, expenditures,
95 order_by=[expenditures.c.date.desc(), expenditures.c.entered_time.desc()],
97 'splits': orm.relation(Split, backref='expenditure',
98 cascade='all, delete'),
99 'tags': orm.relation(Tag, backref='expenditure',
100 cascade='all, delete'),
101 'subitems': orm.relation(Subitem, backref='expenditure',
102 cascade='all, delete')
105 orm.mapper(Split, splits, properties={
106 'user': orm.relation(User)
109 orm.mapper(Tag, tags)
111 orm.mapper(Subitem, subitems, properties={
112 'user': orm.relation(User)
115 orm.mapper(Transfer, transfers,
116 order_by=[transfers.c.date.desc(), transfers.c.entered_time.desc()],
118 'debtor': orm.relation(User,
119 primaryjoin=(transfers.c.debtor_id==\
121 'creditor': orm.relation(User,
122 primaryjoin=(transfers.c.creditor_id==\
126 __all__ = ['users', 'expenditures', 'splits', 'tags', 'subitems', 'transfers',
127 'User', 'Expenditure', 'Split', 'Tag', 'Subitem', 'Transfer',