WMS_MAIN/app/lib/report/formatters.js

168 lines
5.0 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

'use strict';
/**
* 报表单元格格式化器注册表(纯函数模块,无 ctx 依赖,可单测)。
*
* 设计约定:
* 1. 所有格式化器首参为单元格原始值(value),其余参数为格式化参数;
* 2. 数值计算统一走「截断取整」(等价旧 PHP 的 intval 语义,向零取整);
* 3. 低库存补偿口径与旧 PHP《7日出入库数据》保持一致:
* 可用库存 < 20 且 7 日入库 < 20 时视为低库存,触发补偿与预警。
*/
/**
* 安全转数值:非有限数值一律按 0 处理。
* @param {*} value 原始值
* @return {number} 数值
*/
function toFiniteNumber(value) {
const number = Number(value);
return Number.isFinite(number) ? number : 0;
}
/**
* 截断取整(PHP intval 语义,向零取整)。
* @param {*} value 原始值
* @return {number} 整数
*/
function integer(value) {
return Math.trunc(toFiniteNumber(value));
}
/**
* 零值占位:0 / '0' / null / undefined / '' 统一显示为 '-'。
* 说明:'0' 一并转 '-',与 PHP empty('0') 为真的旧口径保持一致。
* @param {*} value 原始值
* @return {*} 非零原值或 '-'
*/
function zeroToDash(value) {
if (value === 0 || value === '0' || value === null || value === undefined || value === '') {
return '-';
}
return value;
}
/**
* 布尔转中文:真值 → '是',假值 → '否'。
* 说明:''、0、'0'、null、undefined、false 均视为假,与 PHP 布尔语义对齐。
* @param {*} flag 原始值
* @return {string} '是' 或 '否'
*/
function yesNo(flag) {
const falsy = flag === false
|| flag === null
|| flag === undefined
|| flag === ''
|| flag === 0
|| flag === '0'
|| String(flag).toLowerCase() === 'false';
return falsy ? '否' : '是';
}
/**
* 7 日日均 ×10 取整(保留一位小数但避免浮点误差)。
* 公式:int(total / days * 10),与旧 PHP intval($ck / 7 * 10) 一致。
* @param {*} value 周期合计值
* @param {*} days 天数
* @return {number} 日均×10 的整数
*/
function avgDaysPerWeek(value, days) {
const total = toFiniteNumber(value);
const dayCount = toFiniteNumber(days);
if (dayCount <= 0) {
return 0;
}
return Math.trunc((total / dayCount) * 10);
}
/**
* 建议补货量(含低库存补偿):
* 基础值 int(ck_total / 7 * 10);仅当低库存(available < 20 且 rk_total < 20)时
* 补偿到不低于 30(保证低库存货主获得最小补货建议)。
* @param {*} ckTotal 7 日总出库
* @param {*} available 可用库存
* @param {*} rkTotal 7 日总入库
* @return {number} 建议补货量
*/
function suggestWithCompensate(ckTotal, available, rkTotal) {
const base = Math.trunc((toFiniteNumber(ckTotal) / 7) * 10);
const availableNumber = toFiniteNumber(available);
const rkNumber = toFiniteNumber(rkTotal);
if (availableNumber < 20 && rkNumber < 20) {
return Math.max(base, 30);
}
return base;
}
/**
* 库存预警判定(布尔):
* 1. 按 7 日均出库 ×4 折算的周转阈值高于可用库存(int(ck/7*4) - available > 0);
* 2. 或处于低库存状态(available < 20 且 rk_total < 20)。
* 展示时建议叠加 yesNo 格式化器转中文。
* @param {*} ckTotal 7 日总出库
* @param {*} available 可用库存
* @param {*} rkTotal 7 日总入库
* @return {boolean} 是否预警
*/
function warnOf(ckTotal, available, rkTotal) {
const threshold = Math.trunc((toFiniteNumber(ckTotal) / 7) * 4);
return threshold - toFiniteNumber(available) > 0
|| (toFiniteNumber(available) < 20 && toFiniteNumber(rkTotal) < 20);
}
/**
* 文本前缀工厂:返回一个给文本加前缀的格式化函数。
* 典型用法:`'` 前缀防科学计数法(Excel 将长数字串强制按文本展示)。
* @param {string} [prefix=''] 前缀
* @return {Function} 格式化函数 (value) => `${prefix}${value}`
*/
function textPrefix(prefix = '') {
return value => `${String(prefix || '')}${value === null || value === undefined ? '' : String(value)}`;
}
/**
* 格式化器注册表(配置驱动报表按名称引用)。
* @type {Object<string, Function>}
*/
const FORMATTERS = Object.freeze({
textPrefix: (value, prefix) => textPrefix(prefix)(value),
zeroToDash,
yesNo,
integer,
avgDaysPerWeek,
suggestWithCompensate,
warnOf,
});
/**
* 按名称应用格式化器。
* @param {string} name 格式化器名称
* @param {*} value 单元格原始值
* @param {...*} args 格式化器额外参数
* @return {*} 格式化结果
* @throws {Error} 未知格式化器名称时抛出
*/
function applyFormat(name, value, ...args) {
const formatterName = String(name || '').trim();
if (!formatterName) {
return value;
}
const formatter = FORMATTERS[formatterName];
if (typeof formatter !== 'function') {
throw new Error(`未知的报表格式化器: ${formatterName}`);
}
return formatter(value, ...args);
}
module.exports = {
FORMATTERS,
applyFormat,
textPrefix,
zeroToDash,
yesNo,
integer,
avgDaysPerWeek,
suggestWithCompensate,
warnOf,
};