Skip to content

Latest commit

 

History

History
126 lines (85 loc) · 2.84 KB

README.md

File metadata and controls

126 lines (85 loc) · 2.84 KB
Raw

Ruby Style Guide

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("https://kyan.com")
$ 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("https://kyan.com")
qr.rows.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 (integer) of the qrcode (defaults to smallest size needed to encode the string)

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

RQRCodeCore::QRCode.new("http://kyan.com", size: 1, level: :m, mode: :alphanumeric)

Development

Tests

You can run the test suite using:

$ ./bin/setup
$ rake

or try the project from the console with:

$ ./bin/console

Linting

The project uses standardrb and can be run with:

$ ./bin/setup
$ rake standard # check
$ rake standard:fix # fix

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.