feat(formula): year,month,day functions

packages/engine-formula/src/functions/date/day/__tests__/index.spec.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http:https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { describe, expect, it } from 'vitest';
+
+import { FUNCTION_NAMES_DATE } from '../../function-names';
+import { Day } from '..';
+import { NumberValueObject } from '../../../../engine/value-object/primitive-object';
+import { ArrayValueObject, transformToValue, transformToValueObject } from '../../../../engine/value-object/array-value-object';
+
+describe('Test day function', () => {
+ const textFunction = new Day(FUNCTION_NAMES_DATE.DAY);
+
+ describe('Day', () => {
+ it('Serial number is normal', () => {
+ const serialNumber = new NumberValueObject(43831);
+ const result = textFunction.calculate(serialNumber);
+ expect(result.getValue()).toStrictEqual(1);
+ });
+
+ it('Serial number is array', () => {
+ const serialNumber = new ArrayValueObject({
+ calculateValueList: transformToValueObject([[1, ' ', 1.23, true, false, null],
+ [0, '100', '2.34', 'test', -3, 1900]]),
+ rowCount: 2,
+ columnCount: 6,
+ unitId: '',
+ sheetId: '',
+ row: 0,
+ column: 0,
+ });
+ const result = textFunction.calculate(serialNumber);
+ expect(transformToValue(result.getArrayValue())).toStrictEqual([[1, '#VALUE!', 1, 1, 0, '#VALUE!'], [0, 9, 2, '#VALUE!', '#NUM!', 14]]);
+ });
+ });
+});

packages/engine-formula/src/functions/date/day/index.ts

