rqrcode 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7559f2004d53b9642306d26b1b95926564216889
-  data.tar.gz: df2bbd25ba80e1975f52dfc0bc354cfff547d17f
+  metadata.gz: 1275547d28967654aa0f1ba1a450c5daa31c582a
+  data.tar.gz: c6ae31e4cdea2370f20a147cbc6f41f6d7d2fdc6
 SHA512:
-  metadata.gz: 814b04bb242a2ee751eafdeb102ef95d8cf53be4c9d71fc7577b1a225fd5fccd702ca19b4f641f0bb3ca150213a7c9e8635e3e9ddb2e3808c8355689465a1a4a
-  data.tar.gz: fdf2cbd54b99a59c1085707799718c84c3f8d28ad0a11754914fa9cece4ecfd4659e23af8faaa8830580296a5e2dece5b32e128461679f5735db865f4aec8e46
+  metadata.gz: 916f34ba9af9afffbfd8ba55116fc130b32a3ffb89db779da2af89df0c167fe49138fd625a33f1f48d648729ae488742921b2dfa10f6349743ff9ac7d865f7e3
+  data.tar.gz: 6ebffce16883fcf0951c6bd601915e1335a709b216cfa2255e1c56b45e496e42b301724f117d81134f403a93960d743b7eb3676239584562622eec216a33226e

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 rvm:
-  - 2.2.0
-  - 2.1.0
+  - 2.2.2
+  - 2.1.6
   - 2.0.0
   - 1.9.3
   - 1.8.7
   - jruby-18mode
-  - jruby-19mode
+  - jruby-19mode

data/CHANGELOG

@@ -1,3 +1,7 @@
+*0.7.0* (Aug 15, 2015)
+
+- Added shape_rendering option for as_svg
+
 *0.6.0* (Jun 2, 2015)
 
 - Improved png rendering. Previous png rendering could result in hard to scan qrcodes.

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem "chunky_png", ~> "1.0"
+gem "chunky_png", "~> 1.0"
 
 group :test, :development do
   gem 'rake'

data/README.md

@@ -4,6 +4,10 @@
 
 ## Short changelog
 
+*0.7.0* (Aug 15, 2015)
+
+- Added shape_rendering option for as_svg
+
 *0.6.0* (Jun 2, 2015)
 
 - Improved png rendering. Previous png rendering could result in hard to scan qrcodes.
@@ -25,128 +29,127 @@ Let's clear up some rQRCode stuff.
 * 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 https://github.com/whomwah/rqrcode
+```ruby
+gem install rqrcode
+```
 
-    git clone git://github.com/whomwah/rqrcode.git
+## Using rQRCode
 
-## Tests
+```ruby
+require 'rqrcode'
 
-To run the tests:
+qrcode = RQRCode::QRCode.new("http://github.com/")
+image = qrcode.as_png
+svg = qrcode.as_svg
+html = qrcode.as_html
+string = qrcode.to_s
+```
 
-    $ rake
+## Image Rendering
+### SVG
 
-## Loading rQRCode Itself
+The SVG renderer will produce a stand-alone SVG as a `String`
 
-You have installed the gem already, yeah?
+```ruby
+qrcode = RQRCode::QRCode.new("http://github.com/")
+# With default options specified explicitly
+svg = qrcode.as_svg(offset: 0, color: '000', 
+                    shape_rendering: 'crispEdges', 
+                    module_size: 11)
+```
 
-    require 'rubygems'
-    require 'rqrcode'
+### PNG
 
-## Simple QRCode generation to screen
+The library can produce a PNG. Result will be a `ChunkyPNG::Image` instance.
 
 ```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
+qrcode = RQRCode::QRCode.new("http://github.com/")
+# With default options specified explicitly
+png = qrcode.as_png(
+          resize_gte_to: false,
+          resize_exactly_to: false,
+          fill: 'white',
+          color: 'black',
+          size: 120,
+          border_modules: 4,
+          file: false,
+          module_px_size: 6,
+          output_file: nil # path to write
+          )
 ```
 
-## Simple QRCode generation to template (RubyOnRails)
-### Controller
+## HTML Rendering
+### In your controller
 ```ruby
-@qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
+@qr = RQRCode::QRCode.new( 'https://github.com/whomwah/rqrcode', :size => 4, :level => :h )
 ```
