Merge pull request #5 from ElBe-Development/dependabot/github_actions/actions/setup-python-5

Bump actions/setup-python from 4 to 5

.github/README.md

@@ -38,60 +38,48 @@ To use localizer-rs, you need a directory (eg. `translations`) with your transla
 
 1. Import the localizer-rs crate:
 
-   ```rust
+    ```rust,ignore
-
+    use localizer_rs;
-   use localizer_rs;
+    ```
-
-   ```
 
 2. Create a new config object:
 
-   ```rust
+    ```rust,ignore
-
+    let config = localizer_rs::Config::new("translations", "en");
-   let config = localizer_rs::Config::new("DIRECTORY NAME", "LANGUAGE NAME");
+    ```
-
-   ```
 
 3. Translate your text:
 
-   ```rust
+    ```rust,ignore
-
+    localizer_rs::t!(config, "key", "placeholder" ="value");
-   config.t("key", vec!["placeholder", "value"]);
+    ```
-
-   ```
 
 ## Example
 
 With the following `en.json` file.
 
 ```json
-
 {
     "error": "{{color.red}}{{bold}}Error:{{end}} Something went wrong: {{details}}."
 }
-
 ```
 
 And the following rust code.
 
-```rust
+```rust,ignore
-
 use localizer_rs;
 
 fn main() {
     let config: localizer_rs::Config = localizer_rs::Config::new("translations", "en");
 
-    println!("{:}", config.t("error", vec![("details", "Path not found")]));
+    println!("{:}", localizer_rs::t!(config, "error", "details" = "Path not found"));
 }
-
 ```
 
 You will get the following output:
 
 ```bash
-
 Error: Something went wrong: Path not found.
