COPYING @@ -1,12 +1,39 @@ -rQRCode -======= += rQRCode, Encode QRCodes -A library for encoding QR Codes in Ruby. Adapted from the Javascript library: +rQRCode is a library for encoding QR Codes in Ruby. It has a simple interface with all the standard qrcode options. It was adapted from the Javascript library by Kazuhiko Arase. -// QRCode for ActionScript - version 1.0.1 - Kazuhiko Arase += An Overview +Let's clear up what rQRCode is. + +# rQRCode is a *standalone library*. It requires no other 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 parse a string into a QR code +# QR code is trademarked by Denso Wave inc + += Rescources + +# wikipedia [http://en.wikipedia.org/wiki/QR_Code] +# Denso-Wave website [http://www.denso-wave.com/qrcode/index-e.html] +# kaywa [http://qrcode.kaywa.com/] + + +== Installing + +You may get the latest stable version from Rubyforge. Source gems are also available. + + $ gem install rqrcode + +=== Loading rQRCode Itself + +You have installed the gem already, yeah? + + require 'rubygems' + require 'qrqcode' + +=== Simple QRCode generation to screen + + qr = RQRCode::QRCode.create('my string to generate') + qr.to_console -Usage -===== -qr = RQRCode::QRCode.new( :size => README @@ -54,7 +54,7 @@ module RQRCode PAD0 = 0xEC PAD1 = 0x11 - def initialize( options = {} ) + def initialize( data, options = {} ) options = options.stringify_keys @type_number = options["size"] || 4 level = options["level"] || "h" @@ -63,14 +63,17 @@ module RQRCode @module_count = 0 @data_cache = nil @data_list = [] + @data = data + + self.create # let's go ! end - def add_data( data ) - new_data = QR8bitByte.new( data ) - @data_list << new_data - @data_cache = nil - end + def create + raise ArgumentError if @data.nil? || @data.size == 0 + @data_list << QR8bitByte.new( @data ) + make_impl( false, get_best_mask_pattern ) + end def is_dark( row, col ) @@ -82,11 +85,6 @@ module RQRCode end - def make - make_impl( false, get_best_mask_pattern ) - end - - def make_impl( test, mask_pattern ) @module_count = @type_number * 4 + 17 @modules = Array.new( @module_count ) lib/rqrcode/qrcode.rb @@ -3,20 +3,25 @@ require File.join(File.dirname(__FILE__), "..", "test_helper") class QRCodeTest < Test::Unit::TestCase require File.dirname(__FILE__) + "/test_data" + def test_argument_error + assert_raise(ArgumentError) { + qr = RQRCode::QRCode.new( :size => 1 ) + } + end + def test_1_H_ - qr = RQRCode::QRCode.new( :size => 1 ) - qr.add_data('duncan') - qr.make + qr = RQRCode::QRCode.new( 'duncan', :size => 1 ) assert_equal qr.modules.length, 21 assert_equal qr.module_count, 21 assert_equal qr.modules, MATRIX_1_H + + qr = RQRCode::QRCode.new( 'duncan', :size => 1 ) + assert_equal qr.modules, MATRIX_1_H end def test_3_H_ - qr = RQRCode::QRCode.new( :size => 3 ) - qr.add_data('duncan') - qr.make + qr = RQRCode::QRCode.new( 'duncan', :size => 3 ) assert_equal qr.modules.length, 29 assert_equal qr.module_count, 29 @@ -24,9 +29,7 @@ class QRCodeTest < Test::Unit::TestCase end def test_5_H_ - qr = RQRCode::QRCode.new( :size => 5 ) - qr.add_data('duncan') - qr.make + qr = RQRCode::QRCode.new( 'duncan', :size => 5 ) assert_equal qr.modules.length, 37 assert_equal qr.module_count, 37 @@ -34,9 +37,7 @@ class QRCodeTest < Test::Unit::TestCase end def test_10_H_ - qr = RQRCode::QRCode.new( :size => 10 ) - qr.add_data('duncan') - qr.make + qr = RQRCode::QRCode.new( 'duncan', :size => 10 ) assert_equal qr.modules.length, 57 assert_equal qr.module_count, 57 @@ -44,9 +45,7 @@ class QRCodeTest < Test::Unit::TestCase end def test_4_H_ - qr = RQRCode::QRCode.new - qr.add_data('www.bbc.co.uk/programmes/b0090blw') - qr.make + qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw') assert_equal qr.modules.length, 33 assert_equal qr.module_count, 33 test/unit/qrcode_test.rb e09c73f51591d61579312f3a015eb85b4b414610 whomwah whomwah@70f6ffcc-3070-48c7-8e95-2772f12856e8 http://github.com/whomwah/rqrcode/commit/90d5ca421ccf89f3c30d569d85714f5c6843119a 90d5ca421ccf89f3c30d569d85714f5c6843119a 2008-02-22T07:04:35-08:00 2008-02-22T07:04:35-08:00 let's try and make the interface nicer git-svn-id: svn+ssh://rubyforge/var/svn/rqrcode/trunk@9 70f6ffcc-3070-48c7-8e95-2772f12856e8 52a58d90e509c42ea278266fdc70e90e11640545 whomwah whomwah@70f6ffcc-3070-48c7-8e95-2772f12856e8