[REF] *_sale_coupon: create coupon module

This refactoring extracts parts of `sale_coupon` module to create a more
generic module called `coupon`. This new module can be extended in
different sales modules to implement functionalities specific to modules
that extend it.

1 files changed, 22 insertions, 187 deletions

diff --git a/addons/coupon/models/coupon_program.py b/addons/coupon/models/coupon_program.py
index 548cc09356a..f9b080df2e4 100644
--- a/addons/coupon/models/coupon_program.py
+++ b/addons/coupon/models/coupon_program.py
@@ -7,10 +7,10 @@ from odoo.exceptions import UserError, ValidationError
 import ast
 
 
-class SaleCouponProgram(models.Model):
-    _name = 'sale.coupon.program'
-    _description = "Sales Coupon Program"
-    _inherits = {'sale.coupon.rule': 'rule_id', 'sale.coupon.reward': 'reward_id'}
+class CouponProgram(models.Model):
+    _name = 'coupon.program'
+    _description = "Coupon Program"
+    _inherits = {'coupon.rule': 'rule_id', 'coupon.reward': 'reward_id'}
     # We should apply 'discount' promotion first to avoid offering free product when we should not.
     # Eg: If the discount lower the SO total below the required threshold
     # Note: This is only revelant when programs have the same sequence (which they have by default)
@@ -18,8 +18,8 @@ class SaleCouponProgram(models.Model):
 
     name = fields.Char(required=True, translate=True)
     active = fields.Boolean('Active', default=True, help="A program is available for the customers when active")
-    rule_id = fields.Many2one('sale.coupon.rule', string="Coupon Rule", ondelete='restrict', required=True)
-    reward_id = fields.Many2one('sale.coupon.reward', string="Reward", ondelete='restrict', required=True, copy=False)
+    rule_id = fields.Many2one('coupon.rule', string="Coupon Rule", ondelete='restrict', required=True)
+    reward_id = fields.Many2one('coupon.reward', string="Reward", ondelete='restrict', required=True, copy=False)
     sequence = fields.Integer(copy=False,
         help="Coupon program will be applied based on given sequence if multiple programs are " +
         "defined on same condition(For minimum amount)")
@@ -45,9 +45,8 @@ class SaleCouponProgram(models.Model):
         ('on_current_order', 'Apply On Current Order'),
         ('on_next_order', 'Send a Coupon')],
         default='on_current_order', string="Applicability")
-    coupon_ids = fields.One2many('sale.coupon', 'program_id', string="Generated Coupons", copy=False)
+    coupon_ids = fields.One2many('coupon.coupon', 'program_id', string="Generated Coupons", copy=False)
     coupon_count = fields.Integer(compute='_compute_coupon_count')
