prawn-qrcode 0.1.0 → 0.1.1

data/README.md

@@ -26,14 +26,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, :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_content, :dot=>2.8)
   render_file("qr3.pdf")
 end
 ```

data/Rakefile

@@ -16,10 +16,12 @@ require 'rake'
 require "rubygems"
 require "rubygems/package_task"
 
-task :default do
-  spec = Gem::Specification.load "prawn-qrcode.gemspec"
-  Gem::PackageTask.new(spec) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = true
-  end
+spec = Gem::Specification.load "prawn-qrcode.gemspec"
+Gem::PackageTask.new(spec).define do |pkg|
+  #pkg.need_zip = true
+  pkg.need_tar = true
 end
+
+task :default => :package
+
+task :clean => :clobber_package

data/lib/prawn/qrcode.rb

@@ -1,3 +1,4 @@
+#--
 # Copyright 2011 Jens Hausherr
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -11,31 +12,37 @@
 #  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.
+# :title: Prawn/QRCode
 #
-# Author::    Jens Hausherr  (mailto:jabbrwcky@googlemail.com)
-# Copyright:: Copyright (c) 2011 Jens Hausherr
-# License::   Apache License, Version 2.0
+# :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
 #
 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.
+  # 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
   #
-  # @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.
+  #   +:level+:: Error correction level to use. One of: (: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 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.
+  #
   def print_qr_code(content, *options)
     opt = options.extract_options!
     qr_version = 0
@@ -57,22 +64,21 @@ module QRCode
     end
   end
 
-  # Renders a prepared QR Code object.
+  # Renders a prepared QR Code (RQRCode::QRCode) 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.
+  # qr_code:: The QR Code (an RQRCode::QRCode) to render
+  #
+  # *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 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.
   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]
+    pos = opt[:pos] ||[0, cursor]
 
     bounding_box pos, :width => extent, :height => extent do |box|
       if stroke

data/prawn-qrcode.gemspec

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-PRAWN_QRCODE_VERSION = "0.1.0"
+PRAWN_QRCODE_VERSION = "0.1.1"
 
 Gem::Specification.new do |spec|
   spec.name = "prawn-qrcode"
@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
   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.add_dependency('prawn', '>= 0.11.1', '<= 0.13')
+  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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn-qrcode
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-01 00:00:00.000000000Z
+date: 2011-09-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
-  requirement: &70310456256060 !ruby/object:Gem::Requirement
+  requirement: &70156970180620 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.11.1
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '0.13'
   type: :runtime
   prerelease: false
-  version_requirements: *70310456256060
+  version_requirements: *70156970180620
 - !ruby/object:Gem::Dependency
   name: rqrcode
-  requirement: &70310456255300 !ruby/object:Gem::Requirement
+  requirement: &70156970210100 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70310456255300
+  version_requirements: *70156970210100
 description: ! "  Prawn/QRCode simplifies the generation and rendering of QRCodes
   in Prawn PDF documents.\n  QR Codes\n"
 email: