rrule-rust 1.0.0 → 1.1.3

package/.eslintrc.js

@@ -0,0 +1,58 @@
+module.exports = {
+  root: true,
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'plugin:eslint-comments/recommended',
+  ],
+  plugins: ['@typescript-eslint'],
+  ignorePatterns: ['node_modules', '/target', '/index.d.ts', '/index.js'],
+  env: {
+    node: true,
+  },
+  overrides: [
+    {
+      files: ['*.ts'],
+      extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:prettier/recommended',
+        'plugin:import/recommended',
+        'plugin:import/typescript',
+      ],
+      parserOptions: {
+        project: ['tsconfig.eslint.json'],
+      },
+      rules: {
+        '@typescript-eslint/interface-name-prefix': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        'import/no-cycle': 'error',
+        'import/no-unresolved': 'error',
+        '@typescript-eslint/no-for-in-array': 'error',
+        'no-implied-eval': 'off',
+        '@typescript-eslint/no-implied-eval': 'error',
+        '@typescript-eslint/no-misused-promises': 'error',
+        'require-await': 'off',
+        '@typescript-eslint/require-await': 'error',
+        '@typescript-eslint/restrict-plus-operands': 'error',
+        '@typescript-eslint/unbound-method': 'error',
+        'import/no-default-export': 'error',
+        'eslint-comments/require-description': 'error',
+        'eslint-comments/disable-enable-pair': 'off',
+        'eslint-comments/no-unlimited-disable': 'off',
+      },
+      settings: {
+        'import/parsers': {
+          '@typescript-eslint/parser': ['.ts'],
+        },
+      },
+      reportUnusedDisableDirectives: true,
+    },
+  ],
+};

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/README.md