-
 ```
 
 Where `Error:` is red and bold.

.github/SECURITY.md

@@ -6,6 +6,8 @@
 | -------- | ------------------ |
 | `v1.0.0` | :white_check_mark: |
 | `v1.1.0` | :white_check_mark: |
+| `v1.1.1` | :white_check_mark: |
+| `v1.2.0` | :white_check_mark: |
 
 ## Reporting a Vulnerability
 

.github/errors.md

@@ -0,0 +1,3 @@
+# errors module
+
+Module for dealing with errors.

.github/workflows/codecov_workflow.yml

@@ -0,0 +1,14 @@
+name: Codecov
+permissions: read-all
+
+on:
+    [push, pull_request]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Upload coverage reports to Codecov
+              uses: codecov/codecov-action@v4
+              env:
+                CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/dependencies.yml

@@ -16,9 +16,9 @@ jobs:
             matrix:
                 python-version: ["3.8"]
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - name: Set up Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v4
+              uses: actions/setup-python@v5
               with:
                   python-version: ${{ matrix.python-version }}
             - name: Install dependencies from txt files
@@ -28,7 +28,7 @@ jobs:
     install-rust-dependencies:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - name: Install dependencies from Cargo.toml
               run: cargo update
             - name: Install dev-dependencies from Cargo.toml
@@ -39,8 +39,8 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               if: ${{ github.event_name != 'push' }}
             - name: Dependency Review
               if: ${{ github.event_name != 'push' }}
-              uses: actions/dependency-review-action@v3
+              uses: actions/dependency-review-action@v4

.github/workflows/label.yml

@@ -20,6 +20,6 @@ jobs:
             pull-requests: write
 
         steps:
-            - uses: actions/labeler@v4
+            - uses: actions/labeler@v5
               with:
                   repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/megalinter.yml

@@ -26,7 +26,7 @@ jobs:
             pull-requests: write
         steps:
             - name: Checkout Code
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                   token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
                   fetch-depth: 0

.github/workflows/rust.yml

@@ -11,7 +11,7 @@ jobs:
     build:
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
             - name: Build
               run: cargo build --verbose
             - name: Run tests

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "localizer-rs"
 description = "Localizer helps localize (translate) your rust applications using json files."
-version = "1.1.0"
+version = "1.2.0"
 authors = [
 	"ElBe-Plaq <elbe.dev.plaq@gmail.com>"
 ]
@@ -10,7 +10,7 @@ rust-version = "1.69"
 documentation = "https://docs.rs/localizer_rs/"
 readme = ".github/README.md"
 repository = "https://github.com/ElBe-Development/localizer-rs/"
-license-file = "LICENSE.txt"
+license = "MIT"
 keywords = ["i18n", "L10n", "json", "local", "translation"]
 categories = [
 	"internationalization",
@@ -20,4 +20,4 @@ publish = true
 
 [dependencies]
 serde = "1.0.188"
-serde_json = "1.0.106"
+serde_json = "1.0.107"

codecov.yml

@@ -0,0 +1,10 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 50%
+        threshold: 1%
+
+comment:
+    require_changes: true
+    require_ci_to_pass: false

dev-requirements.txt

@@ -1 +1 @@
-pre-commit==3.3.2; python_version>='3.8'
+pre-commit==4.1.0; python_version>='3.8'

examples/main.rs

@@ -5,15 +5,16 @@ fn main() {
 
     println!(
         "{:}",
-        config.t(
+        localizer_rs::t!(
+            config,
             "error",
-            vec![("details", "Something went wrong when trying to do stuff")]
+            "details" = "Something went wrong when trying to do stuff"
         )
     );
     println!(
         "{:}",
-        config.t("success", vec![("balance", "$10"), ("user", "John Doe")])
+        localizer_rs::t!(config, "success", "balance" = "$10", "user" = "John Doe")
     );
 
-    println!("{:}", config.t("all", vec![]));
+    println!("{:}", localizer_rs::t!(config, "all"));
 }

justfile

@@ -10,8 +10,7 @@ build *ARGUMENTS:
 
 # Removes temporary files
 clean:
-	rm -rf target
+	cargo clean
-	rm -rf Tools/__pycache__
 
 # Lints the rust source files
 lint *ARGUMENTS:

src/errors.rs

@@ -1,5 +1,6 @@
+#![doc = include_str!("../.github/errors.md")]
 // localizer-rs errors
-// Version: 1.1.0
+// Version: 1.1.1
 
 // Copyright (c) 2023-present ElBe Development.
 
@@ -58,12 +59,39 @@ use std::fmt;
 /// ```
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
 pub struct Error {
+    /// The errors name.
     pub name: String,
+    /// The error description.
     pub description: String,
+    /// The errors exit code.
     pub exit_code: i32,
 }
 
+/// Display implementation for the error object.
 impl fmt::Display for Error {
+    /// Format implementation for the error object.
+    ///
+    /// # Parameters
+    ///
+    /// - `self`: The error object.
+    /// - `f`: The [`fmt::Formatter`] to use.
+    ///
+    /// # Returns
+    ///
+    /// A [`fmt::Result`] containing the formatted error message.
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # use localizer_rs;
+    /// # let error = localizer_rs::errors::Error::new("name", "description", 1);
+    /// println!("{}", error);
+    /// ```
+    ///
+    /// # See also
+    ///
+    /// - [`fmt::Display`]
+    /// - [`Error`]
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         write!(f, "\x1b[31;1m{}\x1b[0m: {}", self.name, self.description)
     }

src/lib.rs

@@ -1,6 +1,6 @@
-#![doc = ".github/README.md"]
+#![doc = include_str!("../.github/README.md")]
 // localizer-rs
-// Version: 1.1.0
+// Version: 1.2.0
 
 // Copyright (c) 2023-present ElBe Development.
 
@@ -37,8 +37,6 @@ use std::fs::File;
 use std::io::BufReader;
 use std::path::Path;
 
-use errors as error_lib;
-
 use serde_json;
 
 
@@ -52,7 +50,8 @@ use serde_json;
 ///
 /// # Parameters
 ///
