source: rattail/rattail/db/model/batch/purchase.py @ 3929ec9

Last change on this file since 3929ec9 was 3929ec9, checked in by Lance Edgar <lance@…>, 23 months ago

Add PurchaseBatch.order_quantities_known and is_truck_dump_parent() etc.

the latter being just for improved code readability. if order quantities are
known then some UI gets turned on to expose that info, otherwise not

  • Property mode set to 100644
File size: 11.8 KB
Line 
1# -*- coding: utf-8; -*-
2################################################################################
3#
4#  Rattail -- Retail Software Framework
5#  Copyright © 2010-2018 Lance Edgar
6#
7#  This file is part of Rattail.
8#
9#  Rattail is free software: you can redistribute it and/or modify it under the
10#  terms of the GNU General Public License as published by the Free Software
11#  Foundation, either version 3 of the License, or (at your option) any later
12#  version.
13#
14#  Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
15#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16#  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
17#  details.
18#
19#  You should have received a copy of the GNU General Public License along with
20#  Rattail.  If not, see <http://www.gnu.org/licenses/>.
21#
22################################################################################
23"""
24Models for purchase order batches
25"""
26
27from __future__ import unicode_literals, absolute_import
28
29import six
30import sqlalchemy as sa
31from sqlalchemy import orm
32from sqlalchemy.ext.declarative import declared_attr
33
34from rattail.db.model import (Base, uuid_column, BatchMixin, BatchRowMixin,
35                              PurchaseBase, PurchaseItemBase, PurchaseCreditBase,
36                              Purchase, PurchaseItem)
37from rattail.db.model.batch import filename_column
38from rattail.util import pretty_quantity
39
40
41class PurchaseBatch(BatchMixin, PurchaseBase, Base):
42    """
43    Hopefully generic batch used for entering new purchases into the system, etc.?
44    """
45    batch_key = 'purchase'
46    __tablename__ = 'purchase_batch'
47    __batchrow_class__ = 'PurchaseBatchRow'
48    model_title = "Purchasing Batch"
49    model_title_plural = "Purchasing Batches"
50
51    @declared_attr
52    def __table_args__(cls):
53        return cls.__batch_table_args__() + cls.__purchase_table_args__() + (
54            sa.ForeignKeyConstraint(['purchase_uuid'], ['purchase.uuid'], name='purchase_batch_fk_purchase'),
55            sa.ForeignKeyConstraint(['truck_dump_batch_uuid'], ['purchase_batch.uuid'], name='purchase_batch_fk_truck_dump_batch', use_alter=True),
56        )
57
58    STATUS_OK                   = 1
59    STATUS_UNKNOWN_PRODUCT      = 2
60    STATUS_TRUCKDUMP_UNCLAIMED  = 3
61    STATUS_TRUCKDUMP_CLAIMED    = 4
62
63    STATUS = {
64        STATUS_OK                       : "ok",
65        STATUS_UNKNOWN_PRODUCT          : "has unknown product(s)",
66        STATUS_TRUCKDUMP_UNCLAIMED      : "not yet fully claimed",
67        STATUS_TRUCKDUMP_CLAIMED        : "fully claimed by child(ren)",
68    }
69
70    purchase_uuid = sa.Column(sa.String(length=32), nullable=True)
71
72    purchase = orm.relationship(
73        Purchase,
74        doc="""
75        Reference to the purchase with which the batch is associated.  May be
76        null, e.g. in the case of a "new purchase" batch.
77        """,
78        backref=orm.backref(
79            'batches',
80            order_by='PurchaseBatch.id',
81            doc="""
82            List of batches associated with the purchase.
83            """))
84
85    mode = sa.Column(sa.Integer(), nullable=False, doc="""
86    Numeric "mode" for the purchase batch, to indicate new/receiving etc.
87    """)
88
89    invoice_file = filename_column(doc="Base name for the associated invoice file, if any.")
90
91    invoice_parser_key = sa.Column(sa.String(length=100), nullable=True, doc="""
92    The key of the parser used to read the contents of the invoice file.
93    """)
94
95    order_quantities_known = sa.Column(sa.Boolean(), nullable=True, doc="""
96    Flag indicating whether the order quantities were known at time of batch
97    creation / population.  Really this is only used for batches of 'receiving'
98    mode, to present a slightly different UI if order quantities were (not) known.
99    """)
100
101    truck_dump = sa.Column(sa.Boolean(), nullable=True, default=False, doc="""
102    Flag indicating whether a "receiving" batch is of the "truck dump"
103    persuasion, i.e.  it does not correspond to a single purchase order but
104    rather is assumed to represent multiple orders.
105    """)
106
107    truck_dump_batch_uuid = sa.Column(sa.String(length=32), nullable=True)
108    truck_dump_batch = orm.relationship(
109        'PurchaseBatch',
110        remote_side='PurchaseBatch.uuid',
111        doc="""
112        Reference to the "truck dump" receiving batch, for which the current
113        batch represents a single invoice which partially "consumes" the truck
114        dump.
115        """,
116        backref=orm.backref(
117            'truck_dump_children',
118            order_by='PurchaseBatch.id',
119            doc="""
120            List of batches which are "children" of the current batch, which is
121            assumed to be a truck dump.
122            """))
123
124    def is_truck_dump_parent(self):
125        """
126        Returns boolean indicating whether or not the batch is a "truck dump"
127        parent.
128        """
129        if self.truck_dump:
130            return True
131        return False
132
133    def is_truck_dump_child(self):
134        """
135        Returns boolean indicating whether or not the batch is a "truck dump"
136        child.
137        """
138        if self.truck_dump_batch:
139            return True
140        return False
141
142    def is_truck_dump_related(self):
143        """
144        Returns boolean indicating whether or not the batch is associated with
145        a "truck dump" in any way, i.e. is a parent or child of such.
146        """
147        if self.is_truck_dump_parent():
148            return True
149        if self.is_truck_dump_child():
150            return True
151        return False
152
153
154class PurchaseBatchRow(BatchRowMixin, PurchaseItemBase, Base):
155    """
156    Row of data within a purchase batch.
157    """
158    __tablename__ = 'purchase_batch_row'
159    __batch_class__ = PurchaseBatch
160
161    @declared_attr
162    def __table_args__(cls):
163        return cls.__batchrow_table_args__() + cls.__purchaseitem_table_args__() + (
164            sa.ForeignKeyConstraint(['item_uuid'], ['purchase_item.uuid'], name='purchase_batch_row_fk_item'),
165        )
166
167    STATUS_OK                           = 1
168    STATUS_PRODUCT_NOT_FOUND            = 2
169    STATUS_COST_NOT_FOUND               = 3
170    STATUS_CASE_QUANTITY_UNKNOWN        = 4
171    STATUS_INCOMPLETE                   = 5
172    STATUS_ORDERED_RECEIVED_DIFFER      = 6
173    STATUS_TRUCKDUMP_UNCLAIMED          = 7
174    STATUS_TRUCKDUMP_CLAIMED            = 8
175    STATUS_TRUCKDUMP_OVERCLAIMED        = 9
176    STATUS_CASE_QUANTITY_DIFFERS        = 10
177
178    STATUS = {
179        STATUS_OK                       : "ok",
180        STATUS_PRODUCT_NOT_FOUND        : "product not found",
181        STATUS_COST_NOT_FOUND           : "product found but not cost",
182        STATUS_CASE_QUANTITY_UNKNOWN    : "case quantity not known",
183        STATUS_CASE_QUANTITY_DIFFERS    : "case quantity differs",
184        STATUS_INCOMPLETE               : "incomplete",
185        STATUS_ORDERED_RECEIVED_DIFFER  : "ordered / received differ",
186        STATUS_TRUCKDUMP_UNCLAIMED      : "not yet fully claimed",
187        STATUS_TRUCKDUMP_CLAIMED        : "fully claimed by child(ren)",
188        STATUS_TRUCKDUMP_OVERCLAIMED    : "OVER claimed by child(ren)",
189    }
190
191    item_uuid = sa.Column(sa.String(length=32), nullable=True)
192
193    item = orm.relationship(
194        PurchaseItem,
195        doc="""
196        Reference to the purchase item with which the batch row is associated.
197        May be null, e.g. in the case of a "new purchase" batch.
198        """)
199
200
201class PurchaseBatchRowClaim(Base):
202    """
203    Represents the connection between a row(s) from a truck dump batch, and the
204    corresponding "child" batch row which claims it, as well as the claimed
205    quantities etc.
206    """
207    __tablename__ = 'purchase_batch_row_claim'
208    __table_args__ = (
209        sa.ForeignKeyConstraint(['claiming_row_uuid'], ['purchase_batch_row.uuid'], name='purchase_batch_row_claim_fk_claiming_row'),
210        sa.ForeignKeyConstraint(['claimed_row_uuid'], ['purchase_batch_row.uuid'], name='purchase_batch_row_claim_fk_claimed_row'),
211    )
212
213    uuid = uuid_column()
214
215    claiming_row_uuid = sa.Column(sa.String(length=32), nullable=False)
216    claiming_row = orm.relationship(
217        PurchaseBatchRow,
218        foreign_keys='PurchaseBatchRowClaim.claiming_row_uuid',
219        doc="""
220        Reference to the "child" row which is claiming some row from a truck
221        dump batch.
222        """,
223        backref=orm.backref(
224            'truck_dump_claims',
225            cascade='all, delete-orphan',
226            doc="""
227            List of claims which this "child" row makes against rows within a
228            truck dump batch.
229            """))
230
231    claimed_row_uuid = sa.Column(sa.String(length=32), nullable=False)
232    claimed_row = orm.relationship(
233        PurchaseBatchRow,
234        foreign_keys='PurchaseBatchRowClaim.claimed_row_uuid',
235        doc="""
236        Reference to the truck dump batch row which is claimed by the "child" row.
237        """,
238        backref=orm.backref(
239            'claims',
240            # cascade='all, delete-orphan',
241            doc="""
242            List of claims made by "child" rows against this truck dump batch row.
243            """))
244
245    cases_received = sa.Column(sa.Numeric(precision=10, scale=4), nullable=True, doc="""
246    Number of cases of product which were ultimately received, and are involved in the claim.
247    """)
248
249    units_received = sa.Column(sa.Numeric(precision=10, scale=4), nullable=True, doc="""
250    Number of units of product which were ultimately received, and are involved in the claim.
251    """)
252
253    cases_damaged = sa.Column(sa.Numeric(precision=10, scale=4), nullable=True, doc="""
254    Number of cases of product which were shipped damaged, and are involved in the claim.
255    """)
256
257    units_damaged = sa.Column(sa.Numeric(precision=10, scale=4), nullable=True, doc="""
258    Number of units of product which were shipped damaged, and are involved in the claim.
259    """)
260
261    cases_expired = sa.Column(sa.Numeric(precision=10, scale=4), nullable=True, doc="""
262    Number of cases of product which were shipped expired, and are involved in the claim.
263    """)
264
265    units_expired = sa.Column(sa.Numeric(precision=10, scale=4), nullable=True, doc="""
266    Number of units of product which were shipped expired, and are involved in the claim.
267    """)
268
269
270@six.python_2_unicode_compatible
271class PurchaseBatchCredit(PurchaseCreditBase, Base):
272    """
273    Represents a working copy of purchase credit tied to a batch row.
274    """
275    __tablename__ = 'purchase_batch_credit'
276
277    @declared_attr
278    def __table_args__(cls):
279        return cls.__purchasecredit_table_args__() + (
280            sa.ForeignKeyConstraint(['row_uuid'], ['purchase_batch_row.uuid'], name='purchase_batch_credit_fk_row'),
281        )
282
283    uuid = uuid_column()
284
285    row_uuid = sa.Column(sa.String(length=32), nullable=True)
286
287    row = orm.relationship(
288        PurchaseBatchRow,
289        doc="""
290        Reference to the batch row with which the credit is associated.
291        """,
292        backref=orm.backref(
293            'credits',
294            doc="""
295            List of :class:`PurchaseBatchCredit` instances for the row.
296            """))
297
298    def __str__(self):
299        if self.cases_shorted is not None and self.units_shorted is not None:
300            qty = "{} cases, {} units".format(
301                pretty_quantity(self.cases_shorted),
302                pretty_quantity(self.units_shorted))
303        elif self.cases_shorted is not None:
304            qty = "{} cases".format(pretty_quantity(self.cases_shorted))
305        elif self.units_shorted is not None:
306            qty = "{} units".format(pretty_quantity(self.units_shorted))
307        else:
308            qty = "??"
309        qty += " {}".format(self.credit_type)
310        if self.credit_type == 'expired' and self.expiration_date:
311            qty += " ({})".format(self.expiration_date)
312        if self.credit_type == 'mispick' and self.mispick_product:
313            qty += " ({})".format(self.mispick_product)
314        if self.invoice_total:
315            return "{} = ${:0.2f}".format(qty, self.invoice_total)
316        return qty
Note: See TracBrowser for help on using the repository browser.