feat: merge foyer-rs/bytesize back to the OG repo

.github/workflows/rust.yml

@@ -2,21 +2,69 @@ name: Rust
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 env:
   CARGO_TERM_COLOR: always
+  CACHE_KEY_SUFFIX: 20240821
 
 jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
+  rust:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        rust_toolchain: [stable, 1.81.0]
+    runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose
+      - uses: actions/checkout@v4
+      - name: Install rust toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust_toolchain }}
+          components: rustfmt, clippy, llvm-tools-preview
+      - name: Cache Cargo home
+        uses: actions/cache@v4
+        id: cache
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-rust-test
+      - name: Install cargo tools
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          cargo install cargo-sort --locked
+      - name: Run rust cargo-sort check
+        # https://github.com/DevinR528/cargo-sort/issues/56
+        if: matrix.os != 'windows-latest'
+        run: |
+          cargo sort -w -c
+      - name: Run rust format check
+        run: |
+          cargo fmt --all -- --check
+      - name: Run rust clippy check
+        run: |
+          cargo clippy --all-features -- -D warnings
+      - if: steps.cache.outputs.cache-hit != 'true'
+        uses: taiki-e/install-action@cargo-llvm-cov
+      - name: Run rust test with coverage
+        env:
+          RUST_BACKTRACE: 1
+        run: |
+          cargo llvm-cov test --all-features
+      - name: Run rust doc test
+        env:
+          RUST_BACKTRACE: 1
+        run: |
+          cargo test --doc --all-features
+      - uses: codecov/codecov-action@v4
+        if: runner.os == 'Linux' && matrix.rust_toolchain == 'stable'
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          verbose: true

Cargo.toml

@@ -1,24 +1,25 @@
 [package]
-name = "bytesize"
-description = "an utility for human-readable bytes representations"
-version = "1.4.0-dev"
-authors = ["Hyunsik Choi <[email protected]>"]
+name = "foyer-bytesize"
+description = "An utility for human-readable bytes representations. Forked from https://github.com/hyunsik/bytesize ."
+version = "2.0.0"
+authors = ["Hyunsik Choi <[email protected]>", "MrCroxx <[email protected]>"]
+edition = "2021"
 
-homepage = "https://github.com/hyunsik/bytesize/"
-documentation = "https://docs.rs/bytesize/"
-repository = "https://github.com/hyunsik/bytesize/"
+homepage = "https://github.com/foyer-rs/bytesize/"
+documentation = "https://docs.rs/foyer-bytesize/"
+repository = "https://github.com/foyer-rs/bytesize/"
 readme = "README.md"
 keywords = ["byte", "byte-size", "utility", "human-readable", "format"]
 license = "Apache-2.0"
 
 [dependencies]
-arbitrary = { version = "1.3.0", optional = true }
-serde = { version = "1.0.185", optional = true }
+arbitrary = { version = "1", features = ["derive"], optional = true }
+serde = { version = "1", optional = true }
 
 [dev-dependencies]
-serde = { version = "1.0.185", features = ["derive"] }
-serde_json = "1.0.105"
-toml = "0.7.6"
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
+toml = "0.8"
 
 [features]
 arbitrary = ["dep:arbitrary"]

Makefile

@@ -0,0 +1,8 @@
+SHELL := /bin/bash
+.PHONY: all
+
+all:
+	cargo sort -w
+	cargo fmt --all
+	cargo clippy --all-features
+	RUST_BACKTRACE=1 cargo test --all-features

README.md

@@ -1,118 +1,107 @@
 ## ByteSize
-[![Build Status](https://travis-ci.org/hyunsik/bytesize.svg?branch=master)](https://travis-ci.org/hyunsik/bytesize)
-[![Crates.io Version](https://img.shields.io/crates/v/bytesize.svg)](https://crates.io/crates/bytesize)
 
+[![Rust](https://github.com/foyer-rs/bytesize/actions/workflows/rust.yml/badge.svg)](https://github.com/foyer-rs/bytesize/actions/workflows/rust.yml)
+[![Crates.io Version](https://img.shields.io/crates/v/foyer-bytesize.svg)](https://crates.io/crates/foyer-bytesize)
+
+Forked from https://github.com/hyunsik/bytesize .
 
 ByteSize is an utility for human-readable byte count representation.
 
 Features:
-* Pre-defined constants for various size units (e.g., B, Kb, kib, Mb, Mib, Gb, Gib, ... PB)
+* Pre-defined constants for various size units (e.g., B, Kb, Kib, Mb, Mib, Gb, Gib, ... PB)
 * `ByteSize` type which presents size units convertible to different size units.
 * Artimetic operations for `ByteSize`
 * FromStr impl for `ByteSize`, allowing to parse from string size representations like 1.5KiB and 521TiB.
 * Serde support for binary and human-readable deserializers like JSON
 
-[API Documentation](https://docs.rs/bytesize/)
+[API Documentation](https://docs.rs/foyer-bytesize/)
+
+### Differences from the original `bytesize`
+
+- Use SI format by default with `Display`.
+- Use "KiB" for SI unit.
+
+Considering the changes, the version of `foyer-bytesize` crate starts from "2" to differ from the original `bytesize` crate.
 
 ## Usage
 
 Add this to your Cargo.toml:
 
 ```toml
 [dependencies]
-bytesize = {version = "1.2.0", features = ["serde"]}
-```
-
-and this to your crate root:
-```rust
-extern crate bytesize;
+bytesize = { package = "foyer-bytesize", version = "2", features = ["serde"]}
 ```
 
 ## Example
+
 ### Human readable representations (SI unit and Binary unit)
-```rust
-#[allow(dead_code)]
-fn assert_display(expected: &str, b: ByteSize) {
-  assert_eq!(expected, format!("{}", b));
-}
 
-#[test]
-  fn test_display() {
-    assert_display("215 B", ByteSize(215));
-    assert_display("215 B", ByteSize::b(215));
-    assert_display("1.0 KB", ByteSize::kb(1));
-    assert_display("301.0 KB", ByteSize::kb(301));
-    assert_display("419.0 MB", ByteSize::mb(419));
-    assert_display("518.0 GB", ByteSize::gb(518));
-    assert_display("815.0 TB", ByteSize::tb(815));
-    assert_display("609.0 PB", ByteSize::pb(609));
-  }
-
-  fn assert_to_string(expected: &str, b: ByteSize, si: bool) {
-    assert_eq!(expected.to_string(), b.to_string_as(si));
-  }
-
-  #[test]
-  fn test_to_string() {
-    assert_to_string("215 B", ByteSize(215), true);
-    assert_to_string("215 B", ByteSize(215), false);
-
-    assert_to_string("215 B", ByteSize::b(215), true);
-    assert_to_string("215 B", ByteSize::b(215), false);
-
-    assert_to_string("1.0 kiB", ByteSize::kib(1), true);
-    assert_to_string("1.0 KB", ByteSize::kib(1), false);
-
-    assert_to_string("293.9 kiB", ByteSize::kb(301), true);
-    assert_to_string("301.0 KB", ByteSize::kb(301), false);
-
-    assert_to_string("1.0 MiB", ByteSize::mib(1), true);
-    assert_to_string("1048.6 KB", ByteSize::mib(1), false);
-
-    assert_to_string("399.6 MiB", ByteSize::mb(419), true);
-    assert_to_string("419.0 MB", ByteSize::mb(419), false);
-
-    assert_to_string("482.4 GiB", ByteSize::gb(518), true);
-    assert_to_string("518.0 GB", ByteSize::gb(518), false);
-
-    assert_to_string("741.2 TiB", ByteSize::tb(815), true);
-    assert_to_string("815.0 TB", ByteSize::tb(815), false);
-
-    assert_to_string("540.9 PiB", ByteSize::pb(609), true);
-    assert_to_string("609.0 PB", ByteSize::pb(609), false);
-  }
-
-  #[test]
-  fn test_parsing_from_str() {
-      // shortcut for writing test cases
-      fn parse(s: &str) -> u64 {
-          s.parse::<ByteSize>().unwrap().0
-      }
-
-      assert_eq!("0".parse::<ByteSize>().unwrap().0, 0);
-      assert_eq!(parse("0"), 0);
-      assert_eq!(parse("500"), 500);
-      assert_eq!(parse("1K"), Unit::KiloByte * 1);
-      assert_eq!(parse("1Ki"), Unit::KibiByte * 1);
-      assert_eq!(parse("1.5Ki"), (1.5 * Unit::KibiByte) as u64);
-      assert_eq!(parse("1KiB"), 1 * Unit::KibiByte);
-      assert_eq!(parse("1.5KiB"), (1.5 * Unit::KibiByte) as u64);
-      assert_eq!(parse("3 MB"), Unit::MegaByte * 3);
-      assert_eq!(parse("4 MiB"), Unit::MebiByte * 4);
-      assert_eq!(parse("6 GB"), 6 * Unit::GigaByte);
-      assert_eq!(parse("4 GiB"), 4 * Unit::GibiByte);
-      assert_eq!(parse("88TB"), 88 * Unit::TeraByte);
-      assert_eq!(parse("521TiB"), 521 * Unit::TebiByte);
-      assert_eq!(parse("8 PB"), 8 * Unit::PetaByte);
-      assert_eq!(parse("8P"), 8 * Unit::PetaByte);
-      assert_eq!(parse("12 PiB"), 12 * Unit::PebiByte);
-  }
+```rust
+    fn assert_display(expected: &str, b: ByteSize) {
+        assert_eq!(expected, format!("{}", b));
+    }
+
+    #[test]
+    fn test_display() {
+        assert_display("215 B", ByteSize::b(215));
+        assert_display("1.0 KiB", ByteSize::kib(1));
+        assert_display("301.0 KiB", ByteSize::kib(301));
+        assert_display("419.0 MiB", ByteSize::mib(419));
+        assert_display("518.0 GiB", ByteSize::gib(518));
+        assert_display("815.0 TiB", ByteSize::tib(815));
+        assert_display("609.0 PiB", ByteSize::pib(609));
+    }
+
+    #[test]
+    fn test_display_alignment() {
+        assert_eq!("|357 B     |", format!("|{:10}|", ByteSize(357)));
+        assert_eq!("|     357 B|", format!("|{:>10}|", ByteSize(357)));
+        assert_eq!("|357 B     |", format!("|{:<10}|", ByteSize(357)));
+        assert_eq!("|  357 B   |", format!("|{:^10}|", ByteSize(357)));
+
+        assert_eq!("|-----357 B|", format!("|{:->10}|", ByteSize(357)));
+        assert_eq!("|357 B-----|", format!("|{:-<10}|", ByteSize(357)));
+        assert_eq!("|--357 B---|", format!("|{:-^10}|", ByteSize(357)));
+    }
+
+    fn assert_to_string(expected: &str, b: ByteSize, si: bool) {
+        assert_eq!(expected.to_string(), b.to_string_as(si));
+    }
+
+    #[test]
+    fn test_to_string_as() {
+        assert_to_string("215 B", ByteSize::b(215), true);
+        assert_to_string("215 B", ByteSize::b(215), false);
+
+        assert_to_string("1.0 KiB", ByteSize::kib(1), true);
+        assert_to_string("1.0 KB", ByteSize::kib(1), false);
+
+        assert_to_string("293.9 KiB", ByteSize::kb(301), true);
+        assert_to_string("301.0 KB", ByteSize::kb(301), false);
+
+        assert_to_string("1.0 MiB", ByteSize::mib(1), true);
+        assert_to_string("1048.6 KB", ByteSize::mib(1), false);
+
+        // a bug case: https://github.com/flang-project/bytesize/issues/8
+        assert_to_string("1.9 GiB", ByteSize::mib(1907), true);
+        assert_to_string("2.0 GB", ByteSize::mib(1908), false);
+
+        assert_to_string("399.6 MiB", ByteSize::mb(419), true);
+        assert_to_string("419.0 MB", ByteSize::mb(419), false);
+
+        assert_to_string("482.4 GiB", ByteSize::gb(518), true);
+        assert_to_string("518.0 GB", ByteSize::gb(518), false);
+
+        assert_to_string("741.2 TiB", ByteSize::tb(815), true);
+        assert_to_string("815.0 TB", ByteSize::tb(815), false);
+
+        assert_to_string("540.9 PiB", ByteSize::pb(609), true);
+        assert_to_string("609.0 PB", ByteSize::pb(609), false);
+    }
 ```
 
 ### Arithmetic operations
 ```rust
-extern crate bytesize;
-
 use bytesize::ByteSize;
 
 fn byte_arithmetic_operator() {