-/// - `path`: The directory containing the translation files. The directory is relative to the path the executable was executed from.
+/// - `path`: The directory containing the translation files.
+///   The directory is relative to the path the executable was executed from.
 /// - `language`: The language to translate to.
 ///
 /// # Returns
@@ -70,7 +69,10 @@ use serde_json;
 /// ```
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
 pub struct Config {
+    /// The directory containing the translation files. The directory is relative to the path the
+    /// executable was executed from.
     pub path: String,
+    /// The language to translate to.
     pub language: String,
 }
 
@@ -84,7 +86,8 @@ impl Config {
     ///
     /// # Parameters
     ///
-    /// - `path`: The directory containing the translation files. The directory is relative to the path the executable was executed from.
+    /// - `path`: The directory containing the translation files.
+    ///   The directory is relative to the path the executable was executed from.
     /// - `language`: The language to translate to.
     ///
     /// # Returns
@@ -122,7 +125,8 @@ impl Config {
     /// # Parameters
     ///
     /// - `self`: The config object. This must be mutable.
-    /// - `str_path`: The directory containing the translation files. The directory is relative to the path the executable was executed from.
+    /// - `str_path`: The directory containing the translation files.
+    ///   The directory is relative to the path the executable was executed from.
     ///
     /// # Returns
     ///
@@ -149,14 +153,13 @@ impl Config {
         match path.try_exists() {
             Ok(value) => {
                 if !value {
-                    let error: error_lib::Error =
+                    let error: errors::Error =
-                        error_lib::Error::new("OS Error", "Translation path was not found", 1);
+                        errors::Error::new("OS Error", "Translation path was not found", 1);
                     error.raise(format!("Path: {:?}", str_path).as_str());
                 }
             }
             Err(_error) => {
-                let error: error_lib::Error =
+                let error: errors::Error = errors::Error::new("OS Error", "Could not open path", 2);
-                    error_lib::Error::new("OS Error", "Could not open path", 2);
                 error.raise(format!("Path: {:?}\nDetails: {}", str_path, _error).as_str());
             }
         }
@@ -164,8 +167,8 @@ impl Config {
         self.path = String::from(match path.to_owned().to_str() {
             Some(value) => value,
             None => {
-                let error: error_lib::Error =
+                let error: errors::Error =
-                    error_lib::Error::new("OS Error", "Path does not seem to be valid", 3);
+                    errors::Error::new("OS Error", "Path does not seem to be valid", 3);
                 error.raise(format!("Path: {:?}", str_path).as_str());
                 ""
             }
@@ -222,15 +225,49 @@ impl Config {
     ///
     /// # See also
     ///
+    /// - [`t!()`]
     /// - [`Config`]
     pub fn t(&self, key: &str, arguments: Vec<(&str, &str)>) -> String {
-        return self.translate::<serde_json::Value>(key, arguments);
+        return self.translate(key, arguments);
     }
 
-    fn translate<T>(&self, key: &str, mut arguments: Vec<(&str, &str)>) -> String
+    /// Translates the specified key in the language specified in the config.
-    where
+    ///
-        T: serde::Serialize + for<'de> serde::Deserialize<'de>,
+    /// # Parameters
-    {
+    ///
+    /// - `self`: The config object.
+    /// - `key`: The key to translate to.
+    /// - `arguments`: The arguments to replace.
+    ///
+    /// # Returns
+    ///
+    /// A `String` containing the translated value.
+    ///
+    /// # Raises
+    ///
+    /// This method throws an exception and exits if
+    ///
+    /// - The translation file could not be found
+    /// - The translation file could not be opened
+    /// - The translation file could not be parsed
+    /// - The parsed json could not be converted to a json value
+    /// - The converted json could not be indexed
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// # use localizer_rs;
+    /// # let config: localizer_rs::Config = localizer_rs::Config::new("examples/translations", "en");
+    /// config.translate("test", vec![]);
+    /// ```
+    ///
+    /// # See also
+    ///
+    /// - [`t!()`]
+    /// - [`Config`]
+    /// - [`Config::t()`]
+    /// - [`serde_json`]
+    pub fn translate(&self, key: &str, mut arguments: Vec<(&str, &str)>) -> String {
         let mut colors: Vec<(&str, &str)> = vec![
             // Formatting codes
             ("end", "\x1b[0m"),
@@ -301,8 +338,8 @@ impl Config {
         };
         let reader: BufReader<File> = BufReader::new(file);
 
-        let json: serde_json::Value = match serde_json::to_value::<T>(
+        let json: serde_json::Value = match serde_json::to_value::<serde_json::Value>(
-            match serde_json::from_reader::<BufReader<File>, T>(reader) {
+            match serde_json::from_reader::<BufReader<File>, serde_json::Value>(reader) {
                 Ok(value) => value,
                 Err(_error) => {
                     let error: errors::Error = errors::Error::new(
@@ -362,3 +399,50 @@ impl Config {
         return result;
     }
 }
+
+
+/// Translates the specified key in the language specified in the config.
+///
+/// # Parameters
+///
+/// - `config`: The config object.
+/// - `key`: The key to translate to.
+/// - `arguments`: Optional parameter. The arguments to replace. Has to be of type `"name" = "value"`.
+///
+/// # Returns
+///
+/// A `String` containing the translated value.
+///
+/// # Examples
+///
+/// ```rust
+/// # use localizer_rs;
+/// # let config: localizer_rs::Config = localizer_rs::Config::new("examples/translations", "en");
+/// localizer_rs::t!(config, "test");
+/// localizer_rs::t!(config, "test", "variable" = "content");
+/// ```
+///
+/// # See also
+///
+/// - [`Config`]
+/// - [`Config::t()`]
+#[macro_export]
+macro_rules! t {
+    ($config:expr, $key:expr) => {
+        {
+            $config.t($key, vec![])
+        }
+    };
+
+    ($config:expr, $key:expr, $($argument_name:literal = $argument_value:literal),* $(,)?) => {
+        {
+            let mut arguments: Vec<(&str, &str)> = vec![];
+
+            $(
+                arguments.push(($argument_name, $argument_value));
+            )*
+
+            $config.t($key, arguments)
+        }
+    };
+}

tests/errors.rs

@@ -1,5 +1,5 @@
 // localizer-rs error tests
-// Version: 1.1.0
+// Version: 1.1.1
 
 // Copyright (c) 2023-present ElBe Development.
 

tests/lib.rs

@@ -1,5 +1,5 @@
 // localizer-rs tests
-// Version: 1.1.0
+// Version: 1.2.0
 
 // Copyright (c) 2023-present ElBe Development.
 
@@ -80,6 +80,18 @@ mod tests {
 
     #[test]
     fn test_translate() {
+        let config: localizer_rs::Config = localizer_rs::Config::new("examples/translations", "en");
+        let translation: String =
+            config.translate("error", vec![("details", "Something went wrong")]);
+
+        assert_eq!(
+            translation.as_str(),
+            "\x1b[31m\x1b[1mError:\x1b[0m Something went wrong"
+        );
+    }
+
+    #[test]
+    fn test_translate_t() {
         let config: localizer_rs::Config = localizer_rs::Config::new("examples/translations", "en");
         let translation: String = config.t("error", vec![("details", "Something went wrong")]);
 
@@ -88,4 +100,16 @@ mod tests {
             "\x1b[31m\x1b[1mError:\x1b[0m Something went wrong"
         );
     }
+
+    #[test]
+    fn test_translate_macro() {
+        let config: localizer_rs::Config = localizer_rs::Config::new("examples/translations", "en");
+        let translation: String =
+            localizer_rs::t!(config, "error", "details" = "Something went wrong");
+
+        assert_eq!(
+            translation.as_str(),
+            "\x1b[31m\x1b[1mError:\x1b[0m Something went wrong"
+        );
+    }
 }