Fix tests, add quiet_zone property to render settings for png and svg

Author: EliasBinder

.tool-versions

@@ -0,0 +1,2 @@
+elixir 1.17.2-otp-27
+erlang 27.0.1

hello.svg

@@ -0,0 +1,25 @@
+defmodule QRCode.MatrixHelper do
+  @moduledoc """
+  Helper functions for matrix manipulation.
+  """
+  alias MatrixReloaded.Matrix
+
+  @spec surround_matrix(Matrix.t(), integer(), integer()) :: Matrix.t()
+  def surround_matrix(matrix, quiet_zone, value) when is_integer(quiet_zone) and quiet_zone >= 0 do
+    {rows, cols} = Matrix.size(matrix)
+
+    # Create new matrix with quiet zone
+    {:ok, new_matrix} = Matrix.new({rows + 2 * quiet_zone, cols + 2 * quiet_zone}, value)
+
+    # Copy matrix to new matrix
+    new_matrix = Enum.reduce(0..rows - 1, new_matrix, fn row, acc_matrix ->
+      Enum.reduce(0..cols - 1, acc_matrix, fn col, acc_matrix_inner ->
+        {:ok, element} = Matrix.get_element(matrix, {row, col})
+        {:ok, updated_matrix} = Matrix.update_element(acc_matrix_inner, element, {row + quiet_zone, col + quiet_zone})
+        updated_matrix
+      end)
+    end)
+
+    new_matrix
+  end
+end

lib/qr_code/matrix_helper.ex

@@ -6,6 +6,7 @@ defmodule QRCode.Render.Png do
   alias MatrixReloaded.Matrix
   alias QRCode.QR
   alias QRCode.Render.PngSettings
+  alias QRCode.MatrixHelper
 
   @doc """
   Create Png image from QR matrix as binary.
@@ -26,15 +27,17 @@ defmodule QRCode.Render.Png do
          %PngSettings{
            scale: scale,
            background_color: background_color,
-           qrcode_color: qrcode_color
+           qrcode_color: qrcode_color,
+           quiet_zone: quiet_zone
          }
        ) do
     {rows, cols} = Matrix.size(matrix)
-    height = rows * scale
-    width = cols * scale
+    height = (rows + 2 * quiet_zone) * scale
+    width = (cols + 2 * quiet_zone) * scale
 
     bitmap =
       matrix
+      |> MatrixHelper.surround_matrix(quiet_zone, 0)
       |> rescale_rows(scale)
       |> List.flatten()
       |> rescale_cols_and_put_colors(scale, to_rgb(background_color), to_rgb(qrcode_color))
@@ -71,4 +74,6 @@ defmodule QRCode.Render.Png do
     Base.decode16!(c, case: :mixed)
     |> :binary.decode_unsigned()
   end
+
+
 end

lib/qr_code/render/png.ex

@@ -5,14 +5,18 @@ defmodule QRCode.Render.PngSettings do
 
   @type background_color :: String.t() | tuple
   @type qrcode_color :: String.t() | tuple
+  @type scale :: integer
+  @type quiet_zone :: integer
 
   @type t :: %__MODULE__{
           scale: integer,
           background_color: background_color,
-          qrcode_color: qrcode_color
+          qrcode_color: qrcode_color,
+          quiet_zone: quiet_zone
         }
 
   defstruct scale: 10,
             background_color: "#ffffff",
-            qrcode_color: "#000000"
+            qrcode_color: "#000000",
+            quiet_zone: 4
 end

lib/qr_code/render/png_settings.ex

@@ -6,6 +6,7 @@ defmodule QRCode.Render.Svg do
   alias MatrixReloaded.Matrix
   alias QRCode.QR
   alias QRCode.Render.SvgSettings
+  alias QRCode.MatrixHelper
 
   @type t :: %__MODULE__{
           xmlns: String.t(),
@@ -30,6 +31,7 @@ defmodule QRCode.Render.Svg do
   @spec create(Result.t(String.t(), QR.t()), SvgSettings.t()) :: Result.t(String.t(), binary())
   def create({:ok, %QR{matrix: matrix}}, settings) do
     matrix
+    |> MatrixHelper.surround_matrix(settings.quiet_zone, 0)
     |> create_svg(settings)
     |> Result.ok()
   end

lib/qr_code/render/svg.ex

@@ -19,6 +19,7 @@ defmodule QRCode.Render.SvgSettings do
   @type qrcode_color :: String.t() | tuple
   @type flatten :: boolean()
   @type structure :: :minify | :readable
+  @type quiet_zone :: integer
 
   @type t :: %__MODULE__{
           scale: integer,
@@ -27,7 +28,8 @@ defmodule QRCode.Render.SvgSettings do
           background_color: background_color,
           qrcode_color: qrcode_color,
           flatten: flatten,
-          structure: structure
+          structure: structure,
+          quiet_zone: quiet_zone
         }
 
   defstruct scale: 10,
@@ -36,5 +38,6 @@ defmodule QRCode.Render.SvgSettings do
             background_color: "#ffffff",
             qrcode_color: "#000000",
             flatten: false,
-            structure: :minify
+            structure: :minify,
+            quiet_zone: 4
 end