@@ -0,0 +1,67 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http:https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { excelSerialToDate } from '../../../basics/date';
+import { ErrorType } from '../../../basics/error-type';
+import type { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { ErrorValueObject } from '../../../engine/value-object/base-value-object';
+import { NumberValueObject } from '../../../engine/value-object/primitive-object';
+import { BaseFunction } from '../../base-function';
+
+export class Day extends BaseFunction {
+ override calculate(serialNumber: BaseValueObject) {
+ if (serialNumber == null) {
+ return new ErrorValueObject(ErrorType.NA);
+ }
+
+ if (serialNumber.isError()) {
+ return serialNumber;
+ }
+
+ if (serialNumber.isArray()) {
+ return serialNumber.map((serialNumberObject) => {
+ if (serialNumberObject.isError()) {
+ return serialNumberObject;
+ }
+
+ if (serialNumberObject.isString() || serialNumberObject.isNull()) {
+ return new ErrorValueObject(ErrorType.VALUE);
+ }
+
+ const dateSerial = +serialNumberObject.getValue();
+
+ if (dateSerial < 0) {
+ return new ErrorValueObject(ErrorType.NUM);
+ }
+
+ // Excel serial 0 is 1900-01-00
+ // Google Sheets serial 0 is 1899-12-30
+ if (dateSerial === 0) {
+ return new NumberValueObject(0);
+ }
+
+ const date = excelSerialToDate(dateSerial);
+
+ const month = date.getDate();
+ const valueObject = new NumberValueObject(month);
+
+ return valueObject;
+ });
+ }
+
+ return new NumberValueObject(excelSerialToDate(+serialNumber.getValue()).getDate());
+ }
+}

packages/engine-formula/src/functions/date/edate/__tests__/index.spec.ts

@@ -47,6 +47,24 @@ describe('Test edate function', () => {
  expect(transformToValue(result.getArrayValue())).toStrictEqual([[43863], [43864]]);
  });
 
+ it('Start date is array with multiple format values', () => {
+ const startDate = new ArrayValueObject({
+ calculateValueList: transformToValueObject([
+ [1, ' ', 1.23, true, false, null],
+ [0, '100', '2.34', 'test', -3, 1900],
+ ]),
+ rowCount: 2,
+ columnCount: 6,
+ unitId: '',
+ sheetId: '',
+ row: 0,
+ column: 0,
+ });
+ const months = new NumberValueObject(1);
+ const result = textFunction.calculate(startDate, months);
+ expect(transformToValue(result.getArrayValue())).toStrictEqual([[32, '#VALUE!', 32, '#VALUE!', '#VALUE!', '#VALUE!'], [31, 130, 33, '#VALUE!', '#NUM!', 1931]]);
+ });
+
  it('Months is array', () => {
  const startDate = new NumberValueObject(43831);
  const months = new ArrayValueObject({
@@ -61,5 +79,21 @@ describe('Test edate function', () => {
  const result = textFunction.calculate(startDate, months);
  expect(transformToValue(result.getArrayValue())).toStrictEqual([[43862], [43891]]);
  });
+
+ it('Months is array with multiple format values', () => {
+ const startDate = new NumberValueObject(43831);
+ const months = new ArrayValueObject({
+ calculateValueList: transformToValueObject([[1, ' ', 1.23, true, false, null],
+ [0, '100', '2.34', 'test', -3, 1900]]),
+ rowCount: 2,
+ columnCount: 6,
+ unitId: '',
+ sheetId: '',
+ row: 0,
+ column: 0,
+ });
+ const result = textFunction.calculate(startDate, months);
+ expect(transformToValue(result.getArrayValue())).toStrictEqual([[43862, '#VALUE!', 43862, '#VALUE!', '#VALUE!', '#VALUE!'], [43831, 46874, 43891, '#VALUE!', 43739, 101660]]);
+ });
  });
 });

packages/engine-formula/src/functions/date/edate/index.ts

@@ -23,6 +23,9 @@ import { ErrorValueObject } from '../../../engine/value-object/base-value-object
 import { NumberValueObject } from '../../../engine/value-object/primitive-object';
 import { BaseFunction } from '../../base-function';
 
+/**
+ * TODO@Dushusir: support plaine text date: =EDATE("2020-1-1",1), =EDATE("2020/1/1",1) and other formats
+ */
 export class Edate extends BaseFunction {
  override calculate(startDate: BaseValueObject, months: BaseValueObject) {
  if (startDate == null || months == null) {
@@ -49,31 +52,36 @@ export class Edate extends BaseFunction {
  months.isArray() ? (months as ArrayValueObject).getColumnCount() : 1
  );
 
- const yearArray = expandArrayValueObject(maxRowLength, maxColumnLength, startDate);
- const monthArray = expandArrayValueObject(maxRowLength, maxColumnLength, months);
+ const startDateArray = expandArrayValueObject(maxRowLength, maxColumnLength, startDate);
+ const monthsArray = expandArrayValueObject(maxRowLength, maxColumnLength, months);
 
- return yearArray.map((startDateObject, rowIndex, columnIndex) => {
- const monthValueObject = monthArray.get(rowIndex, columnIndex);
+ return startDateArray.map((startDateObject, rowIndex, columnIndex) => {
+ const monthsValueObject = monthsArray.get(rowIndex, columnIndex);
 
  if (startDateObject.isError()) {
  return startDateObject;
  }
 
- if (monthValueObject.isError()) {
- return monthValueObject;
+ if (monthsValueObject.isError()) {
+ return monthsValueObject;
  }
 
- if (startDateObject.isString() || monthValueObject.isString()) {
+ if (startDateObject.isString() || startDateObject.isNull() || startDateObject.isBoolean() || monthsValueObject.isString() || monthsValueObject.isNull() || monthsValueObject.isBoolean()) {
  return new ErrorValueObject(ErrorType.VALUE);
  }
 
  const startDateSerial = +startDateObject.getValue();
- const monthValue = Math.floor(+monthValueObject.getValue());
+
+ if (startDateSerial < 0) {
+ return new ErrorValueObject(ErrorType.NUM);
+ }
+
+ const monthsValue = Math.floor(+monthsValueObject.getValue());
 
  const startDate = excelSerialToDate(startDateSerial);
 
  const year = startDate.getUTCFullYear();
- const month = startDate.getUTCMonth() + monthValue;
+ const month = startDate.getUTCMonth() + monthsValue;
  const day = startDate.getUTCDate();
 
  const resultDate = new Date(Date.UTC(year, month, day));

packages/engine-formula/src/functions/date/function-map.ts

@@ -15,12 +15,18 @@
  */
 
 import { DateFunction } from './date';
+import { Day } from './day';
 import { Edate } from './edate';
 import { FUNCTION_NAMES_DATE } from './function-names';
+import { Month } from './month';
 import { Today } from './today';
+import { Year } from './year';
 
 export const functionDate = [
- [Today, FUNCTION_NAMES_DATE.TODAY],
  [DateFunction, FUNCTION_NAMES_DATE.DATE],
+ [Day, FUNCTION_NAMES_DATE.DAY],
  [Edate, FUNCTION_NAMES_DATE.EDATE],
+ [Month, FUNCTION_NAMES_DATE.MONTH],
+ [Today, FUNCTION_NAMES_DATE.TODAY],
+ [Year, FUNCTION_NAMES_DATE.YEAR],
 ];

packages/engine-formula/src/functions/date/month/__tests__/index.spec.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http:https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { describe, expect, it } from 'vitest';
+
+import { FUNCTION_NAMES_DATE } from '../../function-names';
+import { Month } from '..';
+import { NumberValueObject } from '../../../../engine/value-object/primitive-object';
+import { ArrayValueObject, transformToValue, transformToValueObject } from '../../../../engine/value-object/array-value-object';
+
+describe('Test month function', () => {
+ const textFunction = new Month(FUNCTION_NAMES_DATE.MONTH);
+
+ describe('Month', () => {
+ it('Serial number is normal', () => {
+ const serialNumber = new NumberValueObject(43831);
+ const result = textFunction.calculate(serialNumber);
+ expect(result.getValue()).toStrictEqual(1);
+ });
+
+ it('Serial number is array', () => {
+ const serialNumber = new ArrayValueObject({
+ calculateValueList: transformToValueObject([[1, ' ', 1.23, true, false, null],
+ [0, '100', '2.34', 'test', -3, 1900]]),
+ rowCount: 2,
+ columnCount: 6,
+ unitId: '',
+ sheetId: '',
+ row: 0,
+ column: 0,
+ });
+ const result = textFunction.calculate(serialNumber);
+ expect(transformToValue(result.getArrayValue())).toStrictEqual([[1, '#VALUE!', 1, 1, 1, '#VALUE!'], [1, 4, 1, '#VALUE!', '#NUM!', 3]]);
+ });
+ });
+});

packages/engine-formula/src/functions/date/month/index.ts

@@ -0,0 +1,67 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http:https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { excelSerialToDate } from '../../../basics/date';
+import { ErrorType } from '../../../basics/error-type';
+import type { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { ErrorValueObject } from '../../../engine/value-object/base-value-object';
+import { NumberValueObject } from '../../../engine/value-object/primitive-object';
+import { BaseFunction } from '../../base-function';
+
+export class Month extends BaseFunction {
+ override calculate(serialNumber: BaseValueObject) {
+ if (serialNumber == null) {
+ return new ErrorValueObject(ErrorType.NA);
+ }
+
+ if (serialNumber.isError()) {
+ return serialNumber;
+ }
+
+ if (serialNumber.isArray()) {
+ return serialNumber.map((serialNumberObject) => {
+ if (serialNumberObject.isError()) {
+ return serialNumberObject;
+ }
+
+ if (serialNumberObject.isString() || serialNumberObject.isNull()) {
+ return new ErrorValueObject(ErrorType.VALUE);
+ }
+
+ const dateSerial = +serialNumberObject.getValue();
+
+ if (dateSerial < 0) {
+ return new ErrorValueObject(ErrorType.NUM);
+ }
+
+ // Excel serial 0 is 1900-01-00
+ // Google Sheets serial 0 is 1899-12-30
+ if (dateSerial === 0) {
+ return new NumberValueObject(1);
+ }
+
+ const date = excelSerialToDate(dateSerial);
+
+ const month = date.getUTCMonth() + 1;
+ const valueObject = new NumberValueObject(month);
+
+ return valueObject;
+ });
+ }
+
+ return new NumberValueObject(excelSerialToDate(+serialNumber.getValue()).getUTCMonth() + 1);
+ }
+}