Deprecate splash info module (#3480)

* Move sibling discount and lunch choices to extracosts

* Move sibling discount on dashboard

* Allow sibling discount to be reverted, fix form

* Remove splash info module

* Remove unused import

* Fix stripe module

* Fix for accounting module view

* Fix hard coded admission and discount in form

* Add sibling discount to tests, fix form and program setup

* Fix deletion of admission and payment (whoops)

* Fix migration

Author: willgearty

esp/esp/accounting/controllers.py

@@ -75,6 +75,7 @@ class ProgramAccountingController(BaseAccountingController):
     def __init__(self, program, *args, **kwargs):
         self.program = program
         self.finaid_items = ['Financial aid grant', 'Sibling discount']
+        self.admission_items = ["Program admission", "Student payment"]
 
     def clear_all_data(self):
         #   Clear all financial data for the program
@@ -126,12 +127,6 @@ def setup_lineitemtypes(self, base_cost, optional_items=None, select_items=None)
         )
         result.append(lit_finaid)
 
-        (lit_sibling, created) = LineItemType.objects.get_or_create(
-            text='Sibling discount',
-            program=program
-        )
-        result.append(lit_sibling)
-
         for item in optional_items:
             (lit_optional, created) = LineItemType.objects.get_or_create(
                 text=item[0],
@@ -172,20 +167,23 @@ def default_finaid_lineitemtype(self):
     def default_siblingdiscount_lineitemtype(self):
         return LineItemType.objects.filter(program=self.program, text='Sibling discount').order_by('-id')[0]
 
+    def default_admission_lineitemtype(self):
+        return LineItemType.objects.filter(program=self.program, text='Program admission').order_by('-id')[0]
+
     def get_lineitemtypes_Q(self, required_only=False, optional_only=False, payment_only=False, lineitemtype_id=None):
         if lineitemtype_id:
             return Q(id=lineitemtype_id)
         q_object = Q(program=self.program) & ~Q(text__in=self.finaid_items) # exclude finaid grants and sibling discounts
+        # The Stripe module (or, if used, donation module) currently takes care of the donation
+        # optional line item, so ignore it in the optional costs module.
+        for module_name in ['CreditCardModule_Stripe', 'DonationModule']:
+            other_module = self.program.getModule(module_name)
+            if other_module and other_module.get_setting('offer_donation', default=True):
+                q_object &= ~Q(text=other_module.get_setting('donation_text'))
         if required_only:
             q_object &= Q(required=True, for_payments=False)
         elif optional_only:
             q_object &= Q(required=False, for_payments=False)
-            # The Stripe module (or, if used, donation module) currently takes care of the donation
-            # optional line item, so ignore it in the optional costs module.
-            for module_name in ['CreditCardModule_Stripe', 'DonationModule']:
-                other_module = self.program.getModule(module_name)
-                if other_module and other_module.get_setting('offer_donation', default=True):
-                    q_object &= ~Q(text=other_module.get_setting('donation_text'))
         elif payment_only:
             q_object &= Q(required=False, for_payments=True)
         return q_object
@@ -300,15 +298,15 @@ def ensure_required_transfers(self):
 
     def apply_preferences(self, optional_items):
         """ Function to ensure there are transfers for this user corresponding
-            to optional line item types, accoring to their preferences.
+            to optional line item types, according to their preferences.
             optional_items is a list of 4-tuples: (item name, quantity, cost, option ID)
             The last 2 items, cost and option ID, are non-required and should
             be set to None if unused.   """
 
         result = []
         program_account = self.default_program_account()
         source_account = self.default_source_account()
-        line_items = self.get_lineitemtypes(optional_only=True)
+        line_items = self.get_lineitemtypes().exclude(text__in=self.admission_items)
 
         #   Clear existing transfers
         Transfer.objects.filter(user=self.user, line_item__in=line_items).delete()
@@ -334,7 +332,7 @@ def apply_preferences(self, optional_items):
                         option = LineItemOptions.objects.get(id=option_id)
                         if cost is None:
                             transfer_amount = option.amount_dec_inherited
-                    for i in range(quantity):
+                    for i in range(quantity or 0):
                         result.append(Transfer.objects.create(source=source_account, destination=program_account, user=self.user, line_item=lit, amount_dec=transfer_amount, option=option))
                     break
             if not matched:
@@ -380,7 +378,7 @@ def get_transfers(self, line_items=None, **kwargs):
     def get_preferences(self, line_items=None):
         #   Return a list of 4-tuples: (item name, quantity, cost, options)
         result = []
-        transfers = self.get_transfers(line_items, optional_only=True)
+        transfers = self.get_transfers(line_items)
         for transfer in transfers:
             li_name = transfer.line_item.text
             if (li_name, transfer.amount_dec, transfer.option_id) not in map(lambda x: (x[0], x[2], x[3]), result):
@@ -547,7 +545,7 @@ def amount_finaid(self, amount_siblingdiscount=None):
         return aid_amount
 
     def amount_siblingdiscount(self):
-        if (not self.program.sibling_discount) or self.program.splashinfo_objects.get(self.user.id):
+        if self.program.sibling_discount and SplashInfo.getForUser(self.user, self.program).siblingdiscount:
             return self.program.sibling_discount
         else:
             return Decimal('0')

esp/esp/accounting/views.py

@@ -83,6 +83,7 @@ def user_accounting(user, progs = []):
             for t in iac.get_transfers().select_related('line_item')
         ]
         sort_order = {"Cost (required)": 0, "Cost (optional)": 1, "Sibling discount": 2, "Financial aid": 3, "Payment": 4}
