prawn-qrcode 0.2.2.1 → 0.3.0

data/examples/prepared_qrcode.rb

@@ -12,20 +12,20 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 require 'rubygems'
-require 'prawn/core'
+require 'prawn'
 require_relative '../lib/prawn/qrcode'
 
-qrcode = RQRCode::QRCode.new 'https://github.com/jabbrwcky/prawn-qrcode', :size=>5
+qrcode = RQRCode::QRCode.new('https://github.com/jabbrwcky/prawn-qrcode', :size=>5)
 
 Prawn::Document::new(:page_size => "A4") do
   text "Prawn QR Code sample 1: Predefined QR-Code"
-  move_down 15
-
+  move_down 10
   text "Sample predefined QR-Code (with stroked bounds) Size of QRCode dots: 1pt (1/72 in)"
+  move_down 45
   render_qr_code(qrcode)
-
-  move_down 20
+  move_down 10
   text "Sample predefined QR-Code (without stroked bounds) Size of QRCode dots: 1pt (1/72 in)"
+  move_down 45
   render_qr_code(qrcode, :stroke=>false)
   render_file("prepared.pdf")
-end
+end

data/lib/prawn/qrcode/version.rb

@@ -0,0 +1,5 @@
+module Prawn
+  module QRCode
+    VERSION = "0.3.0"
+  end
+end

data/lib/prawn/qrcode.rb

@@ -25,116 +25,106 @@ require 'rqrcode'
 # *Copyright*:: Copyright (c) 2011 Jens Hausherr
 # *License*::   Apache License, Version 2.0
 #
-module QRCode
+module Prawn
+  module QRCode
+    # The default size for QR Code modules is 1/72 in
+    DEFAULT_DOTSIZE = 1.to_f
 
-  # The default size for QR Code modules is 1/72 in
-  DEFAULT_DOTSIZE = 1.to_f
+    # Prints a QR Code to the PDF document. The QR Code creation happens on the fly.
+    #
+    # content::  The string to render as content of the QR Code
+    #
+    # *options:: Named optional parameters
+    #
+    #   +:level+:: Error correction level to use. One of: (:l,:m,:h,:q), Defaults to :m
+    #   +:extent+:: Size of QR Code given in pt (1 pt == 1/72 in)
+    #   +:pos+:: Two-element array containing the position at which the QR-Code should be rendered. Defaults to [0,cursor]
+    #   +:dot+:: Size of QR Code module/dot. Calculated from extent or defaulting to 1pt
+    #   +:stroke+:: boolean value whether to draw bounds around the QR Code.
+    #             Defaults to true.
+    #   +:align+:: Optional alignment within the current bounding box. Valid values are :left, :right, and :center. If set
+    #             This option overrides the horizontal positioning specified in :pos. Defaults to nil.
+    #   +:debug+:: Optional boolean, renders a coordinate grid around the QRCode if true (uses Prawn#stroke_axis)
+    #
+    def print_qr_code(content, level: :m, dot: DEFAULT_DOTSIZE, pos: [0,cursor], stroke: true, **options)
+      qr_version = 0
+      dot_size = dot
 
-  # Prints a QR Code to the PDF document. The QR Code creation happens on the fly.
-  #
-  # content::  The string to render as content of the QR Code
-  #
-  # *options:: Named optional parameters
-  #
-  #   +:level+:: Error correction level to use. One of: (:l,:m,:h,:q), Defaults to :m
-  #   +:extent+:: Size of QR Code given in pt (1 pt == 1/72 in)
-  #   +:pos+:: Two-element array containing the position at which the QR-Code should be rendered. Defaults to [0,cursor]
-  #   +:dot+:: Size of QR Code module/dot. Calculated from extent or defaulting to 1pt
-  #   +:stroke+:: boolean value whether to draw bounds around the QR Code.
-  #             Defaults to true.
-  #   +:align+:: Optional alignment within the current bounding box. Valid values are :left, :right, and :center. If set
-  #             This option overrides the horizontal positioning specified in :pos. Defaults to nil.
-  #
-  def print_qr_code(content, *options)
-    opt = options.extract_options!
-    qr_version = 0
-    level = opt[:level] || :m
-    extent = opt[:extent].to_f
-    dot_size = opt[:dot].to_f || DEFAULT_DOTSIZE
-    begin
-      qr_version +=1
-      qr_code = RQRCode::QRCode.new(content, :size=>qr_version, :level=>level)
+      begin
+        qr_version += 1
+        qr_code = RQRCode::QRCode.new(content, size: qr_version, level: level)
+        dot = options[:extent] / (8 + qr_code.modules.length) if options[:extent]
 
-      dot_size = extent/(8+qr_code.modules.length) if extent
-      render_qr_code(qr_code, opt.merge(:dot=>dot_size))
-    rescue RQRCode::QRCodeRunTimeError
-      if qr_version <40
-        retry
-      else
-        raise
+        render_qr_code(qr_code, dot: dot, pos: pos, stroke: stroke, **options)
+      rescue RQRCode::QRCodeRunTimeError
+        if qr_version < 40
+          retry
+        else
+          raise
+          end
       end
     end
-  end
-
-  # Renders a prepared QR Code (RQRCode::QRCode) object.
-  #
-  # qr_code:: The QR Code (an RQRCode::QRCode) to render
-  #
-  # *options:: Named optional parameters
-  #   +:extent+:: Size of QR Code given in pt (1 pt == 1/72 in)
-  #   +:pos+:: Two-element array containing the position at which the QR-Code should be rendered. Defaults to [0,cursor]
-  #   +:dot+:: Size of QR Code module/dot. Calculated from extent or defaulting to 1pt
-  #   +:stroke+:: boolean value whether to draw bounds around the QR Code. Defaults to true.
-  #   +:align+:: Optional alignment within the current bounding box. Valid values are :left, :right, and :center. If set
-  #             This option overrides the horizontal positioning specified in :pos. Defaults to nil.
-  def render_qr_code(qr_code, *options)
-    opt = options.extract_options!
-    dot = opt[:dot].to_f || DEFAULT_DOTSIZE
-    extent= opt[:extent].to_f || (8+qr_code.modules.length) * dot
-    stroke = true
-    stroke = opt[:stroke] if opt.has_key?(:stroke)
-
-    foreground_color = opt[:foreground_color] || '000000'
-    background_color = opt[:background_color] || 'FFFFFF'
-    stroke_color = opt[:stroke_color] || '000000'
-
-    pos = opt[:pos] ||[0, cursor]
-
-    align = opt[:align]
-    case(align)
-    when :center
-      pos[0] = (@bounding_box.right / 2) - (extent / 2)
-    when :right
-      pos[0] = @bounding_box.right - extent
-    when :left
-      pos[0] = 0;
-    end
-
-    stroke_color stroke_color
-    fill_color background_color
 
-    bounding_box pos, :width => extent, :height => extent do |box|
-      fill_color foreground_color
+    # Renders a prepared QR Code (RQRCode::QRCode) object.
+    #
+    # qr_code:: The QR Code (an RQRCode::QRCode) to render
+    #
+    # *options:: Named optional parameters
+    #   +:extent+:: Size of QR Code given in pt (1 pt == 1/72 in)
+    #   +:pos+:: Two-element array containing the position at which the QR-Code should be rendered. Defaults to [0,cursor]
+    #   +:dot+:: Size of QR Code module/dot. Calculated from extent or defaulting to 1pt
+    #   +:stroke+:: boolean value whether to draw bounds around the QR Code. Defaults to true.
+    #   +:align+:: Optional alignment within the current bounding box. Valid values are :left, :right, and :center. If set
+    #             This option overrides the horizontal positioning specified in :pos. Defaults to nil.
+    #   +:debug+:: Optional boolean, renders a coordinate grid around the QRCode if true (uses Prawn#stroke_axis)
+    #
+    def render_qr_code(qr_code, dot: DEFAULT_DOTSIZE, pos: [0,cursor], stroke: true, foreground_color: '000000', background_color: 'FFFFFF', stroke_color: '000000', **options)
+      extent = extent || (8 + qr_code.modules.length) * dot
 
-      if stroke
-        stroke_bounds
+      case options[:align]
+      when :center
+        pos[0] = (@bounding_box.right / 2) - (extent / 2)
+      when :right
+        pos[0] = @bounding_box.right - extent
+      when :left
+        pos[0] = 0
       end
 
-      pos_y = 4*dot +qr_code.modules.length * dot
+      fill_color background_color
+
+      bounding_box(pos, width: extent, height: extent) do |_box|
+        fill_color foreground_color
+        pos_y = 4 * dot + qr_code.modules.length * dot
 
-      qr_code.modules.each_index do |row|
-        pos_x = 4*dot
-        dark_col = 0
-        qr_code.modules.each_index do |col|
-          move_to [pos_x, pos_y]
-          if qr_code.dark?(row, col)
-            dark_col = dark_col+1
-          else
-            if (dark_col>0)
-              fill { rectangle([pos_x - dark_col*dot, pos_y], dot*dark_col, dot) }
-              dark_col = 0
+        qr_code.modules.each_index do |row|
+          pos_x = 4 * dot
+          dark_col = 0
+          qr_code.modules.each_index do |col|
+            move_to [pos_x, pos_y]
+            if qr_code.dark?(row, col)
+              dark_col += 1
+            else
+              if dark_col > 0
+                fill { rectangle([pos_x - dark_col * dot, pos_y], dot * dark_col, dot) }
+                dark_col = 0
+              end
             end
+            pos_x += dot
           end
-          pos_x = pos_x + dot
+          if dark_col > 0
+            fill { rectangle([pos_x - dark_col * dot, pos_y], dot * dark_col, dot) }
+          end
+          pos_y -= dot
         end
-        if (dark_col > 0)
-          fill { rectangle([pos_x - dark_col*dot, pos_y], dot*dark_col, dot) }
+
+        if stroke
+          fill_color stroke_color
+          stroke_bounds
         end
-        pos_y = pos_y - dot
+        stroke_axis(at: [-1,-1], negative_axes_length: 0, color: '0C0C0C', step_length: 50)  if options[:debug]
       end
     end
   end
-
 end
 
-Prawn::Document.extensions << QRCode
+Prawn::Document.extensions << Prawn::QRCode

data/prawn-qrcode.gemspec

@@ -1,4 +1,5 @@
-# Copyright 2011-2014 Jens Hausherr
+# coding: utf-8
+# Copyright 2011-2017 Jens Hausherr
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -12,30 +13,37 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prawn/qrcode/version'
+
 Gem::Specification.new do |spec|
   spec.name                      = "prawn-qrcode"
-  spec.version                   = "0.2.2.1"
+  spec.version                   = Prawn::QRCode::VERSION
   spec.platform                  = Gem::Platform::RUBY
   spec.summary                   = "Print QR Codes in PDF"
   spec.licenses                  = [ 'Apache License 2.0' ]
   spec.files                     =  Dir.glob("{examples,lib}/**/**/*") +
                       ["Rakefile", "prawn-qrcode.gemspec"]
   spec.require_path              = "lib"
-  spec.required_ruby_version     = '>= 1.8.7'
+  spec.required_ruby_version     = '>= 2.0.0'
   spec.required_rubygems_version = ">= 1.3.6"
 
   spec.extra_rdoc_files          = %w{README.md LICENSE}
   spec.rdoc_options << '--title' << 'Prawn/QRCode Documentation' <<
                        '--main'  << 'README.md' << '-q'
   spec.authors                   = ["Jens Hausherr"]
-  spec.email                     = ["jabbrwcky@googlemail.com"]
-  #spec.rubyforge_project         = "prawn-qrcode"
+  spec.email                     = ["jabbrwcky@gmail.com"]
   spec.homepage                   = "http://github.com/jabbrwcky/prawn-qrcode"
 
   spec.description                = <<END_DESC
   Prawn/QRCode simplifies the generation and rendering of QRCodes in Prawn PDF documents.
 END_DESC
 
-  spec.add_dependency('prawn', '>= 0.11.1')
+  spec.add_dependency('prawn', '>=1')
   spec.add_dependency('rqrcode', '>=0.4.1')
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  #spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-qrcode
 version: !ruby/object:Gem::Version
-  version: 0.2.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jens Hausherr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2017-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rqrcode
   requirement: !ruby/object:Gem::Requirement
@@ -38,10 +38,38 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.1
-description: |2
-    Prawn/QRCode simplifies the generation and rendering of QRCodes in Prawn PDF documents.
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: "  Prawn/QRCode simplifies the generation and rendering of QRCodes in
+  Prawn PDF documents.\n"
 email:
-- jabbrwcky@googlemail.com
+- jabbrwcky@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -51,10 +79,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/autosize.pdf
 - examples/autosize_qrcode.rb
+- examples/dotsize.pdf
 - examples/dotsize_qrcode.rb
+- examples/prepared.pdf
 - examples/prepared_qrcode.rb
 - lib/prawn/qrcode.rb
+- lib/prawn/qrcode/version.rb
 - prawn-qrcode.gemspec
 homepage: http://github.com/jabbrwcky/prawn-qrcode
 licenses:
@@ -73,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -81,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Print QR Codes in PDF