rattail/tailbone
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Refactor "receive row" and "declare credit" tools per buefy theme

Browse source
This commit is contained in:
Lance Edgar 2021-12-08 19:44:50 -06:00
parent ae76ceea04
commit 10e34b83ed
10 changed files with 313 additions and 89 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
tailbone/api/batch/receiving.py
View file

@ -118,11 +118,7 @@ class ReceivingBatchViews(APIBatchView):
return {'purchases': purchases}
def normalize_eligible_purchase(self, purchase):
return {
'key': purchase.uuid,
'department_uuid': purchase.department_uuid,
'display': self.render_eligible_purchase(purchase),
}
return self.handler.normalize_eligible_purchase(purchase)
def render_eligible_purchase(self, purchase):
return self.handler.render_eligible_purchase(purchase)

24
tailbone/forms/core.py
View file

@ -343,8 +343,9 @@ class Form(object):
model_instance=None, model_class=None, appstruct=UNSPECIFIED, nodes={}, enums={}, labels={},
assume_local_times=False, renderers=None,
hidden={}, widgets={}, defaults={}, validators={}, required={}, helptext={}, focus_spec=None,
action_url=None, cancel_url=None, use_buefy=None, component='tailbone-form'):
action_url=None, cancel_url=None, use_buefy=None, component='tailbone-form',
vuejs_field_converters={},
):
self.fields = None
if fields is not None:
self.set_fields(fields)
@ -380,6 +381,7 @@ class Form(object):
self.cancel_url = cancel_url
self.use_buefy = use_buefy
self.component = component
self.vuejs_field_converters = vuejs_field_converters or {}
@property
def component_studly(self):
@ -702,6 +704,9 @@ class Form(object):
"""
return self.helptext[key]
def set_vuejs_field_converter(self, field, converter):
self.vuejs_field_converters[field] = converter
def render(self, template=None, **kwargs):
if not template:
if self.readonly and not self.use_buefy:
@ -788,6 +793,11 @@ class Form(object):
model value for the given field. This JS will be written as part of
the overall response, to be interpreted on the client side.
"""
if field.name in self.vuejs_field_converters:
convert = self.vuejs_field_converters[field.name]
value = convert(field.cstruct)
return json.dumps(value)
if isinstance(field.schema.typ, deform.FileData):
# TODO: we used to always/only return 'null' here but hopefully
# this also works, to show existing filename when present
@ -807,6 +817,16 @@ class Form(object):
except Exception as error:
raise TailboneJSONFieldError(field.name, error)
def get_error_messages(self, field):
if field.error:
return field.error.messages()
error = self.make_deform_form().error
if error:
if isinstance(error, colander.Invalid):
if error.node.name == field.name:
return error.messages()
def messages_json(self, messages):
dump = json.dumps(messages)
dump = dump.replace("'", ''')

71
tailbone/templates/deform/cases_units.pt
View file

@ -1,29 +1,58 @@
<!--! -*- mode: html; -*- -->
<div tal:define="oid oid|field.oid;
name name|field.name;
css_class css_class|field.widget.css_class;
style style|field.widget.style;"
style style|field.widget.style;
use_buefy use_buefy|0;"
i18n:domain="deform"
tal:omit-tag="">
${field.start_mapping()}
<div>
<input type="text" name="cases" value="${cases}"
tal:attributes="style style;
class string: form-control ${css_class or ''};
cases_attributes|field.widget.cases_attributes|{};"
placeholder="cases"
autocomplete="off"
id="${oid}-cases"/>
Cases
<div tal:condition="not use_buefy" tal:omit-tag="">
${field.start_mapping()}
<div>
<input type="text" name="cases" value="${cases}"
tal:attributes="style style;
class string: form-control ${css_class or ''};
cases_attributes|field.widget.cases_attributes|{};"
placeholder="cases"
autocomplete="off"
id="${oid}-cases"/>
Cases
</div>
<div>
<input type="text" name="units" value="${units}"
tal:attributes="class string: form-control ${css_class or ''};
style style;
units_attributes|field.widget.units_attributes|{};"
placeholder="units"
autocomplete="off"
id="${oid}-units"/>
Units
</div>
${field.end_mapping()}
</div>
<div>
<input type="text" name="units" value="${units}"
tal:attributes="class string: form-control ${css_class or ''};
style style;
units_attributes|field.widget.units_attributes|{};"
placeholder="units"
autocomplete="off"
id="${oid}-units"/>
Units
<div tal:condition="use_buefy"
tal:define="vmodel vmodel|'field_model_' + name;"
tal:omit-tag="">
${field.start_mapping()}
<b-field label="Cases">
<b-input name="cases" autocomplete="off"
tal:attributes="v-model string: ${vmodel + '.cases'};
cases_attributes|field.widget.cases_attributes|{};">
</b-input>
</b-field>
<b-field label="Units">
<b-input name="units" autocomplete="off"
tal:attributes="v-model string: ${vmodel + '.units'};
units_attributes|field.widget.units_attributes|{};">
</b-input>
</b-field>
${field.end_mapping()}
</div>
${field.end_mapping()}
</div>

54
tailbone/templates/forms/deform_buefy.mako
View file

@ -1,4 +1,5 @@
## -*- coding: utf-8; -*-
<%namespace file="/forms/util.mako" import="render_buefy_field" />
<script type="text/x-template" id="${form.component}-template">
@ -9,6 +10,9 @@
% endif
<section>
% if form_body is not Undefined and form_body:
${form_body|n}
% else:
% for field in form.fields:
% if form.readonly or (field not in dform and field in form.readonly_fields):
<b-field horizontal
@ -17,29 +21,11 @@
</b-field>
% elif field in dform:
<% field = dform[field] %>
% if form.field_visible(field.name):
<b-field horizontal
label="${form.get_label(field.name)}"
## TODO: is this class="file" really needed?
% if isinstance(field.schema.typ, deform.FileData):
class="file"
% endif
% if field.error:
type="is-danger"
:message='${form.messages_json(field.error.messages())|n}'
% endif
>
${field.serialize(use_buefy=True)|n}
</b-field>
% else:
## hidden field
${field.serialize()|n}
% endif
${render_buefy_field(dform[field])}
% endif
% endfor
% endif
</section>
% if buttons:
@ -48,6 +34,20 @@
% elif not form.readonly and (buttons is Undefined or (buttons is not None and buttons is not False)):
<br />
<div class="buttons">
% if getattr(form, 'show_cancel', True):
% if form.auto_disable_cancel:
<once-button tag="a" href="${form.cancel_url or request.get_referrer()}"
text="Cancel">
</once-button>
% else:
<b-button tag="a" href="${form.cancel_url or request.get_referrer()}">
Cancel
</b-button>
% endif
% endif
% if getattr(form, 'show_reset', False):
<input type="reset" value="Reset" class="button" />
% endif
## TODO: deprecate / remove the latter option here
% if form.auto_disable_save or form.auto_disable:
<b-button type="is-primary"
@ -61,20 +61,6 @@
${getattr(form, 'submit_label', getattr(form, 'save_label', "Submit"))}
</b-button>
% endif
% if getattr(form, 'show_reset', False):
<input type="reset" value="Reset" class="button" />
% endif
% if getattr(form, 'show_cancel', True):
% if form.auto_disable_cancel:
<once-button tag="a" href="${form.cancel_url or request.get_referrer()}"
text="Cancel">
</once-button>
% else:
<b-button tag="a" href="${form.cancel_url or request.get_referrer()}">
Cancel
</b-button>
% endif
% endif
</div>
% endif

24
tailbone/templates/forms/util.mako Normal file
View file

@ -0,0 +1,24 @@
## -*- coding: utf-8; -*-
<%def name="render_buefy_field(field, bfield_kwargs={})">
% if form.field_visible(field.name):
<% error_messages = form.get_error_messages(field) %>
<b-field horizontal
label="${form.get_label(field.name)}"
## TODO: is this class="file" really needed?
% if isinstance(field.schema.typ, deform.FileData):
class="file"
% endif
% if error_messages:
type="is-danger"
:message='${form.messages_json(error_messages)|n}'
% endif
${h.HTML.render_attrs(bfield_kwargs)}
>
${field.serialize(use_buefy=True)|n}
</b-field>
% else:
## hidden field
${field.serialize()|n}
% endif
</%def>

60
tailbone/templates/receiving/declare_credit.mako
View file

@ -1,16 +1,19 @@
## -*- coding: utf-8; -*-
<%inherit file="/base.mako" />
<%inherit file="/form.mako" />
<%namespace file="/forms/util.mako" import="render_buefy_field" />
<%def name="title()">Declare Credit for Row #${row.sequence}</%def>
<%def name="context_menu_items()">
% if master.rows_viewable and request.has_perm('{}.view'.format(permission_prefix)):
${parent.context_menu_items()}
% if master.rows_viewable and master.has_perm('view'):
<li>${h.link_to("View this {}".format(row_model_title), row_action_url('view', row))}</li>
% endif
</%def>
<%def name="extra_javascript()">
${parent.extra_javascript()}
% if not use_buefy:
<script type="text/javascript">
function toggleFields(creditType) {
@ -34,11 +37,49 @@
});
</script>
% endif
</%def>
<div style="display: flex; justify-content: space-between;">
<%def name="render_buefy_form()">
<div class="form-wrapper">
<p class="block">
Please select the "state" of the product, and enter the
appropriate quantity.
</p>
<p class="block">
Note that this tool will
<span class="has-text-weight-bold">deduct</span> from the
"received" quantity, and
<span class="has-text-weight-bold">add</span> to the
corresponding credit quantity.
</p>
<p class="block">
Please see ${h.link_to("Receive Row", url('{}.receive_row'.format(route_prefix), uuid=batch.uuid, row_uuid=row.uuid))}
if you need to "receive" instead of "convert" the product.
</p>
${parent.render_buefy_form()}
</%def>
<%def name="buefy_form_body()">
${render_buefy_field(dform['credit_type'])}
${render_buefy_field(dform['quantity'])}
${render_buefy_field(dform['expiration_date'], bfield_kwargs={'v-show': "field_model_credit_type == 'expired'"})}
</%def>
<%def name="render_form()">
% if use_buefy:
${form.render_deform(buttons=capture(self.render_form_buttons), form_body=capture(self.buefy_form_body))|n}
% else:
<p style="padding: 1em;">
Please select the "state" of the product, and enter the appropriate
@ -55,11 +96,10 @@
if you need to "receive" instead of "convert" the product.
</p>
${form.render()|n}
</div><!-- form-wrapper -->
${parent.render_form()}
<ul id="context-menu">
${self.context_menu_items()}
</ul>
% endif
</%def>
</div>
${parent.body()}

57
tailbone/templates/receiving/receive_row.mako
View file

@ -1,16 +1,19 @@
## -*- coding: utf-8; -*-
<%inherit file="/base.mako" />
<%inherit file="/form.mako" />
<%namespace file="/forms/util.mako" import="render_buefy_field" />
<%def name="title()">Receive for Row #${row.sequence}</%def>
<%def name="context_menu_items()">
% if master.rows_viewable and request.has_perm('{}.view'.format(permission_prefix)):
${parent.context_menu_items()}
% if master.rows_viewable and master.has_perm('view'):
<li>${h.link_to("View this {}".format(row_model_title), row_action_url('view', row))}</li>
% endif
</%def>
<%def name="extra_javascript()">
${parent.extra_javascript()}
% if not use_buefy:
<script type="text/javascript">
function toggleFields(mode) {
@ -34,11 +37,46 @@
});
</script>
% endif
</%def>
<div style="display: flex; justify-content: space-between;">
<%def name="render_buefy_form()">
<div class="form-wrapper">
<p class="block">
Please select the "state" of the product, and enter the appropriate
quantity.
</p>
<p class="block">
Note that this tool will <span class="has-text-weight-bold">add</span>
the corresponding quantities for the row.
</p>
<p class="block">
Please see ${h.link_to("Declare Credit", url('{}.declare_credit'.format(route_prefix), uuid=batch.uuid, row_uuid=row.uuid))}
if you need to "convert" some already-received amount, into a credit.
</p>
${parent.render_buefy_form()}
</%def>
<%def name="buefy_form_body()">
${render_buefy_field(dform['mode'])}
${render_buefy_field(dform['quantity'])}
${render_buefy_field(dform['expiration_date'], bfield_kwargs={'v-show': "field_model_mode == 'expired'"})}
</%def>
<%def name="render_form()">
% if use_buefy:
${form.render_deform(buttons=capture(self.render_form_buttons), form_body=capture(self.buefy_form_body))|n}
% else:
<p style="padding: 1em;">
Please select the "state" of the product, and enter the appropriate
@ -55,11 +93,10 @@
if you need to "convert" some already-received amount, into a credit.
</p>
${form.render()|n}
</div><!-- form-wrapper -->
${parent.render_form()}
<ul id="context-menu">
${self.context_menu_items()}
</ul>
% endif
</%def>
</div>
${parent.body()}

11
tailbone/templates/receiving/view_row.mako
View file

@ -8,8 +8,19 @@
<h3>Receiving Tools</h3>
<div class="object-helper-content">
<div style="white-space: nowrap;">
% if use_buefy:
<once-button type="is-primary"
tag="a" href="${url('{}.receive_row'.format(route_prefix), uuid=batch.uuid, row_uuid=row.uuid)}"
text="Receive Product">
</once-button>
<once-button type="is-primary"
tag="a" href="${url('{}.declare_credit'.format(route_prefix), uuid=batch.uuid, row_uuid=row.uuid)}"
text="Declare Credit">
</once-button>
% else:
${h.link_to("Receive Product", url('{}.receive_row'.format(route_prefix), uuid=batch.uuid, row_uuid=row.uuid), class_='button autodisable')}
${h.link_to("Declare Credit", url('{}.declare_credit'.format(route_prefix), uuid=batch.uuid, row_uuid=row.uuid), class_='button autodisable')}
% endif
</div>
</div>
</div>

5
tailbone/views/purchasing/batch.py
View file

@ -637,6 +637,11 @@ class PurchasingBatchView(BatchMasterView):
g.set_label('catalog_unit_cost', "Catalog Cost")
g.filters['catalog_unit_cost'].label = "Catalog Unit Cost"
# po_unit_cost
g.set_renderer('po_unit_cost', self.render_row_grid_cost)
g.set_label('po_unit_cost', "PO Cost")
g.filters['po_unit_cost'].label = "PO Unit Cost"
# invoice_unit_cost
g.set_renderer('invoice_unit_cost', self.render_row_grid_cost)
g.set_label('invoice_unit_cost', "Invoice Cost")

90
tailbone/views/purchasing/receiving.py
View file

@ -144,6 +144,7 @@ class ReceivingBatchView(PurchasingBatchView):
'cases_received',
'units_received',
'catalog_unit_cost',
'po_unit_cost',
'invoice_unit_cost',
'invoice_total_calculated',
'credits',
@ -152,6 +153,7 @@ class ReceivingBatchView(PurchasingBatchView):
]
row_form_fields = [
'sequence',
'item_entry',
'upc',
'item_id',
@ -487,6 +489,14 @@ class ReceivingBatchView(PurchasingBatchView):
if self.creating:
f.remove('invoice_total_calculated')
# hide all invoice fields if batch does not have invoice file
if not self.creating and not self.handler.has_invoice_file(batch):
f.remove('invoice_file',
'invoice_date',
'invoice_number',
'invoice_total',
'invoice_total_calculated')
# receiving_complete
if self.creating:
f.remove('receiving_complete')
@ -506,8 +516,12 @@ class ReceivingBatchView(PurchasingBatchView):
elif workflow == 'from_po':
f.remove('truck_dump_batch_uuid',
'date_ordered',
'po_number',
'invoice_file',
'invoice_parser_key')
'invoice_parser_key',
'invoice_date',
'invoice_number')
elif workflow == 'from_po_with_invoice':
f.remove('truck_dump_batch_uuid')
@ -736,11 +750,25 @@ class ReceivingBatchView(PurchasingBatchView):
def configure_row_grid(self, g):
super(ReceivingBatchView, self).configure_row_grid(g)
batch = self.get_instance()
# vendor_code
g.filters['vendor_code'].default_active = True
g.filters['vendor_code'].default_verb = 'contains'
# catalog_unit_cost
if (self.handler.has_purchase_order(batch)
or self.handler.has_invoice_file(batch)):
g.remove('catalog_unit_cost')
# po_unit_cost
if self.handler.has_invoice_file(batch):
g.remove('po_unit_cost')
# invoice_unit_cost
if not self.handler.has_invoice_file(batch):
g.remove('invoice_unit_cost')
# credits
# note that sorting by credits involves a subquery with group by clause.
# seems likely there may be a better way? but this seems to work fine
@ -753,7 +781,6 @@ class ReceivingBatchView(PurchasingBatchView):
# hide 'ordered' columns for truck dump parent, if its "children first"
# flag is set, since that batch type is only concerned with receiving
batch = self.get_instance()
if batch.is_truck_dump_parent() and not batch.truck_dump_children_first:
g.remove('cases_ordered',
'units_ordered')
@ -788,6 +815,11 @@ class ReceivingBatchView(PurchasingBatchView):
return css_class
def get_row_instance_title(self, row):
if row.upc:
return row.upc.pretty()
return super(ReceivingBatchView, self).get_row_instance_title(row)
def transform_unit_url(self, row, i):
# grid action is shown only when we return a URL here
if self.row_editable(row):
@ -795,6 +827,18 @@ class ReceivingBatchView(PurchasingBatchView):
if row.product and row.product.is_pack_item():
return self.get_row_action_url('transform_unit', row)
def vuejs_convert_quantity(self, cstruct):
result = dict(cstruct)
if result['cases'] is colander.null:
result['cases'] = None
elif isinstance(result['cases'], decimal.Decimal):
result['cases'] = float(result['cases'])
if result['units'] is colander.null:
result['units'] = None
elif isinstance(result['units'], decimal.Decimal):
result['units'] = float(result['units'])
return result
def receive_row(self, **kwargs):
"""
Primary desktop view for row-level receiving.
@ -830,14 +874,24 @@ class ReceivingBatchView(PurchasingBatchView):
schema = ReceiveRowForm().bind(session=self.Session())
form = forms.Form(schema=schema, request=self.request, use_buefy=use_buefy)
form.cancel_url = self.get_row_action_url('view', row)
# mode
mode_values = [(mode, mode) for mode in possible_modes]
if use_buefy:
form.set_widget('mode', dfwidget.SelectWidget(values=mode_values))
mode_widget = dfwidget.SelectWidget(values=mode_values)
else:
form.set_widget('mode', forms.widgets.JQuerySelectWidget(values=mode_values))
mode_widget = forms.widgets.JQuerySelectWidget(values=mode_values)
form.set_widget('mode', mode_widget)
# quantity
form.set_widget('quantity', forms.widgets.CasesUnitsWidget(amount_required=True,
one_amount_only=True))
form.set_vuejs_field_converter('quantity', self.vuejs_convert_quantity)
# expiration_date
form.set_type('expiration_date', 'date_jquery')
# TODO: what is this one about again?
form.remove_field('quick_receive')
if form.validate(newstyle=True):
@ -946,6 +1000,7 @@ class ReceivingBatchView(PurchasingBatchView):
View for declaring a credit, i.e. converting some "received" or similar
quantity, to a credit of some sort.
"""
use_buefy = self.get_use_buefy()
row = self.get_row_instance()
batch = row.batch
possible_credit_types = [
@ -965,11 +1020,23 @@ class ReceivingBatchView(PurchasingBatchView):
}
schema = DeclareCreditForm()
form = forms.Form(schema=schema, request=self.request)
form.set_widget('credit_type', forms.widgets.JQuerySelectWidget(
values=[(m, m) for m in possible_credit_types]))
form = forms.Form(schema=schema, request=self.request,
use_buefy=use_buefy)
# credit_type
values = [(m, m) for m in possible_credit_types]
if use_buefy:
widget = dfwidget.SelectWidget(values=values)
else:
widget = forms.widgets.JQuerySelectWidget(values=values)
form.set_widget('credit_type', widget)
# quantity
form.set_widget('quantity', forms.widgets.CasesUnitsWidget(
amount_required=True, one_amount_only=True))
form.set_vuejs_field_converter('quantity', self.vuejs_convert_quantity)
# expiration_date
form.set_type('expiration_date', 'date_jquery')
if form.validate(newstyle=True):
@ -1554,6 +1621,15 @@ class ReceiveRowForm(colander.MappingSchema):
quick_receive = colander.SchemaNode(colander.Boolean())
def deserialize(self, *args):
result = super(ReceiveRowForm, self).deserialize(*args)
if result['mode'] == 'expired' and not result['expiration_date']:
msg = "Expiration date is required for items with 'expired' mode."
self.raise_invalid(msg, node=self.get('expiration_date'))
return result
class DeclareCreditForm(colander.MappingSchema):