qrencoder 1.0.0

data/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-01-03
+
+* Initial release
+  * Wooo!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/qrencoder
+lib/qrencoder.rb
+test/test_qrencoder.rb

data/README.txt

@@ -0,0 +1,107 @@
+qrencoder
+    by Jacob Harris
+    http://www.nimblecode.com/
+    http://nycrb.rubyforge.org/qrencoder
+
+== DESCRIPTION:
+
+This Gem is a wrapper around an useful open-source library for creating QR
+Codes, a two-dimensional bar code format popular in Japan (and readable by cell
+phones even) created by the Denso-Wave Corporation in 1994. These bar codes look
+like the following:
+
+http://www.denso-wave.com/qrcode/images/qrcode.gif
+
+The specification for QR codes is readable at
+http://www.denso-wave.com/qrcode/index-e.html. QR Code is not the only 2-D
+barcode standard in existence, and it is in wider use in Japan than elsewhere.
+Notable competitors include PDF417, Semacode/DataMatrix, and Maxi Code (seen on
+UPS labels) in North America; ShotCode in the UK; and an additional format used
+in Korea. All vary in look and capacity, but QR code has one of the largest
+information densities and capacities among them with the following maximum data
+
+* Numeric	7,089
+* Alphanumeric 4,296
+* 8-Bit 2,953
+* Kanji 1,817
+
+All of these in a square that may range from 21 to 177 pixels a side (there are
+40 different "versions" of the code that specify different sizes). In addition,
+multiple levels of error correction are possible which might also influence the
+final size.
+
+== FEATURES/PROBLEMS:
+  
+* This gem requires you to build and install an external C library
+* The QREncode lib this GEM is built around is NOT thread-safe!
+
+== SYNOPSIS:
+
+There are 4 initialization methods for creating a QR code, two for strings, two
+for data. Both of these come in a simpler variant which take the string/data to
+be encoded. The second argument is a QR Code version (used to pick the size of
+the final QR Code); this version is adjusted upwards if the data is too large to
+fit within the specified version.
+
+  img = QRCode.encode_string(text, 1)
+  puts "#{img.version}"  #=> 7
+  puts "#{img.width}"    #=> 34
+  img.save_png("/tmp/foo.png")
+
+You can retrieve the pixels of the output image directly or use the included
+methods to save a PNG file directly.
+
+== REQUIREMENTS:
+
+This gem requires you to build the C library lib <tt>libqrcode.a</tt> available
+from http://megaui.net/fukuchi/works/qrencode/index.en.html. 
+
+Normally, the build process also expects you to install <tt>libpng</tt>, but
+this is only used for the <tt>qrenc</tt> command-line utility and can be avoided
+if you run the following build sequence:
+
+  ./configure --without-tools
+  make
+  sudo make install
+
+This gem also requires the following gems to be installed:
+
+* ruby-inline
+* png
+
+== INSTALL:
+
+* First build the <tt>libqrencode</tt> library following the instructions above.
+* Then <tt>sudo gem install qrencoder --include-dependencies</tt>
+
+== QRCODE LICENSE:
+
+The QR Code specification was created and patented by the Denso Corporation of
+Japan. Although the Denso Corporation retains their patent, it is "open in the
+sense that the specification of QR Code is disclosed and that the patent right
+owned by Denso Wave is not exercised." according to their website.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/qrencoder.rb'
+
+Hoe.new('qrencoder', QRCode::GEM_VERSION) do |p|
+  p.rubyforge_name = 'nycrb'
+  p.author = 'Jacob Harris'
+  p.email = 'harrisj@schizopolis.net'
+  p.summary = 'A gem for creating 2-dimensional barcodes following the QR Code specification.'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = 'http://nycrb.rubyforge.org/qrencoder'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['RubyInline', '>=3.6.2']
+  p.extra_deps << ['png', '>=1.0.0']
+end
+
+# vim: syntax=Ruby

data/lib/qrencoder.rb