@@ -10,15 +10,14 @@
 
 
 1. [Quick Start](#quick-start)
-2. RRule
-3. RRuleSet
+2. [Perfomance](#perfomance)
 
 ## Quick Start
 
-See [__test__ folder](https://github.com/lsndr/rrule-rust/tree/master/__test__) to see more use cases
+See [test folder](https://github.com/lsndr/rrule-rust/tree/master/__test__) to find more use cases
 
 ```
-  npm install rrule-rust 
+  npm i rrule-rust 
 ```
 
 
@@ -26,12 +25,28 @@ See [__test__ folder](https://github.com/lsndr/rrule-rust/tree/master/__test__)
 import { RRule, RRuleSet, Frequency } from 'rrule-rust';
 
 const rrule = new RRule(Frequency.Daily).setCount(5);
-const set = new RRuleSet(873205200000, 'US/Eastern').rrule(rrule);
+const set = new RRuleSet(873205200000, 'US/Eastern').addRrule(rrule);
 
 const dates = set.all(); // [ 873205200000, 873291600000, 873378000000, 873464400000, 873550800000 ]
 const asString = set.toString(); // DTSTART;TZID=US/Eastern:19970902T090000\nFREQ=daily;COUNT=5;BYHOUR=9;BYMINUTE=0;BYSECOND=0
 ```
 
+## Perfomance
+
+```
+  Host: MacBook Pro, 13-inch, 2018
+  OS: macOS 13.2 (22D49)
+  Processor: 2,3 GHz Quad-Core Intel Core i5
+  Memory: 16 GB 2133 MHz LPDDR3
+```
+
+|          | rrule        | rrule-rust   |              |
+| -------- | ------------ | ------------ | ------------ |
+| UTC TZ   | 8 128 ops/s  | 42 343 ops/s | ~5x faster   |
+| Other TZ | 68 ops/s     | 40 549 ops/s | ~600x faster |
+
+You can run benchmarks using `npm run benchmark`
+
 ## License
 
 `rrule-rust` is [MIT licensed](LICENSE.md).

package/benchmark/.gitignore

@@ -0,0 +1,3 @@
+*
+!index.ts
+!.gitignore

package/benchmark/index.ts

@@ -0,0 +1,57 @@
+import b from 'benny';
+import * as node from 'rrule';
+import * as rust from '../';
+
+b.suite(
+  'UTC TZ',
+  b.add('rrule-rust', () => {
+    const rrule = new rust.RRule(rust.Frequency.Daily)
+      .setCount(30)
+      .setInterval(1);
+    const set = new rust.RRuleSet(1679428740000, 'UTC').addRrule(rrule);
+
+    set.all();
+  }),
+  b.add('rrule', () => {
+    const rrule = new node.RRule({
+      freq: node.RRule.DAILY,
+      dtstart: new Date(Date.UTC(2023, 2, 21, 23, 59, 0)),
+      tzid: 'UTC',
+      count: 30,
+      interval: 1,
+    });
+
+    rrule.all();
+  }),
+
+  b.cycle(),
+  b.complete(),
+);
+
+b.suite(
+  'Other TZ',
+  b.add('rrule-rust', () => {
+    const rrule = new rust.RRule(rust.Frequency.Daily)
+      .setCount(30)
+      .setInterval(1);
+    const set = new rust.RRuleSet(1679428740000, 'Pacific/Kiritimati').addRrule(
+      rrule,
+    );
+
+    set.all();
+  }),
+  b.add('rrule', () => {
+    const rrule = new node.RRule({
+      freq: node.RRule.DAILY,
+      dtstart: new Date(Date.UTC(2023, 2, 21, 23, 59, 0)),
+      tzid: 'Pacific/Kiritimati',
+      count: 30,
+      interval: 1,
+    });
+
+    rrule.all();
+  }),
+
+  b.cycle(),
+  b.complete(),
+);

package/index.d.ts

@@ -70,13 +70,13 @@ export class RRule {
 export type JsRRuleSet = RRuleSet
 export class RRuleSet {
   constructor(dtstart: number, tzid: string)
+  static parse(str: string): RRuleSet
   toString(): string
-  rrule(jsRrule: RRule): this
-  exrule(jsRrule: RRule): this
-  after(timestamp: number): this
-  before(timestamp: number): this
-  exdate(timestamp: number): this
-  getDtstart(): number
-  getTzid(): string
+  addRrule(jsRrule: RRule): this
+  addExrule(jsRrule: RRule): this
+  addExdate(timestamp: number): this
+  get dtstart(): number
+  get tzid(): string
   all(limit?: number | undefined | null): number[]
+  between(after: number, before: number, inclusive?: boolean | undefined | null): number[]
 }

package/index.js

@@ -1,3 +1,9 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
 const { existsSync, readFileSync } = require('fs')
 const { join } = require('path')
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rrule-rust",
-  "version": "1.0.0",
+  "version": "1.1.3",
   "main": "index.js",
   "types": "index.d.ts",
   "keywords": [
@@ -39,11 +39,39 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@napi-rs/cli": "^2.14.8",
-    "ava": "^5.1.1"
+    "@napi-rs/cli": "^2.15.1",
+    "@types/node": "^18.15.5",
+    "@typescript-eslint/eslint-plugin": "^5.50.0",
+    "@typescript-eslint/parser": "^5.50.0",
+    "ava": "^5.1.1",
+    "benny": "^3.7.1",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "lint-staged": "^13.1.0",
+    "pre-commit": "^1.2.2",
+    "prettier": "^2.8.3",
+    "rrule": "^2.7.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  },
+  "pre-commit": [
+    "lint:fix-staged",
+    "test"
+  ],
+  "lint-staged": {
+    "**/*.{js,ts,json}": "eslint --fix --max-warnings=0"
   },
   "ava": {
-    "timeout": "3m"
+    "timeout": "10m",
+    "extensions": [
+      "ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ]
   },
   "engines": {
     "node": ">= 10"
@@ -55,22 +83,26 @@
     "prepublishOnly": "napi prepublish -t npm",
     "test": "ava",
     "universal": "napi universal",
-    "version": "napi version"
+    "version": "napi version",
+    "benchmark": "ts-node ./benchmark/index.ts",
+    "lint": "eslint \"**/*.{js,ts,json}\" --max-warnings=0",
+    "lint:fix": "yarn lint --fix",
+    "lint:fix-staged": "lint-staged"
   },
   "optionalDependencies": {
-    "@rrule-rust/lib-win32-x64-msvc": "1.0.0",
-    "@rrule-rust/lib-darwin-x64": "1.0.0",
-    "@rrule-rust/lib-linux-x64-gnu": "1.0.0",
-    "@rrule-rust/lib-darwin-arm64": "1.0.0",
-    "@rrule-rust/lib-android-arm64": "1.0.0",
-    "@rrule-rust/lib-linux-arm64-gnu": "1.0.0",
-    "@rrule-rust/lib-linux-arm64-musl": "1.0.0",
-    "@rrule-rust/lib-win32-arm64-msvc": "1.0.0",
-    "@rrule-rust/lib-linux-arm-gnueabihf": "1.0.0",
-    "@rrule-rust/lib-linux-x64-musl": "1.0.0",
-    "@rrule-rust/lib-freebsd-x64": "1.0.0",
-    "@rrule-rust/lib-win32-ia32-msvc": "1.0.0",
-    "@rrule-rust/lib-android-arm-eabi": "1.0.0",
-    "@rrule-rust/lib-darwin-universal": "1.0.0"
+    "@rrule-rust/lib-win32-x64-msvc": "1.1.3",
+    "@rrule-rust/lib-darwin-x64": "1.1.3",
+    "@rrule-rust/lib-linux-x64-gnu": "1.1.3",
+    "@rrule-rust/lib-darwin-arm64": "1.1.3",
+    "@rrule-rust/lib-android-arm64": "1.1.3",
+    "@rrule-rust/lib-linux-arm64-gnu": "1.1.3",
+    "@rrule-rust/lib-linux-arm64-musl": "1.1.3",
+    "@rrule-rust/lib-win32-arm64-msvc": "1.1.3",
+    "@rrule-rust/lib-linux-arm-gnueabihf": "1.1.3",
+    "@rrule-rust/lib-linux-x64-musl": "1.1.3",
+    "@rrule-rust/lib-freebsd-x64": "1.1.3",
+    "@rrule-rust/lib-win32-ia32-msvc": "1.1.3",
+    "@rrule-rust/lib-android-arm-eabi": "1.1.3",
+    "@rrule-rust/lib-darwin-universal": "1.1.3"
   }
 }

package/src/lib.rs

@@ -284,8 +284,6 @@ impl JsRRule {
 pub struct JsRRuleSet {
   tz: Tz,
   rrule_set: RRuleSet,
-  before: Option<i64>,
-  after: Option<i64>,
 }
 
 #[napi]
@@ -296,12 +294,16 @@ impl JsRRuleSet {
     let date = timestamp_to_date_with_tz(dtstart, &tz);
     let rrule_set = RRuleSet::new(date);
 
-    JsRRuleSet {
-      rrule_set,
-      tz,
-      before: None,
-      after: None,
-    }
+    JsRRuleSet { rrule_set, tz }
+  }
+
+  #[napi(factory, ts_return_type="RRuleSet")]
+  pub fn parse(str: String) -> Self {
+    let rrule_set: RRuleSet = str.parse().unwrap();
+    let dtstart = rrule_set.get_dt_start();
+    let tz = dtstart.timezone();
+
+    JsRRuleSet { rrule_set, tz }
   }
 
   #[napi]
@@ -310,7 +312,7 @@ impl JsRRuleSet {
   }
 
   #[napi]
-  pub fn rrule(&mut self, js_rrule: &JsRRule) -> napi::Result<&Self> {
+  pub fn add_rrule(&mut self, js_rrule: &JsRRule) -> napi::Result<&Self> {
     let dt_start = self.rrule_set.get_dt_start().clone();
     let rrule = js_rrule.validate(dt_start);
 
@@ -320,7 +322,7 @@ impl JsRRuleSet {
   }
 
   #[napi]
-  pub fn exrule(&mut self, js_rrule: &JsRRule) -> napi::Result<&Self> {
+  pub fn add_exrule(&mut self, js_rrule: &JsRRule) -> napi::Result<&Self> {
     let rrule = js_rrule.validate(*self.rrule_set.get_dt_start());
 
     replace_with_or_abort(&mut self.rrule_set, |self_| self_.exrule(rrule));
@@ -329,21 +331,7 @@ impl JsRRuleSet {
   }
 
   #[napi]
-  pub fn after(&mut self, timestamp: i64) -> napi::Result<&Self> {
-    self.after = Some(timestamp);
-
-    Ok(self)
-  }
-
-  #[napi]
-  pub fn before(&mut self, timestamp: i64) -> napi::Result<&Self> {
-    self.before = Some(timestamp);
-
-    Ok(self)
-  }
-
-  #[napi]
-  pub fn exdate(&mut self, timestamp: i64) -> napi::Result<&Self> {
+  pub fn add_exdate(&mut self, timestamp: i64) -> napi::Result<&Self> {
     replace_with_or_abort(&mut self.rrule_set, |self_| {
       self_.exdate(timestamp_to_date_with_tz(timestamp, &self.tz))
     });
@@ -351,13 +339,13 @@ impl JsRRuleSet {
     Ok(self)
   }
 
-  #[napi]
-  pub fn get_dtstart(&self) -> napi::Result<i64> {
+  #[napi(getter)]
+  pub fn dtstart(&self) -> napi::Result<i64> {
     Ok(self.rrule_set.get_dt_start().timestamp_millis())
   }
 
-  #[napi]
-  pub fn get_tzid(&self) -> napi::Result<String> {
+  #[napi(getter)]
+  pub fn tzid(&self) -> napi::Result<String> {
     Ok(String::from(self.tz.name()))
   }
 
@@ -375,21 +363,25 @@ impl JsRRuleSet {
     Ok(arr)
   }*/
 
-  fn is_after(&self, timestamp: i64) -> bool {
-    if let Some(after) = self.after {
-      if timestamp <= after {
-        return false;
-      }
+  fn is_after(&self, timestamp: i64, after_timestamp: i64, inclusive: Option<bool>) -> bool {
+    let inclusive = inclusive.unwrap_or(false);
+
+    if inclusive && timestamp < after_timestamp {
+      return false;
+    } else if !inclusive && timestamp <= after_timestamp {
+      return false;
     }
 
     true
   }
 
-  fn is_before(&self, timestamp: i64) -> bool {
-    if let Some(before) = self.before {
-      if timestamp >= before {
-        return false;
-      }
+  fn is_before(&self, timestamp: i64, before_timestamp: i64, inclusive: Option<bool>) -> bool {
+    let inclusive = inclusive.unwrap_or(false);
+
+    if inclusive && timestamp > before_timestamp {
+      return false;
+    } else if !inclusive && timestamp >= before_timestamp {
+      return false;
     }
 
     true
@@ -411,8 +403,20 @@ impl JsRRuleSet {
       }
 
       let timestamp = date.timestamp_millis();
-      let is_after = self.is_after(timestamp);
-      let is_before = self.is_before(timestamp);
+      arr.insert(timestamp).unwrap();
+    }
+
+    Ok(arr)
+  }
+
+  #[napi(ts_return_type = "number[]")]
+  pub fn between(&self, env: Env, after: i64, before: i64, inclusive: Option<bool>) -> napi::Result<Array> {
+    let mut arr = env.create_array(0).unwrap();
+
+    for date in self.rrule_set.into_iter() {
+      let timestamp = date.timestamp_millis();
+      let is_after = self.is_after(timestamp, after, inclusive);
+      let is_before = self.is_before(timestamp, before, inclusive);
 
       if is_after && is_before {
         arr.insert(timestamp).unwrap();

package/tsconfig.eslint.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2017",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "removeComments": true,
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "strict": true
+  }
+}