tailbone/tailbone/views/reports.py
2017-12-06 13:50:02 -06:00

256 lines
8.1 KiB
Python

# -*- coding: utf-8; -*-
################################################################################
#
# Rattail -- Retail Software Framework
# Copyright © 2010-2017 Lance Edgar
#
# This file is part of Rattail.
#
# Rattail is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# Rattail. If not, see <http://www.gnu.org/licenses/>.
#
################################################################################
"""
Reporting views
"""
from __future__ import unicode_literals, absolute_import
import re
import rattail
from rattail.db import model
from rattail.files import resource_path
from rattail.time import localtime
from mako.template import Template
from pyramid.response import Response
from tailbone.db import Session
from tailbone.views import View
from tailbone.views.exports import ExportMasterView
plu_upc_pattern = re.compile(r'^000000000(\d{5})$')
weighted_upc_pattern = re.compile(r'^002(\d{5})00000\d$')
def get_upc(product):
"""
UPC formatter. Strips PLUs to bare number, and adds "minus check digit"
for non-PLU UPCs.
"""
upc = unicode(product.upc)
m = plu_upc_pattern.match(upc)
if m:
return unicode(int(m.group(1)))
m = weighted_upc_pattern.match(upc)
if m:
return unicode(int(m.group(1)))
return '{0}-{1}'.format(upc[:-1], upc[-1])
class OrderingWorksheet(View):
"""
This is the "Ordering Worksheet" report.
"""
report_template_path = 'tailbone:reports/ordering_worksheet.mako'
upc_getter = staticmethod(get_upc)
def __call__(self):
if self.request.params.get('vendor'):
vendor = Session.query(model.Vendor).get(self.request.params['vendor'])
if vendor:
departments = []
uuids = self.request.params.get('departments')
if uuids:
for uuid in uuids.split(','):
dept = Session.query(model.Department).get(uuid)
if dept:
departments.append(dept)
preferred_only = self.request.params.get('preferred_only') == '1'
body = self.write_report(vendor, departments, preferred_only)
response = Response(content_type='text/html')
response.headers['Content-Length'] = len(body)
response.headers['Content-Disposition'] = 'attachment; filename=ordering.html'
response.text = body
return response
return {}
def write_report(self, vendor, departments, preferred_only):
"""
Rendering engine for the ordering worksheet report.
"""
q = Session.query(model.ProductCost)
q = q.join(model.Product)
q = q.filter(model.Product.deleted == False)
q = q.filter(model.ProductCost.vendor == vendor)
q = q.filter(model.Product.department_uuid.in_([x.uuid for x in departments]))
if preferred_only:
q = q.filter(model.ProductCost.preference == 1)
costs = {}
for cost in q:
dept = cost.product.department
subdept = cost.product.subdepartment
costs.setdefault(dept, {})
costs[dept].setdefault(subdept, [])
costs[dept][subdept].append(cost)
def cost_sort_key(cost):
product = cost.product
brand = product.brand.name if product.brand else ''
key = '{0} {1}'.format(brand, product.description)
return key
now = localtime(self.request.rattail_config)
data = dict(
vendor=vendor,
costs=costs,
cost_sort_key=cost_sort_key,
date=now.strftime('%a %d %b %Y'),
time=now.strftime('%I:%M %p'),
get_upc=self.upc_getter,
rattail=rattail,
)
template_path = resource_path(self.report_template_path)
template = Template(filename=template_path)
return template.render(**data)
class InventoryWorksheet(View):
"""
This is the "Inventory Worksheet" report.
"""
report_template_path = 'tailbone:reports/inventory_worksheet.mako'
upc_getter = staticmethod(get_upc)
def __call__(self):
"""
This is the "Inventory Worksheet" report.
"""
departments = Session.query(model.Department)
if self.request.params.get('department'):
department = departments.get(self.request.params['department'])
if department:
body = self.write_report(department)
response = Response(content_type=b'text/html')
response.headers[b'Content-Length'] = len(body)
response.headers[b'Content-Disposition'] = b'attachment; filename=inventory.html'
response.text = body
return response
departments = departments.order_by(model.Department.name)
departments = departments.all()
return{'departments': departments}
def write_report(self, department):
"""
Generates the Inventory Worksheet report.
"""
def get_products(subdepartment):
q = Session.query(model.Product)
q = q.outerjoin(model.Brand)
q = q.filter(model.Product.deleted == False)
q = q.filter(model.Product.subdepartment == subdepartment)
if self.request.params.get('weighted-only'):
q = q.filter(model.Product.weighed == True)
if self.request.params.get('exclude-not-for-sale'):
q = q.filter(model.Product.not_for_sale == False)
q = q.order_by(model.Brand.name, model.Product.description)
return q.all()
now = localtime(self.request.rattail_config)
data = dict(
date=now.strftime('%a %d %b %Y'),
time=now.strftime('%I:%M %p'),
department=department,
get_products=get_products,
get_upc=self.upc_getter,
)
template_path = resource_path(self.report_template_path)
template = Template(filename=template_path)
return template.render(**data)
class ReportOutputView(ExportMasterView):
"""
Master view for report output
"""
model_class = model.ReportOutput
route_prefix = 'report_output'
url_prefix = '/reports/generated'
downloadable = True
grid_columns = [
'id',
'report_name',
'filename',
'created',
'created_by',
]
form_fields = [
'id',
'report_name',
'filename',
'created',
'created_by',
]
def configure_grid(self, g):
super(ReportOutputView, self).configure_grid(g)
g.set_link('filename')
def configure_form(self, f):
super(ReportOutputView, self).configure_form(f)
if self.viewing:
f.set_renderer('filename', self.render_download)
def render_download(self, report, field):
path = report.filepath(self.rattail_config)
url = self.get_action_url('download', report)
return self.render_file_field(path, url=url)
def download(self):
report = self.get_instance()
path = report.filepath(self.rattail_config)
return self.file_response(path)
def add_routes(config):
config.add_route('reports.ordering', '/reports/ordering')
config.add_route('reports.inventory', '/reports/inventory')
def includeme(config):
add_routes(config)
config.add_view(OrderingWorksheet, route_name='reports.ordering',
renderer='/reports/ordering.mako')
config.add_view(InventoryWorksheet, route_name='reports.inventory',
renderer='/reports/inventory.mako')
ReportOutputView.defaults(config)