qr4r 0.2.0 → 0.3.0

data/.rvmrc

@@ -1,3 +1,3 @@
-#rvm use --create 1.9.2-p290@qr4r
-rvm use --create 1.8.7-p334
+rvm use --create 1.9.2-p290@qr4r
+#rvm use --create 1.8.7-p334
 

data/README.md

@@ -1,6 +1,6 @@
 # QR Encoding via Ruby - with PNG output
 
-Leveraging RQRCode and mojo_magick, we've built a very thin gem that generates QR codes in a png file
+Leveraging [rqrcode](http://whomwah.github.com/rqrcode/) and [mojo_magick](http://github.com/2rye/mojo_magick), we've built a very thin gem that generates QR codes in a png file
 
 # Include in your project
 
@@ -12,9 +12,23 @@ In your code, add
     
     require 'qr4r'
 
-To use it
-   
+To use it:
+
+    Qr4r::encode(input_string, output_file_path, size = 3)
+
+*input_string* and *output_file_path* should be strings.  Size should be an integer from 1 - 10.  The final output size is square and will be 33 * size pixels.  e.g.  if size = 4, the image will be 132x132.  Default size is 3 (images are 99x99 pixels).
+
+NOTE: strings to be encoded are currently limited to 34 characters
+To encode the string 'qr codes are the new hotness' like this:
+  
     string_to_encode = 'qr codes are the new hotness'
     Qr4r::encode(string_to_encode, 'qrcode.out.png')  
 
+Not happy with the default size (99px x 99px)? Adjust the size with the 3rd argument to encode
+
+    # the following produces an image who's size is 165px x 165px
+    string_to_encode = 'big qr codes are the new hotness'
+    Qr4r::encode(string_to_encode, 'qrcode.out.png', 5)  
+
+
 

data/lib/qr4r/version.rb

@@ -1,3 +1,3 @@
 module Qr4r
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/qr4r.rb

@@ -1,9 +1,40 @@
 require 'rqrcode'
 require 'mojo_magick'
 module Qr4r
-  # size should indicate dot pixel size, size of 3 makes black pixels of 3x3
-  def self.encode(str, outfile, size = 3)
-    qr = RQRCode::QRCode.new(str)
+
+  # params we use
+  #   pixel_size  - size of each dot, default = 3
+  # params we pass to QRCode include :size and :level
+  #   size   - the size of the qrcode (default 4)
+  #   level  - the error correction level, can be:
+  #      * Level :l 7%  of code can be restored
+  #      * Level :m 15% of code can be restored
+  #      * Level :q 25% of code can be restored
+  #      * Level :h 30% of code can be restored
+  # note: if size is not included and 4 appears to be too small for the included string, we'll make it bigger
+  #       if you include size, we'll use it, which may lead to an error if the string is too long
+  # Limitations are as follows:
+  #   size = 1, max string length = 7
+  #   size = 2, max string length = 14
+  #   size = 3, max string length = 24
+  #   size = 4, max string length = 34
+  #   size = 5, max string length = 44
+  #   size = 6, max string length = 58
+  #   size = 7, max string length = 64
+  #   size = 8, max string length = 84
+  #   size = 9, max string length = 98
+  #   size = 10, max string length = 119
+
+  def self.encode(str, outfile, *rest)
+    opts = rest[0] if rest && rest.length > 0
+    opts = opts || {} 
+    if !opts[:size]
+      opts.merge!({:size => compute_size(str)})
+    end
+    if !opts[:pixel_size]
+      opts.merge!({:pixel_size => 3})
+    end
+    qr = RQRCode::QRCode.new(str, opts)
     data = []
     qr.modules.each_index do |x|
       qr.modules.each_index do |y|
@@ -19,11 +50,32 @@ module Qr4r
       c.blob(d, :format => :rgb, :depth => 8, :size => ("%dx%d" % [qr.modules.size, qr.modules.size]))
       c.file outfile
     end
-    MojoMagick::convert do |c| 
-      c.file outfile
-      c.scale "%dx%d" % [qr.modules.size, qr.modules.size].map{|s| s*size}
-      c.file outfile
+    if opts[:pixel_size]
+      MojoMagick::convert do |c|
+        wd = qr.modules.size * opts[:pixel_size]
+        c.file outfile
+        c.scale "%dx%d" % [ wd, wd ]
+        c.file outfile
+      end
+    end
+  end
+
+  private
+  SIZE_RESTRICTIONS = [0, 7, 14, 24, 34, 44, 58, 64, 84, 98, 119] 
+
+  def self.compute_size(str)
+    slen = str.size
+    size = 4
+    ii = 0
+    while ii < SIZE_RESTRICTIONS.length do
+      if slen < SIZE_RESTRICTIONS[ii]
+        break
+      end
+      ii+=1
+    end
+    if ii > 10
+      raise "Your string is too big for this encoder.  It should be less than #{SIZE_RESTRICTIONS.last} characters"
     end
+    return ii
   end
-   
 end

data/test/qr4r_test.rb

@@ -10,19 +10,93 @@ class Qr4rTest < Test::Unit::TestCase
     # assert that it worked
     assert File.exists?(f.path)
     r = MojoMagick::get_image_size(f.path)
-    assert r[:height] == 99
-    assert r[:width] == 99
+    assert r[:height] == 25 * 3
+    assert r[:width] == 25 * 3
   end
 
   def test_encode_with_size
     # do something
     f = Tempfile.new(['qr4r','.png'])
-    Qr4r::encode('whatever yo', f.path, 4)
+    Qr4r::encode('whatever yo', f.path, :size => 4)
     # assert that it worked
     assert File.exists?(f)
     r = MojoMagick::get_image_size(f.path)
-    assert r[:height] == 4 * 33
-    assert r[:width] == 4 * 33
+    assert r[:height] == 33 * 3
+    assert r[:width] == 33 * 3
   end
 
+  def test_encode_with_pixel_size
+    # do something
+    f = Tempfile.new(['qr4r','.png'])
+    Qr4r::encode('whatever yo', f.path, :pixel_size => 5)
+    # assert that it worked
+    assert File.exists?(f)
+    r = MojoMagick::get_image_size(f.path)
+    assert r[:height] == 25 * 5
+    assert r[:width] == 25 * 5
+  end
+
+  def test_encode_with_size_and_level
+    # do something
+    f = Tempfile.new(['qr4r','.png'])
+    Qr4r::encode('whatever yo', f.path, :size => 4, :level => :m)
+    # assert that it worked
+    assert File.exists?(f)
+    r = MojoMagick::get_image_size(f.path)
+    assert r[:height] == 33 * 3
+    assert r[:width] == 33 * 3
+  end
+
+  def test_a_long_string_with_size_thats_too_small
+    caught = false
+    begin
+      f = Tempfile.new(['qr4r','.png'])
+      Qr4r::encode('this string should also be encodable. don\'t ya think', f.path, :size => 4)
+    rescue
+      caught = true
+    end
+    assert caught, 'Expected an error'
+  end
+
+  def test_a_long_string_with_size_thats_right
+    f = Tempfile.new(['qr4r','.png'])
+    Qr4r::encode('this string should also be encodable. don\'t ya think', f.path, :size => 10)
+    assert File.exists?(f)
+    r = MojoMagick::get_image_size(f.path)
+    assert r[:height] == 57 * 3
+    assert r[:width] == 57 * 3
+  end
+
+  def test_a_long_string_without_size
+    f = Tempfile.new(['qr4r','.png'])
+    Qr4r::encode('this string should also be encodable. don\'t ya think', f.path)
+    assert File.exists?(f)
+    r = MojoMagick::get_image_size(f.path)
+    assert r[:height] = 41 * 3
+    assert r[:width] = 41 * 3
+
+  end
+
+  def test_compute_size
+    test_sizes =   [ 7, 14, 24, 34, 44, 58, 64, 84, 98]
+    test_sizes.each_with_index do |sz, idx|
+      str = 'a'*(sz-1)
+      assert Qr4r.send(:compute_size, str) == idx+1
+      str = 'a'*(sz)
+      assert Qr4r.send(:compute_size, str) == idx+2
+    end
+  end
+
+  def test_compute_size_too_big
+    str = 'a'*120
+    caught = false
+    begin
+      Qr4r.send(:compute_size, str)
+    rescue Exception => ex
+      caught = true
+    end
+    assert caught, "Expected exception"
+    
+  end
+    
 end

metadata

@@ -1,77 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: qr4r
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Jon Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rqrcode
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2153649300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mojo_magick
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2153649300
+- !ruby/object:Gem::Dependency
+  name: mojo_magick
+  requirement: &2153648880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2153648880
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153648460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *2153648460
 description: QR PNG Generator for Ruby. Leveraging RQRCode and MojoMagick modules
-email: 
+email:
 - r@2rye.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .rvmrc
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - init.rb
@@ -83,36 +64,27 @@ files:
 - test/qr4r_test.rb
 homepage: http://github.com/2rye/qr4r
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: qr4r
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: qr4r-0.2.0
-test_files: 
+summary: qr4r-0.3.0
+test_files:
 - test/qr4r_test.rb

data/Gemfile.lock

@@ -1,20 +0,0 @@
-PATH
-  remote: .
-  specs:
-    qr4r (0.1.5)
-      mojo_magick
-      rqrcode
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    mojo_magick (0.4.2)
-    rake (0.9.2.2)
-    rqrcode (0.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  qr4r!
-  rake