Merge pull request #18 from anas-elgarhy/renovate/clap-4.x

fix(deps): update rust crate clap to 4.3.2

.github/workflows/aur-release.yml

@@ -0,0 +1,24 @@
+name: aur-release
+
+on:
+  push:
+    tags:
+      - "*" # Run on any tag
+
+jobs:
+    aur-publish:
+        runs-on: ubuntu-latest
+        steps:
+        - uses: actions/checkout@v3
+    
+        - name: Publish AUR package
+          uses: anas-elgarhy/aur-release-action@v4.1
+          with:
+            ssh_private_key: ${{ secrets.AUR_SSH_PRIVATE_KEY }}
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            pkgbuild_path: archpackage/PKGBUILD # Use this if the PKGBUILD file is not in the root directory
+            # aur_submodule_path: archpackage/aarty
+            git_username: Anas Elgarhy # Use this if you want to change the git username (recommended)
+            git_email: anas.elgarhy.dev@gmail.com # Use this if you want to change the git email (recommended)
+            commit_message: UpUp Update %FILENAME% to %VERSION% yoo # Use this if you want to change the commit message
+            try_build_and_install: false

.mergify.yml

@@ -0,0 +1,7 @@
+pull_request_rules:
+  - name: Automatic merge on approval
+    conditions:
+      - "#approved-reviews-by>=1"
+    actions:
+      merge:
+        method: merge

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "aarty"
-version = "0.2.0"
+version = "0.4.8"
 edition = "2021"
 authors = ["Anas Elgarhy <anas.elgarhy.dev@gmail.com>"]
 description = "A simple CLI tool to convert the images to ASCII art"
