RubyRqrr

RubyRqrr (Ruby RQ'er) is a Ruby gem that provides a simple interface to scan images for QR codes. It uses the Rust crate RQrr under the hood to decode QR codes. This gem is a simple wrapper around the Rust crate to provide a Ruby interface.

At this time, this gem requires the Rust toolchain to be installed. If you do not have Rust installed, you can install it by following the instructions at rustup.rs.

We will be working on releasing precompiled binaries in the future to remove this requirement for most users.

bundle add ruby_rqrr

If bundler is not being used to manage dependencies, install the gem by executing:

gem install ruby_rqrr

The gem provides a module RubyRqrr with a single method detect_qrs_in_image that takes an image file path as an argument and returns an array of QR codes found in the image.

require 'ruby_rqrr'

RubyRqrr.detect_qrs_in_image('path/to/image.png')
["https://github.com/phchun/ruby_rqrr"]

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

We will follow the RQrr versioning for the first three digits. The fourth digit will be used for RubyRqrr specific changes within that version of RQrr.

Bug reports and pull requests are welcome on GitHub at https://github.com/phchun/ruby_rqrr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

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

Everyone interacting in the RubyRqrr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.