Skip to content
The QRCode encoding/decoding lib that powers: https://github.com/whomwah/rqrcode
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
bin
lib
test
.gitignore
Gemfile
Gemfile.lock
LICENSE.txt
README.md Add badge and update workflow name Sep 16, 2019
Rakefile
rqrcode_core.gemspec

README.md

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.

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 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

Add this line to your application's Gemfile:

gem 'rqrcode_core'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rqrcode_core

Basic Usage

$ require 'rqrcode_core'
$ qr = RQRCodeCore::QRCode.new('my string to generate', size: 4, level: :h)
$ puts qr.to_s

Output:

xxxxxxx x  x x   x x  xx  xxxxxxx
x     x  xxx  xxxxxx xxx  x     x
x xxx x  xxxxx x       xx x xxx x
... etc

Doing your own rendering

require 'rqrcode_core'

qr = RQRCodeCore::QRCode.new('my string to generate', size: 4, level: :h)
qr.modules.each do |row|
  row.each do |col|
    print col ? '#' : ' '
  end

  print "\n"
end

Options

The library expects a string to be parsed in, other args are optional.

string - the string you wish to encode

size   - the size of the qrcode (default 4)

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):
  * :number
  * :alphanumeric
  * :byte_8bit
  * :kanji

Example

qr = RQRCodeCore::QRCode.new('hello world', size: 1, level: :m, mode: :alphanumeric)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/whomwah/rqrcode_core.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.