feat: v0.5.1, solving clippy lintings and adapted the code to Rust v1.82.0

Author: TheRustifyer

Cargo.toml

@@ -21,11 +21,11 @@ members = [
 
 [dependencies]
 # Project crates
-canyon_connection = { workspace = true, path = "canyon_connection" }
-canyon_crud = { workspace = true, path = "canyon_crud" }
-canyon_entities = { workspace = true, path = "canyon_entities" }
-canyon_migrations = { workspace = true, path = "canyon_migrations", optional = true  }
-canyon_macros = { workspace = true, path = "canyon_macros" }
+canyon_connection = { workspace = true }
+canyon_crud = { workspace = true }
+canyon_entities = { workspace = true }
+canyon_migrations = { workspace = true, optional = true  }
+canyon_macros = { workspace = true }
 
 # To be marked as opt deps
 tokio-postgres = { workspace = true, optional = true }
@@ -35,11 +35,11 @@ mysql_common = { workspace = true, optional = true }
 
 
 [workspace.dependencies]
-canyon_crud = { version = "0.5.0", path = "canyon_crud" }
-canyon_connection = { version = "0.5.0", path = "canyon_connection" }
-canyon_entities = { version = "0.5.0", path = "canyon_entities" }
-canyon_migrations = { version = "0.5.0", path = "canyon_migrations"}
-canyon_macros = { version = "0.5.0", path = "canyon_macros" }
+canyon_crud = { version = "0.5.1", path = "canyon_crud" }
+canyon_connection = { version = "0.5.1", path = "canyon_connection" }
+canyon_entities = { version = "0.5.1", path = "canyon_entities" }
+canyon_migrations = { version = "0.5.1", path = "canyon_migrations"}
+canyon_macros = { version = "0.5.1", path = "canyon_macros" }
 
 tokio = { version = "1.27.0", features = ["full"]  }
 tokio-util = { version = "0.7.4", features = ["compat"]  }
@@ -64,10 +64,8 @@ partialdebug = "0.2.0"
 quote = "1.0.9"
 proc-macro2 = "1.0.27"
 
-
-
 [workspace.package]
-version = "0.5.0"
+version = "0.5.1"
 edition = "2021"
 authors = ["Alex Vergara<pyzyryab@tutanota.com>, Gonzalo Busto Musi<gonzalo.busto@gmail.com>"]
 documentation = "https://zerodaycode.github.io/canyon-book/"
@@ -77,7 +75,7 @@ license = "MIT"
 description = "A Rust ORM and QueryBuilder"
 
 [features]
-postgres = ["tokio-postgres", "canyon_connection/postgres", "canyon_crud/postgres", "canyon_migrations/postgres", "canyon_macros/postgres"]
-mssql = ["tiberius", "canyon_connection/mssql", "canyon_crud/mssql", "canyon_migrations/mssql", "canyon_macros/mssql"]
-mysql = ["mysql_async", "mysql_common", "canyon_connection/mysql", "canyon_crud/mysql", "canyon_migrations/mysql", "canyon_macros/mysql"]
+postgres =   ["tokio-postgres",    "canyon_connection/postgres", "canyon_crud/postgres",    "canyon_migrations/postgres", "canyon_macros/postgres"]
+mssql =      ["tiberius",          "canyon_connection/mssql",    "canyon_crud/mssql",       "canyon_migrations/mssql",    "canyon_macros/mssql"]
+mysql =      ["mysql_async",       "mysql_common",               "canyon_connection/mysql", "canyon_crud/mysql",          "canyon_migrations/mysql", "canyon_macros/mysql"]
 migrations = ["canyon_migrations", "canyon_macros/migrations"]

README.md

@@ -140,3 +140,40 @@ If you want to run the tests (because this is the first thing that you want to d
 - If you have Docker, and `Canyon-SQL` cloned of forked, you can run our docker-compose file `(docker/docker-compose.yml)`, which will initialize a `PostgreSQL` and `MySql` database and will put content on it to make the tests able to work.
 - Finally, some tests run against `MSSQL`. We didn't found a nice way of inserting data directly when the Docker wakes up, but instead, we run a very special test located at `tests/crud/mod.rs`, that is named `initialize_sql_server_docker_instance`. When you run this one, initial data will be inserted into the tables that are created when this test run.
 (If you know a better way of doing this, please, open an issue to let us know, and improve this process!)
+
+## Known issues
+
+### Missing dependency: OpenSSL
+
+There's a certain set of common issues while building `Canyon-SQL` in development or in client code. Those building issues
+are related with missing packages or dependencies that `Cargo` doesn't resolves automatically depending on the underlying OS.
+
+```
+openssl-sys@0.9.104: Could not find directory of OpenSSL installation, and this `-sys` crate cannot proceed without this knowledge.
+If OpenSSL is installed and this crate had trouble finding it,  you can set the `OPENSSL_DIR` environment variable for the compilation process.
+See stderr section below for further information.
+```
+
+This means that the `OpenSSL` package isn't installed on your system or not in *PATH*.
+
+In a Debian based system, you can just `sudo apt install libssl-dev`. For others, just use your package manager
+to solve it by install it.
+
+### Missing dependency: pkg-config
+
+```
+Could not find openssl via pkg-config:
+  Could not run `PKG_CONFIG_ALLOW_SYSTEM_CFLAGS=1 pkg-config --libs --cflags openssl`
+  The pkg-config command could not be found.
+```
+`Cargo` may try to discover the `OpenSSL` package via `pkg-config`. If you find this error, you can
+`sudo apt install pkg-config` on *apt* based systems. For other systems, you must read your package manager
+docs and install it.
+
+### failed to run custom build command for `libgssapi-sys vX.X.X`
+
+The problem is missing a *C* header `gssapi.h`.
+
+- Alpine: `apk --update add krb5-pkinit krb5-dev krb5`
+- Ubuntu: `apt-get -y install gcc libgssapi-krb5-2 libkrb5-dev libsasl2-modules-gssapi-mit`
+

canyon_crud/src/query_elements/query_builder.rs

@@ -66,9 +66,9 @@ pub mod ops {
         /// Generates a `WHERE` SQL clause for constraint the query.
         ///
         /// * `column` - A [`FieldValueIdentifier`] that will provide the target
-        /// column name and the value for the filter
+        ///     column name and the value for the filter
         /// * `op` - Any element that implements [`Operator`] for create the comparison
-        /// or equality binary operator
+        ///     or equality binary operator
         fn r#where<Z: FieldValueIdentifier<'a, T>>(
             &mut self,
             column: Z,
@@ -80,9 +80,9 @@ pub mod ops {
         /// Generates an `AND` SQL clause for constraint the query.
         ///
         /// * `column` - A [`FieldValueIdentifier`] that will provide the target
-        /// column name and the value for the filter
+        ///     column name and the value for the filter
         /// * `op` - Any element that implements [`Operator`] for create the comparison
-        /// or equality binary operator
+        ///     or equality binary operator
         fn and<Z: FieldValueIdentifier<'a, T>>(
             &mut self,
             column: Z,
@@ -93,10 +93,10 @@ pub mod ops {
         /// the filter in conjunction with an `IN` operator that will ac
         ///
         /// * `column` - A [`FieldIdentifier`] that will provide the target
-        /// column name for the filter, based on the variant that represents
-        /// the field name that maps the targeted column name
+        ///     column name for the filter, based on the variant that represents
+        ///     the field name that maps the targeted column name
         /// * `values` - An array of [`QueryParameter`] with the values to filter
-        /// inside the `IN` operator
+        ///     inside the `IN` operator
         fn and_values_in<Z, Q>(&mut self, column: Z, values: &'a [Q]) -> &mut Self
         where
             Z: FieldIdentifier<T>,
@@ -106,10 +106,10 @@ pub mod ops {
         /// the filter in conjunction with an `IN` operator that will ac
         ///
         /// * `column` - A [`FieldIdentifier`] that will provide the target
-        /// column name for the filter, based on the variant that represents
-        /// the field name that maps the targeted column name
+        ///     column name for the filter, based on the variant that represents
+        ///     the field name that maps the targeted column name
         /// * `values` - An array of [`QueryParameter`] with the values to filter
-        /// inside the `IN` operator
+        ///     inside the `IN` operator
         fn or_values_in<Z, Q>(&mut self, r#or: Z, values: &'a [Q]) -> &mut Self
         where
             Z: FieldIdentifier<T>,
@@ -118,18 +118,16 @@ pub mod ops {
         /// Generates an `OR` SQL clause for constraint the query.
         ///
         /// * `column` - A [`FieldValueIdentifier`] that will provide the target
-        /// column name and the value for the filter
+        ///     column name and the value for the filter
         /// * `op` - Any element that implements [`Operator`] for create the comparison
-        /// or equality binary operator
+        ///     or equality binary operator
         fn or<Z: FieldValueIdentifier<'a, T>>(&mut self, column: Z, op: impl Operator)
             -> &mut Self;
 
         /// Generates a `ORDER BY` SQL clause for constraint the query.
         ///
-        /// * `order_by` - A [`FieldIdentifier`] that will provide the target
-        /// column name
-        /// * `desc` - a boolean indicating if the generated `ORDER_BY` must be
-        /// in ascending or descending order
+        /// * `order_by` - A [`FieldIdentifier`] that will provide the target  column name
+        /// * `desc` - a boolean indicating if the generated `ORDER_BY` must be in ascending or descending order
         fn order_by<Z: FieldIdentifier<T>>(&mut self, order_by: Z, desc: bool) -> &mut Self;
     }
 }
@@ -452,9 +450,9 @@ where
 }
 
 /// Contains the specific database operations of the *UPDATE* SQL statements.
-///  
+///
 /// * `set` - To construct a new `SET` clause to determine the columns to
-/// update with the provided values
+///     update with the provided values
 #[derive(Debug, Clone)]
 pub struct UpdateQueryBuilder<'a, T>
 where
@@ -590,9 +588,9 @@ where
 
 /// Contains the specific database operations associated with the
 /// *DELETE* SQL statements.
-///  
+///
 /// * `set` - To construct a new `SET` clause to determine the columns to
-/// update with the provided values
+///     update with the provided values
 #[derive(Debug, Clone)]
 pub struct DeleteQueryBuilder<'a, T>
 where

canyon_macros/src/utils/function_parser.rs

@@ -5,6 +5,7 @@ use syn::{
 
 /// Implementation of syn::Parse for the `#[canyon]` proc-macro
 #[derive(Clone)]
+#[allow(dead_code)]
 pub struct FunctionParser {
     pub attrs: Vec<Attribute>,
     pub vis: Visibility,

canyon_macros/src/utils/helpers.rs

@@ -127,7 +127,8 @@ fn test_entity_database_name_defaulter() {
         "MajorLeague".to_owned()
     );
 }
-///
+
+/// Autogenerates a default table name for an entity given their struct name
 pub fn default_database_table_name_from_entity_name(ty: &str) -> String {
     let struct_name: String = ty.to_string();
     let mut table_name: String = String::new();

canyon_macros/src/utils/macro_tokens.rs

@@ -6,6 +6,7 @@ use syn::{Attribute, DeriveInput, Fields, Generics, Type, Visibility};
 
 /// Provides a convenient way of store the data for the TokenStream
 /// received on a macro
+#[allow(dead_code)]
 pub struct MacroTokens<'a> {
     pub vis: &'a Visibility,
     pub ty: &'a Ident,
@@ -114,7 +115,7 @@ impl<'a> MacroTokens<'a> {
         column_names_as_chars.as_str().to_owned()
     }
 
-    ///
+    /// Retrieves the value of the index of an annotated field with #[primary_key]
     pub fn get_pk_index(&self) -> Option<usize> {
         let mut pk_index = None;
         for (idx, field) in self.fields.iter().enumerate() {

canyon_migrations/src/migrations/memory.rs

@@ -57,7 +57,6 @@ impl Transaction<Self> for CanyonMemory {}
 impl CanyonMemory {
     /// Queries the database to retrieve internal data about the structures
     /// tracked by `CanyonSQL`
-    #[cfg(not(cargo_check))]
     #[allow(clippy::nonminimal_bool)]
     pub async fn remember(
         datasource: &DatasourceConfig,
@@ -184,7 +183,6 @@ impl CanyonMemory {
 
     /// Parses the Rust source code files to find the one who contains Canyon entities
     /// ie -> annotated with `#[canyon_entity]`
-    #[cfg(not(cargo_check))]
     async fn find_canyon_entity_annotated_structs(
         &mut self,
         canyon_entities: &[CanyonRegisterEntity<'_>],

tests/canyon_integration_tests.rs

@@ -1,11 +1,11 @@
-// Integration tests for the heart of a Canyon-SQL application, the CRUD operations.
+/// Integration tests for the heart of a Canyon-SQL application, the CRUD operations.
 ///
-// This tests will tests mostly the whole source code of Canyon, due to its integration nature
+/// This tests will tests mostly the whole source code of Canyon, due to its integration nature
 ///
-// Guide-style: Almost every operation in Canyon is `Result` wrapped (without the) unckecked
-// variants of the `find_all` implementations. We will go to directly `.unwrap()` the results
-// because, if there's something wrong in the code reported by the tests, we want to *panic*
-// and abort the execution.
+/// Guide-style: Almost every operation in Canyon is `Result` wrapped (without the) unckecked
+/// variants of the `find_all` implementations. We will go to directly `.unwrap()` the results
+/// because, if there's something wrong in the code reported by the tests, we want to *panic*
+/// and abort the execution.
 extern crate canyon_sql;
 
 use std::error::Error;

tests/crud/foreign_key_operations.rs

@@ -1,13 +1,13 @@
-// Integration tests for the CRUD operations available in `Canyon` that
-// generates and executes *SELECT* statements based on a entity
-// annotated with the `#[foreign_key(... args)]` annotation looking
-// for the related data with some entity `U` that acts as is parent, where `U`
-// impls `ForeignKeyable` (isn't required, but it won't unlock the
-// reverse search features parent -> child, only the child -> parent ones).
+/// Integration tests for the CRUD operations available in `Canyon` that
+/// generates and executes *SELECT* statements based on a entity
+/// annotated with the `#[foreign_key(... args)]` annotation looking
+/// for the related data with some entity `U` that acts as is parent, where `U`
+/// impls `ForeignKeyable` (isn't required, but it won't unlock the
+/// reverse search features parent -> child, only the child -> parent ones).
 ///
-// Names of the foreign key methods are autogenerated for the direct and
-// reverse side of the implementations.
-// For more info: TODO -> Link to the docs of the foreign key chapter
+/// Names of the foreign key methods are autogenerated for the direct and
+/// reverse side of the implementations.
+/// For more info: TODO -> Link to the docs of the foreign key chapter
 use canyon_sql::crud::CrudOperations;
 
 #[cfg(feature = "mssql")]

tests/crud/querybuilder_operations.rs

@@ -3,11 +3,11 @@ use crate::constants::MYSQL_DS;
 #[cfg(feature = "mssql")]
 use crate::constants::SQL_SERVER_DS;
 
-// Tests for the QueryBuilder available operations within Canyon.
+/// Tests for the QueryBuilder available operations within Canyon.
 ///
-// QueryBuilder are the way of obtain more flexibility that with
-// the default generated queries, essentially for build the queries
-// with the SQL filters
+/// QueryBuilder are the way of obtain more flexibility that with
+/// the default generated queries, essentially for build the queries
+/// with the SQL filters
 ///
 use canyon_sql::{
     crud::CrudOperations,