@@ -1,3 +1,9 @@ +*0.3.0* (Feb 28th, 2008) + +* added more documentation +* changed to_console to to_s (what was I thinking) +* add more tests + *0.2.1* (Feb 24th, 2008) * small changes to rakefile and readme CHANGELOG @@ -1,10 +1,10 @@ -= rQRCode, Encode QRCodes +== rQRCode, Encode QRCodes 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. RubyForge Project Page http://rubyforge.org/projects/rqrcode/ -= An Overview +== An Overview Let's clear up some rQRCode stuff. @@ -13,7 +13,7 @@ Let's clear up some rQRCode stuff. # 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 -= Rescources +== Rescources wikipedia:: http://en.wikipedia.org/wiki/QR_Code Denso-Wave website:: http://www.denso-wave.com/qrcode/index-e.html @@ -36,7 +36,7 @@ You have installed the gem already, yeah? === Simple QRCode generation to screen qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h ) - puts qr.to_console + puts qr.to_s # # Prints: # xxxxxxx x x x x x xx xxxxxxx @@ -52,10 +52,10 @@ You have installed the gem already, yeah? <b>View: (minimal styling added)</b> <style type="text/css"> table { - border-width: 0; - border-style: none; - border-color: #0000ff; - border-collapse: collapse; + border-width: 0; + border-style: none; + border-color: #0000ff; + border-collapse: collapse; } td { border-width: 0; @@ -74,11 +74,11 @@ You have installed the gem already, yeah? <table> <% @qr.modules.each_index do |x| %> <tr> - <% x.each_index do |y| %> + <% @qr.modules.each_index do |y| %> <% if @qr.is_dark(x,y) %> - <td class="black"/> + <td class="black"/> <% else %> - <td class="white"/> + <td class="white"/> <% end %> <% end %> </tr> README @@ -6,30 +6,30 @@ require 'rake/rdoctask' require 'rake/testtask' NAME = "rqrcode" -VERS = "0.2.1" +VERS = "0.3.0" CLEAN.include ['pkg', 'rdoc'] Gem::manage_gems spec = Gem::Specification.new do |s| - s.name = NAME - s.version = VERS - s.author = "Duncan Robertson" - s.email = "duncan@whomwah.com" - s.homepage = "http://rqrcode.rubyforge.org" - s.platform = Gem::Platform::RUBY - s.summary = "A library to encode QR Codes" - s.rubyforge_project = NAME - s.description = <<EOF -rQRCode is a library for encoding QRCodes. The simple -interace allows you to simply create QRCodes ready to -be displayed in the way you choose. + s.name = NAME + s.version = VERS + s.author = "Duncan Robertson" + s.email = "duncan@whomwah.com" + s.homepage = "http://rqrcode.rubyforge.org" + s.platform = Gem::Platform::RUBY + s.summary = "A library to encode QR Codes" + s.rubyforge_project = NAME + s.description = <<EOF +rQRCode is a library for encoding QR Codes. The simple +interface allows you to simply create QR Code data +structures ready to be displayed in the way you choose. EOF s.files = FileList["lib/**/*", "test/*"].exclude("rdoc").to_a - s.require_path = "lib" - s.has_rdoc = true + s.require_path = "lib" + s.has_rdoc = true s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"] - s.test_file = "test/runtest.rb" + s.test_file = "test/runtest.rb" end task :build_package => [:repackage] @@ -61,5 +61,5 @@ Rake::RDocTask.new("rdoc") { |rdoc| desc "rdoc to rubyforge" task :rubyforge => [:rdoc] do - sh %{/usr/bin/scp -r -p rdoc/* rubyforge:/var/www/gforge-projects/rqrcode} + sh %{/usr/bin/scp -r -p rdoc/* rubyforge:/var/www/gforge-projects/rqrcode} end Rakefile @@ -1,9 +1,9 @@ module CoreExtensions #:nodoc: module Array #:nodoc: module Behavior - def extract_options! - last.is_a?(::Hash) ? pop : {} - end - end - end + def extract_options! + last.is_a?(::Hash) ? pop : {} + end + end + end end lib/rqrcode/core_ext/array/behavior.rb @@ -12,10 +12,10 @@ module RQRCode #:nodoc: QRMODE = { - :mode_number => 1 << 0, - :mode_alpha_num => 1 << 1, - :mode_8bit_byte => 1 << 2, - :mode_kanji => 1 << 3 + :mode_number => 1 << 0, + :mode_alpha_numk => 1 << 1, + :mode_8bit_byte => 1 << 2, + :mode_kanji => 1 << 3 } QRERRORCORRECTLEVEL = { @@ -36,45 +36,57 @@ module RQRCode #:nodoc: :pattern111 => 7 } - # Generic QRCode exception class. + # StandardErrors - class QRCodeArgumentError < ArgumentError; end - class QRCodeRunTimeError < RuntimeError; end + class QRCodeArgumentError < ArgumentError; end + class QRCodeRunTimeError < RuntimeError; end - # This is the main interface for creating your QRCode - # You create a new instance of QRCode and then you have - # a few simple methods to choose form + # == Creation + # + # QRCode objects expect only one required constructor parameter + # and an optional hash of any other. Here's a few examples: + # + # qr = RQRCode::QRCode.new('hello world') + # qr = RQRCode::QRCode.new('hello world', :size => 1, :level => :m ) + # class QRCode attr_reader :modules, :module_count PAD0 = 0xEC - PAD1 = 0x11 - - # Expects a string to be parsed in, other options have defaults - - def initialize( *args ) - raise QRCodeArgumentError unless args.first.kind_of?( String ) - - @data = args.shift - options = args.extract_options! - level = options[:level] || :h + PAD1 = 0x11 + + # Expects a string to be parsed in, other args are optional + # + # # string - the string you wish to encode + # # size - the size of the qrcode + # # level - the error correction level + # qr = RQRCode::QRCode.new('hello world', :size => 1, :level => :m ) + # + + def initialize( *args ) + raise QRCodeArgumentError unless args.first.kind_of?( String ) + + @data = args.shift + options = args.extract_options! + level = options[:level] || :h @error_correct_level = QRERRORCORRECTLEVEL[ level.to_sym ] - @type_number = options[:size] || 4 - @module_count = @type_number * 4 + 17 - @modules = nil - @data_cache = nil - @data_list = QR8bitByte.new( @data ) + @type_number = options[:size] || 4 + @module_count = @type_number * 4 + 17 + @modules = nil + @data_cache = nil + @data_list = QR8bitByte.new( @data ) - self.make # let's go ! + self.make end - # called parsing in a row and col coordinate - # * return true or false - # * raise exception if row < 0 - # * raise exception if col < 0 - # * raise exception if @module_count <= row - # * raise exception if @module_count <= col + # <tt>is_dark</tt> is called with a +col+ and +row+ parameter. This will + # return true or false based on whether that coordinate exists in the + # matrix returned. It would normally be called while iterating through + # <tt>modules</tt>. A simple example would be: + # + # instance.is_dark( 10, 10 ) => true + # def is_dark( row, col ) if row < 0 || @module_count <= row || col < 0 || @module_count <= col @@ -83,8 +95,31 @@ module RQRCode #:nodoc: @modules[row][col] end - def to_console( row = 'x', col = ' ' ) - res = [] + # This is a public method that returns the QR Code you have + # generated as a string. It will not be able to be read + # in this format by a QR Code reader, but will give you an + # idea if the final outout. It takes two optional args + # +:true+ and +:false+ which are there for you to choose + # how the output looks. Here's an example of it's use: + # + # instance.to_s => + # xxxxxxx x x x x x xx xxxxxxx + # x x xxx xxxxxx xxx x x + # x xxx x xxxxx x xx x xxx x + # + # instance._to_s( :true => 'E', :false => 'Q') => + # EEEEEEEQEQQEQEQQQEQEQQEEQQEEEEEEE + # EQQQQQEQQEEEQQEEEEEEQEEEQQEQQQQQE + # EQEEEQEQQEEEEEQEQQQQQQQEEQEQEEEQE + # + + def to_s( *args ) + options = args.extract_options! + row = options[:true] || 'x' + col = options[:false] || ' ' + + res = [] + @modules.each_index do |c| tmp = [] @modules.each_index do |r| @@ -95,17 +130,17 @@ module RQRCode #:nodoc: end end res << tmp.join - end - res.join("\n") + end + res.join("\n") end - protected + protected - def make #:nodoc: + def make #:nodoc: make_impl( false, get_best_mask_pattern ) - end + end - private + private def make_impl( test, mask_pattern ) #:nodoc: @@ -196,7 +231,7 @@ module RQRCode #:nodoc: @modules[row + r][col + c] = false end end - end + end end end end @@ -249,7 +284,7 @@ module RQRCode #:nodoc: end # fixed module - @modules[ @module_count - 8 ][8] = !test + @modules[ @module_count - 8 ][8] = !test end @@ -290,7 +325,7 @@ module RQRCode #:nodoc: break end end - end + end end def QRCode.create_data( type_number, error_correct_level, data_list ) #:nodoc: @@ -302,16 +337,16 @@ module RQRCode #:nodoc: buffer.put( data.get_length, QRUtil.get_length_in_bits( data.mode, type_number ) ) - data.write( buffer ) + data.write( buffer ) total_data_count = 0 ( 0...rs_blocks.size ).each do |i| - total_data_count = total_data_count + rs_blocks[i].data_count + total_data_count = total_data_count + rs_blocks[i].data_count end if buffer.get_length_in_bits > total_data_count * 8 raise QRCodeRunTimeError, - "code length overflow. (#{buffer.get_length_in_bits}>#{total_data_count})" + "code length overflow. (#{buffer.get_length_in_bits}>#{total_data_count})" end if buffer.get_length_in_bits + 4 <= total_data_count * 8 @@ -374,8 +409,8 @@ module RQRCode #:nodoc: ( 0...rs_blocks.size ).each do |r| if i < dcdata[r].size index += 1 - data[index-1] = dcdata[r][i] - end + data[index-1] = dcdata[r][i] + end end end @@ -383,8 +418,8 @@ module RQRCode #:nodoc: ( 0...rs_blocks.size ).each do |r| if i < ecdata[r].size index += 1 - data[index-1] = ecdata[r][i] - end + data[index-1] = ecdata[r][i] + end end end lib/rqrcode/qrcode/qr_code.rb @@ -63,7 +63,7 @@ module RQRCode #:nodoc: ( 0...get_length ).each do |i| num[i] = get(i) - end + end ( 0...e.get_length ).each do |i| tmp = num[i].nil? ? 0 : num[i] lib/rqrcode/qrcode/qr_polynomial.rb @@ -44,7 +44,7 @@ module RQRCode #:nodoc: [2, 35, 17], [2, 35, 13], - # 4 + # 4 [1, 100, 80], [2, 50, 32], [2, 50, 24], @@ -62,7 +62,7 @@ module RQRCode #:nodoc: [4, 43, 19], [4, 43, 15], - # 7 + # 7 [2, 98, 78], [4, 49, 31], [2, 32, 14, 4, 33, 15], @@ -80,7 +80,7 @@ module RQRCode #:nodoc: [4, 36, 16, 4, 37, 17], [4, 36, 12, 4, 37, 13], - # 10 + # 10 [2, 86, 68, 2, 87, 69], [4, 69, 43, 1, 70, 44], [6, 43, 19, 2, 44, 20], @@ -94,7 +94,7 @@ module RQRCode #:nodoc: if rs_block.nil? raise QRCodeRunTimeError, - "bad rsblock @ typeno: #{type_no}/error_correct_level:#{error_correct_level}" + "bad rsblock @ typeno: #{type_no}/error_correct_level:#{error_correct_level}" end length = rs_block.size / 3 lib/rqrcode/qrcode/qr_rs_block.rb @@ -25,7 +25,7 @@ module RQRCode #:nodoc: [6, 24, 42], [6, 26, 46], [6, 28, 50], - [6, 30, 54], + [6, 30, 54], [6, 32, 58], [6, 34, 62], [6, 26, 46, 66], @@ -57,7 +57,7 @@ module RQRCode #:nodoc: [6, 30, 58, 86, 114, 142, 170] ] - G15 = 1 << 10 | 1 << 8 | 1 << 5 | 1 << 4 | 1 << 2 | 1 << 1 | 1 << 0 + G15 = 1 << 10 | 1 << 8 | 1 << 5 | 1 << 4 | 1 << 2 | 1 << 1 | 1 << 0 G18 = 1 << 12 | 1 << 11 | 1 << 10 | 1 << 9 | 1 << 8 | 1 << 5 | 1 << 2 | 1 << 0 G15_MASK = 1 << 14 | 1 << 12 | 1 << 10 | 1 << 4 | 1 << 1 @@ -116,7 +116,7 @@ module RQRCode #:nodoc: when QRMASKPATTERN[:pattern111] ( (i * j) % 3 + (i + j) % 2) % 2 == 0 else - raise QRCodeRunTimeError, "bad mask_pattern: #{mask_pattern}" + raise QRCodeRunTimeError, "bad mask_pattern: #{mask_pattern}" end end @@ -137,7 +137,7 @@ module RQRCode #:nodoc: # 1 - 9 case mode - when QRMODE[:mode_number] : 10 + when QRMODE[:mode_number] : 10 when QRMODE[:mode_alpha_num] : 9 when QRMODE[:mode_8bit_byte] : 8 when QRMODE[:mode_kanji] : 8 @@ -149,7 +149,7 @@ module RQRCode #:nodoc: # 10 -26 case mode - when QRMODE[:mode_number] : 12 + when QRMODE[:mode_number] : 12 when QRMODE[:mode_alpha_num] : 11 when QRMODE[:mode_8bit_byte] : 16 when QRMODE[:mode_kanji] : 10 @@ -161,7 +161,7 @@ module RQRCode #:nodoc: # 27 - 40 case mode - when QRMODE[:mode_number] : 14 + when QRMODE[:mode_number] : 14 when QRMODE[:mode_alpha_num] : 13 when QRMODE[:mode_8bit_byte] : 16 when QRMODE[:mode_kanji] : 12 @@ -199,7 +199,7 @@ module RQRCode #:nodoc: if same_count > 5 lost_point += (3 + same_count - 5) - end + end end end @@ -211,8 +211,8 @@ module RQRCode #:nodoc: count = count + 1 if qr_code.is_dark( row + 1, col ) count = count + 1 if qr_code.is_dark( row, col + 1 ) count = count + 1 if qr_code.is_dark( row + 1, col + 1 ) - lost_point = lost_point + 3 if (count == 0 || count == 4) - end + lost_point = lost_point + 3 if (count == 0 || count == 4) + end end # level 3 @@ -239,15 +239,15 @@ module RQRCode #:nodoc: ( 0...module_count ).each do |row| if qr_code.is_dark(row, col) dark_count = dark_count + 1 - end + end end end ratio = (100 * dark_count / module_count / module_count - 50).abs / 5 lost_point = lost_point * 10 - lost_point - end + lost_point + end end lib/rqrcode/qrcode/qr_util.rb @@ -2,75 +2,77 @@ require "test/unit" require "lib/rqrcode" class QRCodeTest < Test::Unit::TestCase - require "test/test_data" + require "test/test_data" - def test_no_data_given - assert_raise(RQRCode::QRCodeArgumentError) { - RQRCode::QRCode.new( :size => 1, :level => :h ) - RQRCode::QRCode.new( :size => 1 ) - RQRCode::QRCode.new - } - assert_raise(RQRCode::QRCodeRunTimeError) { - qr = RQRCode::QRCode.new('duncan') - qr.is_dark(0,999999) - } - end + def test_no_data_given + assert_raise(RQRCode::QRCodeArgumentError) { + RQRCode::QRCode.new( :size => 1, :level => :h ) + RQRCode::QRCode.new( :size => 1 ) + RQRCode::QRCode.new + } + assert_raise(RQRCode::QRCodeRunTimeError) { + qr = RQRCode::QRCode.new('duncan') + qr.is_dark(0,999999) + } + end def test_H_ - qr = RQRCode::QRCode.new( 'duncan', :size => 1 ) + qr = RQRCode::QRCode.new( 'duncan', :size => 1 ) assert_equal qr.modules.size, 21 - assert_equal qr.modules, MATRIX_1_H + assert_equal qr.modules, MATRIX_1_H - qr = RQRCode::QRCode.new( 'duncan', :size => 1 ) - assert_equal qr.modules, MATRIX_1_H - qr = RQRCode::QRCode.new( 'duncan', :size => 1, :level => :l ) - assert_equal qr.modules, MATRIX_1_L - qr = RQRCode::QRCode.new( 'duncan', :size => 1, :level => :m ) - assert_equal qr.modules, MATRIX_1_M - qr = RQRCode::QRCode.new( 'duncan', :size => 1, :level => :q ) - assert_equal qr.modules, MATRIX_1_Q + qr = RQRCode::QRCode.new( 'duncan', :size => 1 ) + assert_equal qr.modules, MATRIX_1_H + qr = RQRCode::QRCode.new( 'duncan', :size => 1, :level => :l ) + assert_equal qr.modules, MATRIX_1_L + qr = RQRCode::QRCode.new( 'duncan', :size => 1, :level => :m ) + assert_equal qr.modules, MATRIX_1_M + qr = RQRCode::QRCode.new( 'duncan', :size => 1, :level => :q ) + assert_equal qr.modules, MATRIX_1_Q end def test_3_H_ - qr = RQRCode::QRCode.new( 'duncan', :size => 3 ) + qr = RQRCode::QRCode.new( 'duncan', :size => 3 ) assert_equal qr.modules.size, 29 - assert_equal qr.modules, MATRIX_3_H + assert_equal qr.modules, MATRIX_3_H end def test_5_H_ - qr = RQRCode::QRCode.new( 'duncan', :size => 5 ) + qr = RQRCode::QRCode.new( 'duncan', :size => 5 ) assert_equal qr.modules.size, 37 - assert_equal qr.modules, MATRIX_5_H + assert_equal qr.modules, MATRIX_5_H end def test_10_H_ - qr = RQRCode::QRCode.new( 'duncan', :size => 10 ) + qr = RQRCode::QRCode.new( 'duncan', :size => 10 ) assert_equal qr.modules.size, 57 - assert_equal qr.modules, MATRIX_10_H + assert_equal qr.modules, MATRIX_10_H end def test_4_H_ - qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw', - :level => :l ) - assert_equal qr.modules, MATRIX_4_L - qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw', - :level => :m ) - assert_equal qr.modules, MATRIX_4_M - qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw', - :level => :q ) - assert_equal qr.modules, MATRIX_4_Q + qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw', + :level => :l ) + assert_equal qr.modules, MATRIX_4_L + qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw', + :level => :m ) + assert_equal qr.modules, MATRIX_4_M + qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw', + :level => :q ) + assert_equal qr.modules, MATRIX_4_Q - qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw') + qr = RQRCode::QRCode.new('www.bbc.co.uk/programmes/b0090blw') assert_equal qr.modules.size, 33 - assert_equal qr.modules, MATRIX_4_H + assert_equal qr.modules, MATRIX_4_H end - def test_to_console - qr = RQRCode::QRCode.new( 'duncan', :size => 1 ) - assert_equal qr.to_console[0..21], "xxxxxxx xx x xxxxxxx\n" - end + def test_to_s + qr = RQRCode::QRCode.new( 'duncan', :size => 1 ) + assert_equal qr.to_s[0..21], "xxxxxxx xx x xxxxxxx\n" + assert_equal qr.to_s( :true => 'q', :false => 'n' )[0..21], "qqqqqqqnqqnqnnqqqqqqq\n" + assert_equal qr.to_s( :true => '@' )[0..21], "@@@@@@@ @@ @ @@@@@@@\n" + end end test/runtest.rb e56cad86ba897e14a28733dac4deff2914cd6d4f whomwah whomwah@70f6ffcc-3070-48c7-8e95-2772f12856e8 http://github.com/whomwah/rqrcode/commit/9b64d5304f04ac1c5b6160266e10a9eebf029e02 9b64d5304f04ac1c5b6160266e10a9eebf029e02 2008-02-28T13:05:23-08:00 2008-02-28T13:05:23-08:00 add more documentation change to_console to to_s remove all tabs and replace with spaces more tests too git-svn-id: svn+ssh://rubyforge/var/svn/rqrcode/trunk@36 70f6ffcc-3070-48c7-8e95-2772f12856e8 7233db6b8b012f5f7ae5e82b0ad3e9d51dbe2803 whomwah whomwah@70f6ffcc-3070-48c7-8e95-2772f12856e8