rqrcode 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b36678dab893b7737a87335397f977752eb01a3b935e8ac8a0025163d9fb4b7
-  data.tar.gz: 9938a0bf2f27ab46db54bf5d6171b3c52bbbd0e650f13bbe5d692ee769f08e88
+  metadata.gz: 43ab1903362d8d91be0e90db63e5fd1f1fe7ab68f217954cad099ba50244c070
+  data.tar.gz: 102e00189844e32950e07ca15afafd6e75c2288ea5af0df181c2daeb1ec02a2c
 SHA512:
-  metadata.gz: 4effb47e47d8d89935fb07957960b5ec6fddcefbe8259b03311b62b6721bdb1838227c1066745fd564a70faab521598a932cf1a6acea2470957458d4415737ff
-  data.tar.gz: a0d482a08eb97e2b5347a248a9ee52daa840d295e04b5d4c4b5c7e6618a6b4e0a3bba6e39f228a77e56048236f87fc76dcd6b49942cbae2a00dc904317af55ee
+  metadata.gz: 1d939b8bf154cc50957f321023c01f065d163b8ba4d046184d0dbe99fa426c81a48454026f98f45a93c13a882990bdb0864e15c4bec4496c2e8005be78add4bb
+  data.tar.gz: e8c05cb0311ff4c93bec2afed05adde2797ab8669caa3d505055b536aac0b3b984524389442f238e7a12d4eaf175d83af508ba63218a8c963f7f0e600fe6e9a6

data/CHANGELOG.md