@@ -0,0 +1,282 @@
+require 'rubygems'
+require 'inline'
+require 'png'
+
+class QRCode
+  GEM_VERSION = '1.0.0'
+  
+  # Encoding modes
+  QR_MODE_NUM = 0
+	QR_MODE_AN = 1			
+	QR_MODE_8 = 2			
+	QR_MODE_KANJI	= 3 
+	
+	# Error correction
+	QR_ECLEVEL_L = 0
+	QR_ECLEVEL_M = 1
+	QR_ECLEVEL_Q = 2
+	QR_ECLEVEL_H = 3
+	
+  ##
+  # Version of the symbol. A QR Code version indicates the size of the 2-D
+  # barcode in modules. See #qrencode_string for a more detailed description of 
+  # the version. Note that the version returned might be larger than the version
+  # specified for an encode_string if the requested version is for a barcode too
+  # small to encode the data.
+  def version; end;
+  
+  ##
+  # Width of the symbol in modules. This value usually corresponds to 1 module 
+  # is 1 pixel, but you could conceivably scale it up if you wanted to.
+  def width; end;
+
+  ##
+  # Returns the raw data of the QRcode within a single array of width*width
+  # elements. Each item is a byte of data of which only the least significant
+  # bit is the pixel. The full use of each bit from Least Significant to Most is
+  # as follows
+  #
+  # * 1=black/0=white
+  # * data and ecc code area
+  # * format information
+  # * version information
+  # * timing pattern
+  # * alignment pattern
+  # * finder pattern and separator
+  # * non-data modules (format, timing, etc.)
+  #
+  # This structure allows the QRcode spec to store multiple types of information
+  # within the allocated output buffers, but you usually only care about the pixel
+  # color. For those cases, just use the #pixels or #points methods.
+  def data; end;
+  
+  ##
+  # Returns the QRcode as an array of rows where each item in a row represents
+  # the value of the pixel (1=black, 0=white)
+  def pixels; end;
+
+  ##
+  # Returns the black pixels of the encoded image as an array of coordinate pairs.
+  def points; end;
+    
+  ##
+  # Encodes a QR code from a string. This version of the method assumes the 
+  # input data is 8-bit ASCII and that you want the most basic error correction.
+  # For more detailed control over those parameters, use #encode_string_ex. This
+  # method takes 2 arguments: a string to encode and a QRCode <tt>version</tt>
+  # which essentially determines the size of the QRCode. 
+  #
+  # What is the version? Each QRCode is made up
+  # of <b>modules</b> which are the basic display element of a QRCode and may
+  # be made up of 1 or more pixels (here, it's just 1 module is 1 pixel).
+  # Version 1 is a 21x21 
+  # module square, while the maximum version 40 is 177x177 modules. The full
+  # module reference is here http://www.denso-wave.com/qrcode/vertable1-e.html
+  #
+  # Should you encode more text than can fit in a module, the encoder will scale
+  # up to the smallest version able to contain your data. Unless you want to 
+  # specifically fix your barcode to a certain version, it's fine to just set
+  # the version argument to 1 and let #encode_string figure out the proper size.  
+  def encode_string; end;
+  
+  ##
+  # This function is similar in purpose to #encode_string, but it allows you to
+  # explicitly specify the encoding and error correction level. There are 4 
+  # arguments to this function:
+  #
+  # * <tt>string</tt> the string to encode
+  # * <tt>version</tt> the version of the QR Code (see #encode_string for explanation)
+  # * <tt>error correction level</tt>
+  # * <tt>encoding mode</tt>
+  #
+  # The following four Constants can be specified for error correction levels, each
+  # specified with the maximum approximate error rate they can compensate for, as
+  # well as the maximum capacity of an 8-bit data QR Code with the error encoding:
+  # 
+  # * <tt>QR_ECLEVEL_L</tt> - 7%/2953 [default]
+	# * <tt>QR_ECLEVEL_M</tt> - 15%/2331
+	# * <tt>QR_ECLEVEL_Q</tt> - 25%/1663
+	# * <tt>QR_ECLEVEL_H</tt> - 30%/1273
+  #
+	# Higher error rates are suitable for applications where the QR Code is likely
+	# to be smudged or damaged, but as is apparent here, they can radically reduce 
+	# the maximum data capacity of a QR Code. 
+	#
+	# There are also 4 possible encodings for a QR Code which can modify the 
+	# maximum data capacity. These are specified with four possible Constants, each
+	# listed here with the maximum capacity available for that encoding at the lowest
+	# error correction rate.
+	#
+	# * <tt>QR_MODE_NUM</tt> - Numeric/7089
+	# * <tt>QR_MODE_AN</tt> - Alphanumeric/4296			
+	# * <tt>QR_MODE_8</tt> - 8-bit ASCII/2953 [default]			
+	# * <tt>QR_MODE_KANJI</tt>	- Kanji (JIS-1 & 2)/1817
+	#
+	# Note that the QR Code specification seemingly predates the rise and triumph
+	# of UTF-8, and the specification makes no requirement that writers and readers
+	# use ISO-8859-1 or UTF-8 or whatever to interpret the data in a barcode. If you
+	# encode in UTF-8, it might be read as ISO-8859-1 or not. 
+  def encode_string_ex; end;
+  
+  # now for the inlines
+  inline do |builder|
+    builder.add_link_flags "-lqrencode"
+    builder.include '"qrencode.h"'
+
+    builder.prefix <<-"END"
+      static void qrcode_free(void *p) {
+        QRcode *qrcode = (QRcode *) p;
+        QRcode_free(qrcode);
+      }
+    END
+    
+    builder.c <<-"END"
+      int width() {
+        QRcode *qrcode;
+        Data_Get_Struct(self, QRcode, qrcode);
+        return qrcode->width;
+      }
+    END
+    
+    builder.c <<-"END"
+      int version() {
+        QRcode *qrcode;
+        Data_Get_Struct(self, QRcode, qrcode);
+        return qrcode->version;
+      }
+    END
+    
+    builder.c <<-"END"
+      VALUE data() {
+        QRcode *qrcode;
+        VALUE out;
+        unsigned char *p, b;
+        int i, max;
+        
+        Data_Get_Struct(self, QRcode, qrcode);
+        p = qrcode->data;
+        max = qrcode->width * qrcode->width;
+        out = rb_ary_new2(max);
+        
+        for (i=0; i < max; i++) {
+          b = *p;
+          rb_ary_push(out, INT2FIX(b));
+          p++;
+        }
+        
+        return out;
+      }
+    END
+    
+    builder.c <<-"END"
+      VALUE pixels() {
+        QRcode *qrcode;
+        VALUE out, row;
+        unsigned char *p;
+        int x, y, bit;
+                     
+        Data_Get_Struct(self, QRcode, qrcode);        
+      	p = qrcode->data;
+    		out = rb_ary_new2(qrcode->width);
+        
+    		for (y=0; y < qrcode->width; y++) {
+    			row = rb_ary_new2(qrcode->width);
+
+    			for (x=0; x < qrcode->width; x++) {
+    				bit = *p & 1;
+    				rb_ary_push(row, INT2FIX(bit));
+    				p++;
+    			}
+
+    			rb_ary_push(out, row);
+    		}
+    		
+    		return out;
+  		}
+    END
+        
+    builder.c <<-"END"
+      VALUE points() {
+        QRcode *qrcode;
+        VALUE out, point;
+        unsigned char *p;
+        int x, y, bit;
+
+        Data_Get_Struct(self, QRcode, qrcode);        
+      	p = qrcode->data;
+    		out = rb_ary_new2(qrcode->width);
+        
+        for (y=0; y < qrcode->width; y++) {
+        	for (x=0; x < qrcode->width; x++) {
+        		bit = *p & 1;
+
+        		if (bit) {
+        			point = rb_ary_new2(2);
+        			rb_ary_push(point, INT2FIX(x));
+        			rb_ary_push(point, INT2FIX(y));
+        			rb_ary_push(out, point);
+        		}
+
+        		p++;
+        	}	
+        }
+        
+        return out;     
+      }
+    END
+    
+    builder.c_singleton <<-"END"
+      VALUE encode_string_ex(const char *string, int version, int eclevel, int mode) {
+        QRcode *code;
+        VALUE klass;
+        
+        code = QRcode_encodeString(string, version, eclevel, mode);
+        klass = rb_const_get_at(rb_cObject, rb_intern("QRCode")); 
+        return Data_Wrap_Struct(klass, NULL, qrcode_free, code);
+      }      
+    END
+
+   builder.c_singleton <<-"END" 
+     VALUE encode_string(const char *string, int version) {
+       QRcode *code;
+       VALUE klass;
+       
+       code = QRcode_encodeString(string, version, QR_ECLEVEL_L, QR_MODE_8);
+       klass = rb_const_get_at(rb_cObject, rb_intern("QRCode")); 
+       return Data_Wrap_Struct(klass, NULL, qrcode_free, code);
+     }
+   END
+        
+#    builder.c <<-"END"
+#      VALUE encode_data_ex(const char *data, int len, int version, int eclevel, int mode) {
+#        QRcode *code;
+#        QRinput *input;
+#        
+#        input = QRinput_new();
+#        QRinput_append(input, mode, data, len);
+#        code = QRcode_encode(input, version, eclevel);
+#        Qrinput_free(input);
+#        return Data_Wrap_Struct(CLASS_OF(self), NULL, qrcode_free, code);        
+#      }
+#    END
+  end 
+  
+  ##
+  # Height of the symbol. Since QR Codes are square, this is the same as the 
+  # width but this alias is provided if you want to avoid confusion.
+  alias :height :width
+  
+  ##
+  # Save the QRcode to a PNG file. You can also specify a margin in pixels around
+  # the image, although the specification requests it should be at least 4 px.
+  def save_png(path, margin=4)
+    canvas = PNG::Canvas.new width + (2*margin), width+(2*margin)
+
+    points.each do |p|
+      canvas.point p[0]+margin, p[1]+margin, PNG::Color::Black
+    end
+    
+    png = PNG.new canvas
+    png.save path
+  end
+end