@@ -31,8 +31,8 @@ exclude = ["images/*"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-clap = { version = "4.0.12-rc.3", features = ["derive"] }
+clap = { version = "4.3.2", features = ["derive"] }
 colored = "2.0.0"
-image = "0.24.4"
+image = "0.24.6"
-log = "0.4.17"
+log = "0.4.18"
-pretty_env_logger = "0.4.0"
+pretty_env_logger = "0.5.0"

README.md

@@ -105,6 +105,9 @@ Options:
           
           [default: 4]
 
+  -w, --width <WIDTH>
+          Enstablish how much wide is the output images, in columns. Overrides `scale`
+
   -b, --background <BACKGROUND>
           The background color to use
 

archpackage/.SRCINFO

@@ -1,6 +1,6 @@
 pkgbase = aarty
 	pkgdesc = A simple CLI tool to convert the images to ASCII art 🦀💙
-	pkgver = 0.1.0
+	pkgver = 0.2.0
 	pkgrel = 1
 	url = https://github.com/anas-elgarhy/aarty
 	arch = x86_64
@@ -8,7 +8,7 @@ pkgbase = aarty
 	makedepends = cargo
 	provides = aarty
 	replaces = aarty
-	source = aarty-0.1.0.tar.gz::https://static.crates.io/crates/aarty/aarty-0.1.0.crate
+	source = aarty-0.2.0.tar.gz::https://static.crates.io/crates/aarty/aarty-0.2.0.crate
-	sha256sums = 0bdf82de5b48760e9dcaee0f474ac8cdc333969c60734c4aaa79bc33930a755f
+	sha256sums = aa8cdf26ac78adf035088d6e12730a593e17a040f54ebfe39f59fc9c438be1c4
 
 pkgname = aarty

archpackage/A

@@ -0,0 +1,2 @@
+nas
+nas

archpackage/PKGBUILD

@@ -38,4 +38,4 @@ package() {
   cd "$pkgname-$pkgver"
   sudo install -Dm0755 -t "/usr/bin/" "target/release/$pkgname"
 }
-sha256sums=('0bdf82de5b48760e9dcaee0f474ac8cdc333969c60734c4aaa79bc33930a755f')
+sha256sums=('aa8cdf26ac78adf035088d6e12730a593e17a040f54ebfe39f59fc9c438be1c4')

archpackage/aarty

@@ -1 +1 @@
-Subproject commit 1070f216ace48058c236dd3398cdf2ce60d52ac6
+Subproject commit b32218c382efd1a956f5f9fcc151aec90862d6e5

archpackage/pkg/aarty/.PKGINFO

@@ -1,15 +0,0 @@
-# Generated by makepkg 6.0.1
-# using fakeroot version 1.29
-pkgname = aarty
-pkgbase = aarty
-pkgver = 0.1.0-1
-pkgdesc = A simple CLI tool to convert the images to ASCII art 🦀💙
-url = https://github.com/anas-elgarhy/aarty
-builddate = 1664878775
-packager = Unknown Packager
-size = 0
-arch = x86_64
-license = MIT
-replaces = aarty
-provides = aarty
-makedepend = cargo

renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

src/args.rs

@@ -19,6 +19,9 @@ pub mod args {
         /// The output scale (1 is the original size)
         #[arg(short, long, default_value = "4")]
         pub scale: u32,
+        /// Enstablish how much wide is the output images, in columns. Overrides `scale`
+        #[arg(short, long, default_value= None )]
+        pub width: Option<u32>,
         /// The background color to use
         #[arg(short, long, default_value = None)]
         pub background: Option<String>,

src/ascii_processor.rs

@@ -11,10 +11,11 @@ pub fn generate_ascii<W: Write>(
 ) -> io::Result<()> {
     let characters = args.characters.chars().collect::<Vec<char>>();
     let (width, height) = image.dimensions();
+    let actual_scale = calculate_scale(args, (width, height));
 
     for y in 0..height {
         for x in 0..width {
-            if y % (args.scale * 2) == 0 && x % args.scale == 0 {
+            if y % (actual_scale * 2) == 0 && x % actual_scale == 0 {
                 let element = get_character(
                     image.get_pixel(x, y),
                     &characters,
@@ -26,7 +27,7 @@ pub fn generate_ascii<W: Write>(
             }
         }
         // Add a new line at the end of each row
-        if y % (args.scale * 2) == 0 {
+        if y % (actual_scale * 2) == 0 {
             buffer.write_all("\n".as_bytes())?;
         }
     }
@@ -60,3 +61,58 @@ fn get_character(
         None => ch,
     }
 }
+
+///
+/// Determine how much scale to use in presence of `width` parameters,
+/// otherwise returns regular `scale` parameter per default behaviour
+///
+#[inline]
+fn calculate_scale(args: &Arguments, dimensions: (u32, u32)) -> u32 {
+    args.width.map_or_else(|| args.scale, |v| dimensions.0 / v)
+}
+
+#[cfg(test)]
+mod test {
+    use crate::args::{
+        args::Arguments,
+        enums::{Mode, OutputMethod},
+    };
+
+    use super::calculate_scale;
+
+    const DIMENSIONS: (u32, u32) = (100, 100);
+
+    #[test]
+    fn test_scale() {
+        let args = Arguments {
+            mode: Mode::NormalAscii,
+            output_method: OutputMethod::Stdout,
+            image: "".into(),
+            characters: "".into(),
+            scale: 4,
+            width: Some(10),
+            background: None,
+            output: "".into(),
+        };
+
+        let scale = calculate_scale(&args, DIMENSIONS);
+        assert_eq!(scale, 10);
+    }
+
+    #[test]
+    fn test_default_scale() {
+        let args = Arguments {
+            mode: Mode::NormalAscii,
+            output_method: OutputMethod::Stdout,
+            image: "".into(),
+            characters: "".into(),
+            scale: 4,
+            width: None,
+            background: None,
+            output: "".into(),
+        };
+
+        let scale = calculate_scale(&args, DIMENSIONS);
+        assert_eq!(scale, 4);
+    }
+}