Merge #5: Rename the package to bencode2json

63b33cb chore: add mandatory package attributes (Jose Celano)
875380d chore: rename package to bencode2json (Jose Celano)

Pull request description:

  Rename the package to `bencode2json`.

ACKs for top commit:
  josecelano:
    ACK 63b33cb

Tree-SHA512: 67aa4a0c97522351fb6244e43fe1d8116e8f506788102872bc0f3a123675d0ab063b7ee9a4c927818ee1ebee1ed1d110bb360ec21625a9f2da40c84c8de769a7

Cargo.toml

@@ -1,6 +1,11 @@
 [package]
+authors = ["Jose Celano <[email protected]>", "Cameron Garnham <[email protected]>"]
+description = "A Bencoded to JSON converter library and console app with no intermediary in-memory structure."
 edition = "2021"
-name = "torrust-bencode2json"
+exclude = [".*", "cSpell.json", "rustfmt.toml"]
+license = "LGPL-3.0"
+name = "bencode2json"
+repository = "https://github.com/torrust/bencode2json"
 version = "0.1.0"
 
 [workspace]

README.md

@@ -92,21 +92,21 @@ echo "d3:foold3:bari42eeee" | cargo run | jq
 You can install the binary with:
 
 ```console
-cargo install torrust-bencode2json
+cargo install bencode2json
 ```
 
 Or by using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall):
 
 ```console
-cargo binstall torrust-bencode2json
+cargo binstall bencode2json
 ```
 
 ## Library
 
 You can install the library with:
 
 ```console
-cargo add torrust-bencode2json
+cargo add bencode2json
 ```
 
 There two ways of using the library:
@@ -117,7 +117,7 @@ There two ways of using the library:
 Example using the high-level parser wrappers:
 
 ```rust
-use torrust_bencode2json::{try_bencode_to_json};
+use bencode2json::{try_bencode_to_json};
 
 let result = try_bencode_to_json(b"d4:spam4:eggse").unwrap();
 
@@ -127,7 +127,7 @@ assert_eq!(result, r#"{"spam":"eggs"}"#);
 Example using the low-level parser:
 
 ```rust
-use torrust_bencode2json::parsers::{BencodeParser};
+use bencode2json::parsers::{BencodeParser};
 
 let mut output = String::new();
 

examples/parser_file_in_file_out.rs

@@ -11,7 +11,7 @@ use std::{
 };
 
 use clap::{Arg, Command};
-use torrust_bencode2json::parsers::BencodeParser;
+use bencode2json::parsers::BencodeParser;
 
 fn main() {
     let matches = Command::new("parser_file_in_file_out")

examples/parser_stdin_stdout.rs

@@ -7,7 +7,7 @@
 //! It prints "spam".
 use std::io;
 
-use torrust_bencode2json::parsers::BencodeParser;
+use bencode2json::parsers::BencodeParser;
 
 fn main() {
     let input = Box::new(io::stdin());

examples/parser_string_in_string_out.rs

@@ -5,7 +5,7 @@
 //! ```
 //!
 //! It prints "spam".
-use torrust_bencode2json::parsers::BencodeParser;
+use bencode2json::parsers::BencodeParser;
 
 fn main() {
     let input = "4:spam".to_string();

examples/parser_string_in_vec_out.rs

@@ -5,7 +5,7 @@
 //! ```
 //!
 //! It prints "spam".
-use torrust_bencode2json::parsers::BencodeParser;
+use bencode2json::parsers::BencodeParser;
 
 fn main() {
     let input = "4:spam".to_string();

examples/parser_vec_in_string_out.rs

@@ -5,7 +5,7 @@
 //! ```
 //!
 //! It prints "spam".
-use torrust_bencode2json::parsers::BencodeParser;
+use bencode2json::parsers::BencodeParser;
 
 fn main() {
     let input = b"4:spam".to_vec();

examples/parser_vec_in_vec_out.rs

@@ -5,7 +5,7 @@
 //! ```
 //!
 //! It prints "spam".
-use torrust_bencode2json::parsers::BencodeParser;
+use bencode2json::parsers::BencodeParser;
 
 fn main() {
     let input = b"4:spam".to_vec();

examples/try_bencode_to_json.rs

@@ -3,7 +3,7 @@
 //! ```not_rust
 //! cargo run --example try_bencode_to_json
 //! ```
-use torrust_bencode2json::try_bencode_to_json;
+use bencode2json::try_bencode_to_json;
 
 fn main() {
     let result = try_bencode_to_json(b"d4:spam4:eggse").unwrap();

src/lib.rs

@@ -18,7 +18,7 @@
 //! function:
 //!
 //! ```rust
-//! use torrust_bencode2json::{try_bencode_to_json};
+//! use bencode2json::{try_bencode_to_json};
 //!
 //! let result = try_bencode_to_json(b"d4:spam4:eggse").unwrap();
 //!

src/main.rs

@@ -13,17 +13,17 @@
 //! ```text
 //! cargo run -- -i ./tests/fixtures/sample.bencode -o output.json
 //! ```
+use bencode2json::parsers::BencodeParser;
 use clap::{Arg, Command};
 use std::fs::File;
 use std::io::{self, Read, Write};
-use torrust_bencode2json::parsers::BencodeParser;
 
 fn main() {
     run();
 }
 
 fn run() {
-    let matches = Command::new("torrust-bencode2json")
+    let matches = Command::new("bencode2json")
         .version("0.1.0")
         .author("Torrust Organization")
         .about("Converts Bencode to JSON")

tests/integration.rs

@@ -7,7 +7,7 @@ mod it_should {
 
     #[test]
     fn read_from_stdin_and_write_to_stdout() {
-        let mut cmd = Command::cargo_bin("torrust-bencode2json").unwrap();
+        let mut cmd = Command::cargo_bin("bencode2json").unwrap();
         cmd.write_stdin("4:spam")
             .assert()
             .success()
@@ -20,7 +20,7 @@ mod it_should {
 
         let output_file = temp_dir.path().join("output.json");
 
-        let mut cmd = Command::cargo_bin("torrust-bencode2json").unwrap();
+        let mut cmd = Command::cargo_bin("bencode2json").unwrap();
 
         cmd.arg("-i")
             .arg("tests/fixtures/sample.bencode")
@@ -40,7 +40,7 @@ mod it_should {
 
         let output_file = temp_dir.path().join("new_file.json");
 
-        let mut cmd = Command::cargo_bin("torrust-bencode2json").unwrap();
+        let mut cmd = Command::cargo_bin("bencode2json").unwrap();
 
         cmd.arg("-i")
             .arg("tests/fixtures/sample.bencode")
@@ -56,7 +56,7 @@ mod it_should {
 
     #[test]
     fn fail_when_the_bencoded_input_is_invalid() {
-        let mut cmd = Command::cargo_bin("torrust-bencode2json").unwrap();
+        let mut cmd = Command::cargo_bin("bencode2json").unwrap();
         cmd.write_stdin("a")
             .assert()
             .failure()
@@ -69,7 +69,7 @@ mod it_should {
 
         let output_file = temp_dir.path().join("output.json");
 
-        let mut cmd = Command::cargo_bin("torrust-bencode2json").unwrap();
+        let mut cmd = Command::cargo_bin("bencode2json").unwrap();
 
         cmd.arg("-i")
             .arg("non_existing_file.bencode")
@@ -85,7 +85,7 @@ mod it_should {
 
         let output_file = temp_dir.path().join("non_existing_dir/new_file.json");
 
-        let mut cmd = Command::cargo_bin("torrust-bencode2json").unwrap();
+        let mut cmd = Command::cargo_bin("bencode2json").unwrap();
 
         cmd.arg("-i")
             .arg("tests/fixtures/sample.bencode")