data/test/test_qrencoder.rb

@@ -0,0 +1,99 @@
+require 'rubygems'
+require 'inline'
+require 'enumerator'
+require 'test/unit' unless defined? $ZENTEST and $ZENTEST
+require './lib/qrencoder.rb'
+
+class TestQRCode < Test::Unit::TestCase
+  inline do |builder|
+    builder.add_link_flags "-lqrencode"
+    builder.include '"qrencode.h"'
+  
+    builder.c <<-"END"
+      VALUE test_img_data(const char *string, int version) {
+        QRcode *code;
+        VALUE out;
+        int i, width;
+        unsigned char *p;
+        
+        code = QRcode_encodeString(string, version, QR_ECLEVEL_L, QR_MODE_8);
+        
+        p = code->data;
+        width = code->width;
+    		out = rb_ary_new2(width*width);
+        
+    		for (i=0; i < width*width; i++) {
+            unsigned char bit;
+    				bit = *p;
+    				rb_ary_push(out, INT2FIX(bit));
+    				p++;
+    		}
+
+    		return out;      	
+      }
+    END
+  end
+  
+  def setup
+    @q = QRCode.encode_string("hi", 1)
+  end
+  
+  def test_class_encode_string
+    assert_equal 1, @q.version
+    assert_equal 21, @q.width
+  end
+
+  def test_class_encode_string_ex
+    #raise NotImplementedError, 'Need to write test_class_encode_string_ex'
+  end
+
+  def test_data
+    assert_equal test_img_data("hi", 1), @q.data
+  end
+
+  def test_height
+    assert_equal @q.width, @q.height
+  end
+
+  def test_pixels
+    arr = []
+    test_img_data("hi", 1).each_slice(@q.width) do |a|
+      arr << a.map { |p| p & 0x1 }
+    end
+    
+    assert_equal arr, @q.pixels
+  end
+
+  def test_points
+    arr = []
+    y = 0
+    
+    test_img_data("hi", 1).each_slice(@q.width) do |r|
+      x = 0;
+      
+      r.each do |p|
+        if (p & 0x1) == 1
+          arr << [x, y]
+        end
+        
+        x += 1
+      end
+      
+      y += 1
+    end
+    
+    assert_equal arr, @q.points
+  end
+
+#  def test_save_png
+#    raise NotImplementedError, 'Need to write test_save_png'
+#  end
+
+  def test_version
+    assert_equal 1, @q.version
+  end
+
+  def test_width
+    assert_equal 21, @q.width
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.1
+specification_version: 1
+name: qrencoder
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-01-24 00:00:00 -05:00
+summary: A gem for creating 2-dimensional barcodes following the QR Code specification.
+require_paths: 
+- lib
+email: harrisj@schizopolis.net
+homepage: http://nycrb.rubyforge.org/qrencoder
+rubyforge_project: nycrb
+description: The author was too lazy to write a description
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Jacob Harris
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/qrencoder
+- lib/qrencoder.rb
+- test/test_qrencoder.rb
+test_files: 
+- test/test_qrencoder.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- qrencoder
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RubyInline
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.6.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: png
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: