Pay Periods - Query Methods / Properties

[jantman]

To enable the rest of the PayPeriod-related issues ( #34 #35 #36 #37 ), the PayPeriod object should have the following methods which take a db_session (a sqlalchemy.orm.scoping.scoped_session or a sqlalchemy.orm.session.Session) and return a sqlalchemy.orm.query.Query (we assume that in most cases we'll just be calling .all() on this Query, but we should return the Query itself for flexibility):

• All active scheduled transactions for the period
• All actual transactions for the period

And the following methods which take a db_session and return a dict or object to be used by something downstream:

• each active recurring budget, along with the budget amount, allocated amount (amount of scheduled transactions or actual transactions this period), the spent amount and the remaining amount.
• Total allocated (budgets plus transactions), total spent, total remaining
• All transactions for the period; this should combine ScheduledTransactions and Transactions into one list, ordered by date, and return them as either objects or dicts in a common format so they can be displayed in one table. This is not going to be a DataTable, or at least is not going to be searchable/filterable/orderable; it will be a fixed representation.
  • Acceptance test for BiweeklyPayPeriod._dict_for_sched_trans() - set a budget start date at the beginning of the second week of a month, so we have a block of 3 consecutive pay periods, the first and last of which span month changes and the middle of which does not. Generate ~56 Monthly ScheduledTransactions on consecutive days, so we have transactions for at least one week on either side of the block of 3 consecutive pay periods. Ensure that each of the 3 pay periods contain the right transactions in the right order.
• Need to exempt any ScheduledTransactions that have been converted to Transactions
• How to handle scheduled income? See comment below

Also:

• Given that a lot of the above use the same queries, we should explicitly cache the query results in the object.
• For testing PayPeriod-related things (acceptance tests), biweeklybudget.settings_example.PAY_PERIOD_START_DATE should be set to the closest Friday to the current date.

[jantman]

Might be a good idea to split this up into some smaller issues...

[jantman]

Split out most of this into: #34 #35 #36 #37

[jantman]

See #40 about income budgets. Need to update b164614 with that once finished.