Merge torrust#20: Add unit tests for Value

f58baf7 chore: undo package rename (Jose Celano) 9833274 tests: add unit test for Value with serde_test (Jose Celano) f94c198 chore: add dev dependency serde_test (Jose Celano) 1eab404 test: add unit tests to Value (Jose Celano) b85b2a4 chore: add code coverage dir to gitignore (Jose Celano) Pull request description: ACKs for top commit: josecelano: ACK f58baf7 Tree-SHA512: e578cba38165a029b2eebda14fa5abc4a6214851798f7960e695e43c5f980b1f45671ee2d7eb30d624722028144f862f9035d9a4461420eacbc972c3dd8c38a6
toby · Oct 9, 2023 · e894328 · e894328
2 parents 97168c5 + f58baf7
commit e894328
Show file tree

Hide file tree

Showing 13 changed files with 735 additions and 30 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 *.rustfmt
 Cargo.lock
 target
+
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,10 +1,10 @@
 [package]
-name = "torrust-serde-bencode"
+name = "serde_bencode"
 description = "A Serde backed Bencode encoding/decoding library for Rust."
 version = "0.2.3"
 authors = ["Toby Padilla <tobypadilla@gmail.com>", "Nautilus Cyberneering <info@nautilus-cyberneering.de>"]
-repository = "https://github.com/torrust/torrust-serde-bencode"
-documentation = "https://docs.rs/torrust-serde-bencode/"
+repository = "https://github.com/toby/serde-bencode"
+documentation = "https://docs.rs/serde_bencode/"
 license = "MIT"
 keywords = ["bencode", "serialize", "deserialize", "serde"]
 edition = "2018"
@@ -15,3 +15,4 @@ serde_bytes = "0.11"
 
 [dev-dependencies]
 serde_derive = "1.0"
+serde_test = "1.0.176"
diff --git a/README.md b/README.md
@@ -1,12 +1,10 @@
 # Torrust Serde Bencode
 
