qr4r 0.3.1 → 0.3.3

data/README.md

@@ -14,21 +14,45 @@ In your code, add
 
 To use it:
 
-    Qr4r::encode(input_string, output_file_path, size = 3)
+    Qr4r::encode(input_string, output_file_path, options)
 
-*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).
+*input_string* and *output_file_path* should be strings.  Options should a list of hash options keyed by symbols.  Possible options are:
+ 
+ * :pixel_size  - specify the size of each 'black' dot in the qrcode.  Default = 3
+ * :border - specify the number of pixels to use for a white border around the outside.  Default = 0
+ * :size  - used by the qr code generation.  A lower number means a smaller overall image.  But it also means that you can encode fewer characters.  This is computeed for you by default based on the input string size.  You should not need to adjust it.
 
-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
+    require 'qr4r'
+    s = 'qr codes are the new hotness'
+    fname = s.gsub(/\s+/,"_") + ".qr.png"
+    Qr4r::encode(s, fname)
+
+Make a bigger QRCode
+
+    s = 'big qr codes are the new hotness'
+    fname = s.gsub(/\s+/,"_") + ".qr.png"
+    Qr4r::encode(s, fname, :pixel_size => 5)
+
+Add a fat border
+
+    s = 'big qr codes are the new hotness with a border'
+    fname = s.gsub(/\s+/,"_") + ".qr.png"
+    Qr4r::encode(s, fname, :border => 20)
+
+
+## Authors
+
+Original author: [Jon Rogers](http://github.com/bunnymatic) [at 2rye](http://2rye.com)
 
-    # 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)  
+Thanks to [Duncan Robertson](http://whomwah.github.com/rqrcode/) for writing rQRCode
 
+## Contributing
+* Fork the project
+* Send a pull request
+* Don't bump the version or modify the gemspec. I'll do that when I merge in your mods and release a new version.
 
+## Copyright
 
+MIT Licence (http://www.opensource.org/licenses/mit-license.html)

data/Rakefile

@@ -13,5 +13,6 @@ task :test do
 end
 
 task :build do
+  `rm qr4r-*.gem`
   puts `gem build qr4r.gemspec`  
 end

data/lib/qr4r.rb

@@ -48,15 +48,16 @@ module Qr4r
     MojoMagick::convert do |c|
       d = data.pack 'C'*data.size
       c.blob(d, :format => :rgb, :depth => 8, :size => ("%dx%d" % [qr.modules.size, qr.modules.size]))
-      c.file outfile
-    end
-    if opts[:pixel_size]
-      MojoMagick::convert do |c|
+      if opts[:pixel_size]
         wd = qr.modules.size * opts[:pixel_size].to_i
-        c.file outfile
         c.scale "%dx%d" % [ wd, wd ]
-        c.file outfile
       end
+      if opts[:border]
+        border = opts[:border].to_i
+        c.bordercolor '"#ffffff"'
+        c.border '%dx%d' % [ border, border ]
+      end
+      c.file outfile
     end
   end
 

data/lib/qr4r/version.rb

@@ -1,3 +1,3 @@
 module Qr4r
-  VERSION = '0.3.1'
+  VERSION = '0.3.3'
 end

data/test/qr4r_test.rb

@@ -25,6 +25,17 @@ class Qr4rTest < Test::Unit::TestCase
     assert r[:width] == 33 * 3
   end
 
+  def test_encode_with_size_and_border
+    # do something
+    f = Tempfile.new(['qr4r','.png'])
+    Qr4r::encode('whatever yo', f.path, :size => 4, :border => 10)
+    # assert that it worked
+    assert File.exists?(f)
+    r = MojoMagick::get_image_size(f.path)
+    assert r[:height] == 33 * 3 + 20
+    assert r[:width] == 33 * 3 + 20
+  end
+
   def test_encode_with_pixel_size
     # do something
     f = Tempfile.new(['qr4r','.png'])

metadata

@@ -2,7 +2,7 @@
 name: qr4r
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors: 
 - Jon Rogers
@@ -92,6 +92,6 @@ rubyforge_project: qr4r
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: qr4r-0.3.1
+summary: qr4r-0.3.3
 test_files: 
 - test/qr4r_test.rb