CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

3.2.0 - 2026-01-08

Added

• Comprehensive benchmarking suite in benchmark/ directory for measuring performance and memory usage across all export formats (SVG, PNG, HTML, ANSI)
• benchmark_helper.rb providing shared utilities for IPS, memory, and stack profiling
• Rake tasks for running benchmarks individually or all at once
• benchmark/README.md explaining usage, metrics, and interpretation of results
• AGENTS.md as a development guide for AI agents

Changed

• SVG rendering: Improved by +130% (from 184 i/s to 424 i/s) with 71% memory reduction
• HTML rendering: Now the fastest export format at 1,876 i/s (rendering-only benchmark)
• Memory efficiency: HTML now uses 6x less memory than SVG (previously 22x)
• Updated minimum Ruby version requirement to >= 3.2.0
• Updated GitHub workflow Ruby matrix to test only supported versions (3.2, 3.3, 3.4, 4.0)
• Updated README.md with benchmark documentation and contribution guidelines

3.1.1 - 2025-11-25

• Update required_ruby_version to support >= rather than ~> ready for Ruby 4

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 2.0.0, which includes breaking changes. Please refer to the rqrcode_core changelog

2.2.0 - 2023-06-17

Changed

• Allow all ChunkyPNG::Color options to be passed into fill and color on as_png [#135]
• Add 3.2 to CI @petergoldstein [#133]
• Development dependency upgrades. Minimum Ruby change [#130]
• README updates

2.1.2 - 2022-07-26

Changed

• Remove setup script as it just calls bundle install [#128]
• Change inline styles to the fill property to allow for strict CSP style-src directive [#127]

2.1.1 - 2022-02-11

Added

• Added in a handler for when color arguments are passed in as symbols e.g color: :yellow. This also allows for the use of the :currentColor keyword. [#122]

2.1.0 - 2021-08-26

Changed

• Sync Gemfile.lock with rqrcode_core.1.2.0 Adds Multimode Support

Added

• Add badge for Standard linting

Changed

• Corrected method name referred to in CHANGELOG.

2.0.0 - 2021-05-06

Added

• A new use_path: option on .as_svg. This uses a <path> node to greatly reduce the final SVG size. [#108]
• A new viewbox: option on .as_svg. Replaces the svg.width and svg.height attribute with svg.viewBox to allow CSS scaling. [#112]
• A new svg_attributes: option on .as_svg. Allows you to pass in custom SVG attributes to be used in the <svg> tag. [#113]

Changed

• README updated
• Rakefile cleaned up. You can now just run rake which will run specs and fix linting using standardrb
• Small documentation clarification @smnscp
• Bump rqrcode_core to ~> 1.0

Breaking Change

• The dependency rqrcode_core-1.0.0 has a tiny breaking change to the to_s public method. https://github.com/whomwah/rqrcode_core/blob/main/CHANGELOG.md#breaking-changes

1.2.0 - 2020-12-26

Changed

• README updated
• bump dependencies
• fix required_ruby_version for Ruby 3 support