+        classified_transfers.sort(key=lambda t: 'Program admission' not in t['transfer'].line_item.text) # put Program admission at the top
         classified_transfers.sort(key=lambda t: sort_order[t['type']])
         result = {
             'program': prog,

esp/esp/program/admin.py

@@ -134,9 +134,12 @@ class Admin_SplashInfo(admin.ModelAdmin):
     list_display = (
         'student',
         'program',
+        'siblingdiscount',
+        'siblingname',
+        'submitted'
     )
-    search_fields = default_user_search('student')
-    list_filter = [ 'program', ]
+    search_fields = default_user_search('student') + ['siblingname']
+    list_filter = [ 'program', 'siblingdiscount', 'submitted']
 admin_site.register(SplashInfo, Admin_SplashInfo)
 
 ## Schedule stuff (wish it was schedule_.py)

esp/esp/program/models/__init__.py

@@ -1285,15 +1285,24 @@ def _sibling_discount_get(self):
         return self._sibling_discount
 
     def _sibling_discount_set(self, value):
+        from esp.accounting.models import LineItemType
         if value is not None:
             self._sibling_discount = Decimal(value)
             Tag.setTag('sibling_discount', target=self, value=self._sibling_discount)
+            LineItemType.objects.get_or_create(text='Sibling discount', program=self, amount_dec = self._sibling_discount)
         else:
             self._sibling_discount = Decimal('0.00')
             Tag.objects.filter(key='sibling_discount', object_id=self.id).delete()
+            LineItemType.objects.filter(text='Sibling discount', program=self).delete()
 
     sibling_discount = property(_sibling_discount_get, _sibling_discount_set)
 
+    def base_cost(self):
+        from esp.accounting.controllers import ProgramAccountingController
+        pac = ProgramAccountingController(self)
+        return pac.default_admission_lineitemtype().amount_dec
+    base_cost = property(base_cost)
+
     @property
     def splashinfo_objects(self):
         """
@@ -1317,8 +1326,8 @@ class SplashInfo(models.Model):
     student = AjaxForeignKey(ESPUser)
     #   Program field may be empty for backwards compatibility with Stanford data
     program = AjaxForeignKey(Program, null=True)
-    lunchsat = models.CharField(max_length=32, blank=True, null=True)
-    lunchsun = models.CharField(max_length=32, blank=True, null=True)
+    lunchsat = models.CharField(max_length=32, blank=True, null=True) # No longer used, kept for backwards compatibility
+    lunchsun = models.CharField(max_length=32, blank=True, null=True) # No longer used, kept for backwards compatibility
     siblingdiscount = models.NullBooleanField(default=False, blank=True)
     siblingname = models.CharField(max_length=64, blank=True, null=True)
     submitted = models.NullBooleanField(default=False, blank=True)
@@ -1351,62 +1360,22 @@ def getForUser(user, program=None):
             n.save()
             return n
 
-    def pretty_version(self, attr_name):
-        #   Look up choices
-        tag_data = Tag.getProgramTag('splashinfo_choices', self.program)
-
-        #   Check for matching item in list of choices
-        if tag_data:
-            tag_struct = json.loads(tag_data)
-            for item in tag_struct[attr_name]:
-                if item[0] == getattr(self, attr_name):
-                    return item[1].decode('utf-8')
-
-        return u'N/A'
-
-    def pretty_satlunch(self):
-        return self.pretty_version('lunchsat')
-
-    def pretty_sunlunch(self):
-        return self.pretty_version('lunchsun')
-
     def execute_sibling_discount(self):
+        from esp.accounting.controllers import IndividualAccountingController
+        from esp.accounting.models import Transfer
+        iac = IndividualAccountingController(self.program, self.student)
+        line_item_type = iac.default_siblingdiscount_lineitemtype()
+        source_account = iac.default_finaid_account()
+        dest_account = iac.default_source_account()
         if self.siblingdiscount:
-            from esp.accounting.controllers import IndividualAccountingController
-            from esp.accounting.models import Transfer
-            iac = IndividualAccountingController(self.program, self.student)
-            source_account = iac.default_finaid_account()
-            dest_account = iac.default_source_account()
-            line_item_type = iac.default_siblingdiscount_lineitemtype()
-            transfer, created = Transfer.objects.get_or_create(source=source_account, destination=dest_account, user=self.student, line_item=line_item_type, amount_dec=Decimal('20.00'))
+            transfer, created = Transfer.objects.get_or_create(source=source_account, destination=dest_account, user=self.student, line_item=line_item_type, amount_dec=self.program.sibling_discount)
             return transfer
+        else:
+            Transfer.objects.filter(source=source_account, destination=dest_account, user=self.student, line_item=line_item_type).delete()
 
     def save(self):
-        from esp.accounting.controllers import IndividualAccountingController
-
-        #   We have two things to put in: "Saturday Lunch" and "Sunday Lunch".
-        #   If they are not there, they will be created.  These names are hard coded.
-        from esp.accounting.models import LineItemType
-        LineItemType.objects.get_or_create(program=self.program, text='Saturday Lunch')
-        LineItemType.objects.get_or_create(program=self.program, text='Sunday Lunch')
-
-        #   Figure out how much everything costs
-        cost_info = json.loads(Tag.getProgramTag('splashinfo_costs', self.program))
-
-        #   Save accounting information
-        iac = IndividualAccountingController(self.program, self.student)
-
-        if not self.lunchsat or self.lunchsat == 'no':
-            iac.set_preference('Saturday Lunch', 0)
-        elif 'lunchsat' in cost_info:
-            iac.set_preference('Saturday Lunch', 1, cost_info['lunchsat'][self.lunchsat])
-
-        if not self.lunchsun or self.lunchsun == 'no':
-            iac.set_preference('Sunday Lunch', 0)
-        elif 'lunchsun' in cost_info:
-            iac.set_preference('Sunday Lunch', 1, cost_info['lunchsun'][self.lunchsun])
-
         super(SplashInfo, self).save()
+        self.execute_sibling_discount()
 
 
 class RegistrationProfile(models.Model):

esp/esp/program/modules/forms/lineitems.py

@@ -4,7 +4,7 @@
 from esp.accounting.models import LineItemType, LineItemOptions
 from esp.program.models import Program
 
-exclude_line_items = ["Sibling discount", "Program admission", "Financial aid grant", "Student payment", "Donation to Learning Unlimited", "Saturday Lunch", "Sunday Lunch"]
+exclude_line_items = ["Sibling discount", "Program admission", "Financial aid grant", "Student payment", "Donation to Learning Unlimited"]
 
 class LineItemForm(forms.ModelForm):
     text = forms.CharField(label = 'Name', widget = forms.TextInput(attrs={'placeholder': '(name)'}), validators=[RegexValidator(regex = '^(' + '|'.join(exclude_line_items) + ')$', message = 'That line item name is reserved for internal operations. Please choose another name.', inverse_match = True)])

esp/esp/program/modules/forms/splashinfo.py

@@ -33,85 +33,39 @@
 """
 
 from django import forms
-from esp.middleware import ESPError
-from esp.tagdict.models import Tag
-import json
+from esp.program.models import Program
 
-"""
-The SplashInfoForm is customizable for different lunch options.
-The choices should be provided in a Tag, splashinfo_choices, which is in
-JSON format.  Example:
-    key = 'splashinfo_choices'
-    value = '{
-        "lunchsat": [["no", "No thanks; I will bring my own lunch"],
-                  ["chicken", "Yes, Chicken"],
-                  ["steak", "Yes, Steak"],
-                  ["spicy_thai", "Yes, Spicy Thai"],
-                  ["veggie", "Yes, Vegetarian"]],
-        "lunchsun": [["no", "No thanks; I will bring my own lunch"],
-                  ["cheese", "Yes, Cheese Pizza"],
-                  ["pepperoni", "Yes, Pepperoni Pizza"]],
-    }'
-
-The interface (including directions, whether to exclude or rename days,
-and costs) should be controlled by overriding the template:
-    program/modules/splashinfomodule/splashinfo.html
-"""
-
-class SplashInfoForm(forms.Form):
-    #   The default choices are somewhat unappetizing...
-    default_choices = [['no', 'No'], ['yes', 'Yes']]
-    discount_choices = [(False, 'I am the first in my household enrolling in Splash (+ $40)'),
-                        (True, 'I have a sibling already enrolled in Splash  (+ $20).')]
-
-    lunchsat = forms.ChoiceField(choices=default_choices)
-    lunchsun = forms.ChoiceField(choices=default_choices)
-    siblingdiscount = forms.ChoiceField(choices=discount_choices, widget=forms.RadioSelect)
+class SiblingDiscountForm(forms.Form):
+    siblingdiscount = forms.TypedChoiceField(choices=[], coerce=lambda x: x == 'True', widget=forms.RadioSelect)
     siblingname = forms.CharField(max_length=128, required=False)
 
     def __init__(self, *args, **kwargs):
-        #   Extract a program if one was provided
         if 'program' in kwargs:
-            program = kwargs['program']
-            del kwargs['program']
+            program = kwargs.pop('program')
         else:
-            program = None
-
-        #   Run default init function
-        super(SplashInfoForm, self).__init__(*args, **kwargs)
-
-        #   Set choices from Tag data (try to get program-specific choices if they exist)
-        tag_data = Tag.getProgramTag('splashinfo_choices', program)
-        if tag_data:
-            tag_struct = json.loads(tag_data)
-            self.fields['lunchsat'].choices = tag_struct['lunchsat']
-            self.fields['lunchsun'].choices = tag_struct['lunchsun']
-
-        if not Tag.getBooleanTag('splashinfo_siblingdiscount', program=program):
-            del self.fields['siblingdiscount']
-            del self.fields['siblingname']
-
-        if not Tag.getBooleanTag('splashinfo_lunchsat', program=program):
-            del self.fields['lunchsat']
-
-        if not Tag.getBooleanTag('splashinfo_lunchsun', program=program):
-            del self.fields['lunchsun']
+            raise KeyError('Need to supply program as named argument to SiblingDiscountForm')
+        self.base_fields['siblingdiscount'].choices = [(False, 'I am the first in my household enrolling in Splash (+ $' + str(program.base_cost) + ').'),
+                                                       (True, 'I have a sibling already enrolled in Splash (+ $' + str(program.base_cost - program.sibling_discount) + ').')]
+        self.base_fields['siblingdiscount'].initial = True
+        super(SiblingDiscountForm, self).__init__(*args, **kwargs)
+
+    def clean(self):
+        cleaned_data = super(SiblingDiscountForm, self).clean()
+        siblingdiscount = cleaned_data.get("siblingdiscount")
+        siblingname = cleaned_data.get("siblingname")
+        if siblingdiscount and not siblingname:
+            self.add_error('siblingname', "You didn't provide the name of your sibling.")
+        elif not siblingdiscount:
+            self.cleaned_data['siblingname'] = ""
 
     def load(self, splashinfo):
-        self.initial['lunchsat'] = splashinfo.lunchsat
-        self.initial['lunchsun'] = splashinfo.lunchsun
         self.initial['siblingdiscount'] = splashinfo.siblingdiscount
         self.initial['siblingname'] = splashinfo.siblingname
 
     def save(self, splashinfo):
-        if 'lunchsat' in self.cleaned_data:
-            splashinfo.lunchsat = self.cleaned_data['lunchsat']
-        if 'lunchsun' in self.cleaned_data:
-            splashinfo.lunchsun = self.cleaned_data['lunchsun']
         if 'siblingdiscount' in self.cleaned_data:
-            splashinfo.siblingdiscount = (self.cleaned_data['siblingdiscount'] == "True")
+            splashinfo.siblingdiscount = self.cleaned_data['siblingdiscount']
         if 'siblingname' in self.cleaned_data:
             splashinfo.siblingname = self.cleaned_data['siblingname']
         splashinfo.submitted = True
         splashinfo.save()
-

esp/esp/program/modules/handlers/creditcardmodule_stripe.py

@@ -85,8 +85,7 @@ def get_setting(self, name, default=None):
         return self.apply_settings().get(name, default)
 
     def line_item_type(self):
-        pac = ProgramAccountingController(self.program)
-        (donate_type, created) = pac.get_lineitemtypes().get_or_create(program=self.program, text=self.get_setting('donation_text'))
+        (donate_type, created) = LineItemType.objects.get_or_create(program=self.program, text=self.get_setting('donation_text'))
         return donate_type
 
     def isCompleted(self):
@@ -170,7 +169,7 @@ def payonline(self, request, tl, one, two, module, extra, prog):
         sibling_type = iac.default_siblingdiscount_lineitemtype()
         grant_type = iac.default_finaid_lineitemtype()
         offer_donation = self.settings['offer_donation']
-        donate_type = iac.get_lineitemtypes().get(text=self.settings['donation_text']) if offer_donation else None
+        donate_type = LineItemType.objects.get(program=self.program, text=self.settings['donation_text']) if offer_donation else None
         context['itemizedcosts'] = iac.get_transfers().exclude(line_item__in=filter(None, [payment_type, sibling_type, grant_type, donate_type])).order_by('-line_item__required')
         context['itemizedcosttotal'] = iac.amount_due()
         #   This amount should be formatted as an integer in order to be

esp/esp/program/modules/handlers/donationmodule.py

@@ -39,7 +39,7 @@
 from esp.users.models import ESPUser, Record
 from esp.tagdict.models import Tag
 from esp.accounting.models import LineItemType
-from esp.accounting.controllers import ProgramAccountingController, IndividualAccountingController
+from esp.accounting.controllers import IndividualAccountingController
 from esp.middleware import ESPError
 from esp.middleware.threadlocalrequest import get_current_request
 
@@ -119,8 +119,7 @@ def get_setting(self, name, default=None):
         return self.apply_settings().get(name, default)
 
     def line_item_type(self):
-        pac = ProgramAccountingController(self.program)
-        (donate_type, created) = pac.get_lineitemtypes().get_or_create(program=self.program, text=self.get_setting('donation_text'))
+        (donate_type, created) = LineItemType.objects.get_or_create(program=self.program, text=self.get_setting('donation_text'))
         return donate_type
 
     def isCompleted(self):