@@ -7,10 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.0] - 2025-04-28
+
+- Added support for `offset_x` and `offset_y` options in the `as_svg` method for independent x and y padding around QR codes [#153]
+
 ## [3.0.0] - 2025-04-24
 
 - Drop support for Ruby <3.0 in order to keep up with dev dependencies.
-- **Breaking Change**: The `rqrcode_core` gem has been updated to version 3.0.0, which includes breaking changes. Please refer to the [rqrcode_core changelog](https://github.com/whomwah/rqrcode/blob/main/CHANGELOG.md)
+- **Breaking Change**: The `rqrcode_core` gem has been updated to version 2.0.0, which includes breaking changes. Please refer to the [rqrcode_core changelog](https://github.com/whomwah/rqrcode_core/blob/main/CHANGELOG.md)
 
 ## [2.2.0] - 2023-06-17
 
@@ -75,7 +79,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - bump dependencies
 - fix `required_ruby_version` for Ruby 3 support
 
-[unreleased]: https://github.com/whomwah/rqrcode/compare/v2.2.0...HEAD
+[unreleased]: https://github.com/whomwah/rqrcode/compare/v3.1.0...HEAD
+[3.1.0]: https://github.com/whomwah/rqrcode/compare/v3.0.0...v3.1.0
+[3.0.0]: https://github.com/whomwah/rqrcode/compare/v2.2.0...v3.0.0
 [2.2.0]: https://github.com/whomwah/rqrcode/compare/v2.1.2...v2.2.0
 [2.1.2]: https://github.com/whomwah/rqrcode/compare/v2.1.1...v2.1.2
 [2.1.1]: https://github.com/whomwah/rqrcode/compare/v2.1.0...v2.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rqrcode (3.0.0)
+    rqrcode (3.1.0)
       chunky_png (~> 1.0)
       rqrcode_core (~> 2.0)
 

data/README.md

@@ -3,20 +3,17 @@
 ![](https://github.com/whomwah/rqrcode/actions/workflows/ruby.yml/badge.svg)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
-
 [RQRCode](https://github.com/whomwah/rqrcode) is a library for creating and rendering QR codes into various formats. It has a simple interface with all the standard QR code options. It was adapted from the Javascript library by Kazuhiko Arase.
 
-* QR code is trademarked by Denso Wave inc
-* Minimum Ruby version is `>= 3.0.0`
-* For `rqrcode` releases `< 2.0.0` please use [this README](https://github.com/whomwah/rqrcode/blob/v1.2.0/README.md)
-* For `rqrcode` releases `< 1.0.0` please use [this README](https://github.com/whomwah/rqrcode/blob/v0.9.0/README.md)
+- QR code is trademarked by Denso Wave inc
+- Minimum Ruby version is `>= 3.0.0`
 
 ## Installing
 
 Add this line to your application's `Gemfile`:
 
 ```ruby
-gem "rqrcode", "~> 2.0"
+gem "rqrcode", "~> 3.0"
 ```
 
 or install manually:
@@ -70,7 +67,6 @@ Expects a string or array (for multi-segment encoding) to be parsed in, other ar
     * :number
     * :alphanumeric
     * :byte_8bit
-    * :kanji
 ```
 
 Example
@@ -99,6 +95,10 @@ Options:
 
 offset          - Padding around the QR Code in pixels
                   (default 0)
+offset_x        - X Padding around the QR Code in pixels
+                  (default offset)
+offset_y        - Y Padding around the QR Code in pixels
+                  (default offset)
 fill            - Background color e.g "ffffff" or :white or :currentColor
                   (default none)
 color           - Foreground color e.g "000" or :black or :currentColor
@@ -118,7 +118,9 @@ viewbox         - Replace the `svg.width` and `svg.height` attribute with `svg.v
 svg_attributes  - A optional hash of custom <svg> attributes. Existing attributes will remain.
                   (default {})
 ```
+
 Example
+
 ```ruby
 require "rqrcode"
 
@@ -209,7 +211,6 @@ IO.binwrite("/tmp/github-qrcode.png", png.to_s)
 
 ![QR code with github url](./images/github-qrcode.png)
 
-
 ### `as_ansi`
 
 The ANSI renderer will produce as a string with ANSI color codes.
@@ -226,7 +227,9 @@ fill_character  - The written character
 quiet_zone_size - Padding around the edge
                   (default 4)
 ```
+
 Example
+
 ```ruby
 require "rqrcode"
 
@@ -280,9 +283,9 @@ The motivation for the above is because the rendering side of this gem takes up
 
 Any contribution PR's will be greatly accepted. It's important that they are well tested and backwards compatible.
 
-* Fork the project
-* Send a pull request
-* Don't touch the .gemspec, I'll do that when I release a new version
+- Fork the project
+- Send a pull request
+- Don't touch the .gemspec, I'll do that when I release a new version
 
 Thanks D.
 
@@ -296,9 +299,9 @@ Oh, and thanks to my bosses at https://kyan.com for giving me time to maintain t
 
 ## Resources
 
-* wikipedia:: http://en.wikipedia.org/wiki/QR_Code
-* Denso-Wave website:: http://www.denso-wave.com/qrcode/index-e.html
-* kaywa:: http://qrcode.kaywa.com
+- wikipedia:: http://en.wikipedia.org/wiki/QR_Code
+- Denso-Wave website:: http://www.denso-wave.com/qrcode/index-e.html
+- kaywa:: http://qrcode.kaywa.com
 
 ## Copyright
 

data/lib/rqrcode/export/svg.rb

@@ -15,7 +15,15 @@ module RQRCode
       end
 
       class Path < BaseOutputSVG
-        def build(module_size, offset, color)
+        def build(module_size, options = {})
+          # Extract values from options
+          color = options[:color]
+          offset_x = options[:offset_x].to_i
+          offset_y = options[:offset_y].to_i
+
+          # Prefix hexadecimal colors unless using a named color (symbol)
+          color = "##{color}" unless color.is_a?(Symbol)
+
           modules_array = @qrcode.modules
           matrix_width = matrix_height = modules_array.length + 1
           empty_row = [Array.new(matrix_width - 1, false)]
@@ -76,23 +84,25 @@ module RQRCode
             path << edge_loop_string
           end
 
-          # Prefix hexadecimal colors unless using a named color (symbol)
-          color = "##{color}" unless color.is_a?(Symbol)
-
-          @result << %{<path d="#{path.join}" fill="#{color}" transform="translate(#{offset},#{offset}) scale(#{module_size})"/>}
+          @result << %{<path d="#{path.join}" fill="#{color}" transform="translate(#{offset_x},#{offset_y}) scale(#{module_size})"/>}
         end
       end
 
       class Rect < BaseOutputSVG
-        def build(module_size, offset, color)
+        def build(module_size, options = {})
+          # Extract values from options
+          color = options[:color]
+          offset_x = options[:offset_x].to_i
+          offset_y = options[:offset_y].to_i
+
           # Prefix hexadecimal colors unless using a named color (symbol)
           color = "##{color}" unless color.is_a?(Symbol)
 
           @qrcode.modules.each_index do |c|
             tmp = []
             @qrcode.modules.each_index do |r|
-              y = c * module_size + offset
-              x = r * module_size + offset
+              x = r * module_size + offset_x
+              y = c * module_size + offset_y
 
               next unless @qrcode.checked?(c, r)
               tmp << %(<rect width="#{module_size}" height="#{module_size}" x="#{x}" y="#{y}" fill="#{color}"/>)
@@ -143,6 +153,10 @@ module RQRCode
       # Options:
       # offset          - Padding around the QR Code in pixels
       #                   (default 0)
+      # offset_x        - X Padding around the QR Code in pixels
+      #                   (default offset)
+      # offset_y        - Y Padding around the QR Code in pixels
+      #                   (default offset)
       # fill            - Background color e.g "ffffff"
       #                   (default none)
       # color           - Foreground color e.g "000"
@@ -164,7 +178,9 @@ module RQRCode
       def as_svg(options = {})
         fill = options[:fill]
         use_path = options[:use_path]
-        offset = options[:offset].to_i || 0
+        offset = options[:offset].to_i
+        offset_x = options.key?(:offset_x) ? options[:offset_x].to_i : offset
+        offset_y = options.key?(:offset_y) ? options[:offset_y].to_i : offset
         color = options[:color] || "000"
         shape_rendering = options[:shape_rendering] || "crispEdges"
         module_size = options[:module_size] || 11
@@ -173,9 +189,11 @@ module RQRCode
         svg_attributes = options[:svg_attributes] || {}
 
         # height and width dependent on offset and QR complexity
-        dimension = (@qrcode.module_count * module_size) + (2 * offset)
+        width = (@qrcode.module_count * module_size) + (2 * offset_x)
+        height = (@qrcode.module_count * module_size) + (2 * offset_y)
+        dimension = [width, height].max
         # use dimensions differently if we are using a viewBox
-        dimensions_attr = viewbox ? %(viewBox="0 0 #{dimension} #{dimension}") : %(width="#{dimension}" height="#{dimension}")
+        dimensions_attr = viewbox ? %(viewBox="0 0 #{width} #{height}") : %(width="#{width}" height="#{height}")
 
         svg_tag_attributes = (DEFAULT_SVG_ATTRIBUTES + [
           dimensions_attr,
@@ -187,7 +205,7 @@ module RQRCode
         close_tag = "</svg>"
 
         output_tag = (use_path ? Path : Rect).new(@qrcode)
-        output_tag.build(module_size, offset, color)
+        output_tag.build(module_size, offset_x: offset_x, offset_y: offset_y, color: color)
 
         if fill
           # Prefix hexadecimal colors unless using a named color (symbol)

data/lib/rqrcode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RQRCode
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Duncan Robertson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-24 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rqrcode_core