-    order_count = fields.Integer(compute='_compute_order_count')
     company_id = fields.Many2one('res.company', string="Company", default=lambda self: self.env.company)
     currency_id = fields.Many2one(string="Currency", related='company_id.currency_id', readonly=True)
     validity_duration = fields.Integer(default=30,
@@ -61,16 +60,9 @@ class SaleCouponProgram(models.Model):
             if self.search(domain):
                 raise ValidationError(_('The program code must be unique!'))
 
-    # The api.depends is handled in `def modified` of `sale_coupon/models/sale_order.py`
-    def _compute_order_count(self):
-        product_data = self.env['sale.order.line'].read_group([('product_id', 'in', self.mapped('discount_line_product_id').ids)], ['product_id'], ['product_id'])
-        mapped_data = dict([(m['product_id'][0], m['product_id_count']) for m in product_data])
-        for program in self:
-            program.order_count = mapped_data.get(program.discount_line_product_id.id, 0)
-
     @api.depends('coupon_ids')
     def _compute_coupon_count(self):
-        coupon_data = self.env['sale.coupon'].read_group([('program_id', 'in', self.ids)], ['program_id'], ['program_id'])
+        coupon_data = self.env['coupon.coupon'].read_group([('program_id', 'in', self.ids)], ['program_id'], ['program_id'])
         mapped_data = dict([(m['program_id'][0], m['program_id_count']) for m in coupon_data])
         for program in self:
             program.coupon_count = mapped_data.get(program.id, 0)
@@ -87,7 +79,7 @@ class SaleCouponProgram(models.Model):
 
     @api.model
     def create(self, vals):
-        program = super(SaleCouponProgram, self).create(vals)
+        program = super(CouponProgram, self).create(vals)
         if not vals.get('discount_line_product_id', False):
             discount_line_product_id = self.env['product.product'].create({
                 'name': program.reward_id.display_name,
@@ -96,14 +88,13 @@ class SaleCouponProgram(models.Model):
                 'supplier_taxes_id': False,
                 'sale_ok': False,
                 'purchase_ok': False,
-                'invoice_policy': 'order',
                 'lst_price': 0, #Do not set a high value to avoid issue with coupon code
             })
             program.write({'discount_line_product_id': discount_line_product_id.id})
         return program
 
     def write(self, vals):
-        res = super(SaleCouponProgram, self).write(vals)
+        res = super(CouponProgram, self).write(vals)
         reward_fields = [
             'reward_type', 'reward_product_id', 'discount_type', 'discount_percentage',
             'discount_apply_on', 'discount_specific_product_ids', 'discount_fixed_amount'
@@ -113,184 +104,28 @@ class SaleCouponProgram(models.Model):
         return res
 
     def unlink(self):
-        for program in self.filtered(lambda x: x.active):
+        if self.filtered('active'):
             raise UserError(_('You can not delete a program in active state'))
-        return super(SaleCouponProgram, self).unlink()
+        # get reference to rule and reward
+        rule = self.rule_id
+        reward = self.reward_id
+        # unlink the program
+        super(CouponProgram, self).unlink()
+        # then unlink the rule and reward
+        rule.unlink()
+        reward.unlink()
+        return True
 
     def toggle_active(self):
-        super(SaleCouponProgram, self).toggle_active()
+        super(CouponProgram, self).toggle_active()
         for program in self:
             program.discount_line_product_id.active = program.active
         coupons = self.filtered(lambda p: not p.active and p.promo_code_usage == 'code_needed').mapped('coupon_ids')
         coupons.filtered(lambda x: x.state != 'used').write({'state': 'expired'})
 
-    def action_view_sales_orders(self):
-        self.ensure_one()
-        orders = self.env['sale.order.line'].search([('product_id', '=', self.discount_line_product_id.id)]).mapped('order_id')
-        return {
-            'name': _('Sales Orders'),
-            'view_mode': 'tree,form',
-            'res_model': 'sale.order',
-            'type': 'ir.actions.act_window',
-            'domain': [('id', 'in', orders.ids), ('state', 'not in', ('draft', 'sent', 'cancel'))],
-            'context': dict(self._context, create=False)
-        }
-
-    def _is_global_discount_program(self):
-        self.ensure_one()
-        return self.promo_applicability == 'on_current_order' and \
-               self.reward_type == 'discount' and \
-               self.discount_type == 'percentage' and \
-               self.discount_apply_on == 'on_order'
-
-    def _keep_only_most_interesting_auto_applied_global_discount_program(self):
-        '''Given a record set of programs, remove the less interesting auto
-        applied global discount to keep only the most interesting one.
-        We should not take promo code programs into account as a 10% auto
-        applied is considered better than a 50% promo code, as the user might
-        not know about the promo code.
-        '''
-        programs = self.filtered(lambda p: p._is_global_discount_program() and p.promo_code_usage == 'no_code_needed')
-        if not programs: return self
-        most_interesting_program = max(programs, key=lambda p: p.discount_percentage)
-        # remove least interesting programs
-        return self - (programs - most_interesting_program)
-
-    def _check_promo_code(self, order, coupon_code):
-        message = {}
-        applicable_programs = order._get_applicable_programs()
-        if self.maximum_use_number != 0 and self.order_count >= self.maximum_use_number:
-            message = {'error': _('Promo code %s has been expired.') % (coupon_code)}
-        elif not self._filter_on_mimimum_amount(order):
-            message = {'error': _('A minimum of %s %s should be purchased to get the reward') % (self.rule_minimum_amount, self.currency_id.name)}
-        elif self.promo_code and self.promo_code == order.promo_code:
-            message = {'error': _('The promo code is already applied on this order')}
-        elif not self.promo_code and self in order.no_code_promo_program_ids:
-            message = {'error': _('The promotional offer is already applied on this order')}
-        elif not self.active:
-            message = {'error': _('Promo code is invalid')}
-        elif self.rule_date_from and self.rule_date_from > order.date_order or self.rule_date_to and order.date_order > self.rule_date_to:
-            message = {'error': _('Promo code is expired')}
-        elif order.promo_code and self.promo_code_usage == 'code_needed':
-            message = {'error': _('Promotionals codes are not cumulative.')}
-        elif self._is_global_discount_program() and order._is_global_discount_already_applied():
-            message = {'error': _('Global discounts are not cumulative.')}
-        elif self.promo_applicability == 'on_current_order' and self.reward_type == 'product' and not order._is_reward_in_order_lines(self):
-            message = {'error': _('The reward products should be in the sales order lines to apply the discount.')}
-        elif not self._is_valid_partner(order.partner_id):
-            message = {'error': _("The customer doesn't have access to this reward.")}
-        elif not self._filter_programs_on_products(order):
-            message = {'error': _("You don't have the required product quantities on your sales order. If the reward is same product quantity, please make sure that all the products are recorded on the sales order (Example: You need to have 3 T-shirts on your sales order if the promotion is 'Buy 2, Get 1 Free'.")}
-        else:
-            if self not in applicable_programs and self.promo_applicability == 'on_current_order':
-                message = {'error': _('At least one of the required conditions is not met to get the reward!')}
-        return message
-
     def _compute_program_amount(self, field, currency_to):
         self.ensure_one()
-        return self.currency_id._convert(getattr(self, field), currency_to, self.company_id, fields.Date.today())
-
-    @api.model
-    def _filter_on_mimimum_amount(self, order):
-        filtered_programs = self.env['sale.coupon.program']
-
-        no_effect_lines = order._get_no_effect_on_threshold_lines()
-        order_amount = {
-            'amount_untaxed' : order.amount_untaxed - sum([line.price_subtotal for line in no_effect_lines]),
-            'amount_tax' : order.amount_tax - sum([line.price_tax for line in no_effect_lines])
-        }
-        for program in self:
-            lines = order.order_line.filtered(lambda line:
-                program.reward_type == 'discount' and
-                (line.product_id == program.discount_line_product_id or
-                line.product_id == program.reward_id.discount_line_product_id
-            ))
-            untaxed_amount = order_amount['amount_untaxed'] - sum([line.price_subtotal for line in lines])
-            tax_amount = order_amount['amount_tax'] - sum([line.price_tax for line in lines])
-            program_amount = program._compute_program_amount('rule_minimum_amount', order.currency_id)
-            if program.rule_minimum_amount_tax_inclusion == 'tax_included' and program_amount <= (untaxed_amount + tax_amount) or program.rule_minimum_amount_tax_inclusion == 'tax_excluded' and program_amount <= untaxed_amount:
-                filtered_programs |= program
-
-        return filtered_programs
-
-    @api.model
-    def _filter_on_validity_dates(self, order):
-        return self.filtered(lambda program:
-            program.rule_date_from and program.rule_date_to and
-            program.rule_date_from <= order.date_order and program.rule_date_to >= order.date_order or
-            not program.rule_date_from or not program.rule_date_to)
-
-    @api.model
-    def _filter_promo_programs_with_code(self, order):
-        '''Filter Promo program with code with a different promo_code if a promo_code is already ordered'''
-        return self.filtered(lambda program: program.promo_code_usage == 'code_needed' and program.promo_code != order.promo_code)
-
-    def _filter_unexpired_programs(self, order):
-        return self.filtered(lambda program: program.maximum_use_number == 0 or program.order_count <= program.maximum_use_number)
-
-    def _filter_programs_on_partners(self, order):
-        return self.filtered(lambda program: program._is_valid_partner(order.partner_id))
-
-    def _filter_programs_on_products(self, order):
-        """
-        To get valid programs according to product list.
-        i.e Buy 1 imac + get 1 ipad mini free then check 1 imac is on cart or not
-        or  Buy 1 coke + get 1 coke free then check 2 cokes are on cart or not
-        """
-        order_lines = order.order_line.filtered(lambda line: line.product_id) - order._get_reward_lines()
-        products = order_lines.mapped('product_id')
-        products_qties = dict.fromkeys(products, 0)
-        for line in order_lines:
-            products_qties[line.product_id] += line.product_uom_qty
-        valid_programs = self.filtered(lambda program: not program.rule_products_domain)
-        for program in self - valid_programs:
-            valid_products = program._get_valid_products(products)
-            ordered_rule_products_qty = sum(products_qties[product] for product in valid_products)
-            # Avoid program if 1 ordered foo on a program '1 foo, 1 free foo'
-            if program.promo_applicability == 'on_current_order' and \
-               program._is_valid_product(program.reward_product_id) and program.reward_type == 'product':
-                ordered_rule_products_qty -= program.reward_product_quantity
-            if ordered_rule_products_qty >= program.rule_min_quantity:
-                valid_programs |= program
-        return valid_programs
-
-    def _filter_not_ordered_reward_programs(self, order):
-        """
-        Returns the programs when the reward is actually in the order lines
-        """
-        programs = self.env['sale.coupon.program']
-        for program in self:
-            if program.reward_type == 'product' and \
-               not order.order_line.filtered(lambda line: line.product_id == program.reward_product_id):
-                continue
-            elif program.reward_type == 'discount' and program.discount_apply_on == 'specific_products' and \
-               not order.order_line.filtered(lambda line: line.product_id in program.discount_specific_product_ids):
-                continue
-            programs |= program
-        return programs
-
-    @api.model
-    def _filter_programs_from_common_rules(self, order, next_order=False):
-        """ Return the programs if every conditions is met
-            :param bool next_order: is the reward given from a previous order
-        """
-        programs = self
-        # Minimum requirement should not be checked if the coupon got generated by a promotion program (the requirement should have only be checked to generate the coupon)
-        if not next_order:
-            programs = programs and programs._filter_on_mimimum_amount(order)
-        programs = programs and programs._filter_on_validity_dates(order)
-        programs = programs and programs._filter_unexpired_programs(order)
-        programs = programs and programs._filter_programs_on_partners(order)
-        # Product requirement should not be checked if the coupon got generated by a promotion program (the requirement should have only be checked to generate the coupon)
-        if not next_order:
-            programs = programs and programs._filter_programs_on_products(order)
-
-        programs_curr_order = programs.filtered(lambda p: p.promo_applicability == 'on_current_order')
-        programs = programs.filtered(lambda p: p.promo_applicability == 'on_next_order')
-        if programs_curr_order:
-            # Checking if rewards are in the SO should not be performed for rewards on_next_order
-            programs += programs_curr_order._filter_not_ordered_reward_programs(order)
-        return programs
+        return self.currency_id._convert(self[field], currency_to, self.company_id, fields.Date.today())
 
     def _is_valid_partner(self, partner):
         if self.rule_partners_domain: