feat: support multiple time crates

Author: svix-jbrown

.github/workflows/CI.yml

@@ -1,72 +1,37 @@
 name: CI
-
 on:
   push:
     branches:
-    - main
+      - main
   pull_request: {}
-
 jobs:
-  check:
-    # Run `cargo check` first to ensure that the pushed code at least compiles.
+  lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - uses: actions-rs/toolchain@v1
-      with:
-        toolchain: nightly
-        override: true
-        profile: minimal
-        components: clippy, rustfmt
-    - uses: Swatinem/rust-cache@v1
-    - name: Check
-      uses: actions-rs/cargo@v1
-      with:
-        command: clippy
-        args: --all --all-targets --all-features
-    - name: rustfmt
-      uses: actions-rs/cargo@v1
-      with:
-        command: fmt
-        args: --all -- --check
-
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: nightly
+          components: clippy, rustfmt
+      - uses: Swatinem/rust-cache@v1
+      - name: clippy
+        run: cargo clippy --all --all-targets --all-features
+      - name: rustfmt
+        run: cargo fmt --all -- --check
   test-versions:
-    needs: check
     runs-on: ubuntu-latest
     strategy:
       matrix:
         rust: [stable, beta]
     steps:
-    - uses: actions/checkout@master
-    - uses: actions-rs/toolchain@v1
-      with:
-        toolchain: ${{ matrix.rust }}
-        override: true
-        profile: minimal
-    - uses: Swatinem/rust-cache@v1
-    - name: Run tests
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
-        args: --all --all-features --all-targets
-    - name: Run doc tests
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
-        args: --doc
-
-#  deny-check:
-#    name: cargo-deny check
-#    runs-on: ubuntu-latest
-#    continue-on-error: ${{ matrix.checks == 'advisories' }}
-#    strategy:
-#      matrix:
-#        checks:
-#          - advisories
-#          - bans licenses sources
-#    steps:
-#      - uses: actions/checkout@v2
-#      - uses: EmbarkStudios/cargo-deny-action@v1
-#        with:
-#          command: check ${{ matrix.checks }}
-#          arguments: --all-features --manifest-path axum/Cargo.toml
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust }}
+      - uses: Swatinem/rust-cache@v2
+      - name: Run tests (all features)
+        run: cargo test --all --all-features --all-targets
+      - name: Run tests (no features)
+        run: cargo test --all --no-default-features --all-targets
+      - name: Run doc tests
+        run: cargo test --doc

.github/workflows/release.yml

@@ -1,33 +1,24 @@
 name: Release
-
 env:
   CARGO_TERM_COLOR: always
-
 on:
   push:
     tags:
       - 'v*'
-
 jobs:
   build:
     runs-on: ubuntu-latest
     environment: release
-
     permissions:
       id-token: write
-
     steps:
       - uses: actions/checkout@v6
-
       - uses: dtolnay/rust-toolchain@stable
-
       - uses: Swatinem/rust-cache@v2
         # only restore cache for faster publishing, don't save back results
-        save-if: false
-
+        save-if: "false"
       - uses: rust-lang/crates-io-auth-action@v1
         id: auth
-
       - name: Publish
         env:
           CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}

.github/workflows/security.yml

@@ -1,22 +1,19 @@
 name: Security
-
 on:
   push:
     branches:
-    - main
-    paths:
-      - '**/Cargo.toml'
-      - '**/Cargo.lock'
+      - main
   pull_request:
     paths:
       - '**/Cargo.toml'
       - '**/Cargo.lock'
-
+      - 'deny.toml'
 jobs:
-  security_audit:
+  cargo-deny:
+    name: cargo-deny check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/audit-check@v1
+      - uses: actions/checkout@v6
+      - uses: EmbarkStudios/cargo-deny-action@v2
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
+          manifest-path: Cargo.toml

Cargo.toml

@@ -2,7 +2,7 @@
 name = "svix-ksuid"
 version = "0.8.0"
 authors = ["Svix Inc. <oss@svix.com>"]
-edition = "2021"
+edition = "2024"
 description="A pure Rust and fully tested KSUID implementation"
 homepage="https://www.svix.com"
 repository="https://github.com/svix/rust-ksuid"
@@ -15,15 +15,20 @@ categories = ["data-structures", "concurrency", "database", "encoding"]
 maintenance = {status="actively-developed"}
 
 [features]
-# Include nothing by default
-default = []
+# Include `time` by default, to match old behavior
+default = ["time03"]
 serde = ["dep:serde"]
+jiff02 = ["dep:jiff"]
+time03 = ["dep:time"]
+chrono04 = ["dep:chrono"]
 
 [dependencies]
 base-encode = "^0.3.1"
 byteorder = "^1.4.3"
 getrandom = "0.4.2"
-time = "0.3.7"
+time = { version = "0.3.47", optional = true }
+chrono = { version = "0.4", optional = true }
+jiff = { version = "0.2", optional = true }
 serde = { version = "^1.0.145", optional = true, features = ["derive"] }
 
 [dev-dependencies]

README.md

@@ -24,8 +24,8 @@ For the Python version, please check out https://github.com/svix/python-ksuid
 
 ## What is a ksuid?
 
-A ksuid is a K sorted UID. In other words, a KSUID also stores a date component, so that ksuids can be approximately 
-sorted based on the time they were created. 
+A ksuid is a K sorted UID. In other words, a KSUID also stores a date component, so that ksuids can be approximately
+sorted based on the time they were created.
 
 Read more [here](https://segment.com/blog/a-brief-history-of-the-uuid/).
 
@@ -41,7 +41,7 @@ svix-ksuid = "^0.6.0"
 ```rust
 use svix_ksuid::*;
 
-let ksuid = Ksuid::new(None, None);
+let ksuid = Ksuid::now(None);
 println!("{}", ksuid.to_string());
 // 1srOrx2ZWZBpBUvZwXKQmoEYga2
 ```
@@ -57,19 +57,22 @@ The code too is fully compatible:
 ```rust
 use svix_ksuid::*;
 
-let ksuid = KsuidMs::new(None, None);
+let ksuid = KsuidMs::now(None);
 ```
 
 And they both implement the same `KsuidLike` trait.
 
 ### Opt-in features
 * `serde` - adds the ability to serialize and deserialize `Ksuid` and `KsuidMs`
   using serde.
+* `time03` - accept timestamps as the `time::OffsetDateTime` type from the [time](https://crates.io/crates/time) (0.3.x) crate – this feature is enabled by default, for compatibility with 0.8.x and older verisons
+* `chrono04` - accept timestamps as the `chrono::DateTime<chrono::Utc>` type from the [chrono](https://crates.io/crates/chrono) (0.4.x) crate
+* `jiff02` - accept timestamps as the `jiff::Timestamp` type from the [jiff](https://crates.io/crates/jiff) (0.2.x) crate
 
 Make sure to enable like this:
 ```toml
 [dependencies]
-svix-ksuid = { version = "^0.6.0", features = ["serde"] }
+svix-ksuid = { version = "^0.6.0", features = ["serde", "jiff02"] }
 ```
 
 ## Examples
@@ -79,7 +82,7 @@ svix-ksuid = { version = "^0.6.0", features = ["serde"] }
 ```rust
 use svix_ksuid::*;
 
-let ksuid = Ksuid::new(None, None);
+let ksuid = Ksuid::now(None);
 
 // Base62
 println!("{}", ksuid.to_string()); // also: ksuid.to_base62()
@@ -90,7 +93,7 @@ println!("{:?}", ksuid.bytes());
 // [13, 53, 196, 51, 225, 147, 62, 55, 242, 117, 112, 135, 99, 173, 199, 116, 90, 245, 231, 242]
 
 // Timestamp (time::OffsetDateTime)
-println!("{:?}", ksuid.timestamp());
+println!("{:?}", ksuid.timestamp::<time::OffsetDateTime>());
 // 2021-05-21T20:04:03Z
 
 // Timestamp (seconds)
@@ -106,9 +109,10 @@ println!("{:?}", ksuid.bytes());
 
 ```rust
 use svix_ksuid::*;
+use chrono::Utc;
 
 // Timestamp is now, payload is randomly generated
-let ksuid = Ksuid::new(None, None);
+let ksuid = Ksuid::now(None);
 
 // Explicitly set either
 let bytes = [12u8; Ksuid::PAYLOAD_BYTES];

deny.toml

@@ -0,0 +1,58 @@
+[graph]
+targets = [
+    { triple = "x86_64-pc-windows-gnu" },
+    { triple = "x86_64-unknown-linux-musl" },
+    { triple = "x86_64-apple-darwin" },
+    { triple = "aarch64-apple-darwin" },
+]
+
+[advisories]
+db-path = "~/.cargo/advisory-db"
+db-urls = ["https://github.com/rustsec/advisory-db"]
+yanked = "deny"
+ignore = [
+]
+
+[licenses]
+allow = [
+    "Apache-2.0",
+    "Apache-2.0 WITH LLVM-exception",
+    "BSD-2-Clause",
+    "BSD-3-Clause",
+    "CC0-1.0",
+    "ISC",
+    "MIT",
+    "MPL-2.0",
+    "Unicode-3.0",
+    "Zlib",
+]
+unused-allowed-license = "allow"
+confidence-threshold = 0.8
+exceptions = [
+]
+
+# TODO: Include internal crates
+[licenses.private]
+ignore = false
+registries = []
+
+[bans]
+multiple-versions = "allow"
+wildcards = "allow"
+highlight = "all"
+allow = []
+deny = [
+    # Versions containing the binary blob
+    # See: https://github.com/serde-rs/serde/issues/2538
+    { name = "serde_derive", version = ">1.0.171, <1.0.184"},
+]
+skip = []
+skip-tree = []
+
+[sources]
+unknown-registry = "deny"
+unknown-git = "deny"
+allow-registry = ["https://github.com/rust-lang/crates.io-index"]
+allow-git = [
+]
+# there are several projects in here, so it's okay if we don't use them all