custom_rqrcode 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef2f8329c3650f1476d38103fc63a82dce86e9aa
+  data.tar.gz: c999d5bbef2592952ee487635f54b47ef8144a3d
+SHA512:
+  metadata.gz: 2582e340f28f2485162986d96a2b0138a24a2305c71a9832fa831583fb4d636d5064509757700ddd3f1ab1352e2d6d790e861c99c4062f565b8ecac8f633fb1e
+  data.tar.gz: ed5aa61ed58d0cbf203b24b1638fd8b7a89b9659c145fc87096c9ac66d7a08078e82c18aefbb169a5d4ff13dfde3e9e7d9eb25db454200082c14088f3b896108

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "rails", ">= 3.0.0"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+
+gem "rqrcode"
+gem "mini_magick"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Render and customize QR codes from Rails 3 applications
+
+This gem extends rqrcode-rails published by samvincent, supporting the output in either SVG or PNG, JPEG, and GIF formats and
+
+providing new options to set background image combined with QR code image.
+
+
+## Installation
+
+Add the following to your `Gemfile`.
+
+    gem 'custom_rqrcode'
+
+If you want to use the PNG, JPEG or GIF format, you will have to have **ImageMagick** installed on your system.
+You will also want to add the **mini_magick** gem to your application's `Gemfile`.
+
+    gem 'mini_magick'
+
+## How to use
+
+In your controller actions, you could return a QR code that links to the current page like this:
+
+```ruby
+respond_to do |format|
+  format.html
+  format.svg  { render :qrcode => request.url, :level => :l, :unit => 10 }
+  format.png  { render :qrcode => request.url }
+  format.gif  { render :qrcode => request.url }
+  format.jpeg { render :qrcode => request.url }
+end
+```
+  
+#### Options:
+
+* `:size`    – This controls how big the QR Code will be. Smallest size will be chosen by default. Set to maintain consistent size.
+* `:level`   – The error correction level, can be:
+  * Level `:l` 7%  of code can be restored
+  * Level `:m` 15% of code can be restored
+  * Level `:q` 25% of code can be restored
+  * Level `:h` 30% of code can be restored (default :h) 
+* `:offset`  – Padding around the QR Code (e.g. 10)
+* `:unit`    – How many pixels per module (e.g. 11)
+* `:fill`    – Background color (e.g "ffffff" or :white)
+* `:color`   – Foreground color for the code (e.g. "000000" or :black)
+* `:bg`      – Background image to be combined with QR code image (e.g. "./img/000.png")
+* `:gravity` – Location where QR code image will be put on the background image (e.g. "center" or "north")
+
+## About
+
+This project was modified from samvincent's project [rqrcode-rails3](https://github.com/samvincent/rqrcode-rails3)
+
+QR codes are encoded by [rqrcode](https://github.com/whomwah/rqrcode)

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'rqrcode-rails3'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/custom_rqrcode.rb

@@ -0,0 +1,54 @@
+require 'action_controller'
+require 'rqrcode'
+require 'rqrcode-rails3/size_calculator.rb'
+require 'rqrcode-rails3/renderers/svg.rb'
+
+module RQRCode
+	Mime::Type.register "image/svg+xml", :svg  unless Mime::Type.lookup_by_extension(:svg)
+	Mime::Type.register "image/png",     :png  unless Mime::Type.lookup_by_extension(:png)
+	Mime::Type.register "image/jpeg",    :jpeg unless Mime::Type.lookup_by_extension(:jpeg)
+	Mime::Type.register "image/gif",     :gif  unless Mime::Type.lookup_by_extension(:gif)
+
+	extend SizeCalculator
+
+	ActionController::Renderers.add :qrcode do |string, options|
+		format = self.request.format.symbol
+		size   = options[:size]  || RQRCode.minimum_qr_size_from_string(string)
+		level  = options[:level] || :h
+
+		bg     = options[:bg] || false
+
+		qrcode = RQRCode::QRCode.new(string, :size => size, :level => level)
+		svg    = RQRCode::Renderers::SVG::render(qrcode, options)
+
+		data   = \
+		if format && format == :svg
+		svg
+		else
+			image = MiniMagick::Image.read(svg) { |i| i.format "svg" }
+			image.format format
+
+			#image = RQRCode::mergeImages(image, bg) if bg
+			if bg
+				print "=============================="
+				bg_image = MiniMagick::Image.open bg
+				gravity = options[:gravity] || "north"
+				image =  bg_image.composite(image) do |c|
+					c.gravity gravity
+				end
+			end
+
+		image.to_blob
+		end
+
+		self.response_body = render_to_string(:text => data, :template => nil)
+	end
+
+	def mergeImages(image, bg, options)
+		bg_image = MiniMagick::Image.open bg
+		gravity = options[:gravity] || "north"
+		bg_image.composite(image) do |c|
+			c.gravity gravity
+		end
+	end
+end

data/lib/rqrcode-rails3/renderers/svg.rb

@@ -0,0 +1,46 @@
+module RQRCode
+  module Renderers
+    class SVG
+      class << self
+        # Render the SVG from the qrcode string provided from the RQRCode gem
+        #   Options:
+        #   offset - Padding around the QR Code (e.g. 10)
+        #   unit   - How many pixels per module (Default: 11)
+        #   fill   - Background color (e.g "ffffff" or :white)
+        #   color  - Foreground color for the code (e.g. "000000" or :black)
+
+        def render(qrcode, options={})
+          offset  = options[:offset].to_i || 0
+          color   = options[:color]       || "000"
+          unit    = options[:unit]        || 11
+
+          # height and width dependent on offset and QR complexity
+          dimension = (qrcode.module_count*unit) + (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}">}
+          close_tag = "</svg>"
+
+          result = []
+          qrcode.modules.each_index do |c|
+            tmp = []
+            qrcode.modules.each_index do |r|
+              y = c*unit + offset
+              x = r*unit + offset
+
+              next unless qrcode.is_dark(c, r)
+              tmp << %{<rect width="#{unit}" height="#{unit}" x="#{x}" y="#{y}" style="fill:##{color}"/>}
+            end 
+            result << tmp.join
+          end
+          
+          if options[:fill]
+            result.unshift %{<rect width="#{dimension}" height="#{dimension}" x="0" y="0" style="fill:##{options[:fill]}"/>}
+          end
+          
+          svg = [xml_tag, open_tag, result, close_tag].flatten.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/rqrcode-rails3/size_calculator.rb

@@ -0,0 +1,40 @@
+module RQRCode
+  module SizeCalculator
+    # size - seems to follow this logic
+    #     # | input | modules 
+    #       | size  | created
+    #-------|-------|--------
+    #     1 |     7 |      21
+    #     2 |    14 |      25 (+4)
+    #     3 |    24 |      29   -
+    #     4 |    34 |      33   -
+    #     5 |    44 |      37   -
+    #     6 |    58 |      41   -
+    #     7 |    64 |      45   -
+    #     8 |    84 |      49   -
+    #     9 |    98 |      53   -
+    #    10 |   119 |      57   -
+    #    11 |   137 |      61   -
+    #    12 |   155 |      65   -
+    #    13 |   177 |      69   -
+    #    14 |   194 |      73   -
+    
+    QR_CHAR_SIZE_VS_SIZE = [7, 14, 24, 34, 44, 58, 64, 84, 98, 119, 137, 155, 177, 194]
+    
+    def minimum_qr_size_from_string(string)
+      QR_CHAR_SIZE_VS_SIZE.each_with_index do |size, index|
+        return (index + 1) if string.size < size
+      end
+      
+      # If it's particularly big, we'll try and create codes until it accepts
+      i = QR_CHAR_SIZE_VS_SIZE.size
+      begin
+        i += 1
+        RQRCode::QRCode.new(string, :size => i)
+        return i
+      rescue RQRCode::QRCodeRunTimeError
+        retry
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: custom_rqrcode
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Johnson Chang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: Based on Rails, Render QR codes with the ability to customize your own
+  QR codes
+email: johnsonchang2012@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/custom_rqrcode.rb
+- lib/rqrcode-rails3/renderers/svg.rb
+- lib/rqrcode-rails3/size_calculator.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.md
+homepage: http://github.com/johnsonchang2012/custom_rqrcode
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Render QR codes with Rails 3
+test_files: []