qrencoder 1.3.4 → 1.4.0

data/History.txt

@@ -1,3 +1,16 @@
+== 1.4.0 / 2011-10-02
+
+* API changes
+  * PNG is now a full-fledged object to allow further
+    customization. See chunky_png for more details.
+  * Update chunky_png dependency to allow newest versions
+
+* Bugfixes
+  * alphanumeric mode was not working correctly
+  * numeric mode segfaulted when passed an integer
+  * Passing an invalid string now raises an ArgumentError
+    rather than segfaulting
+
 == 1.3.4 / 2011-03-08
 
 * 1 Minor enhancement

data/README.rdoc

@@ -12,12 +12,12 @@ like the following:
 
 http://www.denso-wave.com/qrcode/images/qrcode.gif
 
-The specification for QR codes is readable at
+The specification for QR Code 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
+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
@@ -40,7 +40,7 @@ Basic usage is as follows:
   puts "#{qrcode.width}"    #=> 34
   qrcode.save_png("/tmp/foo.png")
 
-You can retrieve the pixels of the QRCode object directly or use the included
+You can retrieve the pixels of the QR Code object directly or use the included
 methods to save a PNG file directly.
 
 See the rdocs[http://rdoc.info/github/harrisj/qrencoder] for options you can
@@ -53,13 +53,13 @@ from http://megaui.net/fukuchi/works/qrencode/index.en.html.
 
 Installation is usually as simple as:
 
-curl http://fukuchi.org/works/qrencode/qrencode-3.1.1.tar.gz | tar xz
-cd qrencode-3.1.1
-./configure
-make
-sudo make install
+  curl http://fukuchi.org/works/qrencode/qrencode-3.1.1.tar.gz | tar xz
+  cd qrencode-3.1.1
+  ./configure
+  make
+  sudo make install
 
-If if worked, you should be able to type <tt>qrencode</tt> and get a help
+If it worked, you should be able to type <tt>qrencode</tt> and get a help
 message.
 
 Normally, the build process also expects you to have <tt>libpng</tt>, but

data/ext/qrencoder_ext/qrencoder_ext.c

@@ -1,8 +1,11 @@
 #include "qrencode.h"
 #include "ruby.h"
+#include "errno.h"
+#include "string.h"
 
 VALUE mQREncoder;
 VALUE cQRCode;
+int errno;
 
 static void qrcode_free(void *p) {
   QRcode *qrcode = (QRcode *) p;
@@ -235,8 +238,17 @@ static VALUE qr_initialize(VALUE self, VALUE _string, VALUE _version, VALUE _ecl
   int eclevel = FIX2INT(_eclevel);
   int hint = FIX2INT(_hint);
   int casesensitive = FIX2INT(_casesensitive);
+  int error = errno;
+  QRcode *code;
+
+  QRinput *input = QRinput_new2(version, eclevel);
+  QRinput_append(input, hint, strlen(string), string);
+  code = QRcode_encodeInput(input);
+  QRinput_free(input);
 
-  QRcode *code = QRcode_encodeString(string, version, eclevel, hint, casesensitive);
+  if (errno != error && errno == 22) {
+    rb_raise(rb_eArgError, "input was too long");
+  }
 
   if (DATA_PTR(self)) {
     QRcode_free(DATA_PTR(self));

data/lib/qrencoder.rb

@@ -45,7 +45,8 @@ module QREncoder
     correction = corrections[options[:correction] || :low]
     mode = modes[options[:mode] || :ascii]
     case_sensitive = options[:case_sensitive] == false ? 0 : 1
-    QRCode.new(string, version, correction, mode, case_sensitive)
+    string.upcase! if mode == QR_MODE_AN
+    QRCode.new(string.to_s, version, correction, mode, case_sensitive)
   end
 
   def self.corrections

data/lib/qrencoder/png.rb

@@ -0,0 +1,51 @@
+require 'chunky_png'
+
+module QREncoder
+  class PNG
+    attr_reader :canvas,
+      :background,
+      :margin,
+      :pixels_per_module,
+      :points,
+      :width
+
+    ##
+    # Takes an optional hash of options. See QRCode#png for details.
+    def initialize(qrcode, options={})
+      @points = qrcode.points
+      @margin = options[:margin] || 4
+      @pixels_per_module= options[:pixels_per_module] || 1
+      @background = options[:transparent] ? ChunkyPNG::Color::TRANSPARENT : ChunkyPNG::Color::WHITE
+      @width = (qrcode.width + (2 * margin)) * pixels_per_module
+
+      @canvas = ChunkyPNG::Image.new(width, width, background)
+      plot_points
+    end
+
+    def method_missing(method, *args, &block)
+      if canvas.respond_to?(method)
+        canvas.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method)
+      super || canvas.respond_to?(method)
+    end
+
+    private
+    def plot_points
+      points.each do |point|
+        pixels_per_module.times do |x_offset|
+          x = (point[0] + margin) * pixels_per_module + x_offset
+          pixels_per_module.times do |y_offset|
+            y = (point[1] + margin) * pixels_per_module + y_offset
+            canvas[x,y] = ChunkyPNG::Color::BLACK
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/qrencoder/qrcode.rb

@@ -1,4 +1,4 @@
-require 'chunky_png'
+require 'qrencoder/png'
 
 module QREncoder
   # Stores and represents data, points, and/or pixels for a QRCode
@@ -22,32 +22,11 @@ module QREncoder
     # [:pixels_per_module] Adjusts the entire PNG image by the given factor, integer. (default: +1+)
     #
     def png(options={})
-      canvas(options)
+      PNG.new(self, options)
     end
 
-    ##
-    # Returns an instance of PNG::Canvas
-    #
-    # Takes an optional hash of options. See QRCode#png for details.
     def canvas(options={})
-      @margin = options[:margin] || 4
-      ppm = options[:pixels_per_module] || 1
-      background = options[:transparent] ? ChunkyPNG::Color::TRANSPARENT : ChunkyPNG::Color::WHITE
-      png_width = (width + (2 * @margin)) * ppm
-
-      canvas = ChunkyPNG::Image.new(png_width, png_width, background)
-
-      points.each do |point|
-        ppm.times do |x_offset|
-          x = (point[0] + @margin) * ppm + x_offset
-          ppm.times do |y_offset|
-            y = (point[1] + @margin) * ppm + y_offset
-            canvas[x,y] = ChunkyPNG::Color::BLACK
-          end
-        end
-      end
-
-      canvas
+      png(options).canvas
     end
   end
 end

data/lib/qrencoder/version.rb

@@ -1,3 +1,3 @@
 module QREncoder
-  VERSION = '1.3.4'
+  VERSION = '1.4.0'
 end

data/spec/integration_spec.rb

@@ -4,8 +4,9 @@ require 'zxing'
 describe QREncoder do
   context "integration" do
     let(:path) { File.expand_path("../../tmp/integration.png", __FILE__) }
-    let(:options) { Hash.new }
-    let(:png) { QREncoder.encode(message).png(options) }
+    let(:png_options) { Hash.new }
+    let(:encoding_options) { Hash.new }
+    let(:png) { QREncoder.encode(message, encoding_options).png(png_options) }
     before do
       File.unlink(path) if File.file?(path)
       png.save(path)
@@ -23,10 +24,26 @@ describe QREncoder do
       it { should == message }
     end
 
+    context "with alphanumeric characters" do
+      let(:message) { "A63b902f" }
+      let(:encoding_options) do
+        { :mode => :alphanumeric }
+      end
+      it { should == "A63B902F" }
+    end
+
+    context "with numeric characters" do
+      let(:message) { 83913 }
+      let(:encoding_options) do
+        { :mode => :numeric }
+      end
+      it { should == "83913" }
+    end
+
     context "with a custom pixel per module size" do
       let(:message) { "bigger" }
-      let(:options) do
-        { :pixels_per_module => 4, :version => 1 }
+      let(:png_options) do
+        { :pixels_per_module => 4 }
       end
       it { should == message }
       it "produces a larger png width and height" do
@@ -34,4 +51,15 @@ describe QREncoder do
       end
     end
   end
+
+  describe "encoding errors" do
+    context "with too-long input" do
+      let(:message) { "a" * 2960 }
+      it "raises an error" do
+        expect {
+          QREncoder.encode(message)
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
 end

data/spec/qrencoder/png_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe QREncoder::PNG do
+  let(:png) { QREncoder::PNG.new(qrcode, options) }
+  let(:qrcode) { QREncoder.encode("hi") }
+  let(:options) { Hash.new }
+
+  describe "#points" do
+    it "is initialized from QRCode points" do
+      points = []
+      qrcode.stub(:points => points)
+      png.points.should == points
+    end
+  end
+
+  describe "#width" do
+    before { qrcode.stub(:width => qrcode_width) }
+    let(:qrcode_width) { 21 }
+    subject { png.width }
+
+    context "with a QRCode width of 21, default margin" do
+      it { should == 29 }
+    end
+
+    context "with a QRCode width of 21, margin of 8" do
+      let(:options) { {:margin => 8} }
+      it { should == 37 }
+    end
+
+    context "with QRCode width of 21, pixels-per-module of 2" do
+      let(:qrcode_width) { 21 }
+      let(:options) { {:pixels_per_module => 2} }
+      it { should == 58 }
+    end
+
+    context "with QRCode width of 25, pixels-per-module of 5, margin of 5" do
+      let(:qrcode_width) { 25 }
+      let(:options) { {:pixels_per_module => 5, :margin => 5} }
+      it { should == (10 + 25) * 5 }
+    end
+  end
+
+  describe "#background" do
+    subject { png }
+
+    context "with default options" do
+      it "should be white" do
+        subject.get_pixel(1,1).should == ChunkyPNG::Color::WHITE
+      end
+    end
+
+    context "with transparent set to true" do
+      subject { png.canvas() }
+      let(:options) { {:transparent => true} }
+      it "should be transparent" do
+        subject.get_pixel(1,1).should == ChunkyPNG::Color::TRANSPARENT
+      end
+    end
+  end
+
+  describe "#canvas" do
+    subject { png.canvas }
+    it { should be_kind_of(ChunkyPNG::Image) }
+  end
+
+  describe "#save" do
+    it "is delegated to canvas" do
+      path = 'a/path.png'
+      png.canvas.should_receive(:save).with(path)
+      png.save(path)
+    end
+  end
+
+  describe "#to_datastream" do
+    it "is delegated to canvas" do
+      png.canvas.should_receive(:to_datastream)
+      png.to_datastream
+    end
+  end
+
+  describe "#to_blob" do
+    it "is delegated to canvas" do
+      png.canvas.should_receive(:to_blob)
+      png.to_blob
+    end
+  end
+
+  describe "#respond_to?" do
+    context "when method exists" do
+      it "returns true" do
+        png.should respond_to(:width)
+      end
+    end
+
+    context "when method does not exist but is defined on ChunkyPNG::Canvas" do
+      it "returns true" do
+        png.should respond_to(:to_datastream)
+      end
+    end
+
+    context "when method exists on neither self or canvas" do
+      it "returns false" do
+        png.should_not respond_to(:a_method_that_does_not_exist)
+      end
+    end
+  end
+end

data/spec/{qrcode_spec.rb → qrencoder/qrcode_spec.rb}

@@ -179,14 +179,14 @@ describe QREncoder::QRCode do
   describe "#png" do
     let(:qrcode) { QREncoder.encode("hi") }
 
-    it "returns an instance of ChunkyPNG" do
-      qrcode.png.should be_kind_of(ChunkyPNG::Image)
+    it "returns an instance of QREncoder::PNG" do
+      qrcode.png.should be_kind_of(QREncoder::PNG)
     end
 
     it "sends options to #canvas" do
-      canvas = ChunkyPNG::Canvas.new(1,1)
+      canvas = QREncoder::PNG.new(qrcode)
       options = { :margin => 5, :transparent => true }
-      qrcode.should_receive(:canvas).with(options).and_return(canvas)
+      qrcode.should_receive(:png).with(options).and_return(canvas)
       qrcode.png(options)
     end
   end
@@ -194,7 +194,7 @@ describe QREncoder::QRCode do
   describe "#save_png" do
     let(:qrcode) { QREncoder.encode("hi") }
     let(:path) do
-      File.expand_path("../../tmp/test.png", __FILE__)
+      File.expand_path("../../../tmp/test.png", __FILE__)
     end
 
     before { File.unlink(path) if File.file?(path) }

data/spec/qrencoder_spec.rb

@@ -42,7 +42,7 @@ describe QREncoder do
 
       it { should be_a_kind_of(QREncoder::QRCode) }
       it "encodes using the specified mode" do
-        QREncoder::QRCode.should_receive(:new).with("string",
+        QREncoder::QRCode.should_receive(:new).with("STRING",
                                                     1,
                                                     QREncoder::QR_ECLEVEL_L,
                                                     QREncoder::QR_MODE_AN,

metadata

@@ -2,7 +2,7 @@
 name: qrencoder
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors: 
 - Jacob Harris
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-08 00:00:00 -06:00
+date: 2011-10-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +23,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.4.0
+        version: "2.4"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -67,7 +67,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.1.0
+        version: "1.1"
   type: :runtime
   version_requirements: *id005
 description: |-
@@ -84,6 +84,7 @@ extra_rdoc_files:
 - README.rdoc
 - ext/qrencoder_ext/qrencoder_ext.c
 files: 
+- lib/qrencoder/png.rb
 - lib/qrencoder/qrcode.rb
 - lib/qrencoder/version.rb
 - lib/qrencoder.rb
@@ -92,7 +93,8 @@ files:
 - History.txt
 - README.rdoc
 - spec/integration_spec.rb
-- spec/qrcode_spec.rb
+- spec/qrencoder/png_spec.rb
+- spec/qrencoder/qrcode_spec.rb
 - spec/qrencoder_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -125,6 +127,7 @@ specification_version: 3
 summary: Wrapper around the C qrencode library for creating QR Codes
 test_files: 
 - spec/integration_spec.rb
-- spec/qrcode_spec.rb
+- spec/qrencoder/png_spec.rb
+- spec/qrencoder/qrcode_spec.rb
 - spec/qrencoder_spec.rb
 - spec/spec_helper.rb