feat(branch): feat/libmake

Author: sebastienrousseau

.gitignore

@@ -6,3 +6,4 @@ build
 Cargo.lock
 Icon?
 src/.DS_Store
+/my_library/

Cargo.toml

@@ -14,7 +14,7 @@ license = "MIT OR Apache-2.0"
 name = "libmake"
 repository = "https://github.com/sebastienrousseau/libmake.git"
 rust-version = "1.69.0"
-version = "0.1.8"
+version = "0.1.9"
 include = [
     "/CONTRIBUTING.md",
     "/LICENSE-APACHE",
@@ -41,20 +41,19 @@ path = "benches/criterion.rs"
 debug = true
 
 [dependencies]
-assert_cmd = "2.0.11"
-clap = "4.2.7"
-csv = "1.2.1"
+assert_cmd = "2.0.12"
+clap = "4.4.6"
+csv = "1.3.0"
 figlet-rs = "0.1.5"
-openssl = { version = "0.10.52", features = ["vendored"] }
-reqwest = { version = "0.11.17", features = ["blocking"] }
-serde = { version = "1.0.162", features = ["derive"] }
-serde_json = "1.0.96"
-serde_yaml = "0.9.21"
-toml = "0.7.3"
+reqwest = { version = "0.11.22", features = ["blocking"] }
+serde = { version = "1.0.188", features = ["derive"] }
+serde_json = "1.0.107"
+serde_yaml = "0.9.25"
+toml = "0.8.2"
 
 [dev-dependencies]
-criterion = "0.5.0"
-predicates = "3.0.3"
+criterion = "0.5.1"
+predicates = "3.0.4"
 
 [lib]
 crate-type = ["lib"]

README.md

@@ -338,6 +338,6 @@ this project.
 [codecov-badge]: https://img.shields.io/codecov/c/github/sebastienrousseau/libmake?style=for-the-badge&token=Q9KJ6XXL67 'Codecov'
 [crates-badge]: https://img.shields.io/crates/v/libmake.svg?style=for-the-badge 'Crates.io Badge'
 [docs-badge]: https://img.shields.io/docsrs/libmake.svg?style=for-the-badge 'Docs.rs Badge'
-[libs-badge]: https://img.shields.io/badge/lib.rs-v0.1.8-orange.svg?style=for-the-badge 'Lib.rs Badge'
+[libs-badge]: https://img.shields.io/badge/lib.rs-v0.1.9-orange.svg?style=for-the-badge 'Lib.rs Badge'
 [license-badge]: https://img.shields.io/crates/l/libmake.svg?style=for-the-badge 'License Badge'
 [made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust Badge'

TEMPLATE.md

@@ -4,7 +4,7 @@
 alt="LibMake logo" width="261" align="right" />
 
 <!-- markdownlint-enable MD033 MD041 -->
-# LibMake v0.1.8 🦀
+# LibMake v0.1.9 🦀
 
 A code generator to reduce repetitive tasks and build high-quality Rust libraries.
 
@@ -63,6 +63,6 @@ The library is designed to be used as a command-line tool. It is available on [C
 [codecov-badge]: https://img.shields.io/codecov/c/github/sebastienrousseau/libmake?style=for-the-badge&token=Q9KJ6XXL67 'Codecov'
 [crates-badge]: https://img.shields.io/crates/v/libmake.svg?style=for-the-badge 'Crates.io Badge'
 [docs-badge]: https://img.shields.io/docsrs/libmake.svg?style=for-the-badge 'Docs.rs Badge'
-[libs-badge]: https://img.shields.io/badge/lib.rs-v0.1.8-orange.svg?style=for-the-badge 'Lib.rs Badge'
+[libs-badge]: https://img.shields.io/badge/lib.rs-v0.1.9-orange.svg?style=for-the-badge 'Lib.rs Badge'
 [license-badge]: https://img.shields.io/crates/l/libmake.svg?style=for-the-badge 'License Badge'
 [made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust Badge'

benches/criterion.rs

@@ -1,3 +1,42 @@
+//! # Benchmark: libmake
+//!
+//! This benchmark tests the performance of the `libmake` crate using the Criterion library.
+//! It measures the execution time of the `run` function from the `libmake` crate.
+//!
+//! ## Purpose
+//!
+//! The purpose of this benchmark is to assess the execution time of the `run` function
+//! from the `libmake` crate under controlled conditions. It helps identify any potential
+//! performance bottlenecks and allows for optimization if needed.
+//!
+//! ## Usage
+//!
+//! To run this benchmark, ensure that you have the `criterion` and `libmake` crates
+//! included as dependencies in your project's `Cargo.toml` file.
+//!
+//! In your project's code, you can use the `criterion_group` and `criterion_main` macros
+//! to define and run benchmarks. In this specific benchmark, the `libmake_benchmark` function
+//! is defined to measure the execution time of the `run` function.
+//!
+//! ```rust
+//! extern crate criterion;
+//! extern crate libmake;
+//!
+//! use criterion::{criterion_group, criterion_main, Criterion};
+//! use libmake::run;
+//!
+//! fn libmake_benchmark(c: &mut Criterion) {
+//!     c.bench_function("libmake", |b| b.iter(run));
+//! }
+//!
+//! criterion_group!(benches, libmake_benchmark);
+//! criterion_main!(benches);
+//! ```
+//!
+//! Running this benchmark will provide performance metrics for the `run` function
+//! from the `libmake` crate, helping you evaluate and optimize its performance.
+
+#![allow(missing_docs)]
 extern crate criterion;
 extern crate libmake;
 

build.rs

@@ -1,4 +1,10 @@
+// Copyright © 2023 LibMake. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+//! This is the main function for the build script.
+//!
+//! Currently, it only instructs Cargo to re-run this build script if `build.rs` is changed.
 fn main() {
     // Avoid unnecessary re-building.
     println!("cargo:rerun-if-changed=build.rs");
-}
+}

examples/generate_from_args.rs

@@ -1,20 +1,51 @@
+//! A simple test program for the `generate_from_args` function.
+//!
+//! This program simulates command line arguments and calls the `generate_from_args` function
+//! to generate files based on the provided arguments.
+//!
+//! # Arguments
+//!
+//! * `--author=<value>` - The author name for the generated files.
+//! * `--output=<value>` - The output directory for the generated files.
+//!
+//! # Example
+//!
+//! To run this test program, use the following command:
+//!
+//! ```
+//! $ cargo run --release
+//! ```
+//!
+//! Make sure to replace `<value>` with the desired values for `--author` and `--output`.
+//!
+//! If successful, this program will print "Successfully generated files!".
+//!
+//! If there is an error, it will print an error message.
+
+// Import the necessary function for generating files from arguments
 use libmake::generator::generate_from_args;
 
 fn main() -> std::io::Result<()> {
+    // Simulate command line arguments
     let args = "--author=Me --output=my_library"
         .split(' ')
         .map(|s| s.to_string())
         .collect::<Vec<String>>();
 
+    // Check if there are at least two arguments (program name and at least one option)
     if args.len() < 2 {
         eprintln!("Usage: {} <args>", args[0]);
         return Ok(());
     }
 
+    // Join the arguments (excluding the program name) into a single string
     let args_str = args[1..].join(" ");
+
+    // Call the `generate_from_args` function with the arguments string
     let result = generate_from_args(&args_str);
     println!("{:?}", result);
 
+    // Check the result of the function call and print a message accordingly
     match result {
         Ok(()) => println!("Successfully generated files!"),
         Err(err) => eprintln!("Error: {}", err),

examples/generate_from_config.rs

@@ -1,8 +1,51 @@
+//! # Example: Generating Templates from a Configuration File
+//!
+//! This is an example that demonstrates how to generate template files
+//! based on a configuration file using the `generate_from_config` function.
+//!
+//! ## Usage
+//!
+//! To run this example, make sure you have a valid configuration file at the specified path.
+//! The example allows you to define the file type (e.g., "yaml") and the file path.
+//! It then calls the `generate_from_config` function with the file path and file type as parameters.
+//!
+//! If generation is successful, it does nothing (the template files are created).
+//! If there is an error during generation, it prints an error message.
+//!
+//! ```rust
+//! use libmake::generator::generate_from_config;
+//!
+//!   // Define the file path for the configuration file.
+//!   let file_path = "./tests/data/mylibrary.yaml";
+//!
+//!   // Define the file type, which is "yaml" in this case.
+//!   let file_type = "yaml";
+//!
+//!   // Call the generate_from_config function with the file_path and file_type.
+//!   // This function generates template files based on the configuration.
+//!   match generate_from_config(file_path, file_type) {
+//!       // If generation is successful, do nothing (the template files are created).
+//!       Ok(_) => (),
+//!       // If there is an error during generation, print an error message.
+//!       Err(err) => eprintln!("Error: {}", err),
+//!   }
+//! ```
+
 use libmake::generator::generate_from_config;
+
 fn main() {
+    // Define the file path for the configuration file.
     let file_path = "./tests/data/mylibrary.yaml";
+
+    // Define the file type, which is "yaml" in this case.
     let file_type = "yaml";
 
-    generate_from_config(file_path, file_type)
-        .expect("Failed to generate the template files");
+    // Call the generate_from_config function with the file_path and file_type.
+    // This function generates template files based on the configuration.
+    match generate_from_config(file_path, file_type) {
+        // If generation is successful, do nothing (the template files are created).
+        Ok(_) => (),
+        // If there is an error during generation, print an error message.
+        Err(err) => eprintln!("Error: {}", err),
+    }
 }

examples/generate_from_csv.rs

@@ -1,6 +1,41 @@
+//! # Example: Generating Templates from a CSV File
+//!
+//! This is a simple test that demonstrates how to generate files from a CSV file
+//! using the `generate_from_csv` function. It attempts to generate template files
+//! from a CSV file and expects the operation to be successful.
+//!
+//! ## Usage
+//!
+//! To run this example, make sure you have a valid CSV file at the specified path.
+//! The example will attempt to generate template files based on the CSV data.
+//! If generation fails, it will print an error message.
+//!
+//! ```rust
+//! // Import the necessary function for generating templates from a CSV file.
+//! use libmake::generator::generate_from_csv;
+//!
+//! /// This is a simple test for generating files from a CSV file using the `generate_from_csv` function.
+//! /// It attempts to generate template files from a CSV file and expects the operation to be successful.
+//! // Define the path to the CSV file to be used for testing.
+//! let csv_file_path = "./tests/data/mylibrary.csv";
+//!
+//! // Attempt to generate template files from the specified CSV file.
+//! // If successful, it indicates that the generation process worked as expected.
+//! generate_from_csv(csv_file_path)
+//!     .expect("Failed to generate the template files");
+//! ```
+
+// Import the necessary function for generating templates from a CSV file.
 use libmake::generator::generate_from_csv;
+
+/// This is a simple test for generating files from a CSV file using the `generate_from_csv` function.
+/// It attempts to generate template files from a CSV file and expects the operation to be successful.
 fn main() {
+    // Define the path to the CSV file to be used for testing.
     let csv_file_path = "./tests/data/mylibrary.csv";
+
+    // Attempt to generate template files from the specified CSV file.
+    // If successful, it indicates that the generation process worked as expected.
     generate_from_csv(csv_file_path)
         .expect("Failed to generate the template files");
 }

examples/generate_from_json.rs

@@ -1,6 +1,44 @@
+//! # Example: Generating Templates from a JSON File
+//!
+//! This example demonstrates how to use the `generate_from_json` function from the `libmake` crate
+//! to generate template files from a JSON file containing configuration data.
+//!
+//! ## Usage
+//!
+//! To run this example, ensure that you have a valid JSON file at the specified path.
+//! The example defines the path to the JSON file (`json_file_path`) and then calls
+//! the `generate_from_json` function with this path as a parameter.
+//!
+//! If the generation process is successful, it does nothing (the template files are created).
+//! If there is an error during generation, it prints an error message.
+//!
+//! ```rust
+//! // Import the necessary function for generating templates from a JSON file.
+//! use libmake::generator::generate_from_json;
+//!
+//! /// This test demonstrates how to use the `generate_from_json` function from the `libmake` crate
+//! /// to generate template files from a JSON file.
+//!
+//! // Define the path to the JSON file that contains configuration data.
+//! let json_file_path = "./tests/data/mylibrary.json";
+//!
+//! // Generate template files based on the data in the JSON file.
+//! // If the generation process fails, an error message is printed.
+//! generate_from_json(json_file_path)
+//!     .expect("Failed to generate the template files");
+//! ```
+
+// Import the necessary function for generating templates from a JSON file.
 use libmake::generator::generate_from_json;
+
+/// This test demonstrates how to use the `generate_from_json` function from the `libmake` crate
+/// to generate template files from a JSON file.
 fn main() {
+    // Define the path to the JSON file that contains configuration data.
     let json_file_path = "./tests/data/mylibrary.json";
+
+    // Generate template files based on the data in the JSON file.
+    // If the generation process fails, an error message is printed.
     generate_from_json(json_file_path)
         .expect("Failed to generate the template files");
 }

examples/generate_from_toml.rs

@@ -1,6 +1,37 @@
+//! # Example: Generating Templates from a TOML File
+//!
+//! This is a simple example that demonstrates how to generate template files
+//! based on configuration stored in a TOML file using the `generate_from_toml`
+//! function.
+//!
+//! ## Usage
+//!
+//! To run this example, make sure you have a valid TOML configuration file
+//! at the specified path. The example will attempt to generate template files
+//! based on the configuration. If generation fails, it will print an error
+//! message.
+//!
+//! ```rust
+//! // Import the necessary function for generating templates from a TOML file.
+//! use libmake::generator::generate_from_toml;
+//!
+//!     // Define the path to the TOML file containing configuration.
+//!     let toml_file_path = "./tests/data/mylibrary.toml"      
+//!     // Generate template files based on the configuration in the TOML file.
+//!     // If generation fails, it will print an error message.
+//!     generate_from_toml(toml_file_path)
+//!         .expect("Failed to generate the template files");
+//! ```
+//!
+// Import the necessary function for generating templates from a TOML file.
 use libmake::generator::generate_from_toml;
+
 fn main() {
+    // Define the path to the TOML file containing configuration.
     let toml_file_path = "./tests/data/mylibrary.toml";
+
+    // Generate template files based on the configuration in the TOML file.
+    // If generation fails, it will print an error message.
     generate_from_toml(toml_file_path)
         .expect("Failed to generate the template files");
 }

examples/generate_from_yaml.rs

@@ -1,6 +1,37 @@
+//! # Example: Generating Templates from a YAML File
+//!
+//! This is a simple example that demonstrates how to use the `generate_from_yaml` function
+//! from the `libmake` crate to generate template files from a YAML file.
+//!
+//! ## Usage
+//!
+//! To run this example, make sure you have a valid YAML file at the specified path.
+//! The example specifies the path to the YAML file (`yaml_file_path`) and then calls
+//! the `generate_from_yaml` function with this path as a parameter.
+//!
+//! If the generation process is successful, it does nothing (the template files are created).
+//! If there is an error during generation, it prints an error message.
+//!
+//! ```rust
+//! // Import the necessary function for generating templates from a YAML file.
+//! use libmake::generator::generate_from_yaml;
+//!
+//! // Specify the path to the YAML file to be used for generating templates.
+//! let yaml_file_path = "./tests/data/mylibrary.yaml";
+//!
+//! // Generate template files from the specified YAML file.
+//! generate_from_yaml(yaml_file_path)
+//!     .expect("Failed to generate the template files");
+//! ```
+
+// Import the necessary function for generating templates from a YAML file.
 use libmake::generator::generate_from_yaml;
+
 fn main() {
+    // Specify the path to the YAML file to be used for generating templates.
     let yaml_file_path = "./tests/data/mylibrary.yaml";
+
+    // Generate template files from the specified YAML file.
     generate_from_yaml(yaml_file_path)
         .expect("Failed to generate the template files");
-}
+}