Module: QRCode

Defined in:
lib/qrcode/encoder.rb,
lib/qrcode.rb,
lib/qrcode/version.rb,
lib/qrcode/output/svg.rb,
lib/qrcode/output/text.rb,
lib/qrcode/encoder/code.rb,
lib/qrcode/encoder/math.rb,
lib/qrcode/encoder/util.rb,
lib/qrcode/encoder/segment.rb,
lib/qrcode/encoder/constants.rb,
lib/qrcode/encoder/bit_buffer.rb,
lib/qrcode/encoder/polynomial.rb,
lib/qrcode/encoder/error_correction_block.rb

Overview

Released under the MIT License. Copyright, 2025, by Samuel Williams.

Defined Under Namespace

Modules: Encoder, Output

Constant Summary collapse

VERSION = 
"0.2.1"

Class Method Summary collapse

Class Method Details

.svg(data, level: :h, mode: :auto, size: nil, max_size: nil, **output_options) ⇒ Object

Convenience method to create a QR code and render as SVG



21
22
23
24
 
# File 'lib/qrcode.rb', line 21

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

.text(data, level: :h, mode: :auto, size: nil, max_size: nil, **output_options) ⇒ Object

Convenience method to create a QR code and render as text



15
16
17
18
 
# File 'lib/qrcode.rb', line 15

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