[pos_product_deposit] Add (bottle) deposit addon for PoS

pos_product_deposit/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+from . import models

pos_product_deposit/__manifest__.py

@@ -0,0 +1,15 @@
+{
+    'name': "pos_product_deposit",
+    'summary': """Attach a deposit to a product that gets automatically added at the PoS""",
+
+    'description': """""",
+
+    'author': "SuperCoop Berlin",
+    'website': "https://supercoop.de",
+    'version': '12.0',
+    'depends': ['product', 'point_of_sale'],
+    'data': [
+        'views/views.xml',
+        'views/assets.xml',
+        ],
+}

pos_product_deposit/models/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+from . import models

pos_product_deposit/models/models.py

@@ -0,0 +1,9 @@
+from odoo import models, fields, api
+
+class ProductTemplate(models.Model):
+    _inherit = "product.template"
+
+    deposit_product_id = fields.Many2one(
+            'product.product',
+            string="Deposit Product",
+            help="Products to automatically add to the sale")

pos_product_deposit/static/src/js/models.js

@@ -0,0 +1,104 @@
+odoo.define("pos_product_deposit.models", function (require) {
+    "use strict";
+
+    var models = require("point_of_sale.models");
+
+    models.load_fields("product.product", ["deposit_product_id"]);
+
+    // DepositOrderline is for deposits. Every product orderline with a deposit has
+    // exactly one DepositOrderline that is updated when its quantity changes. To
+    // always ensure this 1-to-1 mapping, never merge DepositOrderline with any
+    // others.
+    var DepositOrderline = models.Orderline.extend({
+        can_be_merged_with: function(orderline) {
+            return false
+        }
+    })
+
+    // This is how ineritance seems to be done in this madness
+    // https://github.com/OCA/pos/blob/d1088fb917896259f75d07913113cebb74a661ed/pos_payment_terminal/static/src/js/models.js#L14
+    // this._super, as documented for 14.0, doesn't seem to work (yet?)
+    var _orderlineproto = models.Orderline.prototype;
+    var Orderline = models.Orderline.extend({
+        initialize: function (attr, options) {
+            var res = _orderlineproto.initialize.apply(this, arguments);
+            // The recompute_deposit_line handler must be called a) when the quantity changes
+            // and b) when the orderline actually gets added to the order (see special case
+            // below, line could still be merged and not added). Attaching this handler seems
+            // to do it.
+            this.on('change', this.recompute_deposit_line, this);
+            return res;
+        },
+        recompute_deposit_line: function() {
+            if (!this.order) {
+                // This happens when recreating the orderline from JSON, the order is
+                // only set later in the init_from_JSON process. We don't care in this case,
+                // the deposit orderline will be restored as well.
+                return
+            }
+            if (!this.collection) {
+                // This happens when the orderline is created but has not yet been added to the
+                // orderlines collection. It may still be merged with an existing orderline and
+                // this object discarded. So avoid creating a deposit orderline for now and rely
+                // that we get called again by the change handler when we get added to the
+                // orderlines collection.
+                return;
+            }
+            if (this.product && this.product.deposit_product_id) {
+                // We store the ID and do a lookup every time because storing a direct
+                // reference would not survive a page reload, where the whole object
+                // gets stored as JSON.
+                if (this.deposit_line_id) {
+                    var deposit_line = this.order.orderlines.get(this.deposit_line_id);
+                    // deposit_line could be unset. This can happen during restore, because
+                    // the referenced orderline has not yet been restored from JSON, or
+                    // because somebody deleted the previously created orderline in the UI.
+                    // Because we can't distinguish the two cases here, be conservative and
+                    // do nothing in that case to avoid creating duplicated lines during restore.
+                    // The trade-off is that if somebody deletes our associated DepositOrderline
+                    // in the UI, it's gone and we won't re-create it.
+                    if (deposit_line) {
+                        if (this.quantity == 0) {
+                            this.order.orderlines.remove(deposit_line);
+                            this.deposit_line_id = undefined;
+                        } else {
+                            deposit_line.set_quantity(this.quantity);
+                        }
+                    }
+                } else {
+                    // Don't (re-)create the orderline if the quantity is zero, it probably just got
+                    // deleted by the code above.
+                    if (this.quantity > 0) {
+                        var deposit_product = this.pos.db.product_by_id[this.product.deposit_product_id[0]];
+                        var deposit_line = new DepositOrderline({}, {
+                            pos: this.pos, order: this.order, product: deposit_product
+                        });
+                        this.deposit_line_id = deposit_line.id;
+                        // Insert the deposit orderline just above where we likely are, at the end. This
+                        // also ensures that the auto-selected orderline after scanning is not the deposit
+                        // but the last scanned orderline.
+                        this.order.orderlines.add(deposit_line, {at: this.order.orderlines.length - 2});
+                        deposit_line.set_quantity(this.quantity);
+                    }
+                }
+            }
+        },
+        /* init_from_JSON, export_as_JSON, clone are overridden to deal with this.deposit_line_id */
+        init_from_JSON: function(json) {
+            this.deposit_line_id = json.deposit_line_id;
+            return _orderlineproto.init_from_JSON.apply(this, arguments);
+        },
+        export_as_JSON: function() {
+            var res = _orderlineproto.export_as_JSON.apply(this, arguments);
+            res.deposit_line_id = this.deposit_line_id;
+            return res;
+        },
+        clone: function() {
+            var res = _orderlineproto.clone.apply(this, arguments);
+            res.deposit_line_id = this.deposit_line_id;
+            return res;
+        },
+
+    });
+    models.Orderline = Orderline;
+});

pos_product_deposit/views/assets.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+
+    <template id="assets" inherit_id="point_of_sale.assets">
+        <xpath expr="." position="inside">
+            <script
+                type="text/javascript"
+                src="/pos_product_deposit/static/src/js/models.js"
+            />
+        </xpath>
+    </template>
+
+</odoo>

pos_product_deposit/views/views.xml

@@ -0,0 +1,12 @@
+<odoo>
+	<record model="ir.ui.view" id="scb_product_form">
+		<field name="name">bees.product.template.form</field>
+		<field name="model">product.template</field>
+		<field name="inherit_id" ref="product.product_template_only_form_view"/>
+		<field name="arch" type="xml">
+			<xpath expr="//field[@name='uom_po_id']" position="after">
+				<field name="deposit_product_id"/>
+			</xpath>
+		</field>
+	</record>
+</odoo>