prawn-qrcode 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669642c6d67bd24eb6d51a546511924ad8e23005ce126a509835e6dcc9799108
-  data.tar.gz: dbd5b4d89edcadbe82fb94fc2c1fa3e964f01e067a473132c7f7c91d6b8179c1
+  metadata.gz: f7bf1bcff14157602b378498911ee03a4677120443b7fe10e7941fdebe88719c
+  data.tar.gz: 88a8704a23314b70e6582ebd0bbe261072a2decea03a97c2392db67b18f68ab1
 SHA512:
-  metadata.gz: dcf9f09766c9a1d72f7c064b0f6d0e30154e3f362dd4050972ab230979e4703e5da1d8fb53e8614caa18fe5f215b2e5908ff0c368621bdbd1de669463f9a83a7
-  data.tar.gz: 2bf546a8b09abd35384ec753d84abae8b2b9efb245529e119d94d3bc1556cdc925847e7679f7983dac633e764aabda94c1eee2a3f2c48732a1297ce25d097a5b
+  metadata.gz: '0598b21b285c7d77d553f4b5ecf1960b08b2e61476f68ad162a6d34f5f35d4fe33f307af9af97e9e89051f7ed021a47f520644f6d976c989cfdb764daa83d7a7'
+  data.tar.gz: ed8cd446792d019665fc1f8bbf2812cc633d5100d333ae49cfc85824d4974f4afb4b27d4245d9ee63095d221fa1f18640c830ca2fdd66c746d128e4b6aabadce

data/README.md

