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

Convert master view overrides into view supplements

Browse source
This commit is contained in:
Lance Edgar 2022-12-10 08:37:23 -06:00
parent ccc13e1097
commit a25e974dff
3 changed files with 68 additions and 133 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
tailbone_woocommerce/templates/products/view.mako
View file

@ -1,54 +0,0 @@
## -*- coding: utf-8; -*-
<%inherit file="tailbone:templates/products/view.mako" />
<%def name="object_helpers()">
${parent.object_helpers()}
${self.render_xref_helper()}
</%def>
<%def name="render_xref_store_button()">
<b-button type="is-primary"
% if woocommerce_store_url:
tag="a" href="${woocommerce_store_url}" target="_blank"
% else:
disabled title="${woocommerce_store_why_no_url}"
% endif
icon-pack="fas"
icon-left="fas fa-external-link-alt">
View in WooCommerce Store
</b-button>
</%def>
<%def name="render_xref_admin_button()">
<b-button type="is-primary"
% if woocommerce_admin_url:
tag="a" href="${woocommerce_admin_url}" target="_blank"
% else:
disabled title="${woocommerce_admin_why_no_url}"
% endif
icon-pack="fas"
icon-left="fas fa-external-link-alt">
View in WooCommerce Admin
</b-button>
</%def>
<%def name="render_xref_helper()">
<div class="object-helper">
<h3>Cross-Reference</h3>
<div class="object-helper-content">
${self.render_xref_store_button()}
${self.render_xref_admin_button()}
</div>
</div>
</%def>
<%def name="extra_main_fields(form)">
${parent.extra_main_fields(form)}
${self.extra_main_fields_woocommerce(form)}
</%def>
<%def name="extra_main_fields_woocommerce(form)">
${form.render_field_readonly('woocommerce_id')}
</%def>
${parent.body()}

29
tailbone_woocommerce/views/__init__.py
View file

@ -0,0 +1,29 @@
# -*- coding: utf-8; -*-
################################################################################
#
# Rattail -- Retail Software Framework
# Copyright © 2010-2022 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/>.
#
################################################################################
"""
Views w/ WooCommerce integration
"""
def includeme(config):
config.include('tailbone_woocommerce.views.products')

118
tailbone_woocommerce/views/products.py
View file

@ -2,7 +2,7 @@
################################################################################
#
# Rattail -- Retail Software Framework
# Copyright © 2010-2021 Lance Edgar
# Copyright © 2010-2022 Lance Edgar
#
# This file is part of Rattail.
#
@ -28,72 +28,68 @@ from sqlalchemy import orm
from rattail_woocommerce.config import woocommerce_admin_product_url
from tailbone.views import products as base
from webhelpers2.html import tags
from tailbone.views import ViewSupplement
class ProductView(base.ProductView):
class ProductViewSupplement(ViewSupplement):
"""
Master view for the Product class.
Product view supplement for WooCommerce integration
"""
route_prefix = 'products'
labels = {
'woocommerce_id': "WooCommerce ID",
}
@property
def form_fields(self):
fields = super(ProductView, self).form_fields
return self.woocommerce_add_form_fields(fields)
def woocommerce_add_form_fields(self, fields):
fields.extend([
'woocommerce_id',
])
return fields
def query(self, session):
query = super(ProductView, self).query(session)
return self.woocommerce_modify_query(query)
def woocommerce_modify_query(self, query):
def get_grid_query(self, query):
model = self.model
return query.outerjoin(model.WooProductExtension)
def configure_grid(self, g):
super(ProductView, self).configure_grid(g)
self.woocommerce_configure_grid(g)
def woocommerce_configure_grid(self, g):
model = self.model
g.set_filter('woocommerce_id', model.WooProductExtension.woocommerce_id)
def configure_form(self, f):
super(ProductView, self).configure_form(f)
self.woocommerce_configure_form(f)
def woocommerce_configure_form(self, f):
f.set_required('woocommerce_id', False)
if self.creating:
f.remove('woocommerce_id')
if not self.master.creating:
f.append('woocommerce_id')
def get_version_child_classes(self):
classes = super(ProductView, self).get_version_child_classes()
return self.woocommerce_add_version_classes(classes)
def woocommerce_add_version_classes(self, classes):
model = self.model
classes.extend([
model.WooProductExtension,
])
return classes
return [model.WooProductExtension]
def template_kwargs_view(self, **kwargs):
kwargs = super(ProductView, self).template_kwargs_view(**kwargs)
return self.woocommerce_template_kwargs_view(**kwargs)
def get_panel_fields_main(self, product):
return ['woocommerce_id']
def get_xref_buttons(self, product):
buttons = []
woo_cached = self.get_woo_cached_product(product)
if woo_cached:
buttons.append({'url': woo_cached.permalink,
'text': "View in WooCommerce Store"})
woo_id = woo_cached.id if woo_cached else product.woocommerce_id
if woo_id:
url = woocommerce_admin_product_url(self.rattail_config, woo_id)
if url:
buttons.append({'url': url,
'text': "View in WooCommerce Admin"})
return buttons
def get_xref_links(self, product):
if product.woocommerce_cache_product:
url = self.request.route_url('woocommerce.products.view',
uuid=product.woocommerce_cache_product.uuid)
return [tags.link_to("View WooCommerce Product", url)]
def get_woo_cached_product(self, product):
"""
Tries to identify the WooCacheProduct for the given Rattail Product.
"""
model = self.model
woo_cached = None
if product.woocommerce_cache_product:
@ -102,7 +98,6 @@ class ProductView(base.ProductView):
elif product.item_id:
# try to find matching woo product, even though not linked
model = self.rattail_config.get_model()
try:
woo_cached = self.Session.query(model.WooCacheProduct)\
.filter(model.WooCacheProduct.sku == product.item_id)\
@ -112,41 +107,6 @@ class ProductView(base.ProductView):
return woo_cached
def woocommerce_template_kwargs_view(self, **kwargs):
product = kwargs['instance']
woo_cached = self.get_woo_cached_product(product)
# WooCommerce Store URL
store_url = why_not = None
if woo_cached:
store_url = woo_cached.permalink
else:
why_not = "WooCommerce cache product not found"
kwargs['woocommerce_store_url'] = store_url
kwargs['woocommerce_store_why_no_url'] = why_not
# WooCommerce Admin URL
admin_url = why_not = None
woo_id = woo_cached.id if woo_cached else product.woocommerce_id
if woo_id:
admin_url = woocommerce_admin_product_url(self.rattail_config,
woo_id)
if not admin_url:
why_not = "WooCommerce Admin URL is not configured"
else:
why_not = "Product is not known to exist in WooCommerce"
kwargs['woocommerce_admin_url'] = admin_url
kwargs['woocommerce_admin_why_no_url'] = why_not
return kwargs
def includeme(config):
# TODO: getting pretty tired of copy/pasting this extra config...
config.add_route('products.print_labels', '/products/labels')
config.add_view(base.print_labels, route_name='products.print_labels',
renderer='json', permission='products.print_labels')
ProductView.defaults(config)
PendingProductView.defaults(config)
ProductViewSupplement.defaults(config)