prawn-qrcode 0.1.0

data/examples/prepared_qrcode.rb

@@ -0,0 +1,31 @@
+# Copyright 2011 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/core'
+require_relative '../lib/prawn/qrcode'
+
+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
+
+  text "Sample predefined QR-Code (with stroked bounds) Size of QRCode dots: 1pt (1/72 in)"
+  render_qr_code(qrcode)
+
+  move_down 20
+  text "Sample predefined QR-Code (without stroked bounds) Size of QRCode dots: 1pt (1/72 in)"
+  render_qr_code(qrcode, :stroke=>false)
+  render_file("prepared.pdf")
+end

data/lib/lib.iml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>
+

data/lib/prawn/qrcode.rb

@@ -0,0 +1,100 @@
+# Copyright 2011 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 'prawn'
+require 'rqrcode'
+
+# Extension for Prawn::Document for rendering QR codes.
+#
+# Author::    Jens Hausherr  (mailto:jabbrwcky@googlemail.com)
+# Copyright:: Copyright (c) 2011 Jens Hausherr
+# License::   Apache License, Version 2.0
+#
+module QRCode
+
+  # The default size for QR Code modules is 1/72 in
+  DEFAULT_DOTSIZE = 1
+
+  # Prints a QR Code to the PDF document. The QR code creation happens on the fly.
+  #
+  # @param content [string] The string to put into the QR Code
+  # @param *options Named optional parameters
+  #   :level:: Error correction level to use (:l,:m,:h,:q), Defaults to :m
+  #   :exent:: Size of QR Code given in pt (1 pt == 1/72 in)
+  #   :pos:: Two-element array containing the position at which the QR-Code sholud 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.
+  def print_qr_code(content, *options)
+    opt = options.extract_options!
+    qr_version = 0
+    level = opt[:level] || :m
+    extent = opt[:extent]
+    dot_size = opt[:dot] || DEFAULT_DOTSIZE
+    begin
+      qr_version +=1
+      qr_code = RQRCode::QRCode.new(content, :size=>qr_version, :level=>level)
+
+      dot_size = extent/(8+qr_code.modules.length) if extent
+      render_qr_code(qr_code, :dot=>dot_size, :pos=>opt[:pos], :stroke=>opt[:stroke])
+    rescue RQRCode::QRCodeRunTimeError
+      if qr_version <40
+        retry
+      else
+        raise
+      end
+    end
+  end
+
+  # Renders a prepared QR Code object.
+  #
+  # @param qr_code [RQRCode::QRCode] The QR Code to render
+  # @param *options Named optional parameters
+  #   :exent:: Size of QR Code given in pt (1 pt == 1/72 in)
+  #   :pos:: Two-element array containing the position at which the QR-Code sholud 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.
+  def render_qr_code(qr_code, *options)
+    opt = options.extract_options!
+    dot = opt[:dot] || DEFAULT_DOTSIZE
+    extent= opt[:extent] || (8+qr_code.modules.length) * dot
+    stroke = (opt.has_key?(:stroke) && opt[:stroke].nil?) || opt[:stroke]
+    pos = opt[:pos] ||[0,cursor]
+
+    bounding_box pos, :width => extent, :height => extent do |box|
+      if stroke
+        stroke_bounds
+      end
+
+      pos_y = 4*dot +qr_code.modules.length * dot
+
+      qr_code.modules.each_index do |row|
+        pos_x = 4*dot
+        qr_code.modules.each_index do |col|
+          move_to [pos_x, pos_y]
+          if qr_code.dark?(row, col)
+            fill { rectangle([pos_x, pos_y], dot, dot) }
+          end
+          pos_x = pos_x + dot
+        end
+        pos_y = pos_y - dot
+      end
+    end
+  end
+
+end
+
+Prawn::Document.extensions << QRCode

data/prawn-qrcode.gemspec

@@ -0,0 +1,41 @@
+# Copyright 2011 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.
+
+PRAWN_QRCODE_VERSION = "0.1.0"
+
+Gem::Specification.new do |spec|
+  spec.name = "prawn-qrcode"
+  spec.version = PRAWN_QRCODE_VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "Print QR Codes in PDF"
+  spec.files =  Dir.glob("{examples,lib}/**/**/*") +
+                      ["Rakefile", "prawn-qrcode.gemspec"]
+  spec.require_path = "lib"
+  spec.required_ruby_version = '>= 1.8.7'
+  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.add_dependency('prawn', '~>0.11.1')
+  spec.add_dependency('rqrcode', '~>0.4.1')
+  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.
+  QR Codes
+END_DESC
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: prawn-qrcode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jens Hausherr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: &70310456256060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310456256060
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: &70310456255300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70310456255300
+description: ! "  Prawn/QRCode simplifies the generation and rendering of QRCodes
+  in Prawn PDF documents.\n  QR Codes\n"
+email:
+- jabbrwcky@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- examples/autosize_qrcode.rb
+- examples/autosized code.pdf
+- examples/dotsize.pdf
+- examples/dotsize_qrcode.rb
+- examples/examples.iml
+- examples/prepared code.pdf
+- examples/prepared_qrcode.rb
+- lib/lib.iml
+- lib/prawn/qrcode.rb
+- Rakefile
+- prawn-qrcode.gemspec
+- README.md
+- LICENSE
+homepage: http://github.com/jabbrwcky/prawn-qrcode
+licenses: []
+post_install_message: 
+rdoc_options:
+- --title
+- Prawn/QRCode Documentation
+- --main
+- README.md
+- -q
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Print QR Codes in PDF
+test_files: []