brotherton-erpnext/erpnext/buying/page/purchase_analytics/purchase_analytics.js

// Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
// License: GNU General Public License v3. See license.txt

frappe.pages['purchase-analytics'].on_page_load = function(wrapper) {
	frappe.ui.make_app_page({
		parent: wrapper,
		title: __('Purchase Analytics'),
		single_column: true
	});

	new erpnext.PurchaseAnalytics(wrapper);

	frappe.breadcrumbs.add("Buying");
}

erpnext.PurchaseAnalytics = frappe.views.TreeGridReport.extend({
	init: function(wrapper) {
		this._super({
			title: __("Purchase Analytics"),
			parent: $(wrapper).find('.layout-main'),
			page: wrapper.page,
			doctypes: ["Item", "Item Group", "Supplier", "Supplier Group", "Company", "Fiscal Year",
				"Purchase Invoice", "Purchase Invoice Item",
				"Purchase Order", "Purchase Order Item[Purchase Analytics]",
				"Purchase Receipt", "Purchase Receipt Item[Purchase Analytics]"],
			tree_grid: { show: true }
		});

		this.tree_grids = {
			"Supplier Group": {
				label: __("Supplier Group / Supplier"),
				show: true,
				item_key: "supplier",
				parent_field: "parent_supplier_group",
				formatter: function(item) {
					return item.supplier_name ? item.supplier_name + " (" + item.name + ")" : item.name;
				}
			},
			"Supplier": {
				label: __("Supplier"),
				show: false,
				item_key: "supplier",
				formatter: function(item) {
					return item.supplier_name ? item.supplier_name + " (" + item.name + ")" : item.name;
				}
			},
			"Item Group": {
				label: "Item",
				show: true,
				parent_field: "parent_item_group",
				item_key: "item_code",
				formatter: function(item) {
					return item.name;
				}
			},
			"Item": {
				label: "Item",
				show: false,
				item_key: "item_code",
				formatter: function(item) {
					return item.name;
				}
			},
		}
	},
	setup_columns: function() {
		this.tree_grid = this.tree_grids[this.tree_type];

		var std_columns = [
			{id: "name", name: this.tree_grid.label, field: "name", width: 300},
			{id: "total", name: "Total", field: "total", plot: false,
				formatter: this.currency_formatter}
		];

		this.make_date_range_columns();
		this.columns = std_columns.concat(this.columns);
	},
	filters: [
		{fieldtype:"Select", label: __("Tree Type"), fieldname: "tree_type",
			options:["Supplier Group", "Supplier", "Item Group", "Item"],
			filter: function(val, item, opts, me) {
				return me.apply_zero_filter(val, item, opts, me);
			}},
		{fieldtype:"Select", label: __("Based On"), fieldname: "based_on",
			options:["Purchase Invoice", "Purchase Order", "Purchase Receipt"]},
		{fieldtype:"Select", label: __("Value or Qty"), fieldname: "value_or_qty",
			options:["Value", "Quantity"]},
		{fieldtype:"Select", label: __("Company"), link:"Company", fieldname: "company",
			default_value: __("Select Company...")},
		{fieldtype:"Date", label: __("From Date"), fieldname: "from_date"},
		{fieldtype:"Date", label: __("To Date"), fieldname: "to_date"},
		{fieldtype:"Select", label: __("Range"), fieldname: "range",
			options:[{label: __("Daily"), value: "Daily"}, {label: __("Weekly"), value: "Weekly"},
				{label: __("Monthly"), value: "Monthly"}, {label: __("Quarterly"), value: "Quarterly"},
				{label: __("Yearly"), value: "Yearly"}]}
	],
	setup_filters: function() {
		var me = this;
		this._super();

		this.trigger_refresh_on_change(["value_or_qty", "tree_type", "based_on", "company"]);

		this.show_zero_check();
	},
	init_filter_values: function() {
		this._super();
		this.filter_inputs.range.val('Monthly');
	},
	prepare_data: function() {
		var me = this;
		if (!this.tl) {
			// add 'Not Set' Supplier & Item
			// (Supplier / Item are not mandatory!!)
			frappe.report_dump.data["Supplier"].push({
				name: __("Not Set"),
				parent_supplier_group: __("All Supplier Groups"),
				id: "Not Set",
			});

			frappe.report_dump.data["Item"].push({
				name: __("Not Set"),
				parent_item_group: "All Item Groups",
				id: "Not Set",
			});
		}

		if (!this.tl || !this.tl[this.based_on]) {
			this.make_transaction_list(this.based_on, this.based_on + " Item");
		}


		if(!this.data || me.item_type != me.tree_type) {
			var items;
			if(me.tree_type=='Supplier') {
				items = frappe.report_dump.data["Supplier"];
			} else if(me.tree_type=='Supplier Group') {
				items = this.prepare_tree("Supplier", "Supplier Group");
			} else if(me.tree_type=="Item Group") {
				items = this.prepare_tree("Item", "Item Group");
			} else if(me.tree_type=="Item") {
				items = frappe.report_dump.data["Item"];
			}

			me.item_type = me.tree_type
			me.parent_map = {};
			me.item_by_name = {};
			me.data = [];

			$.each(items, function(i, v) {
				var d = copy_dict(v);

				me.data.push(d);
				me.item_by_name[d.name] = d;
				if(d[me.tree_grid.parent_field]) {
					me.parent_map[d.name] = d[me.tree_grid.parent_field];
				}
				me.reset_item_values(d);
			});

			this.set_indent();

		} else {
			// otherwise, only reset values
			$.each(this.data, function(i, d) {
				me.reset_item_values(d);
			});
		}

		this.prepare_balances();
		if(me.tree_grid.show) {
			this.set_totals(false);
			this.update_groups();
		} else {
			this.set_totals(true);
		}
	},
	prepare_balances: function() {
		var me = this;
		var from_date = frappe.datetime.str_to_obj(this.from_date);
		var to_date = frappe.datetime.str_to_obj(this.to_date);
		var is_val = this.value_or_qty == 'Value';

		$.each(this.tl[this.based_on], function(i, tl) {
			if (me.is_default('company') ? true : tl.company === me.company) {
				var posting_date = frappe.datetime.str_to_obj(tl.posting_date);
				if (posting_date >= from_date && posting_date <= to_date) {
					var item = me.item_by_name[tl[me.tree_grid.item_key]] ||
						me.item_by_name['Not Set'];
					item[me.column_map[tl.posting_date].field] += (is_val ? tl.base_net_amount : tl.qty);
				}
			}
		});
	},
	update_groups: function() {
		var me = this;

		$.each(this.data, function(i, item) {
			var parent = me.parent_map[item.name];
			while(parent) {
				var parent_group = me.item_by_name[parent];

				$.each(me.columns, function(c, col) {
					if (col.formatter == me.currency_formatter) {
						parent_group[col.field] =
							flt(parent_group[col.field])
							+ flt(item[col.field]);
					}
				});
				parent = me.parent_map[parent];
			}
		});
	},
	set_totals: function(sort) {
		var me = this;
		var checked = false;
		$.each(this.data, function(i, d) {
			d.total = 0.0;
			$.each(me.columns, function(i, col) {
				if(col.formatter==me.currency_formatter && !col.hidden && col.field!="total")
					d.total += d[col.field];
				if(d.checked) checked = true;
			})
		});

		if(sort)this.data = this.data.sort(function(a, b) { return b.total - a.total; });

		if(!this.checked) {
			this.data[0].checked = true;
		}
	}
});