cron-converter-u2q 0.1.15 → 0.1.20

package/README.md

@@ -15,13 +15,13 @@ Easily convert cron expressions between Unix and Quartz formats with the `cron-c
 Using npm:
 
 ```bash
-npm install cron-converter
+npm install cron-converter-u2q
 ```
 
 Using yarn:
 
 ```bash
-yarn add cron-converter
+yarn add cron-converter-u2q
 ```
 
 ### Usage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cron-converter-u2q",
-  "version": "0.1.15",
+  "version": "0.1.20",
   "description": "Converts cron expressions between unix and quartz formats",
   "main": "lib/index.js",
   "types": "types/index.d.ts",

package/src/__tests__/index.test.ts

@@ -1,41 +1,86 @@
-import { CronConverterU2Q as c2q } from '../index';
+import { CronConverterU2Q as converter, CronDescriberU2Q as describer } from '../index';
 
 //Basic suite of tests
 describe('Unix2Quartz Conversion', () => {
 
+    test('Every minute', () => {
+        const result = converter.unixToQuartz('* * * * *');
+        expect(result).toBe("0 * * ? * *");
+    });
+
     test('Every 5 minutes', () => {
-        const result = c2q.unixToQuartz('*/5 * * * *');
+        const result = converter.unixToQuartz('*/5 * * * *');
         expect(result).toBe("0 */5 * ? * *");
     });
 
+    test('Every hour at minute 30', () => {
+        const result = converter.unixToQuartz('30 * * * *');
+        expect(result).toBe("0 30 * ? * *");
+    });
+
     test('Everyday at 12pm', () => {
-        const result = c2q.unixToQuartz('0 12 * * *');
+        const result = converter.unixToQuartz('0 12 * * *');
         expect(result).toBe("0 0 12 ? * *");
     });
 
-    test('Every Monday at 12pm conversion', () => {
-        const result = c2q.unixToQuartz('0 12 * * 1');
+    test('Every Monday at 12pm', () => {
+        const result = converter.unixToQuartz('0 12 * * 1');
         expect(result).toBe("0 0 12 ? * 1");
     });
 
-    test('Every 10th day of the month conversion', () => {
-        const result = c2q.unixToQuartz('0 0 10 * *');
+    test('Every 10th day of the month', () => {
+        const result = converter.unixToQuartz('0 0 10 * *');
         expect(result).toBe("0 0 0 10 * ?");
     });
 
-    test('Every January 1st at 12am conversion', () => {
-        const result = c2q.unixToQuartz('0 0 1 1 *');
+    test('Every January 1st at 12am', () => {
+        const result = converter.unixToQuartz('0 0 1 1 *');
         expect(result).toBe("0 0 0 1 1 ?");
     });
 
-    test('Every last day of the month conversion', () => {
-        const result = c2q.unixToQuartz('59 23 L * *');
+    test('Every last day of the month', () => {
+        const result = converter.unixToQuartz('59 23 L * *');
         expect(result).toBe("0 59 23 L * ?");
     });
 
-    //Failing test case
+    test('Every day at 2:30 AM', () => {
+        const result = converter.unixToQuartz('30 2 * * *');
+        expect(result).toBe('0 30 2 ? * *');
+    });
+
+    test('Every Monday at 2:30 AM', () => {
+        const result = converter.unixToQuartz('30 2 * * 1');
+        expect(result).toBe('0 30 2 ? * 1');
+    });
+
+    test('Every day at 1:00 AM and 1:00 PM', () => {
+        const result = converter.unixToQuartz('0 1,13 * * *');
+        expect(result).toBe('0 0 1,13 ? * *');
+    });
+
+    test('Every 15 minutes', () => {
+        const result = converter.unixToQuartz('*/15 * * * *');
+        expect(result).toBe('0 */15 * ? * *');
+    });
+
+    //Include
+    // test('Last day of every month at 4:45 PM conversion', () => {
+    //     const result = converter.unixToQuartz('45 16 28-31 * *');
+    //     expect(result).toBe('45 16 L * ?');
+    // });
+
+    // test('Last Sunday of every month at 4:45 PM conversion', () => {
+    //     const result = converter.unixToQuartz('45 16 22-31 * 0');
+    //     expect(result).toBe('45 16 ? * 7L');
+    // });
+
+    // test('Second Wednesday of every month at 1:00 AM conversion', () => {
+    //     const result = converter.quartzToUnix('0 1 ? * 3#2');
+    //     expect(result).toBe('Not directly possible without additional logic');
+    // });
+
     // test('Every last Friday of the month conversion', () => {
-    //     const result = c2q.unixToQuartz('0 0 L * 5');
+    //     const result = converter.unixToQuartz('0 0 * * 5'); //Find equivalent unix expression
     //     expect(result).toBe("0 0 0 ? * 5L");
     // });
 
@@ -45,38 +90,42 @@ describe('Unix2Quartz Conversion', () => {
 describe('Quartz2Unix Conversion', () => {
 
     test('Every 5 minutes conversion', () => {
-        const result = c2q.quartzToUnix('0 */5 * ? * *');
+        const result = converter.quartzToUnix('0 */5 * ? * *');
         expect(result).toBe("*/5 * * * *");
     });
 
     test('Everyday at 12pm conversion', () => {
-        const result = c2q.quartzToUnix('0 0 12 ? * *');
+        const result = converter.quartzToUnix('0 0 12 ? * *');
         expect(result).toBe("0 12 * * *");
     });
 
     test('Every Monday at 12pm conversion', () => {
-        const result = c2q.quartzToUnix('0 0 12 ? * 1');
+        const result = converter.quartzToUnix('0 0 12 ? * 1');
         expect(result).toBe("0 12 * * 1");
     });
 
     test('Every 10th day of the month conversion', () => {
-        const result = c2q.quartzToUnix('0 0 0 10 * ?');
+        const result = converter.quartzToUnix('0 0 0 10 * ?');
         expect(result).toBe("0 0 10 * *");
     });
 
     test('Every January 1st at 12am conversion', () => {
-        const result = c2q.quartzToUnix('0 0 0 1 1 ?');
+        const result = converter.quartzToUnix('0 0 0 1 1 ?');
         expect(result).toBe("0 0 1 1 *");
     });
 
     test('Every last day of the month conversion', () => {
-        const result = c2q.quartzToUnix('0 59 23 L * ?');
+        const result = converter.quartzToUnix('0 59 23 L * ?');
         expect(result).toBe("59 23 L * *");
     });
+});
 
-    //Failing test case
-    // test('Every last Friday of the month conversion', () => {
-    //     const result = c2q.quartzToUnix('0 0 0 ? * 5L');
-    //     expect(result).toBe("0 0 L * 5");
-    // });
-});
+
+
+// describe('Unix Description', () => {
+
+//     test('Describe every 5 minutes', () => {
+//         const result = describer.describe('*/5 * * * *');
+//         expect(result).toBe("Every 5 minutes");
+//     });
+// });

package/src/converter.ts

@@ -1,8 +1,6 @@
-export class CronConverterU2Q {
+import { ExpressionHelper as helper } from './helper';
 
-    static readonly delimiter = ' ';
-    static readonly unixExpressionLength = 5;
-    static readonly quartzExpressionLengths = [6, 7];
+export class CronConverterU2Q {
     static readonly everyXUnitsReplacePlaceholder = `%s`
     static readonly quartzEveryXUnitsRegex = /^0\/(\d+)$/; // For handling 0/5 units
     static readonly unixEveryXUnitsRegex = /^\/(\d+)$/; // For handling */5 units
@@ -15,14 +13,16 @@ export class CronConverterU2Q {
      * @returns the corresponding quartz expression
      */
     public static unixToQuartz(unixExpression: string): string {
+        const parts = helper.GetExpressionParts(unixExpression);
+        const [min, hour, dom, month, dow] = parts.map(part => this.convertIntervalParts(part));
 
-        this.validateIfNullOrEmpty(unixExpression);
-        const parts = unixExpression.split(this.delimiter);
-        if (parts.length !== this.unixExpressionLength) throw new Error(`Invalid unix cron format`);
+        // Converting Unix DOW to Quartz DOW
+        let quartzDow = dow.includes(',') ? dow.split(',').map(day => {
+            if (day === '0' || day === '7') return '1';
+            return (parseInt(day, 10) + 1).toString();
+        }).join(',') : dow;
 
-        const [min, hour, dom, month, dow] = parts.map(part => this.convertIntervalParts(part));
         let quartzDom = dom;
-        let quartzDow = dow;
 
         if (dom !== '*' && dow === '*') quartzDow = '?';
         else if (dom === '*') quartzDom = '?';
@@ -36,23 +36,27 @@ export class CronConverterU2Q {
      * @returns the corresponding unix expression
      */
     public static quartzToUnix(quartzExpression: string): string {
+        const parts = helper.GetExpressionParts(quartzExpression);
+        const [_, min, hour, dom, month, dow] = parts.map(part => this.convertIntervalParts(part, true));
 
-        this.validateIfNullOrEmpty(quartzExpression);
-        const parts = quartzExpression.replace('?', '*').split(this.delimiter);
-        if (!this.quartzExpressionLengths.includes(parts.length)) throw new Error(`Invalid quartz cron format`);
 
-        const [_, min, hour, dom, month, dow] = parts.map(part => this.convertIntervalParts(part, true));
+        // Converting Quartz DOW to Unix DOW
+        let unixDow = dow.includes(',') ? dow.split(',').map(day => {
+            if (day === '1') return '0';
+            if (day === '?') return '*';
+            return (parseInt(day, 10) - 1).toString();
+        }).join(',') : dow;
 
-        return `${min} ${hour} ${dom} ${month} ${dow}`;
-    }
+        let unixDom = dom;
+
+        // If dow in Quartz was '?', set unixDom to '*'
+        if (dow === '?') unixDom = '*';
 
-    private static validateIfNullOrEmpty(cronExpression: string | undefined | null): void {
-        if (!cronExpression || cronExpression.trim() === '') throw new Error('Empty or null expression');
+
+        return `${min} ${hour} ${unixDom} ${month} ${unixDow}`;
     }
 
     private static convertIntervalParts(part: string, isQuartz = false): string {
-        part = part.trim();
-
         const everyXUnitsPattern = isQuartz ? this.quartzEveryXUnitsRegex : this.unixEveryXUnitsRegex;
         const matches = part.match(everyXUnitsPattern);
         const everyXUnitsReplacePattern = isQuartz ? this.quartzEveryXUnitsReplacePattern : this.unixEveryXUnitsReplacePattern;

package/src/describer.ts

@@ -0,0 +1,58 @@
+import { ExpressionHelper as helper } from './helper';
+
+export class CronDescriberU2Q {
+
+    public static describe(expression: string): string {
+        const [second, min, hour, dom, month, dow] = helper.GetExpressionParts(expression);
+        return `${this.describeSecond(second)} ${this.describeMinute(min)} ${this.describeHour(hour)} ${this.describeDayOfMonth(dom)} ${this.describeMonth(month)} ${this.describeDayOfWeek(dow)}`.trim();
+    }
+
+    // #region Standard cron description logic 
+
+    private static describeSecond(second: string): string {
+        if (second === '*') return 'Every second';
+        if (second.startsWith('*/')) return `Every ${second.split('/')[1]} seconds`;
+        return `At second ${second}`;
+    }
+
+    private static describeMinute(min: string): string {
+        if (min === '*') return 'Every minute';
+        if (min.startsWith('*/')) return `Every ${min.split('/')[1]} minutes`;
+        return `At minute ${min}`;
+    }
+
+    private static describeHour(hour: string): string {
+        if (hour === '*') return 'of every hour';
+        if (hour.startsWith('*/')) return `Every ${hour.split('/')[1]} hours`;
+        return `At ${hour} o'clock`;
+    }
+
+    private static describeDayOfMonth(dom: string): string {
+        if (dom === '*') return 'on every day';
+        return `on the ${this.ordinalSuffix(Number(dom))} of the month`;
+    }
+
+    private static describeMonth(month: string): string {
+        if (month === '*') return 'of every month';
+        const months = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'];
+        return `in ${months[Number(month) - 1]}`;
+    }
+
+    private static describeDayOfWeek(dow: string): string {
+        if (dow === '*') return '';
+        const days = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];
+        return `on ${days[Number(dow)]}`;
+    }
+
+    private static ordinalSuffix(i: number): string {
+        const j = i % 10;
+        const k = i % 100;
+        if (j == 1 && k != 11) return i + "st";
+        if (j == 2 && k != 12) return i + "nd";
+        if (j == 3 && k != 13) return i + "rd";
+        return i + "th";
+    }
+
+    //#endregion
+
+}

