Stock Ageing report migated to Script report

stock/report/stock_ageing/stock_ageing.js

@@ -0,0 +1,40 @@
+// Copyright (c) 2013, Web Notes Technologies Pvt. Ltd. and Contributors
+// License: GNU General Public License v3. See license.txt
+
+wn.query_reports["Stock Ageing"] = {
+	"filters": [
+		{
+			"fieldname":"company",
+			"label": wn._("Company"),
+			"fieldtype": "Link",
+			"options": "Company",
+			"default": wn.defaults.get_user_default("company"),
+			"reqd": 1
+		},
+		{
+			"fieldname":"to_date",
+			"label": wn._("To Date"),
+			"fieldtype": "Date",
+			"default": wn.datetime.get_today(),
+			"reqd": 1
+		},
+		{
+			"fieldname":"warehouse",
+			"label": wn._("Warehouse"),
+			"fieldtype": "Link",
+			"options": "Warehouse"
+		},
+		{
+			"fieldname":"item_code",
+			"label": wn._("Item"),
+			"fieldtype": "Link",
+			"options": "Item"
+		},
+		{
+			"fieldname":"brand",
+			"label": wn._("Brand"),
+			"fieldtype": "Link",
+			"options": "Brand"
+		}
+	]
+}

stock/report/stock_ageing/stock_ageing.py

@@ -0,0 +1,99 @@
+# Copyright (c) 2013, Web Notes Technologies Pvt. Ltd. and Contributors
+# License: GNU General Public License v3. See license.txt
+
+from __future__ import unicode_literals
+import webnotes
+from webnotes.utils import date_diff
+from webnotes import _
+
+def execute(filters=None):
+	
+	columns = get_columns()
+	item_details = get_fifo_queue(filters)
+	to_date = filters["to_date"]
+	data = []
+	for item, item_dict in item_details.items():
+		fifo_queue = item_dict["fifo_queue"]
+		details = item_dict["details"]
+		if not fifo_queue: continue
+		
+		average_age = get_average_age(fifo_queue, to_date)
+		earliest_age = date_diff(to_date, fifo_queue[0][1])
+		latest_age = date_diff(to_date, fifo_queue[-1][1])
+		
+		data.append([item, details.item_name, details.description, details.brand, 
+			average_age, earliest_age, latest_age, details.stock_uom])
+		
+	return columns, data
+	
+def get_average_age(fifo_queue, to_date):
+	batch_age = age_qty = total_qty = 0.0
+	for batch in fifo_queue:
+		batch_age = date_diff(to_date, batch[1])
+		age_qty += batch_age * batch[0]
+		total_qty += batch[0]
+	
+	return (age_qty / total_qty) if total_qty else 0.0
+	
+def get_columns():
+	return ["Item Code:Link/Item:100", "Item Name::100", "Description::200", 
+		"Brand:Link/Brand:100", "Average Age:Float:100", "Earliest:Int:80", 
+		"Latest:Int:80", "UOM:Link/UOM:100"]
+		
+def get_fifo_queue(filters):
+	item_details = {}
+	for d in get_stock_ledger_entries(filters):
+		item_details.setdefault(d.name, {"details": d, "fifo_queue": []})
+		fifo_queue = item_details[d.name]["fifo_queue"]
+		if d.actual_qty > 0:
+			fifo_queue.append([d.actual_qty, d.posting_date])
+		else:
+			qty_to_pop = abs(d.actual_qty)
+			while qty_to_pop:
+				batch = fifo_queue[0] if fifo_queue else [0, None]
+				if 0 < batch[0] <= qty_to_pop:
+					# if batch qty > 0 
+					# not enough or exactly same qty in current batch, clear batch
+					qty_to_pop -= batch[0]
+					fifo_queue.pop(0)
+				else:
+					# all from current batch
+					batch[0] -= qty_to_pop
+					qty_to_pop = 0
+
+	return item_details
+	
+def get_stock_ledger_entries(filters):
+	if not filters.get("company"):
+		webnotes.throw(_("Company is mandatory"))
+	if not filters.get("to_date"):
+		webnotes.throw(_("To Date is mandatory"))
+	
+	return webnotes.conn.sql("""select 
+			item.name, item.item_name, brand, description, item.stock_uom, actual_qty, posting_date
+		from `tabStock Ledger Entry` sle,
+			(select name, item_name, description, stock_uom, brand
+				from `tabItem` {item_conditions}) item
+		where item_code = item.name and
+			company = %(company)s and
+			posting_date <= %(to_date)s
+			{sle_conditions}
+			order by posting_date, posting_time, sle.name"""\
+		.format(item_conditions=get_item_conditions(filters),
+			sle_conditions=get_sle_conditions(filters)), filters, as_dict=True)
+	
+def get_item_conditions(filters):
+	conditions = []
+	if filters.get("item_code"):
+		conditions.append("item_code=%(item_code)s")
+	if filters.get("brand"):
+		conditions.append("brand=%(brand)s")
+	
+	return "where {}".format(" and ".join(conditions)) if conditions else ""
+	
+def get_sle_conditions(filters):
+	conditions = []
+	if filters.get("warehouse"):
+		conditions.append("warehouse=%(warehouse)s")
+	
+	return "and {}".format(" and ".join(conditions)) if conditions else ""

stock/report/stock_ageing/stock_ageing.txt

@@ -0,0 +1,21 @@
+[
+ {
+  "creation": "2013-12-02 17:09:31", 
+  "docstatus": 0, 
+  "modified": "2013-12-02 17:09:31", 
+  "modified_by": "Administrator", 
+  "owner": "Administrator"
+ }, 
+ {
+  "doctype": "Report", 
+  "is_standard": "Yes", 
+  "name": "__common__", 
+  "ref_doctype": "Item", 
+  "report_name": "Stock Ageing", 
+  "report_type": "Script Report"
+ }, 
+ {
+  "doctype": "Report", 
+  "name": "Stock Ageing"
+ }
+]