-### View: (minimal styling added)
-```erb
-<style type="text/css">
+
+### In your view
+```html
+<%= raw @qr.as_html %>
+```
+
+### CSS
+```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;
+  border-left: solid 10px #000;
+  padding: 0; 
+  margin: 0; 
+  width: 0px; 
+  height: 10px; 
 }
-td.black { background-color: #000; }
-td.white { background-color: #fff; }
-</style>
 
-<%= raw @qr.as_html %>
+td.black { border-color: #000; }
+td.white { border-color: #fff; }
 ```
+    
+## On the console
 
-If you want to generate the HTML manually for customization, you can start with the following:
-
-```erb
-<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>
+```ruby
+qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
+puts qr.to_s
 ```
 
-## Exporting
-
-You can also require optional export features:
+Output:
 
-* SVG -> no dependencies
-* PNG -> depends on 'chunky_png' gem
-* JPG -> depends on 'mini_magick' gem
-
-Example to render png:
+```
+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 
+```
 
+## Doing your own rendering
 ```ruby
-require 'rqrcode/export/png'
-image = RQRCode::QRCode.new("nice qr").as_png
+qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
+qr.modules.each do |row|
+    row.each do |col| 
+        print col ? "X" : " "
+    end
+    print "\n"
+end
 ```
 
-Notice the 'as\_png'. Same goes for 'as\_svg', 'as\_xxx'.
-
-### Export Options
+## API Documentation
 
-Exporters support these options:
+[http://www.rubydoc.info/gems/rqrcode](http://www.rubydoc.info/gems/rqrcode)
 
-* size  - Image size, in pixels.
-* fill  - Background color, defaults to 'white'
-* color - Foreground color, defaults to 'black'
-
-SVG Export supports the parameter `module_size` to generate smaller or larger QR Codes
+## Resources
 
-```ruby
-require 'rqrcode/export/svg'
-svg = RQRCode::QRCode.new("nice qr").as_svg(:module_size => 6)
-```
+* 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
 
 ## Authors
 

data/TODO.md

@@ -1,3 +1,4 @@
+- Add to_ansi rendering_
 - Add Numeric mode
 - Add Kanji mode
 - Add ECI Mode

data/lib/rqrcode/export/png.rb

@@ -11,7 +11,7 @@ module RQRCode
       # There are two sizing algoritams.
       #
       # - Original that can result in blurry and hard to scan images
-      # - Google's Chart API inspired sizing that risizes the module size to fit within the given image size.
+      # - Google's Chart API inspired sizing that resizes the module size to fit within the given image size.
       # 
       # The Googleis one will be used when no options are given or when the new size option is used.
       #

data/lib/rqrcode/export/svg.rb

@@ -3,24 +3,28 @@
 module RQRCode
   module Export
 
-    # Render the SVG from the Qrcode.
-    #
-    # Options:
-    # offset - Padding around the QR Code (e.g. 10)
-    # fill - Background color (e.g "ffffff" or :white)
-    # color - Foreground color for the code (e.g. "000000" or :black)
-    # module_size - The Pixel size of each module (e.g. 11)
     module SVG
+
+      # Render the SVG from the Qrcode.
+      #
+      # Options:
+      # offset - Padding around the QR Code (e.g. 10)
+      # fill - Background color (e.g "ffffff" or :white)
+      # color - Foreground color for the code (e.g. "000000" or :black)
+      # module_size - The Pixel size of each module (e.g. 11)
+      # shape_rendering - Defaults to crispEdges
+      #
       def as_svg(options={})
         offset = options[:offset].to_i || 0
         color = options[:color] || "000"
+        shape_rendering = options[:shape_rendering] || "crispEdges"
         module_size = options[:module_size] || 11
 
         # height and width dependent on offset and QR complexity
         dimension = (self.module_count*module_size) + (2*offset)
 
         xml_tag = %{<?xml version="1.0" standalone="yes"?>}
-        open_tag = %{<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ev="http://www.w3.org/2001/xml-events" width="#{dimension}" height="#{dimension}">}
+        open_tag = %{<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ev="http://www.w3.org/2001/xml-events" width="#{dimension}" height="#{dimension}" shape-rendering="#{shape_rendering}">}
         close_tag = "</svg>"
 
         result = []

data/lib/rqrcode/qrcode/qr_code.rb

@@ -121,6 +121,10 @@ module RQRCode #:nodoc:
 
       max_size_array        = QRMAXDIGITS[level][mode]
       size                  = options[:size] || smallest_size_for(string, max_size_array)
+      
+      if size > QRUtil.max_size
+        raise QRCodeArgumentError, "Given size greater than maximum possible size of #{QRUtil.max_size}"
+      end
 
       @error_correct_level  = QRERRORCORRECTLEVEL[level]
       @version              = size
@@ -160,31 +164,32 @@ module RQRCode #:nodoc:
     #  x     x  xxx  xxxxxx xxx  x     x
     #  x xxx x  xxxxx x       xx x xxx x
     #
-    #  instance._to_s( :true => 'E', :false => 'Q') =>
+    #  instance._to_s( :dark => 'E', :light => 'Q') =>
     #  EEEEEEEQEQQEQEQQQEQEQQEEQQEEEEEEE
     #  EQQQQQEQQEEEQQEEEEEEQEEEQQEQQQQQE
     #  EQEEEQEQQEEEEEQEQQQQQQQEEQEQEEEQE
     #
-
     def to_s( *args )
       options                = args.extract_options!
-      row                    = options[:true] || 'x'
-      col                    = options[:false] || ' '
-
-      res = []
-
-      @modules.each_index do |c|
-        tmp = []
-        @modules.each_index do |r|
-          if is_dark(c,r)
-            tmp << row
-          else
-            tmp << col
-          end
+      dark                   = options[:dark] || options[:true] || 'x'
+      light                  = options[:light] || options[:false] || ' '
+      quiet_zone_size        = options[:quiet_zone_size] || 0
+
+      rows = []
+
+      @modules.each do |row|
+        cols = light * quiet_zone_size
+        row.each do |col|
+          cols += (col ? dark : light)
         end
-        res << tmp.join
-     end
-      res.join("\n")
+        rows << cols
+      end
+      
+      quiet_zone_size.times do
+        rows.unshift(light * (rows.first.length / light.size))
+        rows << light * (rows.first.length / light.size)
+      end 
+      rows.join("\n")
     end
 
     protected
@@ -392,7 +397,7 @@ module RQRCode #:nodoc:
       buffer.end_of_message(max_data_bits)
 
       if buffer.get_length_in_bits > max_data_bits
-        raise QRCodeRunTimeError, "code length overflow. (#{buffer.get_length_in_bits}>#{max_data_bits})"
+        raise QRCodeRunTimeError, "code length overflow. (#{buffer.get_length_in_bits}>#{max_data_bits}). (Try a larger size!)"
       end
 
       buffer.pad_until(max_data_bits)

data/lib/rqrcode/qrcode/qr_util.rb

@@ -73,6 +73,10 @@ module RQRCode #:nodoc:
       QRMODE[:mode_kanji] => [8, 10, 12],
     }
 
+    def QRUtil.max_size
+      PATTERN_POSITION_TABLE.count
+    end
+
     def QRUtil.get_bch_format_info( data )
       d = data << 10
       while QRUtil.get_bch_digit(d) - QRUtil.get_bch_digit(G15) >= 0

data/lib/rqrcode/version.rb

@@ -1,3 +1,3 @@
 module RQRCode
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/test/test_rqrcode.rb

@@ -101,6 +101,12 @@ class QRCodeTest < Test::Unit::TestCase
     assert RQRCode::QRCode.new("40952", :size => 1, :level => :h)
     assert RQRCode::QRCode.new("40932", :size => 1, :level => :h)
   end
+  
+  def test_exceed_max_size
+    assert_raise RQRCode::QRCodeArgumentError do
+      RQRCode::QRCode.new( 'duncan', :size => 41 )
+    end
+  end
 
   def test_levels
     assert RQRCode::QRCode.new("duncan", :level => :l)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Björn Blomqvist
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A library to encode QR Codes