package/src/helper.ts

@@ -0,0 +1,19 @@
+export class ExpressionHelper {
+    static readonly delimiter = ' ';
+    static readonly unixExpressionLength = 5;
+    static readonly quartzExpressionLengths = [6, 7];
+
+    public static GetExpressionParts(expression: string): string[] {
+        this.validateIfNullOrEmpty(expression);
+        const parts = expression.split(this.delimiter).map(part => part.trim());
+        if (this.quartzExpressionLengths.includes(parts.length)) return parts.map(part => part.replace('?', '*')) //if quartz, cleanup
+        if (this.unixExpressionLength == parts.length) return parts;// if unix, return as it is
+
+        throw new Error(`Invalid cron expression!`)
+    }
+
+    private static validateIfNullOrEmpty(cronExpression: string | undefined | null): void {
+        if (!cronExpression || cronExpression.trim() === '') throw new Error('Empty or null expression');
+    }
+
+}

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './converter';
+export * from './describer';
 
 

package/.github/workflows/integration.yml

@@ -1,33 +0,0 @@
-name: Build
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-jobs:
-  build:
-    name: Build and Test
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [16.x, 18.x, 20.x]
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Clean Install Dependencies
-        run: npm ci
-
-      - name: Run Tests
-        run: npm test
-
-      - name: Linting
-        run: npm run lint
-
-      - name: Run build
-        run: npm run build --if-present

package/.github/workflows/release.yml

@@ -1,55 +0,0 @@
-name: Release
-on:
-  workflow_run:
-    workflows: ["Build"]
-    types:
-      - completed
-jobs:
-  release:
-    permissions: write-all
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Setup node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "18.x"
-          registry-url: "https://registry.npmjs.org"
-
-      - name: Publish to NPM
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: Get package version
-        id: pkgver
-        run: echo "::set-output name=version::$(node -p "require('./package.json').version")"
-
-        # Creates a .tgz file in your working directory
-      - name: Package NPM tarball
-        run: npm pack
-
-      # - name: Debug GitHub event
-      #   run: echo "${{ toJson(github.event.release) }}"
-
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ steps.pkgver.outputs.version }}
-          release_name: Release ${{ steps.pkgver.outputs.version }}
-          draft: false
-          prerelease: false
-
-      - name: Upload Release Asset
-        id: upload-release-asset
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`.
-          asset_path: ./cron-converter-u2q-${{ steps.pkgver.outputs.version }}.tgz
-          asset_name: cron-converter-u2q-${{ steps.pkgver.outputs.version }}.tgz
-          asset_content_type: application/gzip