rqrcode_core 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc2b513b4aa28453c231e4fa52d53c4406bf03bbba9df84ab87eed0e22193389
-  data.tar.gz: fc7b7bfc2ad40315031899501b94a1b2a35c8987b6eeff9cd9c71d77b4e5d3d4
+  metadata.gz: 160d94f790053a577012156c6d6dc7b5e6aa6f88766590d0494f06f9896fe89f
+  data.tar.gz: 2a653148523a2a04acad3abd81d62cd8d28835a43dc1dfe6821b9ab6c8c99609
 SHA512:
-  metadata.gz: de4b6fdb7ab8f356fb55aedbc93fb949f51f1f68acebdc1aa7d4b82ecf90cf785065104bbf68170ea39f20671ff513c5eb212cbbdb42f38f099f133612d70d17
-  data.tar.gz: 0a2e8ea5a6e0a2bf43a9d94a3333cc95d6558f47f6369dd5a07107e12079db85b8a21dec57ef31920a855648c96e630fc68d40942e3f9e4570a6f2f07b4c1ee5
+  metadata.gz: 7b27968f77e89d07980174c98961abd1255efa317993f246161d940b53dcd185567c6710e567c6596cb1af8789fb2ee584aa2d14fdbc1b5ac3351f5552429c7d
+  data.tar.gz: 953c1d8de80226d141049519128c25dc345b6661b44fdc1b263c1590e4554b45cbc84a59a10c67b8c9f5e980cad0a3b8d58e5b81030532291b9d87097d96c98b

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: whomwah
+buy_me_a_coffee: duncanrobertson

data/.github/workflows/ruby.yml

@@ -3,11 +3,10 @@ name: rqrcode_core
 on:
   push:
     branches:
-    - master
-    - release/*
-  pull_request:
-    branches:
-    - master
+      - main
+      - release
+  pull_request: # Runs on any PR regardless of target branch
+  workflow_dispatch:
 
 jobs:
   Build:
@@ -15,15 +14,15 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.5, 2.6, 2.7, 3.0]
+        ruby: ["3.0", "3.1", "3.2", "3.3", "3.4"]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v1
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run Tests
-      run: bundle exec rake test
-    - name: StandardRB Check
-      run: bundle exec standardrb --format progress
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run Tests
+        run: bundle exec rake test
+      - name: StandardRB Check
+        run: bundle exec standardrb --format progress

data/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2025-04-24
+
+- Various README updates
+- Fix for issue #43
+- Fix for issue #42
+- Drop Ruby < 3 to keep up with dependency updates
+- Add option to use ENV `RQRCODE_CORE_ARCH_BITS` to override the bits value (32 or 64) used during the encoding process.
+  This has been shown to greatly reduce the memory usage but I can't prove it doesn't break anything for all people.
+  Use at your own risk.
+- Fixed the 'Do Your Own Rendering' example code to reflect the current interface.
+
+## [1.2.0] - 2021-08-26
+
+- Added Multi Mode Support which allows for multi-segment encoding. Thanks to [@ssayer](https://github.com/ssayer)
+
 ## [1.1.0] - 2021-07-01
 
 - Add a basic benchmark file
@@ -25,7 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Breaking Changes
 
-- Very niche but a breaking change never the less. The `to_s` method *no longer* accepts the `:true` and `:false` arguments, but prefers `:dark` and `:light`.
+- Very niche but a breaking change never the less. The `to_s` method _no longer_ accepts the `:true` and `:false` arguments, but prefers `:dark` and `:light`.
 
 ## [0.2.0] - 2020-12-26
 
@@ -33,7 +48,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - fix `required_ruby_version` for Ruby 3 support
 
-[unreleased]: https://github.com/whomwah/rqrcode_core/compare/v1.1.0...HEAD
+[unreleased]: https://github.com/whomwah/rqrcode_core/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/whomwah/rqrcode_core/compare/v1.2.0...2.0.0
+[1.2.0]: https://github.com/whomwah/rqrcode_core/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/whomwah/rqrcode_core/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/whomwah/rqrcode_core/compare/v0.2.0...v1.0.0
 [0.2.0]: https://github.com/whomwah/rqrcode_core/compare/v0.1.2...v0.2.0

data/Gemfile.lock

@@ -1,43 +1,56 @@
 PATH
   remote: .
   specs:
-    rqrcode_core (1.1.0)
+    rqrcode_core (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    minitest (5.25.1)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rubocop (1.12.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rubocop (1.66.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.10.1)
-      rubocop (>= 0.90.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    standard (1.0.5)
-      rubocop (= 1.12.1)
-      rubocop-performance (= 1.10.1)
-    standardrb (1.0.0)
-      standard
-    unicode-display_width (2.0.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.22.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.41.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.66.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.5)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.5.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.22.0)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
+  aarch64-linux
   ruby
 
 DEPENDENCIES
@@ -45,7 +58,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rqrcode_core!
-  standardrb (~> 1.0)
+  standard (~> 1.41)
 
 BUNDLED WITH
-   2.2.15
+   2.5.16

data/README.md

@@ -3,16 +3,17 @@
 
 # RQRCodeCore
 
-`rqrcode_core` is a library for encoding QR codes in pure Ruby. It has a simple interface with all the standard qrcode options. It was originally adapted in 2008 from a Javascript library by [Kazuhiko Arase](https://github.com/kazuhikoarase).
+`rqrcode_core` is a library for encoding QR Codes in pure Ruby. It has a simple interface with all the standard qrcode options. It was originally adapted in 2008 from a Javascript library by [Kazuhiko Arase](https://github.com/kazuhikoarase).
 
 Features:
 
-* `rqrcode_core` is a Ruby only library. It requires no native libraries. Just Ruby!
-* It is an encoding library. You can't decode QR codes with it.
-* The interface is simple and assumes you just want to encode a string into a QR code.
-* QR code is trademarked by Denso Wave inc.
+- `rqrcode_core` is a Ruby only library. It requires no 3rd party libraries. Just Ruby!
+- It is an encoding library. You can't decode QR Codes with it.
+- The interface is simple and assumes you just want to encode a string into a QR Code, but also allows for encoding multiple segments.
+- QR Code is trademarked by Denso Wave inc.
+- Minimum Ruby version is `>= 3.0.0`
 
-`rqrcode_core` is the basis of the popular `rqrcode` gem [https://github.com/whomwah/rqrcode]. This gem allows you to generate different renderings of your QR code, including `png`, `svg` and `ansi`.
+`rqrcode_core` is the basis of the popular `rqrcode` gem [https://github.com/whomwah/rqrcode]. This gem allows you to generate different renderings of your QR Code, including `png`, `svg` and `ansi`.
 
 ## Installation
 
@@ -47,13 +48,26 @@ x xxx x  xxxxx x       xx x xxx x
 ... etc
 ```
 
+## Multiple Encoding Support
+
+```ruby
+$ require "rqrcode_core"
+$ qr = RQRCodeCore::QRCode.new([
+  {data: "byteencoded", mode: :byte_8bit},
+  {data: "A1" * 100, mode: :alphanumeric},
+  {data: "1" * 500, mode: :number}
+])
+```
+
+This will create a QR Code with byte encoded, alphanumeric and number segments. Any combination of encodings/segments will work provided it fits within size limits.
+
 ## Doing your own rendering
 
 ```ruby
 require "rqrcode_core"
 
 qr = RQRCodeCore::QRCode.new("https://kyan.com")
-qr.rows.each do |row|
+qr.modules.each do |row|
   row.each do |col|
     print col ? "#" : " "
   end
@@ -64,12 +78,14 @@ end
 
 ### Options
 
-The library expects a string to be parsed in, other args are optional.
+The library expects a string or array (for multiple encodings) to be parsed in, other args are optional.
 
 ```
-string - the string you wish to encode
+data - the string or array you wish to encode
+
+size - the size (integer) of the QR Code (defaults to smallest size needed to encode the string)
 
-size   - the size (integer) of the qrcode (defaults to smallest size needed to encode the string)
+max_size - the max_size (Integer) of the QR Code (default RQRCodeCore::QRUtil.max_size)
 
 level  - the error correction level, can be:
   * Level :l 7%  of code can be restored
@@ -77,17 +93,16 @@ level  - the error correction level, can be:
   * Level :q 25% of code can be restored
   * Level :h 30% of code can be restored (default :h)
 
-mode   - the mode of the qrcode (defaults to alphanumeric or byte_8bit, depending on the input data):
+mode - the mode of the QR Code (defaults to alphanumeric or byte_8bit, depending on the input data, only used when data is a string):
   * :number
   * :alphanumeric
   * :byte_8bit
-  * :kanji
 ```
 
 #### Example
 
 ```ruby
-RQRCodeCore::QRCode.new("http://kyan.com", size: 1, level: :m, mode: :alphanumeric)
+RQRCodeCore::QRCode.new("http://kyan.com", size: 2, level: :m, mode: :byte_8bit)
 ```
 
 ## Development
@@ -117,6 +132,10 @@ $ rake standard # check
 $ rake standard:fix # fix
 ```
 
+## Experimental
+
+On 64 bit systems when generating lots of QR Codes the lib will consume more memory than on a 32 bit systems during the internal "right shift zero fill" steps (this is expected). In tests though, it's shown that by forcing the lib to think you're on a 32 systems greatly reduces the memory footprint. This could of course have undesired consequences too! but if you're happy to try, you can use the `RQRCODE_CORE_ARCH_BITS` ENV to make this change. e.g `RQRCODE_CORE_ARCH_BITS=32`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/whomwah/rqrcode_core.

data/lib/rqrcode_core/qrcode/qr_bit_buffer.rb

@@ -15,12 +15,12 @@ module RQRCodeCore
 
     def get(index)
       buf_index = (index / 8).floor
-      ((QRUtil.rszf(@buffer[buf_index], 7 - index % 8)) & 1) == 1
+      (QRUtil.rszf(@buffer[buf_index], 7 - index % 8) & 1) == 1
     end
 
     def put(num, length)
       (0...length).each do |i|
-        put_bit(((QRUtil.rszf(num, length - i - 1)) & 1) == 1)
+        put_bit((QRUtil.rszf(num, length - i - 1) & 1) == 1)
       end
     end
 

data/lib/rqrcode_core/qrcode/qr_code.rb

@@ -2,15 +2,16 @@
 
 module RQRCodeCore
   QRMODE = {
-    mode_number: 1 << 0,
-    mode_alpha_numk: 1 << 1,
-    mode_8bit_byte: 1 << 2
+    mode_number: 1 << 0,      # 1 (binary: 0001)
+    mode_alpha_numk: 1 << 1,  # 2 (binary: 0010)
+    mode_8bit_byte: 1 << 2   # 4 (binary: 0100)
   }.freeze
 
   QRMODE_NAME = {
     number: :mode_number,
     alphanumeric: :mode_alpha_numk,
-    byte_8bit: :mode_8bit_byte
+    byte_8bit: :mode_8bit_byte,
+    multi: :mode_multi
   }.freeze
 
   QRERRORCORRECTLEVEL = {
@@ -49,89 +50,19 @@ module RQRCodeCore
   # http://web.archive.org/web/20110710094955/http://www.denso-wave.com/qrcode/vertable2-e.html
   # http://web.archive.org/web/20110710094955/http://www.denso-wave.com/qrcode/vertable3-e.html
   # http://web.archive.org/web/20110710094955/http://www.denso-wave.com/qrcode/vertable4-e.html
-  # Each array contains levels max chars from level 1 to level 40
-  QRMAXDIGITS = {
-    l: {
-      mode_number: [
-        41, 77, 127, 187, 255, 322, 370, 461, 552, 652, 772,
-        883, 1022, 1101, 1250, 1408, 1548, 1725, 1903, 2061,
-        2232, 2409, 2620, 2812, 3057, 3283, 3514, 3669, 3909, 4158,
-        4417, 4686, 4965, 5253, 5529, 5836, 6153, 6479, 6743, 7089
-      ],
-      mode_alpha_numk: [
-        25, 47, 77, 114, 154, 195, 224, 279, 335, 395,
-        468, 535, 619, 667, 758, 854, 938, 1046, 1153, 1249,
-        1352, 1460, 1588, 1704, 1853, 1990, 2132, 2223, 2369, 2520,
-        2677, 2840, 3009, 3183, 3351, 3537, 3729, 3927, 4087, 4296
-      ],
-      mode_8bit_byte: [
-        17, 32, 53, 78, 106, 134, 154, 192, 230, 271,
-        321, 367, 425, 458, 520, 586, 644, 718, 792, 858,
-        929, 1003, 1091, 1171, 1273, 1367, 1465, 1528, 1628, 1732,
-        1840, 1952, 2068, 2188, 2303, 2431, 2563, 2699, 2809, 2953
-      ]
-    },
-    m: {
-      mode_number: [
-        34, 63, 101, 149, 202, 255, 293, 365, 432, 513,
-        604, 691, 796, 871, 991, 1082, 1212, 1346, 1500, 1600,
-        1708, 1872, 2059, 2188, 2395, 2544, 2701, 2857, 3035, 3289,
-        3486, 3693, 3909, 4134, 4343, 4588, 4775, 5039, 5313, 5596
-      ],
-      mode_alpha_numk: [
-        20, 38, 61, 90, 122, 154, 178, 221, 262, 311,
-        366, 419, 483, 528, 600, 656, 734, 816, 909, 970,
-        1035, 1134, 1248, 1326, 1451, 1542, 1637, 1732, 1839, 1994,
-        2113, 2238, 2369, 2506, 2632, 2780, 2894, 3054, 3220, 3391
-      ],
-      mode_8bit_byte: [
-        14, 26, 42, 62, 84, 106, 122, 152, 180, 213,
-        251, 287, 331, 362, 412, 450, 504, 560, 624, 666,
-        711, 779, 857, 911, 997, 1059, 1125, 1190, 1264, 1370,
-        1452, 1538, 1628, 1722, 1809, 1911, 1989, 2099, 2213, 2331
-      ]
-    },
-    q: {
-      mode_number: [
-        27, 48, 77, 111, 144, 178, 207, 259, 312, 364,
-        427, 489, 580, 621, 703, 775, 876, 948, 1063, 1159,
-        1224, 1358, 1468, 1588, 1718, 1804, 1933, 2085, 2181, 2358,
-        2473, 2670, 2805, 2949, 3081, 3244, 3417, 3599, 3791, 3993
-      ],
-      mode_alpha_numk: [
-        16, 29, 47, 67, 87, 108, 125, 157, 189, 221,
-        259, 296, 352, 376, 426, 470, 531, 574, 644, 702,
-        742, 823, 890, 963, 1041, 1094, 1172, 1263, 1322, 1429,
-        1499, 1618, 1700, 1787, 1867, 1966, 2071, 2181, 2298, 2420
-      ],
-      mode_8bit_byte: [
-        11, 20, 32, 46, 60, 74, 86, 108, 130, 151,
-        177, 203, 241, 258, 292, 22, 364, 394, 442, 482,
-        509, 565, 611, 661, 715, 751, 805, 868, 908, 982,
-        1030, 1112, 1168, 1228, 1283, 1351, 1423, 1499, 1579, 1663
-      ]
-    },
-    h: {
-      mode_number: [
-        17, 34, 58, 82, 106, 139, 154, 202, 235, 288, 331, 374, 427, 468, 530, 602, 674,
-        331, 374, 427, 468, 530, 602, 674, 746, 813, 919,
-        969, 1056, 1108, 1228, 1286, 1425, 1501, 1581, 1677, 1782,
-        1897, 2022, 2157, 2301, 2361, 2524, 2625, 2735, 2927, 3057
-
-      ],
-      mode_alpha_numk: [
-        10, 20, 35, 50, 64, 84, 93, 122, 143, 174, 200,
-        200, 227, 259, 283, 321, 365, 408, 452, 493, 557,
-        587, 640, 672, 744, 779, 864, 910, 958, 1016, 1080,
-        1150, 1226, 1307, 1394, 1431, 1530, 1591, 1658, 1774, 1852
-      ],
-      mode_8bit_byte: [
-        7, 14, 24, 34, 44, 58, 64, 84, 98, 119,
-        137, 155, 177, 194, 220, 250, 280, 310, 338, 382,
-        403, 439, 461, 511, 535, 593, 625, 658, 698, 742,
-        790, 842, 898, 958, 983, 1051, 1093, 1139, 1219, 1273
-      ]
-    }
+  QRMAXBITS = {
+    l: [152, 272, 440, 640, 864, 1088, 1248, 1552, 1856, 2192, 2592, 2960, 3424, 3688, 4184,
+      4712, 5176, 5768, 6360, 6888, 7456, 8048, 8752, 9392, 10_208, 10_960, 11_744, 12_248,
+      13_048, 13_880, 14_744, 15_640, 16_568, 17_528, 18_448, 19_472, 20_528, 21_616, 22_496, 23_648],
+    m: [128, 224, 352, 512, 688, 864, 992, 1232, 1456, 1728, 2032, 2320, 2672, 2920, 3320, 3624,
+      4056, 4504, 5016, 5352, 5712, 6256, 6880, 7312, 8000, 8496, 9024, 9544, 10_136, 10_984,
+      11_640, 12_328, 13_048, 13_800, 14_496, 15_312, 15_936, 16_816, 17_728, 18_672],
+    q: [104, 176, 272, 384, 496, 608, 704, 880, 1056, 1232, 1440, 1648, 1952, 2088, 2360, 2600, 2936,
+      3176, 3560, 3880, 4096, 4544, 4912, 5312, 5744, 6032, 6464, 6968, 7288, 7880, 8264, 8920, 9368,
+      9848, 10288, 10832, 11408, 12016, 12656, 13328],
+    h: [72, 128, 208, 288, 368, 480, 528, 688, 800, 976, 1120, 1264, 1440, 1576, 1784,
+      2024, 2264, 2504, 2728, 3080, 3248, 3536, 3712, 4112, 4304, 4768, 5024, 5288, 5608, 5960,
+      6344, 6760, 7208, 7688, 7888, 8432, 8768, 9136, 9776, 10_208]
   }.freeze
 
   # StandardErrors
@@ -152,69 +83,58 @@ module RQRCodeCore
   class QRCode
     attr_reader :modules, :module_count, :version
 
-    # Expects a string to be parsed in, other args are optional
+    # Expects a string or array (for multi-segment encoding) to be parsed in, other args are optional
     #
-    #   # string - the string you wish to encode
-    #   # size   - the size (Integer) of the qrcode (defaults to smallest size needed to encode the string)
-    #   # level  - the error correction level, can be:
+    #   # data - the string, QRSegment or array of Hashes (with data:, mode: keys) you wish to encode
+    #   # size - the size (Integer) of the QR Code (defaults to smallest size needed to encode the data)
+    #   # max_size - the max_size (Integer) of the QR Code (default RQRCodeCore::QRUtil.max_size)
+    #   # level - the error correction level, can be:
     #      * Level :l 7%  of code can be restored
     #      * Level :m 15% of code can be restored
     #      * Level :q 25% of code can be restored
     #      * Level :h 30% of code can be restored (default :h)
-    #   # mode   - the mode of the qrcode (defaults to alphanumeric or byte_8bit, depending on the input data):
+    #   # mode - the mode of the QR Code (defaults to alphanumeric or byte_8bit, depending on the input data, only used when data is a string):
     #      * :number
     #      * :alphanumeric
     #      * :byte_8bit
-    #      * :kanji
     #
     #   qr = RQRCodeCore::QRCode.new('hello world', size: 1, level: :m, mode: :alphanumeric)
-    #
-
-    def initialize(string, *args)
-      if !string.is_a? String
-        raise QRCodeArgumentError, "The passed data is #{string.class}, not String"
-      end
+    #   segment_qr = QRCodeCore::QRCode.new({ data: 'foo', mode: :byte_8bit })
+    #   multi_qr = RQRCodeCore::QRCode.new([{ data: 'foo', mode: :byte_8bit }, { data: 'bar1', mode: :alphanumeric }])
 
+    def initialize(data, *args)
       options = extract_options!(args)
-      level = (options[:level] || :h).to_sym
 
-      if !QRERRORCORRECTLEVEL.has_key?(level)
-        raise QRCodeArgumentError, "Unknown error correction level `#{level.inspect}`"
+      level = (options[:level] || :h).to_sym
+      max_size = options[:max_size] || QRUtil.max_size
+
+      @data = case data
+      when String
+        QRSegment.new(data: data, mode: options[:mode])
+      when Array
+        raise QRCodeArgumentError, "Array must contain Hashes with :data and :mode keys" unless data.all? { |seg| seg.is_a?(Hash) && %i[data mode].all? { |s| seg.key? s } }
+        data.map { |seg| QRSegment.new(**seg) }
+      when QRSegment
+        data
+      else
+        raise QRCodeArgumentError, "data must be a String, QRSegment, or an Array"
       end
+      @error_correct_level = QRERRORCORRECTLEVEL[level]
 
-      @data = string
-
-      mode = QRMODE_NAME[(options[:mode] || "").to_sym]
-      # If mode is not explicitely given choose mode according to data type
-      mode ||= if RQRCodeCore::QRNumeric.valid_data?(@data)
-        QRMODE_NAME[:number]
-      elsif QRAlphanumeric.valid_data?(@data)
-        QRMODE_NAME[:alphanumeric]
-      else
-        QRMODE_NAME[:byte_8bit]
+      unless @error_correct_level
+        raise QRCodeArgumentError, "Unknown error correction level `#{level.inspect}`"
       end
 
-      max_size_array = QRMAXDIGITS[level][mode]
-      size = options[:size] || smallest_size_for(string, max_size_array)
+      size = options[:size] || minimum_version(limit: max_size)
 
-      if size > QRUtil.max_size
+      if size > max_size
         raise QRCodeArgumentError, "Given size greater than maximum possible size of #{QRUtil.max_size}"
       end
 
-      @error_correct_level = QRERRORCORRECTLEVEL[level]
       @version = size
       @module_count = @version * 4 + QRPOSITIONPATTERNLENGTH
       @modules = Array.new(@module_count)
-      @data_list =
-        case mode
-        when :mode_number
-          QRNumeric.new(@data)
-        when :mode_alpha_numk
-          QRAlphanumeric.new(@data)
-        else
-          QR8bitByte.new(@data)
-        end
-
+      @data_list = multi_segment? ? QRMulti.new(@data) : @data.writer
       @data_cache = nil
       make
     end
@@ -293,6 +213,11 @@ module RQRCodeCore
       QRERRORCORRECTLEVEL.invert[@error_correct_level]
     end
 
+    # Return true if this QR Code includes multiple encoded segments
+    def multi_segment?
+      @data.is_a?(Array)
+    end
+
     # Return a symbol in QRMODE.keys for current mode used
     def mode
       case @data_list
@@ -307,14 +232,14 @@ module RQRCodeCore
 
     protected
 
-    def make #:nodoc:
+    def make # :nodoc:
       prepare_common_patterns
       make_impl(false, get_best_mask_pattern)
     end
 
     private
 
-    def prepare_common_patterns #:nodoc:
+    def prepare_common_patterns # :nodoc:
       @modules.map! { |row| Array.new(@module_count) }
 
       place_position_probe_pattern(0, 0)
@@ -326,7 +251,7 @@ module RQRCodeCore
       @common_patterns = @modules.map(&:clone)
     end
 
-    def make_impl(test, mask_pattern) #:nodoc:
+    def make_impl(test, mask_pattern) # :nodoc:
       @modules = @common_patterns.map(&:clone)
 
       place_format_info(test, mask_pattern)
@@ -341,15 +266,15 @@ module RQRCodeCore
       map_data(@data_cache, mask_pattern)
     end
 
-    def place_position_probe_pattern(row, col) #:nodoc:
+    def place_position_probe_pattern(row, col) # :nodoc:
       (-1..7).each do |r|
         next unless (row + r).between?(0, @module_count - 1)
 
         (-1..7).each do |c|
           next unless (col + c).between?(0, @module_count - 1)
 
-          is_vert_line = (r.between?(0, 6) && (c == 0 || c == 6))
-          is_horiz_line = (c.between?(0, 6) && (r == 0 || r == 6))
+          is_vert_line = r.between?(0, 6) && (c == 0 || c == 6)
+          is_horiz_line = c.between?(0, 6) && (r == 0 || r == 6)
           is_square = r.between?(2, 4) && c.between?(2, 4)
 
           is_part_of_probe = is_vert_line || is_horiz_line || is_square
@@ -358,11 +283,11 @@ module RQRCodeCore
       end
     end
 
-    def get_best_mask_pattern #:nodoc:
+    def get_best_mask_pattern # :nodoc:
       min_lost_point = 0
       pattern = 0
 
-      (0...8).each do |i|
+      8.times do |i|
         make_impl(true, i)
         lost_point = QRUtil.get_lost_points(modules)
 
@@ -374,13 +299,13 @@ module RQRCodeCore
       pattern
     end
 
-    def place_timing_pattern #:nodoc:
+    def place_timing_pattern # :nodoc:
       (8...@module_count - 8).each do |i|
         @modules[i][6] = @modules[6][i] = i % 2 == 0
       end
     end
 
-    def place_position_adjust_pattern #:nodoc:
+    def place_position_adjust_pattern # :nodoc:
       positions = QRUtil.get_pattern_positions(@version)
 
       positions.each do |row|
@@ -389,7 +314,7 @@ module RQRCodeCore
 
           (-2..2).each do |r|
             (-2..2).each do |c|
-              is_part_of_pattern = (r.abs == 2 || c.abs == 2 || (r == 0 && c == 0))
+              is_part_of_pattern = r.abs == 2 || c.abs == 2 || (r == 0 && c == 0)
               @modules[row + r][col + c] = is_part_of_pattern
             end
           end
@@ -397,22 +322,22 @@ module RQRCodeCore
       end
     end
 
-    def place_version_info(test) #:nodoc:
+    def place_version_info(test) # :nodoc:
       bits = QRUtil.get_bch_version(@version)
 
-      (0...18).each do |i|
-        mod = (!test && ((bits >> i) & 1) == 1)
+      18.times do |i|
+        mod = !test && ((bits >> i) & 1) == 1
         @modules[(i / 3).floor][ i % 3 + @module_count - 8 - 3 ] = mod
         @modules[i % 3 + @module_count - 8 - 3][ (i / 3).floor ] = mod
       end
     end
 
-    def place_format_info(test, mask_pattern) #:nodoc:
+    def place_format_info(test, mask_pattern) # :nodoc:
       data = (@error_correct_level << 3 | mask_pattern)
       bits = QRUtil.get_bch_format_info(data)
 
       QRFORMATINFOLENGTH.times do |i|
-        mod = (!test && ((bits >> i) & 1) == 1)
+        mod = !test && ((bits >> i) & 1) == 1
 
         # vertical
         row = if i < 6
@@ -439,7 +364,7 @@ module RQRCodeCore
       @modules[@module_count - 8][8] = !test
     end
 
-    def map_data(data, mask_pattern) #:nodoc:
+    def map_data(data, mask_pattern) # :nodoc:
       inc = -1
       row = @module_count - 1
       bit_index = 7
@@ -449,7 +374,7 @@ module RQRCodeCore
         col -= 1 if col <= 6
 
         loop do
-          (0...2).each do |c|
+          2.times do |c|
             if @modules[row][col - c].nil?
               dark = false
               if byte_index < data.size && !data[byte_index].nil?
@@ -478,19 +403,24 @@ module RQRCodeCore
       end
     end
 
-    def smallest_size_for(string, max_size_array) #:nodoc:
-      l = string.bytesize
-      ver = max_size_array.index { |i| i >= l }
-      raise QRCodeRunTimeError, "code length overflow. (#{l} digits > any version capacity)" unless ver
-      ver + 1
+    def minimum_version(limit: QRUtil.max_size, version: 1)
+      raise QRCodeRunTimeError, "Data length exceed maximum capacity of version #{limit}" if version > limit
+
+      max_size_bits = QRMAXBITS[error_correction_level][version - 1]
+
+      size_bits = multi_segment? ? @data.sum { |seg| seg.size(version) } : @data.size(version)
+
+      return version if size_bits < max_size_bits
+
+      minimum_version(limit: limit, version: version + 1)
     end
 
-    def extract_options!(arr) #:nodoc:
+    def extract_options!(arr) # :nodoc:
       arr.last.is_a?(::Hash) ? arr.pop : {}
     end
 
     class << self
-      def count_max_data_bits(rs_blocks) #:nodoc:
+      def count_max_data_bits(rs_blocks) # :nodoc:
         max_data_bytes = rs_blocks.reduce(0) do |sum, rs_block|
           sum + rs_block.data_count
         end
@@ -498,7 +428,7 @@ module RQRCodeCore
         max_data_bytes * 8
       end
 
-      def create_data(version, error_correct_level, data_list) #:nodoc:
+      def create_data(version, error_correct_level, data_list) # :nodoc:
         rs_blocks = QRRSBlock.get_rs_blocks(version, error_correct_level)
         max_data_bits = QRCode.count_max_data_bits(rs_blocks)
         buffer = QRBitBuffer.new(version)
@@ -515,7 +445,7 @@ module RQRCodeCore
         QRCode.create_bytes(buffer, rs_blocks)
       end
 
-      def create_bytes(buffer, rs_blocks) #:nodoc:
+      def create_bytes(buffer, rs_blocks) # :nodoc:
         offset = 0
         max_dc_count = 0
         max_ec_count = 0
@@ -542,7 +472,7 @@ module RQRCodeCore
           ecdata_block = Array.new(rs_poly.get_length - 1)
           ecdata_block.size.times do |i|
             mod_index = i + mod_poly.get_length - ecdata_block.size
-            ecdata_block[i] = mod_index >= 0 ? mod_poly.get(mod_index) : 0
+            ecdata_block[i] = (mod_index >= 0) ? mod_poly.get(mod_index) : 0
           end
           ecdata[r] = ecdata_block
         end

data/lib/rqrcode_core/qrcode/qr_math.rb

@@ -6,7 +6,7 @@ module RQRCodeCore
       exp_table = Array.new(256)
       log_table = Array.new(256)
 
-      (0...8).each do |i|
+      8.times do |i|
         exp_table[i] = 1 << i
       end
 
@@ -17,7 +17,7 @@ module RQRCodeCore
           ^ exp_table[i - 8]
       end
 
-      (0...255).each do |i|
+      255.times do |i|
         log_table[exp_table[i]] = i
       end
 

data/lib/rqrcode_core/qrcode/qr_multi.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RQRCodeCore
+  class QRMulti
+    def initialize(data)
+      @data = data
+    end
+
+    def write(buffer)
+      @data.each { |seg| seg.writer.write(buffer) }
+    end
+  end
+end

data/lib/rqrcode_core/qrcode/qr_segment.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RQRCodeCore
+  class QRSegment
+    attr_reader :data, :mode
+
+    def initialize(data:, mode: nil)
+      @data = data
+      @mode = QRMODE_NAME.dig(mode&.to_sym)
+
+      # If mode is not explicitly found choose mode according to data type
+      @mode ||= if RQRCodeCore::QRNumeric.valid_data?(@data)
+        QRMODE_NAME[:number]
+      elsif QRAlphanumeric.valid_data?(@data)
+        QRMODE_NAME[:alphanumeric]
+      else
+        QRMODE_NAME[:byte_8bit]
+      end
+    end
+
+    def size(version)
+      4 + header_size(version) + content_size
+    end
+
+    def header_size(version)
+      QRUtil.get_length_in_bits(QRMODE[mode], version)
+    end
+
+    def content_size
+      chunk_size, bit_length, extra = case mode
+      when :mode_number
+        [3, QRNumeric::NUMBER_LENGTH[3], QRNumeric::NUMBER_LENGTH[data_length % 3] || 0]
+      when :mode_alpha_numk
+        [2, 11, 6]
+      when :mode_8bit_byte
+        [1, 8, 0]
+      end
+
+      (data_length / chunk_size) * bit_length + (((data_length % chunk_size) == 0) ? 0 : extra)
+    end
+
+    def writer
+      case mode
+      when :mode_number
+        QRNumeric.new(data)
+      when :mode_alpha_numk
+        QRAlphanumeric.new(data)
+      when :mode_multi
+        QRMulti.new(data)
+      else
+        QR8bitByte.new(data)
+      end
+    end
+
+    private
+
+    def data_length
+      data.bytesize
+    end
+  end
+end

data/lib/rqrcode_core/qrcode/qr_util.rb

@@ -57,10 +57,17 @@ module RQRCodeCore
     BITS_FOR_MODE = {
       QRMODE[:mode_number] => [10, 12, 14],
       QRMODE[:mode_alpha_numk] => [9, 11, 13],
-      QRMODE[:mode_8bit_byte] => [8, 16, 16],
-      QRMODE[:mode_kanji] => [8, 10, 12]
+      QRMODE[:mode_8bit_byte] => [8, 16, 16]
     }.freeze
 
+    # This value is used during the right shift zero fill step. It is
+    # auto set to 32 or 64 depending on the arch of your system running.
+    # 64 consumes a LOT more memory. In tests it's shown changing it to 32
+    # on 64 bit systems greatly reduces the memory footprint. You can use
+    # RQRCODE_CORE_ARCH_BITS to make this change but beware it may also
+    # have unintended consequences so use at your own risk.
+    ARCH_BITS = ENV.fetch("RQRCODE_CORE_ARCH_BITS", nil)&.to_i || 1.size * 8
+
     def self.max_size
       PATTERN_POSITION_TABLE.count
     end
@@ -74,8 +81,8 @@ module RQRCodeCore
     end
 
     def self.rszf(num, count)
-      # zero fill right shift
-      (num >> count) & ((2**((num.size * 8) - count)) - 1)
+      # right shift zero fill
+      (num >> count) & ((1 << (ARCH_BITS - count)) - 1)
     end
 
     def self.get_bch_version(data)
@@ -247,7 +254,8 @@ module RQRCodeCore
         sum + col.count(true)
       end
 
-      ratio = dark_count / (modules.size * modules.size)
+      # Convert to float to prevent integer division
+      ratio = dark_count.to_f / (modules.size * modules.size)
       ratio_delta = (100 * ratio - 50).abs / 5
 
       ratio_delta * DEMERIT_POINTS_4

data/lib/rqrcode_core/qrcode.rb

@@ -5,7 +5,9 @@ require "rqrcode_core/qrcode/qr_alphanumeric"
 require "rqrcode_core/qrcode/qr_bit_buffer"
 require "rqrcode_core/qrcode/qr_code"
 require "rqrcode_core/qrcode/qr_math"
+require "rqrcode_core/qrcode/qr_multi"
 require "rqrcode_core/qrcode/qr_numeric"
 require "rqrcode_core/qrcode/qr_polynomial"
 require "rqrcode_core/qrcode/qr_rs_block"
+require "rqrcode_core/qrcode/qr_segment"
 require "rqrcode_core/qrcode/qr_util"

data/lib/rqrcode_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RQRCodeCore
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/rqrcode_core.gemspec

@@ -16,6 +16,10 @@ Gem::Specification.new do |spec|
   EOF
   spec.homepage = "https://github.com/whomwah/rqrcode_core"
   spec.license = "MIT"
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/whomwah/rqrcode_core/issues",
+    "changelog_uri" => "https://github.com/whomwah/rqrcode_core/blob/main/CHANGELOG.md"
+  }
 
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -24,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.3"
+  spec.required_ruby_version = "~> 3.0"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "standardrb", "~> 1.0"
+  spec.add_development_dependency "standard", "~> 1.41"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode_core
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Duncan Robertson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2025-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: standardrb
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.41'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.41'
 description: |
   rqrcode_core is a Ruby library for encoding QR Codes. The simple
   interface (with no runtime dependencies) allows you to create QR Code data structures.
@@ -75,6 +75,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -92,33 +93,37 @@ files:
 - lib/rqrcode_core/qrcode/qr_bit_buffer.rb
 - lib/rqrcode_core/qrcode/qr_code.rb
 - lib/rqrcode_core/qrcode/qr_math.rb
+- lib/rqrcode_core/qrcode/qr_multi.rb
 - lib/rqrcode_core/qrcode/qr_numeric.rb
 - lib/rqrcode_core/qrcode/qr_polynomial.rb
 - lib/rqrcode_core/qrcode/qr_rs_block.rb
+- lib/rqrcode_core/qrcode/qr_segment.rb
 - lib/rqrcode_core/qrcode/qr_util.rb
 - lib/rqrcode_core/version.rb
 - rqrcode_core.gemspec
 homepage: https://github.com/whomwah/rqrcode_core
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/whomwah/rqrcode_core/issues
+  changelog_uri: https://github.com/whomwah/rqrcode_core/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: A library to encode QR Codes
 test_files: []