Add option to encode command

Add `--size` option to set the module size in pixels.
sorairolake · Dec 13, 2023 · c0003eb · c0003eb
1 parent 116aff2
commit c0003eb
Show file tree

Hide file tree

Showing 20 changed files with 326 additions and 10 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -20,6  20,8 @@ project adheres to https://semver.org/[Semantic Versioning].
 
 * Add methods to optimize the output image to the documents
   ({pull-request-url}/301[#301])
 * Add `--size` option to set the module size in pixels
   ({pull-request-url}/304[#304])
 
 == {compare-url}/v0.8.8\...v0.8.9[0.8.9] - 2023-12-07
 

diff --git a/docs/man/man1/qrtool-encode.1.adoc b/docs/man/man1/qrtool-encode.1.adoc
@@ -4,7  4,7 @@
 
 = qrtool-encode(1)
 // Specify in UTC.
-:docdate: 2023-12-04
 :docdate: 2023-12-13
 :doctype: manpage
 ifdef::revnumber[:mansource: qrtool {revnumber}]
 :manmanual: General Commands Manual
@@ -44,6  44,10 @@ _STRING_::
 
   Read input data from a file. This option conflicts with _STRING_.
 
 *-s*, *--size* _NUMBER_::
 
   The module size in pixels. Default is 8.
 
 *-l*, *--error-correction-level* _LEVEL_::
 
   Error correction level.

diff --git a/src/app.rs b/src/app.rs
@@ -65,12  65,18 @@ pub fn run() -> anyhow::Result<()> {
                     eprintln!("Level: {:?}", metadata.error_correction_level());
                 }
 
                 let module_size = arg.size.get();
                 match arg.output_format {
                     format @ (OutputFormat::Svg | OutputFormat::Terminal) => {
                         let string = if format == OutputFormat::Svg {
-                            encode::to_svg(&code, arg.margin, &(arg.foreground, arg.background))
                             encode::to_svg(
                                 &code,
                                 arg.margin,
                                 &(arg.foreground, arg.background),
                                 module_size,
                             )
                         } else {
-                            encode::to_terminal(&code, arg.margin)
                             encode::to_terminal(&code, arg.margin, module_size)
                         };
 
                         if let Some(file) = arg.output {
@@ -82,8  88,12 @@ pub fn run() -> anyhow::Result<()> {
                         }
                     }
                     OutputFormat::Png => {
-                        let image =
-                            encode::to_image(&code, arg.margin, &(arg.foreground, arg.background));
                         let image = encode::to_image(
                             &code,
                             arg.margin,
                             &(arg.foreground, arg.background),
                             module_size,
                         );
 
                         if let Some(file) = arg.output {
                             image

diff --git a/src/cli.rs b/src/cli.rs
@@ -4,6  4,7 @@
 
 use std::{
     io::{self, Write},
     num::NonZeroU32,
     path::PathBuf,
 };
 
@@ -82,6  83,10 @@ pub struct Encode {
     )]
     pub read_from: Option<PathBuf>,
 
     /// The module size in pixels.
     #[arg(short, long, default_value("8"), value_name("NUMBER"))]
     pub size: NonZeroU32,
 
     /// Error correction level.
     #[arg(
         short('l'),

diff --git a/src/encode.rs b/src/encode.rs
@@ -52,26  52,34 @@ pub fn push_data_for_selected_mode(
 }
 
 /// Renders the QR code into an image.
-pub fn to_svg(code: &QrCode, margin: u32, colors: &(Color, Color)) -> String {
 pub fn to_svg(code: &QrCode, margin: u32, colors: &(Color, Color), module_size: u32) -> String {
     Renderer::<svg::Color<'_>>::new(&code.to_colors(), code.width(), margin)
         .dark_color(svg::Color(&colors.0.to_hex_string()))
         .light_color(svg::Color(&colors.1.to_hex_string()))
         .module_dimensions(module_size, module_size)
         .build()
 }
 
 /// Renders the QR code into the terminal as UTF-8 string.
-pub fn to_terminal(code: &QrCode, margin: u32) -> String {
 pub fn to_terminal(code: &QrCode, margin: u32, module_size: u32) -> String {
     Renderer::<unicode::Dense1x2>::new(&code.to_colors(), code.width(), margin)
         .dark_color(unicode::Dense1x2::Light)
         .light_color(unicode::Dense1x2::Dark)
         .module_dimensions(module_size, module_size)
         .build()
 }
 
 /// Renders the QR code into an image.
-pub fn to_image(code: &QrCode, margin: u32, colors: &(Color, Color)) -> DynamicImage {
 pub fn to_image(
     code: &QrCode,
     margin: u32,
     colors: &(Color, Color),
     module_size: u32,
 ) -> DynamicImage {
     let image = Renderer::<Rgba<u8>>::new(&code.to_colors(), code.width(), margin)
         .dark_color(Rgba::from(colors.0.to_rgba8()))
         .light_color(Rgba::from(colors.1.to_rgba8()))
         .module_dimensions(module_size, module_size)
         .build();
     DynamicImage::ImageRgba8(image)
 }

diff --git a/tests/data/colored/rgb.svg b/tests/data/colored/rgb.svg
diff --git a/tests/data/colored/rgb.svg.license b/tests/data/colored/rgb.svg.license
@@ -0,0  1,3 @@
 SPDX-FileCopyrightText: 2023 Shun Sakai
 
 SPDX-License-Identifier: Apache-2.0 OR MIT
diff --git a/tests/data/colored/rgba.svg b/tests/data/colored/rgba.svg
diff --git a/tests/data/colored/rgba.svg.license b/tests/data/colored/rgba.svg.license
@@ -0,0  1,3 @@
 SPDX-FileCopyrightText: 2023 Shun Sakai
 
 SPDX-License-Identifier: Apache-2.0 OR MIT
diff --git a/tests/data/encode/encode.svg b/tests/data/encode/encode.svg
diff --git a/tests/data/encode/encode.svg.license b/tests/data/encode/encode.svg.license
@@ -0,0  1,3 @@
 SPDX-FileCopyrightText: 2023 Shun Sakai
 
 SPDX-License-Identifier: Apache-2.0 OR MIT