qrcode 0.0.1 → 0.1.0

data/lib/qrcode/encoder/util.rb

@@ -0,0 +1,269 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2008-2025, by Duncan Robertson.
+# Copyright, 2009, by Chris Mowforth.
+# Copyright, 2011, by Gioele Barabucci.
+# Copyright, 2012-2015, by Björn Blomqvist.
+# Copyright, 2012, by xn.
+# Copyright, 2014, by Sean Doig.
+# Copyright, 2020, by Nathaniel Roman.
+# Copyright, 2021, by Sam Sayer.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "constants"
+require_relative "math"
+require_relative "polynomial"
+
+module QRCode
+	module Encoder
+		class Util
+			PATTERN_POSITION_TABLE = [
+				[],
+				[6, 18],
+				[6, 22],
+				[6, 26],
+				[6, 30],
+				[6, 34],
+				[6, 22, 38],
+				[6, 24, 42],
+				[6, 26, 46],
+				[6, 28, 50],
+				[6, 30, 54],
+				[6, 32, 58],
+				[6, 34, 62],
+				[6, 26, 46, 66],
+				[6, 26, 48, 70],
+				[6, 26, 50, 74],
+				[6, 30, 54, 78],
+				[6, 30, 56, 82],
+				[6, 30, 58, 86],
+				[6, 34, 62, 90],
+				[6, 28, 50, 72, 94],
+				[6, 26, 50, 74, 98],
+				[6, 30, 54, 78, 102],
+				[6, 28, 54, 80, 106],
+				[6, 32, 58, 84, 110],
+				[6, 30, 58, 86, 114],
+				[6, 34, 62, 90, 118],
+				[6, 26, 50, 74, 98, 122],
+				[6, 30, 54, 78, 102, 126],
+				[6, 26, 52, 78, 104, 130],
+				[6, 30, 56, 82, 108, 134],
+				[6, 34, 60, 86, 112, 138],
+				[6, 30, 58, 86, 114, 142],
+				[6, 34, 62, 90, 118, 146],
+				[6, 30, 54, 78, 102, 126, 150],
+				[6, 24, 50, 76, 102, 128, 154],
+				[6, 28, 54, 80, 106, 132, 158],
+				[6, 32, 58, 84, 110, 136, 162],
+				[6, 26, 54, 82, 110, 138, 166],
+				[6, 30, 58, 86, 114, 142, 170]
+			].freeze
+			
+			G15 = 1 << 10 | 1 << 8 | 1 << 5 | 1 << 4 | 1 << 2 | 1 << 1 | 1 << 0
+			G18 = 1 << 12 | 1 << 11 | 1 << 10 | 1 << 9 | 1 << 8 | 1 << 5 | 1 << 2 | 1 << 0
+			G15_MASK = 1 << 14 | 1 << 12 | 1 << 10 | 1 << 4 | 1 << 1
+			
+			DEMERIT_POINTS_1 = 3
+			DEMERIT_POINTS_2 = 3
+			DEMERIT_POINTS_3 = 40
+			DEMERIT_POINTS_4 = 10
+			
+			BITS_FOR_MODE = {
+				MODE[:mode_number] => [10, 12, 14],
+				MODE[:mode_alpha_numk] => [9, 11, 13],
+				MODE[: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
+			
+			def self.get_bch_format_info(data)
+				d = data << 10
+				while Encoder::Util.get_bch_digit(d) - Encoder::Util.get_bch_digit(G15) >= 0
+					d ^= (G15 << (Encoder::Util.get_bch_digit(d) - Encoder::Util.get_bch_digit(G15)))
+				end
+				((data << 10) | d) ^ G15_MASK
+			end
+			
+			def self.rszf(num, count)
+				# right shift zero fill
+				(num >> count) & ((1 << (ARCH_BITS - count)) - 1)
+			end
+			
+			def self.get_bch_version(data)
+				d = data << 12
+				while Encoder::Util.get_bch_digit(d) - Encoder::Util.get_bch_digit(G18) >= 0
+					d ^= (G18 << (Encoder::Util.get_bch_digit(d) - Encoder::Util.get_bch_digit(G18)))
+				end
+				(data << 12) | d
+			end
+			
+			def self.get_bch_digit(data)
+				digit = 0
+				
+				while data != 0
+					digit += 1
+					data = Encoder::Util.rszf(data, 1)
+				end
+				
+				digit
+			end
+			
+			def self.get_pattern_positions(version)
+				PATTERN_POSITION_TABLE[version - 1]
+			end
+			
+			def self.get_mask(mask_pattern, i, j)
+				if mask_pattern > MASK_COMPUTATIONS.size
+					raise RuntimeError, "bad mask_pattern: #{mask_pattern}"
+				end
+				
+				MASK_COMPUTATIONS[mask_pattern].call(i, j)
+			end
+			
+			def self.get_error_correct_polynomial(error_correct_length)
+				a = Encoder::Polynomial.new([1], 0)
+				
+				(0...error_correct_length).each do |i|
+					a = a.multiply(Encoder::Polynomial.new([1, Encoder::Math.gexp(i)], 0))
+				end
+				
+				a
+			end
+			
+			def self.get_length_in_bits(mode, version)
+				if !MODE.value?(mode)
+					raise RuntimeError, "Unknown mode: #{mode}"
+				end
+				
+				if version > 40
+					raise RuntimeError, "Unknown version: #{version}"
+				end
+				
+				if version.between?(1, 9)
+					# 1 - 9
+					macro_version = 0
+				elsif version <= 26
+					# 10 - 26
+					macro_version = 1
+				elsif version <= 40
+					# 27 - 40
+					macro_version = 2
+				end
+				
+				BITS_FOR_MODE[mode][macro_version]
+			end
+			
+			def self.get_lost_points(modules)
+				demerit_points = 0
+				
+				demerit_points += Encoder::Util.demerit_points_1_same_color(modules)
+				demerit_points += Encoder::Util.demerit_points_2_full_blocks(modules)
+				demerit_points += Encoder::Util.demerit_points_3_dangerous_patterns(modules)
+				demerit_points += Encoder::Util.demerit_points_4_dark_ratio(modules)
+				
+				demerit_points
+			end
+			
+			def self.demerit_points_1_same_color(modules)
+				demerit_points = 0
+				module_count = modules.size
+				
+				# level1
+				(0...module_count).each do |row|
+					(0...module_count).each do |col|
+						same_count = 0
+						dark = modules[row][col]
+						
+						(-1..1).each do |r|
+							next if row + r < 0 || module_count <= row + r
+							
+							(-1..1).each do |c|
+								next if col + c < 0 || module_count <= col + c
+								next if r == 0 && c == 0
+								if dark == modules[row + r][col + c]
+									same_count += 1
+								end
+							end
+						end
+						
+						if same_count > 5
+							demerit_points += (DEMERIT_POINTS_1 + same_count - 5)
+						end
+					end
+				end
+				
+				demerit_points
+			end
+			
+			def self.demerit_points_2_full_blocks(modules)
+				demerit_points = 0
+				module_count = modules.size
+				
+				# level 2
+				(0...(module_count - 1)).each do |row|
+					(0...(module_count - 1)).each do |col|
+						count = 0
+						count += 1 if modules[row][col]
+						count += 1 if modules[row + 1][col]
+						count += 1 if modules[row][col + 1]
+						count += 1 if modules[row + 1][col + 1]
+						if count == 0 || count == 4
+							demerit_points += DEMERIT_POINTS_2
+						end
+					end
+				end
+				
+				demerit_points
+			end
+			
+			def self.demerit_points_3_dangerous_patterns(modules)
+				demerit_points = 0
+				module_count = modules.size
+				
+				# level 3
+				modules.each do |row|
+					(module_count - 6).times do |col_idx|
+						if row[col_idx] && !row[col_idx + 1] && row[col_idx + 2] && row[col_idx + 3] && row[col_idx + 4] && !row[col_idx + 5] && row[col_idx + 6]
+							demerit_points += DEMERIT_POINTS_3
+						end
+					end
+				end
+				
+				(0...module_count).each do |col|
+					(0...(module_count - 6)).each do |row|
+						if modules[row][col] && !modules[row + 1][col] && modules[row + 2][col] && modules[row + 3][col] && modules[row + 4][col] && !modules[row + 5][col] && modules[row + 6][col]
+							demerit_points += DEMERIT_POINTS_3
+						end
+					end
+				end
+				
+				demerit_points
+			end
+			
+			def self.demerit_points_4_dark_ratio(modules)
+				# level 4
+				dark_count = modules.reduce(0) do |sum, col|
+					sum + col.count(true)
+				end
+				
+				# 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
+			end
+		end
+	end
+end

data/lib/qrcode/encoder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "encoder/code"
+
+# @namespace
+module QRCode
+	# @namespace
+	module Encoder
+	end
+end

data/lib/qrcode/output/svg.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module QRCode
+	module Output
+		# SVG renderer for scalable vector graphics
+		class SVG
+			attr_reader :qrcode, :cell_size, :border, :dark_color, :light_color
+			
+			def initialize(qrcode, cell_size: 10, border: 2, dark_color: "#000000", light_color: "#ffffff")
+				@qrcode = qrcode
+				@cell_size = cell_size
+				@border = border
+				@dark_color = dark_color
+				@light_color = light_color
+			end
+			
+			def render
+				total_size = (qrcode.size + (border * 2)) * cell_size
+				
+				svg = []
+				svg << %[<?xml version="1.0" encoding="UTF-8"?>]
+				svg << %[<svg xmlns="http://www.w3.org/2000/svg" width="#{total_size}" height="#{total_size}" viewBox="0 0 #{total_size} #{total_size}">]
+				
+				# Background rectangle
+				svg << %[  <rect x="0" y="0" width="#{total_size}" height="#{total_size}" fill="#{light_color}"/>]
+				
+				# Generate dark modules as rectangles
+				qrcode.size.times do |row|
+					qrcode.size.times do |col|
+						if qrcode.checked?(row, col)
+							x = (col + border) * cell_size
+							y = (row + border) * cell_size
+							svg << %[  <rect x="#{x}" y="#{y}" width="#{cell_size}" height="#{cell_size}" fill="#{dark_color}"/>]
+						end
+					end
+				end
+				
+				svg << %[</svg>]
+				svg.join("\n")
+			end
+		end
+	end
+end

data/lib/qrcode/output/text.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module QRCode
+	module Output
+		# Text renderer using Unicode half-height block characters
+		class Text
+			# Unicode block characters for different combinations
+			BLOCKS = {
+				[false, false] => " ",   # Both light - single space
+				[false, true]  => "▄",   # Top light, bottom dark
+				[true, false]  => "▀",   # Top dark, bottom light  
+				[true, true]   => "█"    # Both dark - full block
+			}.freeze
+			
+			attr_reader :qrcode, :border
+			
+			def initialize(qrcode, border: 2)
+				@qrcode = qrcode
+				@border = border
+			end
+			
+			def render
+				lines = []
+				
+				# Add top border
+				border.times do
+					lines << " " * total_width
+				end
+				
+				# Process QR code in pairs of rows to use half-height blocks
+				(0...qrcode.size).step(2) do |row|
+					line = " " * border  # Left border
+					
+					qrcode.size.times do |col|
+						top = qrcode.checked?(row, col)
+						bottom = (row + 1 < qrcode.size) ? qrcode.checked?(row + 1, col) : false
+						line += BLOCKS[[top, bottom]]
+					end
+					
+					line += " " * border  # Right border
+					lines << line
+				end
+				
+				# Add bottom border
+				border.times do
+					lines << " " * total_width
+				end
+				
+				lines.join("\n")
+			end
+			
+			private
+			
+			def total_width
+				qrcode.size + (border * 2)
+			end
+		end
+	end
+end

data/lib/qrcode/version.rb

@@ -1,3 +1,14 @@
-module Qrcode
-  VERSION = "0.0.1"
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2011-2025, by Duncan Robertson.
+# Copyright, 2012-2016, by Björn Blomqvist.
+# Copyright, 2012, by xn.
+# Copyright, 2013, by Yauhen Kharuzhy.
+# Copyright, 2015, by Tonči Damjanić.
+# Copyright, 2015, by Bjorn Blomqvist.
+# Copyright, 2025, by Samuel Williams.
+
+module QRCode
+	VERSION = "0.1.0"
 end

data/lib/qrcode.rb

@@ -1,5 +1,25 @@
-require "qrcode/version"
+# frozen_string_literal: true
 
-module Qrcode
-  # Your code goes here...
+# Released under the MIT License.
+# Copyright, 2019-2020, by Duncan Robertson.
+# Copyright, 2020, by Nathaniel Roman.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "qrcode/version"
+require_relative "qrcode/encoder"
+require_relative "qrcode/output/text"
+require_relative "qrcode/output/svg"
+
+module QRCode
+	# Convenience method to create a QR code and render as text
+	def self.text(data, level: :h, mode: :auto, size: nil, max_size: nil, **output_options)
+		qr = Encoder::Code.build(data, level: level, mode: mode, size: size, max_size: max_size)
+		Output::Text.new(qr, **output_options).render
+	end
+	
+	# Convenience method to create a QR code and render as SVG
+	def self.svg(data, level: :h, mode: :auto, size: nil, max_size: nil, **output_options)
+		qr = Encoder::Code.build(data, level: level, mode: mode, size: size, max_size: max_size)
+		Output::SVG.new(qr, **output_options).render
+	end
 end

data/license.md

@@ -0,0 +1,54 @@
+# MIT License
+
+Copyright, 2008-2025, by Duncan Robertson.  
+Copyright, 2009, by Chris Mowforth.  
+Copyright, 2009, by Tore Darell.  
+Copyright, 2011, by Daniel Schierbeck.  
+Copyright, 2011, by Ken Collins.  
+Copyright, 2011, by Gioele Barabucci.  
+Copyright, 2011, by Marcos Piccinini.  
+Copyright, 2012-2018, by Björn Blomqvist.  
+Copyright, 2012, by xn.  
+Copyright, 2013, by Yauhen Kharuzhy.  
+Copyright, 2013, by Andreas Finger.  
+Copyright, 2013-2016, by Bjorn Blomqvist.  
+Copyright, 2013, by Jon Evans.  
+Copyright, 2014, by Sean Doig.  
+Copyright, 2015, by Bart Jedrocha.  
+Copyright, 2015, by Simon Males.  
+Copyright, 2015, by Ferdinand Rosario.  
+Copyright, 2015, by Christopher Lord.  
+Copyright, 2015, by José Luis Honorato.  
+Copyright, 2015, by Tonči Damjanić.  
+Copyright, 2015-2016, by Fabio Napoleoni.  
+Copyright, 2016, by Christian Campbell.  
+Copyright, 2016, by Andy Brody.  
+Copyright, 2017, by Nicolò Gnudi.  
+Copyright, 2019, by Thibaut Barrère.  
+Copyright, 2019, by Masataka Pocke Kuwabara.  
+Copyright, 2020, by Nathaniel Roman.  
+Copyright, 2020, by dependabot[bot].  
+Copyright, 2020, by Jeremy Evans.  
+Copyright, 2021, by Simon Schrape.  
+Copyright, 2021, by Sam Sayer.  
+Copyright, 2022, by James Neal.  
+Copyright, 2025, by Matt Rohrer.  
+Copyright, 2025, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,60 @@
+# QRCode
+
+A pure Ruby library for generating QR codes with multiple output formats. Generate QR codes as text art for terminal display or as scalable SVG graphics for web and print applications.
+
+This is a fork of [`rqrcode_core`](https://github.com/whomwah/rqrcode_core), which was originally
+adapted in 2008 from a Javascript library by \[Kazuhiko Arase\](https://github.com/kazuhikoarase/
+qrcode-generator).
+
+[![Development Status](https://github.com/socketry/qrcode/workflows/Test/badge.svg)](https://github.com/socketry/qrcode/actions?workflow=Test)
+
+## Features
+
+  - **Pure Ruby**: No external dependencies, works with any Ruby application.
+  - **Multiple Output Formats**: Text (Unicode blocks) and SVG output built-in.
+  - **Automatic Optimization**: Intelligently selects the most efficient encoding (numeric, alphanumeric, or binary).
+  - **Error Correction**: Full support for all four standardized error correction levels (L, M, Q, H).
+  - **Multi-Segment Encoding**: Optimize large data by mixing encoding modes in a single QR code.
+  - **Command Line Tools**: Bake tasks for generating QR codes from the terminal.
+  - **Standards Compliant**: Follows ISO/IEC 18004 QR Code specification.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/qrcode/) for more details.
+
+  - [Getting Started](https://socketry.github.io/qrcode/guides/getting-started/index) - This guide explains how to get started with `qrcode` to generate QR codes in Ruby.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/qrcode/releases/index) for all releases.
+
+### v0.1.0
+
+  - **Breaking**: Complete refactor of encoder architecture with cleaner segment-based design.
+  - **Breaking**: Renamed `RSBlock` to `ErrorCorrectionBlock` with cleaner method names (`for`, `table_entry_for`).
+  - **Breaking**: Simplified `Code` constructor to take segments array, added `Code.build()` factory method.
+  - **Breaking**: Removed redundant `Multi` class - multi-segment support now built into `Code` directly.
+  - Added self-contained segment classes: `Segment`, `NumericSegment`, `AlphanumericSegment`.
+  - Added comprehensive test coverage for output functionality (Text and SVG).
+  - Added `size` alias for `module_count` for cleaner API.
+  - Added proper documentation explaining error correction level encoding from ISO/IEC 18004.
+  - Improved code organization with `QRCode::Encoder` namespace for all encoding classes.
+  - Removed QR prefix from encoder file and class names for cleaner codebase.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,14 @@
+# Releases
+
+## v0.1.0
+
+  - **Breaking**: Complete refactor of encoder architecture with cleaner segment-based design.
+  - **Breaking**: Renamed `RSBlock` to `ErrorCorrectionBlock` with cleaner method names (`for`, `table_entry_for`).
+  - **Breaking**: Simplified `Code` constructor to take segments array, added `Code.build()` factory method.
+  - **Breaking**: Removed redundant `Multi` class - multi-segment support now built into `Code` directly.
+  - Added self-contained segment classes: `Segment`, `NumericSegment`, `AlphanumericSegment`.
+  - Added comprehensive test coverage for output functionality (Text and SVG).
+  - Added `size` alias for `module_count` for cleaner API.
+  - Added proper documentation explaining error correction level encoding from ISO/IEC 18004.
+  - Improved code organization with `QRCode::Encoder` namespace for all encoding classes.
+  - Removed QR prefix from encoder file and class names for cleaner codebase.