rqrcode 0.4.0 → 0.4.1

data/CHANGELOG

@@ -1,3 +1,7 @@
+*0.4.1* (Aug 16th, 2011)
+
+* Compute common patterns only once (5% to 10% speedup) [https://github.com/gioele]
+
 *0.4.0* (Aug 13th, 2011)
 
 * Code optimization: 30% speedup [https://github.com/gioele]

data/README.md

@@ -0,0 +1,119 @@
+# rQRCode, Encode QRCodes
+
+## Overview
+
+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.
+
+Let's clear up some rQRCode stuff.
+
+* 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 encode a string into a QR code
+* QR code is trademarked by Denso Wave inc
+
+## Resources
+
+* 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 Rubygems. 
+
+    gem install rqrcode
+
+You can also get the latest source from http://github.com/whomwah/rqrcode
+
+    git clone git://github.com/whomwah/rqrcode.git
+
+## Tests
+
+To run the tests:
+
+    $ rake
+ 
+## Loading rQRCode Itself
+
+You have installed the gem already, yeah?
+
+    require 'rubygems'
+    require 'rqrcode'
+
+## Simple QRCode generation to screen
+
+```ruby
+qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
+puts qr.to_s
+#
+# Prints:
+# 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
+```
+
+## Simple QRCode generation to template (RubyOnRails)
+
+```erb
+# Controller
+@qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
+
+# View: (minimal styling added)
+<style type="text/css">
+table {
+  border-width: 0;
+  border-style: none;
+  border-color: #0000ff;
+  border-collapse: collapse;
+}
+td {
+  border-width: 0; 
+  border-style: none;
+  border-color: #0000ff; 
+  border-collapse: collapse; 
+  padding: 0; 
+  margin: 0; 
+  width: 10px; 
+  height: 10px; 
+}
+td.black { background-color: #000; }
+td.white { background-color: #fff; }
+</style>
+
+<table>
+<% @qr.modules.each_index do |x| %>
+  <tr>  
+  <% @qr.modules.each_index do |y| %>
+   <% if @qr.dark?(x,y) %>
+    <td class="black"/>
+   <% else %>
+    <td class="white"/>
+   <% end %>
+  <% end %>
+  </tr>
+<% end %>
+</table>
+```
+
+## Authors
+
+Original author: Duncan Robertson
+
+Special thanks to the following people for submitting patches:
+
+* [Gioele Barabucci](https://github.com/gioele) 
+* [Rob la Lau](https://github.com/ohreally)
+* [Chris Mowforth](http://blog.99th.st)
+* [Tore Darell](http://tore.darell.no)
+* [Daniel Schierbeck](https://github.com/dasch)
+* Vladislav Gorodetskiy
+
+## Contributing
+* Fork the project
+* Send a pull request
+* Don't touch the .gemspec, I'll do that when I release a new version
+
+## Copyright
+
+MIT Licence (http://www.opensource.org/licenses/mit-license.html)

data/lib/rqrcode/qrcode/qr_code.rb

@@ -47,6 +47,9 @@ module RQRCode #:nodoc:
         Proc.new { |i,j| ((i * j) % 3 + (i + j) % 2) % 2 == 0 },
   ]
 
+  QRPOSITIONPATTERNLENGTH = (7 + 1) * 2 + 1
+  QRFORMATINFOLENGTH = 15
+
   # StandardErrors
 
   class QRCodeArgumentError < ArgumentError; end
@@ -95,8 +98,8 @@ module RQRCode #:nodoc:
 
       @data                 = string
       @error_correct_level  = QRERRORCORRECTLEVEL[level]
-      @type_number          = size
-      @module_count         = @type_number * 4 + 17
+      @version              = size
+      @module_count         = @version * 4 + QRPOSITIONPATTERNLENGTH
       @modules              = Array.new( @module_count )
       @data_list            = QR8bitByte.new( @data )
       @data_cache           = nil
@@ -113,7 +116,7 @@ module RQRCode #:nodoc:
     #
 
     def is_dark( row, col )
-      if row < 0 || @module_count <= row || col < 0 || @module_count <= col
+      if !row.between?(0, @module_count - 1) || !col.between?(0, @module_count - 1)
         raise QRCodeRunTimeError, "Invalid row/column pair: #{row}, #{col}"
       end
       @modules[row][col]
@@ -163,29 +166,33 @@ module RQRCode #:nodoc:
     protected
 
     def make #:nodoc:
+      prepare_common_patterns
       make_impl( false, get_best_mask_pattern )
     end
 
     private
 
+    def prepare_common_patterns
+        @modules.map! { |row| Array.new(@module_count) }
 
-    def make_impl( test, mask_pattern ) #:nodoc:
+        place_position_probe_pattern(0, 0)
+        place_position_probe_pattern(@module_count - 7, 0)
+        place_position_probe_pattern(0, @module_count - 7)
+        place_position_adjust_pattern
+        place_timing_pattern
 
-      ( 0...@module_count ).each do |row|
-        @modules[row] = Array.new( @module_count )
-      end
+        @common_patterns = @modules.map(&:clone)
+    end
 
-      setup_position_probe_pattern( 0, 0 )
-      setup_position_probe_pattern( @module_count - 7, 0 )
-      setup_position_probe_pattern( 0, @module_count - 7 )
-      setup_position_adjust_pattern
-      setup_timing_pattern
-      setup_type_info( test, mask_pattern )
-      setup_type_number( test ) if @type_number >= 7
+    def make_impl( test, mask_pattern ) #:nodoc:
+      @modules = @common_patterns.map(&:clone)
+
+      place_format_info(test, mask_pattern)
+      place_version_info(test) if @version >= 7
 
       if @data_cache.nil?
         @data_cache = QRCode.create_data( 
-          @type_number, @error_correct_level, @data_list 
+          @version, @error_correct_level, @data_list
         ) 
       end
 
@@ -193,16 +200,19 @@ module RQRCode #:nodoc:
     end
 
 
-    def setup_position_probe_pattern( row, col ) #:nodoc:
-      ( -1..7 ).each do |r|
-        next if ( row + r )  <= -1 || @module_count <= ( row + r )
-        ( -1..7 ).each do |c|
-          next if ( col + c ) <= -1 || @module_count <= ( col + c )
-          if 0 <= r && r <= 6 && ( c == 0 || c == 6 ) || 0 <= c && c <= 6 && ( r == 0 || r == 6 ) || 2 <= r && r <= 4 && 2 <= c && c <= 4
-            @modules[row + r][col + c] = true;
-          else
-            @modules[row + r][col + c] = false;
-          end
+    def place_position_probe_pattern( row, col ) #:nodoc:
+      (-1..7).each do |r|
+        next if !(row + r).between?(0, @module_count - 1)
+
+        (-1..7).each do |c|
+          next if !(col + c).between?(0, @module_count - 1)
+
+          is_vert_line = (r.between?(0, 6) && (c == 0 || c == 6))
+          is_horiz_line = (c.between?(0, 6) && (r == 0 || r == 6))
+          is_square = r.between?(2,4) && c.between?(2, 4)
+
+          is_part_of_probe = is_vert_line || is_horiz_line || is_square
+          @modules[row + r][col + c] = is_part_of_probe
         end
       end
     end
@@ -225,30 +235,24 @@ module RQRCode #:nodoc:
     end
 
 
-    def setup_timing_pattern #:nodoc:
+    def place_timing_pattern #:nodoc:
       ( 8...@module_count - 8 ).each do |i|
         @modules[i][6] = @modules[6][i] = i % 2 == 0 
       end
     end
 
 
-    def setup_position_adjust_pattern #:nodoc:
-      pos = QRUtil.get_pattern_position(@type_number)
-
-      ( 0...pos.size ).each do |i|
-        ( 0...pos.size ).each do |j|
-          row = pos[i]
-          col = pos[j]
+    def place_position_adjust_pattern #:nodoc:
+      positions = QRUtil.get_pattern_positions(@version)
 
+      positions.each do |row|
+        positions.each do |col|
           next unless @modules[row][col].nil?
 
           ( -2..2 ).each do |r|
             ( -2..2 ).each do |c|
-              if r == -2 || r == 2 || c == -2 || c == 2 || ( r == 0 && c == 0 )
-                @modules[row + r][col + c] = true
-              else
-                @modules[row + r][col + c] = false
-              end
+              is_part_of_pattern = (r.abs == 2 || c.abs == 2 || ( r == 0 && c == 0 ))
+              @modules[row + r][col + c] = is_part_of_pattern
             end
           end  
         end
@@ -256,8 +260,8 @@ module RQRCode #:nodoc:
     end
 
 
-    def setup_type_number( test ) #:nodoc:
-      bits = QRUtil.get_bch_type_number( @type_number )
+    def place_version_info(test) #:nodoc:
+      bits = QRUtil.get_bch_version(@version)
 
       ( 0...18 ).each do |i|
         mod = ( !test && ( (bits >> i) & 1) == 1 )
@@ -267,30 +271,32 @@ module RQRCode #:nodoc:
     end
 
 
-    def setup_type_info( test, mask_pattern ) #:nodoc:
+    def place_format_info(test, mask_pattern) #:nodoc:
       data = (@error_correct_level << 3 | mask_pattern)
-      bits = QRUtil.get_bch_type_info( data )
+      bits = QRUtil.get_bch_format_info(data)
 
-      ( 0...15 ).each do |i|
+      QRFORMATINFOLENGTH.times do |i|
         mod = (!test && ( (bits >> i) & 1) == 1)
 
         # vertical
         if i < 6
-          @modules[i][8] = mod
+          row = i
         elsif i < 8
-          @modules[ i + 1 ][8] = mod
+          row = i + 1
         else
-          @modules[ @module_count - 15 + i ][8] = mod
+          row = @module_count - 15 + i
         end
+        @modules[row][8] = mod
 
         # horizontal
         if i < 8
-          @modules[8][ @module_count - i - 1 ] = mod
+          col = @module_count - i - 1
         elsif i < 9
-          @modules[8][ 15 - i - 1 + 1 ] = mod
+          col = 15 - i - 1 + 1
         else
-          @modules[8][ 15 - i - 1 ] = mod
+          col = 15 - i - 1
         end
+        @modules[8][col] = mod
       end
 
       # fixed module
@@ -346,14 +352,14 @@ module RQRCode #:nodoc:
       return max_data_bytes * 8
     end
 
-    def QRCode.create_data( type_number, error_correct_level, data_list ) #:nodoc:
-      rs_blocks = QRRSBlock.get_rs_blocks( type_number, error_correct_level )
+    def QRCode.create_data(version, error_correct_level, data_list) #:nodoc:
+      rs_blocks = QRRSBlock.get_rs_blocks(version, error_correct_level)
       buffer = QRBitBuffer.new
 
       data = data_list
       buffer.put( data.mode, 4 )
       buffer.put( 
-        data.get_length, QRUtil.get_length_in_bits( data.mode, type_number ) 
+        data.get_length, QRUtil.get_length_in_bits(data.mode, version)
       )
       data.write( buffer )  
 

data/lib/rqrcode/qrcode/qr_rs_block.rb

@@ -268,12 +268,12 @@ RQRCode::QRRSBlock::RS_BLOCK_TABLE = [
 
     ]
 
-    def QRRSBlock.get_rs_blocks( type_no, error_correct_level )
-      rs_block = QRRSBlock.get_rs_block_table( type_no, error_correct_level )
+    def QRRSBlock.get_rs_blocks(version, error_correct_level)
+      rs_block = QRRSBlock.get_rs_block_table(version, error_correct_level)
 
       if rs_block.nil?
         raise QRCodeRunTimeError,
-          "bad rsblock @ typeno: #{type_no}/error_correct_level:#{error_correct_level}"
+          "bad rsblock @ version: #{version}/error_correct_level:#{error_correct_level}"
       end
 
       length = rs_block.size / 3
@@ -293,16 +293,16 @@ RQRCode::QRRSBlock::RS_BLOCK_TABLE = [
     end
 
 
-    def QRRSBlock.get_rs_block_table( type_number, error_correct_level )
+    def QRRSBlock.get_rs_block_table(version, error_correct_level)
       case error_correct_level
       when QRERRORCORRECTLEVEL[:l]
-        QRRSBlock::RS_BLOCK_TABLE[(type_number - 1) * 4 + 0]
+        QRRSBlock::RS_BLOCK_TABLE[(version - 1) * 4 + 0]
       when QRERRORCORRECTLEVEL[:m]
-        QRRSBlock::RS_BLOCK_TABLE[(type_number - 1) * 4 + 1]
+        QRRSBlock::RS_BLOCK_TABLE[(version - 1) * 4 + 1]
       when QRERRORCORRECTLEVEL[:q]
-        QRRSBlock::RS_BLOCK_TABLE[(type_number - 1) * 4 + 2]
+        QRRSBlock::RS_BLOCK_TABLE[(version - 1) * 4 + 2]
       when QRERRORCORRECTLEVEL[:h]
-        QRRSBlock::RS_BLOCK_TABLE[(type_number - 1) * 4 + 3]
+        QRRSBlock::RS_BLOCK_TABLE[(version - 1) * 4 + 3]
       else
         nil
       end

data/lib/rqrcode/qrcode/qr_util.rb

@@ -73,7 +73,7 @@ module RQRCode #:nodoc:
       QRMODE[:mode_kanji] => [8, 10, 12],
     }
 
-    def QRUtil.get_bch_type_info( data )
+    def QRUtil.get_bch_format_info( data )
       d = data << 10
       while QRUtil.get_bch_digit(d) - QRUtil.get_bch_digit(G15) >= 0
         d ^= (G15 << (QRUtil.get_bch_digit(d) - QRUtil.get_bch_digit(G15)))
@@ -82,7 +82,7 @@ module RQRCode #:nodoc:
     end
 
 
-    def QRUtil.get_bch_type_number( data )
+    def QRUtil.get_bch_version(data)
       d = data << 12
       while QRUtil.get_bch_digit(d) - QRUtil.get_bch_digit(G18) >= 0
         d ^= (G18 << (QRUtil.get_bch_digit(d) - QRUtil.get_bch_digit(G18)))
@@ -103,8 +103,8 @@ module RQRCode #:nodoc:
     end
 
 
-    def QRUtil.get_pattern_position( type_number )
-      PATTERN_POSITION_TABLE[ type_number - 1 ]
+    def QRUtil.get_pattern_positions(version)
+      PATTERN_POSITION_TABLE[version - 1]
     end
 
 
@@ -128,27 +128,27 @@ module RQRCode #:nodoc:
     end
 
 
-    def QRUtil.get_length_in_bits(mode, type)
+    def QRUtil.get_length_in_bits(mode, version)
       if !QRMODE.value?(mode)
           raise QRCodeRunTimeError, "Unknown mode: #{mode}"
       end
 
-      if type > 40
-        raise QRCodeRunTimeError, "Unknown type: #{type}"
+      if version > 40
+        raise QRCodeRunTimeError, "Unknown version: #{version}"
       end
 
-      if 1 <= type && type <= 9
+      if version.between?(1, 9)
         # 1 - 9
-        macro_type = 0
-      elsif type <= 26
+        macro_version = 0
+      elsif version <= 26
         # 10 - 26
-        macro_type = 1
-      elsif type <= 40
+        macro_version = 1
+      elsif version <= 40
         # 27 - 40
-        macro_type = 2
+        macro_version = 2
       end
 
-      return BITS_FOR_MODE[mode][macro_type]
+      return BITS_FOR_MODE[mode][macro_version]
     end
 
     def QRUtil.get_lost_points(modules)

data/lib/rqrcode/version.rb

@@ -1,3 +1,3 @@
 module RQRCode
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/rqrcode.gemspec

@@ -22,7 +22,7 @@ EOF
   s.add_development_dependency("bundler", ">= 1.0.0")
 
   s.has_rdoc      = true
-  s.extra_rdoc_files = ["README.org", "CHANGELOG", "LICENSE"]  
+  s.extra_rdoc_files = ["README.md", "CHANGELOG", "LICENSE"]  
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/test/test_rqrcode.rb

@@ -71,10 +71,10 @@ class QRCodeTest < Test::Unit::TestCase
 
   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"
+    assert_equal "xxxxxxx xx x  xxxxxxx\n", qr.to_s[0..21]
+    assert_equal "qqqqqqqnqqnqnnqqqqqqq\n",
+                 qr.to_s( :true => 'q', :false => 'n' )[0..21]
+    assert_equal "@@@@@@@ @@ @  @@@@@@@\n", qr.to_s( :true => '@' )[0..21]
   end
 
   def test_rszf_error_not_thrown

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rqrcode
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Duncan Robertson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-14 00:00:00 +01:00
+date: 2011-08-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,7 +60,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.org
+- README.md
 - CHANGELOG
 - LICENSE
 files: 
@@ -68,7 +68,7 @@ files:
 - CHANGELOG
 - Gemfile
 - LICENSE
-- README.org
+- README.md
 - Rakefile
 - lib/rqrcode.rb
 - lib/rqrcode/core_ext.rb

data/README.org

@@ -1,108 +0,0 @@
-* rQRCode, Encode QRCodes
-
-** Overview
-
-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.
-
-Let's clear up some rQRCode stuff.
-
-- 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 encode a string into a QR code
-- QR code is trademarked by Denso Wave inc
-
-** Resources
-
-- 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 Rubygems. 
-
-: $ gem install rqrcode
-
-You can also get the source from http://github.com/whomwah/rqrcode
-
-: $ git clone git://github.com/whomwah/rqrcode.git
- 
-** Loading rQRCode Itself
-
-You have installed the gem already, yeah?
-
-: require 'rubygems'
-: require 'rqrcode'
-
-** Simple QRCode generation to screen
-
-: qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
-: puts qr.to_s
-: #
-: # Prints:
-: # 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
-
-** Simple QRCode generation to template (RubyOnRails)
-
-: # Controller
-: @qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
-:
-: # View: (minimal styling added)
-: <style type="text/css">
-: table {
-:   border-width: 0;
-:   border-style: none;
-:   border-color: #0000ff;
-:   border-collapse: collapse;
-: }
-: td {
-:   border-width: 0; 
-:   border-style: none;
-:   border-color: #0000ff; 
-:   border-collapse: collapse; 
-:   padding: 0; 
-:   margin: 0; 
-:   width: 10px; 
-:   height: 10px; 
-: }
-: td.black { background-color: #000; }
-: td.white { background-color: #fff; }
-: </style>
-:
-: <table>
-: <% @qr.modules.each_index do |x| %>
-:   <tr>  
-:   <% @qr.modules.each_index do |y| %>
-:    <% if @qr.dark?(x,y) %>
-:     <td class="black"/>
-:    <% else %>
-:     <td class="white"/>
-:    <% end %>
-:   <% end %>
-:   </tr>
-: <% end %>
-: </table>
-
-** Authors
-
-Original author: Duncan Robertson
-
-Special thanks to the following people for submitting patches:
-
-- Gioele Barabucci 
-- Rob la Lau
-- Chris Mowforth
-- Tore Darell
-- Vladislav Gorodetskiy
-
-** Contributing
-- Fork the project
-- Send a pull request
-- Don't touch the .gemspec, I'll do that when I release a new version
-
-** Copyright
-
-MIT Licence (http://www.opensource.org/licenses/mit-license.html)