@@ -5,7 +5,7 @@ A simple extension to generate and/or render QRCodes for Prawn PDFs
 ![TravisCI Build state](https://travis-ci.org/jabbrwcky/prawn-qrcode.svg?branch=master)
 [![Gem Version](https://badge.fury.io/rb/prawn-qrcode.svg)](http://badge.fury.io/rb/prawn-qrcode)
 
-Prawn/QRCode is a Prawn (>= 0.11.1) extension to simplify rendering of QR Codes*.
+Prawn/QRCode is a Prawn (>= 1.0.0) extension to simplify rendering of QR Codes*.
 
 (*) QR Code is registered trademark of DENSO WAVE INCORPORATED.
     See http://www.denso-wave.com/qrcode/ for more information.
@@ -13,7 +13,7 @@ Prawn/QRCode is a Prawn (>= 0.11.1) extension to simplify rendering of QR Codes*
 ## Install
 
 ```bash
-$ gem install prawn-qrcode
+gem install prawn-qrcode
 ```
 
 ## Usage
@@ -22,7 +22,7 @@ $ gem install prawn-qrcode
 require 'prawn/qrcode'
 
 qrcode_content = "http://github.com/jabbrwcky/prawn-qrcode"
-qrcode = RQRCode::QRCode.new(qrcode_content, :level=>:h, :size => 5)
+qrcode = RQRCode::QRCode.new(qrcode_content, level: :h, size: 5)
 
 # Render a prepared QRCode at he cursor position
 # using a default module (e.g. dot) size of 1pt or 1/72 in
@@ -34,14 +34,14 @@ end
 # Render a code for raw content and a given total code size.
 # Renders a QR Code at the cursor position measuring 1 in in width/height.
 Prawn::Document::new do
-  print_qr_code(qrcode_content, :extent=>72)
+  print_qr_code(qrcode_content, extent: 72)
   render_file("qr2.pdf")
 end
 
 # Render a code for raw content with a given dot size
 Prawn::Document::new do
   # Renders a QR Code at he cursor position using a dot (module) size of 2.8/72 in (roughly 1 mm).
-  render_qr_code(qrcode, :dot=>2.8)
+  render_qr_code(qrcode, dot: 2.8)
   render_file("qr3.pdf")
 end
 ```

data/Rakefile

@@ -1,4 +1,4 @@
-# Copyright 2011 Jens Hausherr
+# Copyright 2011 - 2109 Jens Hausherr
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -13,16 +13,23 @@
 #  limitations under the License.
 
 require 'rake'
-require "rubygems"
-require "rubygems/package_task"
-require "bundler/gem_tasks"
+require 'rubygems'
+require 'rubygems/package_task'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-spec = Gem::Specification.load "prawn-qrcode.gemspec"
+spec = Gem::Specification.load 'prawn-qrcode.gemspec'
 Gem::PackageTask.new(spec).define do |pkg|
-  #pkg.need_zip = true
+  # pkg.need_zip = true
   pkg.need_tar = true
 end
 
-task :default => :package
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/test_*.rb']
+end
+
+task :default => :test
 
 task :clean => :clobber_package

data/examples/autosize_qrcode.rb

@@ -1,4 +1,4 @@
-# Copyright 2011 Jens Hausherr
+# Copyright 2011 - 2109 Jens Hausherr
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -16,21 +16,21 @@ require 'prawn'
 require 'prawn/measurement_extensions'
 require_relative '../lib/prawn/qrcode'
 
-qrcode = 'https://github.com/jabbrwcky/prawn-qrcode'
+data = 'https://github.com/jabbrwcky/prawn-qrcode'
 
 Prawn::Document.new(page_size: 'A4') do
   text 'Sample autosized QR-Code (with stroked bounds) Size of QRCode : 1 in (72 pt)'
-  print_qr_code(qrcode, extent: 72)
+  print_qr_code(data, extent: 72)
   move_down 20
 
   text 'Sample autosized QR-Code (with and without stroked bounds) Size of QRCode : 2 in (144 pt)'
   cpos = cursor
-  print_qr_code(qrcode, extent: 144)
-  print_qr_code(qrcode, pos: [150, cpos], extent: 144, stroke: false)
+  print_qr_code(data, extent: 144)
+  print_qr_code(data, pos: [150, cpos], extent: 144, stroke: false)
   move_down 10
 
   text 'Sample autosized QR-Code (with stroked bounds) Size of QRCode :10 cm'
-  print_qr_code(qrcode, extent: 10.send(:cm), stroke: true, level: :q)
+  print_qr_code(data, extent: 10.send(:cm), stroke: true, level: :q)
   move_down 10
   text "Quite huge, isn't it?"
   render_file('autosize.pdf')

data/examples/dotsize_qrcode.rb

@@ -1,4 +1,4 @@
-# Copyright 2011 Jens Hausherr
+# Copyright 2011 - 2109 Jens Hausherr
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -39,9 +39,9 @@ Prawn::Document.new(page_size: 'A4') do
   print_qr_code(qrcode, dot: 1.mm)
   print_qr_code(qrcode, pos: [150, cpos], dot: 1.mm, stroke: false)
   font 'Courier', size: 8 do
-    text_box "require 'prawn/measurement_extensions'\n\n" +
-     "print_qr_code(qrcode, dot: 1.mm)\n"+
-     "print_qr_code(qrcode, pos: [150,cpos], dot: 1.mm, stroke: false)", at: [320, cpos], height: 200, width: 220
+    text_box "require 'prawn/measurement_extensions'\n\n" \
+             "print_qr_code(qrcode, dot: 1.mm)\n" \
+             'print_qr_code(qrcode, pos: [150,cpos], dot: 1.mm, stroke: false)', at: [320, cpos], height: 200, width: 220
   end
 
   move_down 30
@@ -53,8 +53,8 @@ Prawn::Document.new(page_size: 'A4') do
   cpos = cursor
   print_qr_code(qrcode, dot: 1.mm, level: :q)
   font 'Courier', size: 8 do
-    text_box "require 'prawn/measurement_extensions'\n\n" +
-     "print_qr_code(qrcode, dot: 1.mm, level: :q)", at: [320, cpos], height: 200, width: 220
+    text_box "require 'prawn/measurement_extensions'\n\n" \
+             'print_qr_code(qrcode, dot: 1.mm, level: :q)', at: [320, cpos], height: 200, width: 220
   end
   render_file('dotsize.pdf')
 end

data/examples/prepared_qrcode.rb

@@ -1,4 +1,4 @@
-# Copyright 2011 Jens Hausherr
+# Copyright 2011 - 2109 Jens Hausherr
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -15,17 +15,17 @@ require 'rubygems'
 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"
+Prawn::Document.new(page_size: 'A4') do
+  text 'Prawn QR Code sample 1: Predefined QR-Code'
   move_down 10
-  text "Sample predefined QR-Code (with stroked bounds) Size of QRCode dots: 1pt (1/72 in)"
+  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 10
-  text "Sample predefined QR-Code (without stroked bounds) Size of QRCode dots: 1pt (1/72 in)"
+  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")
+  render_qr_code(qrcode, stroke: false)
+  render_file('prepared.pdf')
 end

data/examples/table_qrcode.rb

@@ -0,0 +1,35 @@
+# Copyright 2011 - 2019 Jens Hausherr
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+require 'rubygems'
+require 'prawn'
+require 'prawn/measurement_extensions'
+require 'prawn/table'
+require_relative '../lib/prawn/qrcode'
+require_relative '../lib/prawn/qrcode/table'
+
+# qrcode = 'https://github.com/jabbrwcky/prawn-qrcode'
+
+Prawn::Document.new(page_size: 'A4') do
+  font 'Helvetica', style: :bold do
+    text 'QRCode in table'
+  end
+  move_down 5.mm
+  cpos = cursor
+  qr = make_qrcode_cell(content: 'https://github.com/jabbrwcky/prawn-qrcode', extent: 72)
+  t = make_table([%w[URL QRCODE],
+                  ['https://github.com/jabbrwcky/prawn-qrcode', qr]])
+  t.draw
+  move_down 20
+  render_file('table.pdf')
+end

data/lib/prawn/qrcode.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright 2010-2014 Jens Hausherr
+# Copyright 2010 - 2019 Jens Hausherr
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -21,109 +21,208 @@ require 'rqrcode'
 # :main: This is an extension for Prawn::Document to simplify rendering QR Codes.
 # The module registers itself as Prawn extension upon loading.
 #
-# *Author*::    Jens Hausherr  (mailto:jabbrwcky@googlemail.com)
-# *Copyright*:: Copyright (c) 2011 Jens Hausherr
-# *License*::   Apache License, Version 2.0
+# @author Jens Hausherr  <jabbrwcky@gmail.com>
+# @copyright Copyright (c) 2011 -2019 Jens Hausherr
+# @license Apache License, Version 2.0
 #
 module Prawn
   module QRCode
-    # The default size for QR Code modules is 1/72 in
+    # DEFAULT_DOTSIZE defines the default size for QR Code modules in multiples of 1/72 in
     DEFAULT_DOTSIZE = 1.to_f
 
-    # Prints a QR Code to the PDF document. The QR Code creation happens on the fly.
+    # Creates a QRCode with a minimal size to fit the data with the requested error correction level.
+    # @since 0.5.0
     #
-    # content::  The string to render as content of the QR Code
+    # @param [string] content The string to render as content of the QR Code
+    # @param [Integer] qr_version Optional number of modules to use initially. Will use more if input overflows module size (Default: 0)
+    # @param [symbol] level Optional Error correction level to use. One of: (:l, :m, :h, :q), Defaults to :m
+    # @param [symbol] mode Optional mode. One of (:number, :alphanumeric, :byte_8bit, :kanji), Defaults to :alphanumeric or :byte_8bit
     #
-    # *options:: Named optional parameters
+    # @return [RQRCode::QRCode] QR code that can hold the specified data with the desired error correction level
     #
-    #   +: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.
-    #   +:margin+:: Size of margin around code in QR-Code modules/dots, Default to 4
-    #   +: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)
+    # @raise [RQRCodeCore::QRCodeRunTimeError] if the data specified will not fit in the largest QR code (QR version 40) with the given error correction level
     #
-    def print_qr_code(content, level: :m, dot: DEFAULT_DOTSIZE, pos: [0,cursor], stroke: true, margin: 4, **options)
-      qr_version = 0
-      dot_size = dot
-
-      begin
-        qr_version += 1
-        qr_code = RQRCode::QRCode.new(content, size: qr_version, level: level)
-        dot = options[:extent] / (2*margin + qr_code.modules.length) if options[:extent]
-
-        render_qr_code(qr_code, dot: dot, pos: pos, stroke: stroke, margin: margin, **options)
-      rescue RQRCodeCore::QRCodeRunTimeError
-        if qr_version < 40
-          retry
-        else
-          raise
-          end
-      end
+    def self.min_qrcode(content, qr_version = 0, level: :m, mode: nil, **)
+      qr_version += 1
+      RQRCode::QRCode.new(content, size: qr_version, level: level, mode: mode)
+    rescue RQRCodeCore::QRCodeRunTimeError
+      retry if qr_version < 40
+      raise
+    end
+
+    # dotsize calculates the required dotsize for a QR code to be rendered with the given extent and the module size
+    # @since 0.5.0
+    #
+    # @param [RQRCode::QRCode] qr_code QR code to render
+    # @param [Integer/Float] extent Size of QR code given in pt (1 pt == 1/72 in)
+    # @param [Integer] margin Width of margin as number of modules (defaults to 4 modules)
+    #
+    # @return [Float] size of dot in pt (1/72 in)
+    def self.dotsize(qr_code, extent, margin = 4)
+      extent.to_f / (2 * margin + qr_code.modules.length).to_f
+    end
+
+    # Prints a QR Code to the PDF document. The QR Code creation happens on the fly.
+    #
+    # @param [string] content The string to render as content of the QR Code
+    # @param [symbol] level Error correction level to use. One of: (:l, :m, :h, :q), Defaults to :m
+    # @param [symbol] mode Optional mode. One of (:number, :alphanumeric, :byte_8bit, :kanji), Defaults to :alphanumeric or :byte_8bit
+    # @param [Array] pos  Two-element array containing the position at which the QR-Code should be rendered. Defaults to [0,cursor]
+    # @param [Hash] options additional options that are passed on to Prawn::QRCode::Renderer
+    #
+    # @see Renderer
+    #
+    def print_qr_code(content, level: :m, mode: nil, pos: [0, cursor], **options)
+      qr_code = Prawn::QRCode.min_qrcode(content, level: level, mode: mode)
+      render_qr_code(qr_code, pos: pos, stroke: stroke, margin: margin, **options)
     end
 
-    # Renders a prepared QR Code (RQRCode::QRCode) object.
+    # Renders a prepared QR code (RQRCode::QRCode) int the pdf.
+    # @since 0.5.0
     #
-    # qr_code:: The QR Code (an RQRCode::QRCode) to render
+    # @param [RQRCode::QRCode] qr_code The QR code (an RQRCode::QRCode) to render
+    # @param [Hash] options additional options that are passed on to Prawn::QRCode::Renderer
     #
-    # *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.
-    #   +:margin+:: Size of margin around code in QR-Code modules/dots, Default to 4
-    #   +: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)
+    # @see Renderer
     #
-    def render_qr_code(qr_code, dot: DEFAULT_DOTSIZE, pos: [0,cursor], stroke: true, foreground_color: '000000', background_color: 'FFFFFF', stroke_color: '000000', margin: 4, **options)
-      extent = extent || (2*margin + qr_code.modules.length) * dot
-
-      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
+    def render_qr_code(qr_code, **options)
+      renderer = Renderer.new(qr_code, **options)
+      renderer.render(self)
+    end
+
+    # QRCodeError is raised on errors specific to Prawn::QRCode
+    # @since 0.5.0
+    class QRCodeError < StandardError; end
+
+    # Renderer is responsible for actually rendering a QR code to pdf
+    # @since 0.5.0
+    class Renderer
+      attr_accessor :qr_code
+
+      RENDER_OPTS = %I[dot pos stroke foreground_color background_color stroke_color margin align debug extent].freeze
+      RENDER_OPTS.each { |attr| attr_writer attr }
+
+      # creates a new renderer for the given QR code
+      #
+      # @param qr_code [RQRCode::QRCode] QR code to render
+      # @param [Hash] options additional options
+      # @option options [Float] :dot size of a dot in pt (1/72 in)
+      # @option options [Array] :pos Two-element array containing the position at which the QR-Code should be rendered. Defaults to [0,cursor]
+      # @option options [bool] :stroke whether to draw bounds around the QR Code. Defaults to true.
+      # @option options [string] :foreground_color 6-digit hex string specifying foreground color; default: '000000'
+      # @option options [string] :background_color 6-digit hex string specifying background color; default: 'FFFFFF'
+      # @option options [string] :stroke_color 6-digit hex string specifying stroke color; default: '000000'
+      # @option options [integer] :margin number of modules as margin around QRcode (default: 4)
+      # @option options [float] :extent overall width/height of QR code in pt (1/72 in)
+      # @option options [bool] :debug render a coordinate grid around the QRCode if true (uses Prawn#stroke_axis)
+      # @option options [symbol] :align 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.
+      #
+      # Options :dot and :extent are mutually exclusive.
+      #
+      # @raise [QRCodeError] if both extent and dot are specified.
+      def initialize(qr_code, **options)
+        raise QRCodeError, 'Specify either :dot or :extent, not both' if options.key?(:dot) && options.key?(:extent)
+
+        @stroke = true
+        @qr_code = qr_code
+        options.select { |k, _v| RENDER_OPTS.include?(k) }.each { |k, v| send("#{k}=", v) }
       end
 
-      fill_color background_color
-
-      bounding_box(pos, width: extent, height: extent) do |_box|
-        fill_color foreground_color
-        pos_y = margin * dot + qr_code.modules.length * dot
-
-        qr_code.modules.each_index do |row|
-          pos_x = margin * dot
-          dark_col = 0
-          qr_code.modules.each_index do |col|
-            move_to [pos_x, pos_y]
-            if qr_code.qrcode.checked?(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
+      def dot
+        @dot ||= Prawn::QRCode.dotsize(qr_code, @extent, margin) if defined?(@extent)
+        @dot ||= DEFAULT_DOTSIZE unless defined?(@extent)
+        @dot
+      end
+
+      attr_reader :stroke
+
+      def foreground_color
+        @foreground_color ||= '000000'
+      end
+
+      def background_color
+        @background_color ||= 'FFFFFF'
+      end
+
+      def stroke_color
+        @stroke_color ||= '000000'
+      end
+
+      def margin
+        @margin ||= 4
+      end
+
+      def extent
+        @extent ||= (2 * margin + qr_code.modules.length) * dot
+        @extent
+      end
+
+      def margin_size
+        margin * dot
+      end
+
+      def align(bounding_box)
+        rlim = bounding_box.right
+        case @align
+        when :center
+          @point[0] = (rlim / 2) - (extent / 2)
+        when :right
+          @point[0] = rlim - extent
+        when :left
+          @point[0] = 0
+        end
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def render(pdf)
+        pdf.fill_color background_color
+
+        pdf.bounding_box(pos(pdf), width: extent, height: extent) do |_box|
+          pdf.fill_color foreground_color
+          margin_dist = margin * dot
+
+          m = qr_code.modules
+
+          pos_y = margin_dist + m.length * dot
+
+          m.each_with_index do |row, index|
+            pos_x = margin_dist
+            dark_col = 0
+
+            row.each_index do |col|
+              pdf.move_to [pos_x, pos_y]
+              if qr_code.qrcode.checked?(index, col)
+                dark_col += 1
+              else
+                if dark_col > 0
+                  dark_col_extent = dark_col * dot
+                  pdf.fill { pdf.rectangle([pos_x - dark_col_extent, pos_y], dark_col_extent, dot) }
+                  dark_col = 0
+                end
               end
+              pos_x += dot
             end
-            pos_x += dot
+
+            pdf.fill { pdf.rectangle([pos_x - dark_col * dot, pos_y], dot * dark_col, dot) } if dark_col > 0
+
+            pos_y -= dot
           end
-          if dark_col > 0
-            fill { rectangle([pos_x - dark_col * dot, pos_y], dot * dark_col, dot) }
+
+          if stroke
+            pdf.fill_color stroke_color
+            pdf.stroke_bounds
           end
-          pos_y -= dot
+          pdf.stroke_axis(at: [-1, -1], negative_axes_length: 0, color: '0C0C0C', step_length: 50) if debug
         end
+      end
 
-        if stroke
-          fill_color stroke_color
-          stroke_bounds
-        end
-        stroke_axis(at: [-1,-1], negative_axes_length: 0, color: '0C0C0C', step_length: 50)  if options[:debug]
+      private
+
+      attr_reader :debug
+
+      def pos(pdf)
+        @pos ||= [0, pdf.cursor]
       end
     end
   end

data/lib/prawn/qrcode/table.rb

@@ -0,0 +1,28 @@
+require_relative 'table/cell'
+
+module Prawn
+  module QRCode
+    module Table
+      # create a Prawn::Table::Cell instacne that renders QR codes as table cell
+      # @since 0.5.0
+      #
+      # @param [Hash] options for creating table cell
+      # @option [String] :content string content to render as QR code
+      # @option [RQRCode::QRCode] :qr_code qr_code object to render
+      # @option [Prawn::QRCode::Renderer] :renderer initialized renderer (contains qr_code)
+      #
+      # The table cell will create a QRCode and Renderer on demand, all necessary options will be passed through
+      #
+      # @see Prawn::QRCode.min_qrcode
+      # @see Prawn::QRCode::Renderer
+      # @see Prawn::Table::Cell
+      #
+      # @return [Prawn::QRCode::Table::Cell] table cell instance for Prawn::Table
+      def make_qrcode_cell(**options)
+        Prawn::QRCode::Table::Cell.new(self, [0, cursor], options)
+      end
+    end
+  end
+end
+
+Prawn::Document.extensions << Prawn::QRCode::Table

data/lib/prawn/qrcode/table/cell.rb

@@ -0,0 +1,45 @@
+require 'prawn/table/cell'
+
+module Prawn
+  module QRCode
+    module Table
+
+      # QRCode is a table cell that renders a QR code inside a table.
+      # Most users will create a table via the PDF DSL method make_qr_code_cell.
+      class Cell < Prawn::Table::Cell
+        QR_OPTIONS = %I[content qr_code renderer level mode extent pos dot stroke margin align].freeze
+        CELL_OPTS = %I[padding borders border_widths border_colors border_lines colspan rowspan at].freeze
+
+        QR_OPTIONS.each { |attr| attr_writer attr }
+
+        def initialize(pdf, pos, **options)
+          super(pdf, pos, options.select { |k, _| CELL_OPTS.include?(k) })
+          @margin = 4
+          @options = options.reject { |k, _| CELL_OPTS.include?(k) }
+          @options.each { |k, v| send("#{k}=", v) }
+        end
+
+        def natural_content_width
+          renderer.extent
+        end
+
+        def natural_content_height
+          renderer.extent
+        end
+
+        def draw_content
+          renderer.render(@pdf)
+        end
+
+        def renderer
+          @renderer ||= Prawn::QRCode::Renderer.new(qr_code, **@options)
+        end
+
+        def qr_code
+          @qr_code = Prawn::QRCode.min_qrcode(content, **@options) unless defined?(@qr_code)
+          @qr_code
+        end
+      end
+    end
+  end
+end

data/lib/prawn/qrcode/version.rb

@@ -1,5 +1,21 @@
+#
+# Copyright 2010 - 2019 Jens Hausherr
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
 module Prawn
   module QRCode
-    VERSION = "0.4.0"
+    VERSION = '0.5.0'.freeze
   end
 end

data/prawn-qrcode.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-# Copyright 2011-2017 Jens Hausherr
+# Copyright 2011 - 2019 Jens Hausherr
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -13,28 +12,28 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'prawn/qrcode/version'
 
 Gem::Specification.new do |spec|
-  spec.name                      = "prawn-qrcode"
+  spec.name                      = 'prawn-qrcode'
   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     = '>= 2.0.0'
-  spec.required_rubygems_version = ">= 1.3.6"
+  spec.summary                   = 'Print QR Codes in PDF'
+  spec.licenses                  = ['Apache License 2.0']
+  spec.files = Dir.glob('{examples,lib,test}/**/**/*') +
+               ['Rakefile', 'prawn-qrcode.gemspec']
+  spec.require_path              = 'lib'
+  spec.required_ruby_version     = '>= 2.2.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@gmail.com"]
-  spec.homepage                   = "http://github.com/jabbrwcky/prawn-qrcode"
+  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@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.
@@ -43,7 +42,9 @@ END_DESC
   spec.add_dependency('prawn', '>=1')
   spec.add_dependency('rqrcode', '>=1.0.0')
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  #spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.12', '>= 5.12.2'
+  spec.add_development_dependency 'prawn-table', '~> 0.2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~>0.66.0'
 end

data/test/test_minqrcode.rb

@@ -0,0 +1,11 @@
+require 'minitest/autorun'
+require 'prawn/qrcode'
+
+class TestMinQRCode < Minitest::Test
+  def test_dot_size_float
+    qrcode = Prawn::QRCode.min_qrcode('foobar')
+    assert(qrcode)
+    dot = Prawn::QRCode.dotsize(qrcode, 72)
+    assert_in_delta(2.5, dot, 0.05)
+  end
+end

data/test/test_renderer.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+require_relative '../lib/prawn/qrcode.rb'
+
+class TestRenderer < Minitest::Test
+  def setup
+    @qrcode = Prawn::QRCode.min_qrcode('https://gituhb.com/jabbrwcky/prawn-qrcode')
+  end
+
+  def test_renderer_defaults
+    r = Prawn::QRCode::Renderer.new(@qrcode)
+
+    assert(r.stroke)
+    assert_equal(Prawn::QRCode::DEFAULT_DOTSIZE, r.dot)
+    assert_equal('000000', r.foreground_color)
+    assert_equal('FFFFFF', r.background_color)
+    assert_equal(4, r.margin)
+    assert_equal(37.0, r.extent)
+  end
+
+  def test_renderer_extent
+    r = Prawn::QRCode::Renderer.new(@qrcode, extent: 72)
+    assert_in_delta(1.9, 0.05, r.extent)
+  end
+
+  def test_conflicting_dotsize_and_extent
+    assert_raises(Prawn::QRCode::QRCodeError) { Prawn::QRCode::Renderer.new(@qrcode, dot: 3, extent: 72) }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-qrcode
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jens Hausherr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-13 00:00:00.000000000 Z
+date: 2019-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -44,28 +44,76 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.12.2
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.66.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.66.0
 description: "  Prawn/QRCode simplifies the generation and rendering of QRCodes in
   Prawn PDF documents.\n"
 email:
@@ -82,9 +130,14 @@ files:
 - examples/autosize_qrcode.rb
 - examples/dotsize_qrcode.rb
 - examples/prepared_qrcode.rb
+- examples/table_qrcode.rb
 - lib/prawn/qrcode.rb
+- lib/prawn/qrcode/table.rb
+- lib/prawn/qrcode/table/cell.rb
 - lib/prawn/qrcode/version.rb
 - prawn-qrcode.gemspec
+- test/test_minqrcode.rb
+- test/test_renderer.rb
 homepage: http://github.com/jabbrwcky/prawn-qrcode
 licenses:
 - Apache License 2.0
@@ -92,8 +145,7 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - "--title"
-- Prawn/QRCode Documentation
-- "--main"
+- Prawn/QRCode Documentation--main
 - README.md
 - "-q"
 require_paths:
@@ -102,14 +154,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Print QR Codes in PDF