Merge pull request #1 from bsodmike/wip/next_release

Release v2.0.0

.github/ISSUE_TEMPLATE/1-problem.md

@@ -0,0 +1,7 @@
+---
+name: Problem
+about: Something does not seem right
+
+---
+
+

.github/ISSUE_TEMPLATE/2-suggestion.md

@@ -0,0 +1,7 @@
+---
+name: Suggestion
+about: Share how Serde could support your use case better
+
+---
+
+

.github/ISSUE_TEMPLATE/3-documentation.md

@@ -0,0 +1,7 @@
+---
+name: Documentation
+about: Certainly there is room for improvement
+
+---
+
+

.github/ISSUE_TEMPLATE/4-other.md

@@ -0,0 +1,7 @@
+---
+name: Anything else!
+about: Whatever is on your mind
+
+---
+
+

.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+  schedule: [cron: "40 1 * * *"]
+
+permissions:
+  contents: read
+
+env:
+  RUSTFLAGS: -Dwarnings
+
+jobs:
+  test:
+    name: Test suite
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+      - run: cargo test
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: Cargo.lock
+          path: Cargo.lock
+
+  stable:
+    name: Rust ${{matrix.rust}}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        rust: [stable, beta]
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{matrix.rust}}
+      - run: cargo build
+
+  nightly:
+    name: Rust nightly ${{matrix.os == 'windows' && '(windows)' || ''}}
+    runs-on: ${{matrix.os}}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+      - run: cargo build
+
+  doc:
+    name: Documentation
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    env:
+      RUSTDOCFLAGS: -Dwarnings
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+      - uses: dtolnay/install@cargo-docs-rs
+      - run: cargo docs-rs
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request'
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@clippy
+      - run: cargo clippy -- -Dclippy::all -Dclippy::pedantic
+
+  # miri:
+  #   name: Miri
+  #   runs-on: ubuntu-latest
+  #   timeout-minutes: 45
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: dtolnay/rust-toolchain@miri
+  #     - run: cargo miri setup
+  #     - run: cargo miri test

CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # Unreleased
 
+# 2.0.0 (8 Sept 2024)
+
+- **added:** Github CI
+- **fixed:** Clippy offences
+- **changed:** Improve docs
+- **changed:** Stablised return values to `u64`. Use of `usize` will need to be re-evaluated for future `no-std` support.
+
+See [PR for changes](https://github.com/bsodmike/better-limit-reader-rs/pull/1/files)
+
+
 # 1.0.2 (7 Sept 2024)
 
 - **changed:** Add enhancement task to README

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "better-limit-reader"
-version = "1.0.2"
+version = "2.0.0"
 authors = ["Michael de Silva <michael@cyberdynea.io>"]
 description = "Configurable limit reader that limits the number of bytes read from an underlying reader, supporting decompression from Gzip and Zlib compressed via `flate2`"
 readme = "README.md"

README.md

@@ -1,19 +1,22 @@
 # better-limit-reader-rs
 
-![Crates.io Version](https://img.shields.io/crates/v/better-limit-reader)
+[![Crates.io Version](https://img.shields.io/crates/v/better-limit-reader)](https://crates.io/crates/better-limit-reader)
 [![Released API docs](https://img.shields.io/docsrs/better-limit-reader)](https://docs.rs/better-limit-reader/)
 
 Exposes LimitReader which is a limit reader, that protects against zip-bombs and other nefarious activities that limits the number of bytes read from an underlying reader.
 
 This crate is heavily inspired by Jon Gjengset’s “Crust of Rust” episode on the [inner workings of git on YouTube](https://youtu.be/u0VotuGzD_w?si=oIuV9CITSWHJXKBu&t=3503) and mitigrating Zip-bombs.
 
+It has been said, the name is a bit _boisterous_, but at least it sets high ambitions for this wee crate.
+
 ## API usage
 
 Refer to the [docs](https://docs.rs/better-limit-reader/latest/better_limit_reader/) for further examples.
 
-### Upcoming enhancements
+### Upcoming enhancements (in no particular order)
 
 - [ ] Gzip decompression.
+- [ ] `no_std` support (?); This needs planning via an issue on Github.
 - TBD: If you have any requests, please open an issue!
 
 ### Building

examples/read_limited.rs

@@ -15,7 +15,7 @@ fn main() -> LimitReaderResult<()> {
     );
 
     let data = limit_reader.buffer();
-    let text = String::from_utf8(data[..bytes_read].to_vec())?;
+    let text = String::from_utf8(data[..(bytes_read as usize)].to_vec())?;
 
     println!("First line from README: {}", &text);
 

src/error.rs

@@ -2,13 +2,16 @@ use crate::{error_from, LimitReaderOutputBuilderError};
 use std::{
     error::Error as StdError,
     fmt::{self},
+    num::TryFromIntError,
     string::FromUtf8Error,
 };
 
 /// Boxed error, a ptr to the Error via dynamic dispatch allocated on the heap at run time.
+#[allow(clippy::module_name_repetitions)]
 pub type BoxError = Box<dyn StdError + Send + Sync>;
 
 /// Default error type for create.
+#[allow(clippy::module_name_repetitions)]
 pub type LimitReaderError = Error;
 
 /// Error type
@@ -19,20 +22,27 @@ pub struct Error {
 
 #[derive(Debug)]
 #[non_exhaustive]
+#[allow(clippy::module_name_repetitions)]
+#[allow(clippy::enum_variant_names)]
 pub enum ErrorKind {
     IoError,
-    Utf8Error,
     LimitReaderOutputBuilderError,
+    Utf8Error,
+    TryFromIntError,
+    LimitReaderError(Box<dyn StdError + Send + Sync>),
 }
 
 impl ErrorKind {
     pub(crate) fn as_str(&self) -> &'static str {
+        #[allow(clippy::enum_glob_use)]
         use ErrorKind::*;
         // tidy-alphabetical-start
         match *self {
             IoError => "io error",
             Utf8Error => "invalid utf-8",
             LimitReaderOutputBuilderError => "builder error",
+            TryFromIntError => "conversion error",
+            LimitReaderError(_) => "boxed error",
         }
     }
 }
@@ -78,6 +88,7 @@ error_from!(
     LimitReaderOutputBuilderError,
     ErrorKind::LimitReaderOutputBuilderError
 );
+error_from!(TryFromIntError, ErrorKind::TryFromIntError);
 
 #[macro_use]
 pub mod macros {