-[![Checking](https://github.com/torrust/torrust-serde-bencode/actions/workflows/checking.yml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/checking.yml) [![Formatting](https://github.com/torrust/torrust-serde-bencode/actions/workflows/formatting.yml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/formatting.yml) [![Testing](https://github.com/torrust/torrust-serde-bencode/actions/workflows/testing.yaml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/testing.yaml) [![Benchmarking](https://github.com/torrust/torrust-serde-bencode/actions/workflows/benchmarking.yml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/benchmarking.yml) [![Coverage](https://github.com/torrust/torrust-serde-bencode/actions/workflows/coverage.yaml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/coverage.yaml)
+[![Checking](https://github.com/torrust/torrust-serde-bencode/actions/workflows/checking.yml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/checking.yml) [![Formatting](https://github.com/torrust/torrust-serde-bencode/actions/workflows/formatting.yml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/formatting.yml) [![Testing](https://github.com/torrust/torrust-serde-bencode/actions/workflows/testing.yaml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/testing.yaml) [![Benchmarking](https://github.com/torrust/torrust-serde-bencode/actions/workflows/benchmarking.yml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/benchmarking.yml) [![Coverage](https://github.com/torrust/torrust-serde-bencode/actions/workflows/coverage.yaml/badge.svg)](https://github.com/torrust/torrust-serde-bencode/actions/workflows/coverage.yaml) [![Crates.io](https://img.shields.io/crates/v/serde_bencode)](https://crates.io/crates/serde_bencode) [![docs.rs](https://img.shields.io/docsrs/serde_bencode)](https://docs.rs/serde_bencode)
 
 A [Serde](https://github.com/serde-rs/serde) backed [Bencode](https://en.wikipedia.org/wiki/Bencode)
 encoding/decoding library for Rust.
 
-Forked from: <https://github.com/toby/serde-bencode> due to inactivity in upstream repo.
-
 ## Installation
 
 Add the following to your `Cargo.toml`:

diff --git a/benches/benches.rs b/benches/benches.rs
@@ -5,9 +5,9 @@ extern crate test;
 extern crate serde_derive;
 
 use serde::Serialize;
+use serde_bencode::de::from_bytes;
+use serde_bencode::ser::Serializer;
 use test::Bencher;
-use torrust_serde_bencode::de::from_bytes;
-use torrust_serde_bencode::ser::Serializer;
 
 #[bench]
 fn ser_de_simple(b: &mut Bencher) {

diff --git a/examples/parse_torrent.rs b/examples/parse_torrent.rs
@@ -1,9 +1,9 @@
 #[macro_use]
 extern crate serde_derive;
 
+use serde_bencode::de;
 use serde_bytes::ByteBuf;
 use std::io::{self, Read};
-use torrust_serde_bencode::de;
 
 #[derive(Debug, Deserialize)]
 struct Node(String, i64);

diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "torrust_serde_bencode_fuzz"
+name = "serde_bencode_fuzz"
 version = "0.0.0"
 authors = ["Automatically generated"]
 publish = false
@@ -11,7 +11,7 @@ cargo-fuzz = true
 [dependencies]
 libfuzzer-sys = "0.4"
 
-[dependencies.torrust_serde_bencode]
+[dependencies.serde_bencode]
 path = ".."
 
 # Prevent this from interfering with workspaces

diff --git a/fuzz/fuzz_targets/from_bytes.rs b/fuzz/fuzz_targets/from_bytes.rs
@@ -1,8 +1,8 @@
 #![no_main]
 use libfuzzer_sys::fuzz_target;
 
-use torrust_serde_bencode::from_bytes;
-use torrust_serde_bencode::value::Value;
+use serde_bencode::from_bytes;
+use serde_bencode::value::Value;
 
 fuzz_target!(|data: &[u8]| {
     let _: Result<Value, _> = from_bytes(data);

diff --git a/src/de.rs b/src/de.rs
@@ -345,7 +345,7 @@ impl<'de, 'a, R: Read> de::Deserializer<'de> for &'a mut Deserializer<R> {
 ///
 /// # Examples
 /// ```
-/// # fn main() -> Result<(), torrust_serde_bencode::Error> {
+/// # fn main() -> Result<(), serde_bencode::Error> {
 /// use serde_derive::{Serialize, Deserialize};
 ///
 /// #[derive(Serialize, Deserialize, PartialEq, Eq, Debug)]
@@ -355,7 +355,7 @@ impl<'de, 'a, R: Read> de::Deserializer<'de> for &'a mut Deserializer<R> {
 /// }
 ///
 /// let encoded = "d4:city18:Duckburg, Calisota6:street17:1313 Webfoot Walke".to_string();
-/// let decoded: Address = torrust_serde_bencode::from_str(&encoded)?;
+/// let decoded: Address = serde_bencode::from_str(&encoded)?;
 ///
 /// assert_eq!(
 ///     decoded,
@@ -384,7 +384,7 @@ where
 ///
 /// # Examples
 /// ```
-/// # fn main() -> Result<(), torrust_serde_bencode::Error> {
+/// # fn main() -> Result<(), serde_bencode::Error> {
 /// use serde_derive::{Serialize, Deserialize};
 ///
 /// #[derive(Serialize, Deserialize, PartialEq, Eq, Debug)]
@@ -394,7 +394,7 @@ where
 /// }
 ///
 /// let encoded = "d4:city18:Duckburg, Calisota6:street17:1313 Webfoot Walke".as_bytes();
-/// let decoded: Address = torrust_serde_bencode::from_bytes(&encoded)?;
+/// let decoded: Address = serde_bencode::from_bytes(&encoded)?;
 ///
 /// assert_eq!(
 ///     decoded,

diff --git a/src/error.rs b/src/error.rs
@@ -9,7 +9,7 @@ use std::fmt::Display;
 use std::io::Error as IoError;
 use std::result::Result as StdResult;
 
-/// Alias for `Result<T, torrust_serde_bencode::Error>`.
+/// Alias for `Result<T, serde_bencode::Error>`.
 pub type Result<T> = StdResult<T, Error>;
 
 /// Represents all possible errors which can occur when serializing or deserializing bencode.

diff --git a/src/lib.rs b/src/lib.rs
@@ -18,12 +18,12 @@
 //!         price: 130,
 //!     };
 //!
-//!     let serialized = torrust_serde_bencode::to_string(&apple)?;
+//!     let serialized = serde_bencode::to_string(&apple)?;
 //!     
 //!     // cspell:disable-next-line
 //!     assert_eq!(serialized, "d4:name5:Apple5:pricei130ee".to_string());
 //!
-//!     let deserialized: Product = torrust_serde_bencode::from_str(&serialized)?;
+//!     let deserialized: Product = serde_bencode::from_str(&serialized)?;
 //!
 //!     assert_eq!(
 //!         deserialized,

diff --git a/src/ser.rs b/src/ser.rs
@@ -351,7 +351,7 @@ impl<'a> ser::Serializer for &'a mut Serializer {
 ///
 /// # Examples
 /// ```
-/// # fn main() -> Result<(), torrust_serde_bencode::Error> {
+/// # fn main() -> Result<(), serde_bencode::Error> {
 /// use serde_derive::{Serialize, Deserialize};
 ///
 /// #[derive(Serialize, Deserialize, PartialEq, Eq, Debug)]
@@ -365,7 +365,7 @@ impl<'a> ser::Serializer for &'a mut Serializer {
 ///     city: "Duckburg, Calisota".to_string(),
 /// };
 ///
-/// let bytes = torrust_serde_bencode::to_bytes(&address)?;
+/// let bytes = serde_bencode::to_bytes(&address)?;
 /// assert_eq!(
 ///     String::from_utf8(bytes).unwrap(),
 ///     "d4:city18:Duckburg, Calisota6:street17:1313 Webfoot Walke",
@@ -388,7 +388,7 @@ pub fn to_bytes<T: ser::Serialize>(b: &T) -> Result<Vec<u8>> {
 ///
 /// # Examples
 /// ```
-/// # fn main() -> Result<(), torrust_serde_bencode::Error> {
+/// # fn main() -> Result<(), serde_bencode::Error> {
 /// use serde_derive::{Serialize, Deserialize};
 ///
 /// #[derive(Serialize, Deserialize, PartialEq, Eq, Debug)]
@@ -403,7 +403,7 @@ pub fn to_bytes<T: ser::Serialize>(b: &T) -> Result<Vec<u8>> {
 /// };
 ///
 /// assert_eq!(
-///     torrust_serde_bencode::to_string(&address)?,
+///     serde_bencode::to_string(&address)?,
 ///     "d4:city18:Duckburg, Calisota6:street17:1313 Webfoot Walke".to_string(),
 /// );
 /// # Ok(())