Added new fields to several models to handle reporting requirements

oscar/apps/order/abstract_models.py

@@ -164,9 +164,11 @@ class AbstractLine(models.Model):
     order = models.ForeignKey('order.Order', related_name='lines')
     
     # We store the partner, their SKU and the title for cases where the product has been
-    # deleted from the catalogue.
-    partner = models.ForeignKey('stock.Partner', related_name='order_lines')
-    partner_sku = models.CharField(_("Partner SKU"), max_length=128, blank=True, null=True)
+    # deleted from the catalogue.  We also store the partner name in case the partner
+    # gets deleted at a later date.
+    partner = models.ForeignKey('stock.Partner', related_name='order_lines', blank=True, null=True, on_delete=models.SET_NULL)
+    partner_name = models.CharField(_("Partner name"), max_length=128)
+    partner_sku = models.CharField(_("Partner SKU"), max_length=128)
     title = models.CharField(_("Title"), max_length=255)
     
     # We don't want any hard links between orders and the products table
@@ -182,9 +184,14 @@ class AbstractLine(models.Model):
     line_price_before_discounts_incl_tax = models.DecimalField(decimal_places=2, max_digits=12)
     line_price_before_discounts_excl_tax = models.DecimalField(decimal_places=2, max_digits=12)
     
-    # Cost price (the price charged by the fulfilment partner for this product).  This
-    # is useful for audit and financial reporting.
-    cost_price = models.DecimalField(decimal_places=2, max_digits=12, blank=True, null=True)
+
+    # REPORTING FIELDS        
+    # Cost price (the price charged by the fulfilment partner for this product).
+    unit_cost_price = models.DecimalField(decimal_places=2, max_digits=12, blank=True, null=True)
+    # Normal site price for item (without discounts)
+    unit_site_price = models.DecimalField(decimal_places=2, max_digits=12, blank=True, null=True)
+    # Retail price at time of purchase
+    unit_retail_price = models.DecimalField(decimal_places=2, max_digits=12, blank=True, null=True)
     
     # Partner information
     partner_line_reference = models.CharField(_("Partner reference"), max_length=128, blank=True, null=True,
@@ -194,7 +201,6 @@ class AbstractLine(models.Model):
     # Estimated dispatch date - should be set at order time
     est_dispatch_date = models.DateField(blank=True, null=True)
     
-    
     @property
     def description(self):
         u"""

oscar/apps/order/utils.py

@@ -2,9 +2,10 @@ from django.contrib.sites.models import Site
 
 from oscar.core.loading import import_module
 import_module('order.models', ['ShippingAddress', 'Order', 'Line', 
-                                              'LinePrice', 'LineAttribute', 'OrderDiscount'], locals())
+                               'LinePrice', 'LineAttribute', 'OrderDiscount'], locals())
 import_module('order.signals', ['order_placed'], locals())
 
+
 class OrderNumberGenerator(object):
     u"""
     Simple object for generating order numbers.
@@ -47,7 +48,7 @@ class OrderCreator(object):
         basket.set_as_submitted()
         
         # Send signal for analytics to pick up
-        order_signals.order_placed.send(sender=self, order=order, user=user)
+        order_placed.send(sender=self, order=order, user=user)
         
         return order
         
@@ -77,18 +78,29 @@ class OrderCreator(object):
     
     def _create_line_models(self, order, basket_line):
         u"""Creates the batch line model."""
-        order_line = order_models.Line(order=order,
-                                      partner=self._get_partner_for_product(basket_line.product),
-                                      product=basket_line.product, 
-                                      title=basket_line.product.get_title(),
-                                      quantity=basket_line.quantity, 
-                                      line_price_excl_tax=basket_line.line_price_excl_tax_and_discounts, 
-                                      line_price_incl_tax=basket_line.line_price_incl_tax_and_discounts,
-                                      line_price_before_discounts_excl_tax=basket_line.line_price_excl_tax,
-                                      line_price_before_discounts_incl_tax=basket_line.line_price_incl_tax,)
-        if basket_line.product.has_stockrecord:
-            order_line.partner_sku = basket_line.product.stockrecord.partner_sku
-            order_line.est_dispatch_date = basket_line.product.stockrecord.dispatch_date
+        partner = self._get_partner_for_product(basket_line.product)
+        stockrecord = basket_line.product.stockrecord
+        order_line = Line(order=order,
+                          # Partner details
+                          partner=partner,
+                          partner_name=partner.name,
+                          partner_sku=stockrecord.partner_sku,
+                          # Product details
+                          product=basket_line.product, 
+                          title=basket_line.product.get_title(),
+                          quantity=basket_line.quantity,
+                          # Price details 
+                          line_price_excl_tax=basket_line.line_price_excl_tax_and_discounts, 
+                          line_price_incl_tax=basket_line.line_price_incl_tax_and_discounts,
+                          line_price_before_discounts_excl_tax=basket_line.line_price_excl_tax,
+                          line_price_before_discounts_incl_tax=basket_line.line_price_incl_tax,
+                          # Reporting details
+                          unit_cost_price = stockrecord.cost_price,
+                          unit_site_price = stockrecord.price_incl_tax,
+                          unit_retail_price = stockrecord.price_retail,
+                          # Shipping details
+                          est_dispatch_date = basket_line.product.stockrecord.dispatch_date
+                          )
         order_line.save()
         self._create_line_price_models(order, order_line, basket_line)
         self._create_line_attributes(order, order_line, basket_line)
@@ -98,18 +110,18 @@ class OrderCreator(object):
         breakdown = basket_line.get_price_breakdown()
         for price_incl_tax, price_excl_tax, quantity in breakdown:
             LinePrice._default_manager.create(order=order,
-                                                  line=order_line, 
-                                                  quantity=quantity, 
-                                                  price_incl_tax=price_incl_tax,
-                                                  price_excl_tax=price_excl_tax)
+                                              line=order_line, 
+                                              quantity=quantity, 
+                                              price_incl_tax=price_incl_tax,
+                                              price_excl_tax=price_excl_tax)
     
     def _create_line_attributes(self, order, order_line, basket_line):
         u"""Creates the batch line attributes."""
         for attr in basket_line.attributes.all():
             LineAttribute._default_manager.create(line=order_line,
-                                                               option=attr.option, 
-                                                               type=attr.option.code,
-                                                               value=attr.value)
+                                                   option=attr.option, 
+                                                   type=attr.option.code,
+                                                   value=attr.value)
             
     def _create_discount_model(self, order, discount):
         u"""

oscar/apps/product/abstract_models.py

@@ -88,7 +88,7 @@ class AbstractItem(models.Model):
     date_created = models.DateTimeField(auto_now_add=True)
 
     # This field is used by Haystack to reindex search
-    date_updated = models.DateTimeField(auto_now=True, null=True, default=None)
+    date_updated = models.DateTimeField(auto_now=True, db_index=True)
 
     objects = models.Manager()
     browsable = BrowsableItemManager()

oscar/apps/search/forms.py

@@ -25,7 +25,7 @@ class MultiFacetedSearchForm(FacetedSearchForm):
         Overriding the search method to allow for multiple facets
         '''
         sqs = super(FacetedSearchForm, self).search().order_by('-score')
-        if hasattr(self, 'cleaned_data') and self.cleaned_data['selected_facets']:
+        if hasattr(self, 'cleaned_data') and 'selected_facets' in self.cleaned_data:
             for f in self.cleaned_data['selected_facets'].split("|"):
                 sqs = sqs.narrow(f)
         return sqs

oscar/apps/search/views.py

@@ -1,8 +1,8 @@
 import json
-import settings
 
 from django.http import HttpResponse, HttpResponseRedirect
 from django.views.generic.base import View
+from django.conf import settings
 from haystack.query import SearchQuerySet
 from haystack.views import FacetedSearchView
 
@@ -85,7 +85,7 @@ class MultiFacetedSearchView(FacetedSearchView):
         '''
         extra = super(MultiFacetedSearchView, self).extra_context()
 
-        if hasattr(self.form, 'cleaned_data') and self.form.cleaned_data['selected_facets']:
+        if hasattr(self.form, 'cleaned_data') and 'selected_facets' in self.form.cleaned_data:
             extra['facets_applied'] = []
             for f in self.form.cleaned_data['selected_facets'].split("|"):
                 facet = f.split(":")

oscar/apps/stock/abstract_models.py

@@ -11,7 +11,7 @@ class AbstractPartner(models.Model):
     
     # A partner can have users assigned to it.  These can be used
     # to provide authentication for webservices etc.
-    users = models.ManyToManyField('auth.User', releatd_name="partners", null=True)
+    users = models.ManyToManyField('auth.User', related_name="partners", null=True)
     
     class Meta:
         verbose_name_plural = 'Fulfillment partners'
@@ -48,28 +48,38 @@ class AbstractStockRecord(models.Model):
     
     # This is the base price for calculations - tax should be applied 
     # by the appropriate method.  We don't store it here as its calculation is 
-    # highly domain-specific.
-    price_excl_tax = models.DecimalField(decimal_places=2, max_digits=12)
+    # highly domain-specific.  It is NULLable because some items don't have a fixed
+    # price.
+    price_excl_tax = models.DecimalField(decimal_places=2, max_digits=12, blank=True, null=True)
+    
+    # Retail price for this item
+    price_retail = models.DecimalField(decimal_places=2, max_digits=12, blank=True, null=True)
     
     # Cost price is optional as not all partner supply it
     cost_price = models.DecimalField(decimal_places=2, max_digits=12, blank=True, null=True)
     
     # Stock level information
-    num_in_stock = models.IntegerField(default=0)
-    num_allocated = models.IntegerField(default=0)
+    num_in_stock = models.IntegerField(default=0, blank=True, null=True)
+    num_allocated = models.IntegerField(default=0, blank=True, null=True)
+    
+    # Date information
+    date_created = models.DateTimeField(auto_now_add=True)
+    date_updated = models.DateTimeField(auto_now=True, db_index=True)
     
     class Meta:
         abstract = True
     
     def decrement_num_in_stock(self, delta):
-        u"""Decrement an item's stock level"""
+        """
+        Decrement an item's stock level
+        """
         if self.num_in_stock >= delta:
             self.num_in_stock -= delta
         self.num_allocated += delta
         self.save()
         
     def set_discount_price(self, price):
-        u"""
+        """
         A setter method for setting a new price.  
         
         This is called from within the "discount" app, which is responsible
@@ -96,14 +106,20 @@ class AbstractStockRecord(models.Model):
     
     @property 
     def price_incl_tax(self):
-        u"""Return a product's price including tax"""
-        return self.price_excl_tax
+        """
+        Return a product's price including tax.
+        
+        This defaults to the price_excl_tax as tax calculations are 
+        domain specific.  This class needs to be subclassed and tax logic
+        added to this method.
+        """
+        return self.price_excl_tax + self.price_tax
     
     @property 
     def price_tax(self):
         u"""Return a product's tax value"""
         return 0
-        
+    
     def __unicode__(self):
         if self.partner_sku:
             return "%s (%s): %s" % (self.partner.name, self.partner_sku, self.product.title)