qrcoder 0.1

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+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,77 @@
+# Creates QR codes images 
+
+This library is fork of Sam Vincent rqrcode-rails3 https://github.com/samvincent/rqrcode-rails3
+Dependes on mini_magic and [rqrcode](https://github.com/whomwah/rqrcode) 
+
+This gem supports generating QR images in SVG, BMP, TIF, JPG, GIF and PNG format. 
+
+## Installation
+
+Add the following to your +Gemfile+.
+
+    gem 'rqrcoder'
+
+or 
+
+    gem install rqrcoder
+
+## How to use
+
+### Image method 
+
+If you use image method you must define output format. 
+
+Allowed formats are 
+  
+  * png 
+  * bmp 
+  * svg 
+  * jpg
+  * gif 
+  * tif
+
+  QRCode.image(text, output, options)
+
+Examples 
+
+    QRCode.image("some text", "/home/user/", :format => [:png, :svg], :filename => "simple_test" 
+    QRCode.image("some text", "/home/user/", :format => :png, :filename => "simple_test" , :unit => 12
+
+### SVG output
+  
+Return svg output 
+
+    QRCode.svg(text, output, options)
+
+Example
+
+    QRCode.svg("some text", "/home/user", :filename => "simple_test", :unit => 12) 
+
+### Other methods
+
+You can use other methods
+  
+    QRCode.bmp(text, output, options)
+    QRCode.png(text, output, options)
+    QRCode.jpg(text, output, options)
+    QRCode.tif(text, output, options)
+    QRCode.gif(text, output, options)
+  
+#### Options:
+
+* `:size`   – This controls how big the QR Code will be. The 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)
+  
+## About
+
+This library is fork of Sam Vincent [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 'rdoc/task'
+
+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    = 'rqrcoder'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/rqrcoder.rb

@@ -0,0 +1,112 @@
+require 'rqrcode'
+require 'rqrcoder/size_calculator.rb'
+require 'rqrcoder/renderers/svg.rb'
+require 'mini_magick'
+
+module QRCoder
+  extend SizeCalculator
+
+  class QRCodeError < StandardError; end
+
+  class QRCode 
+    IMAGE_FORMATS = [:jpg , :png, :gif, :tif, :bmp]
+
+    class << self
+
+      # 
+      # Create qr image or images 
+      #
+      # == Parameters
+      #
+      # * text    <tt>String</tt> -- String for qrcode
+      # * output  <tt>String</tt> -- String for path where to save files
+      # * options <tt>Hash</tt>   -- Hash with options
+      #
+      # === Options  
+      #
+      # * :format   - Array or symbol. Allowed formats are :png, :bmp, :svg, :jpg, :gif and :tif
+      # * :filename - String for filename without extension. Extension will be added automaticly.
+      # * :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)
+      #
+      # === Example 
+      # 
+      #  QRCode.image("some text", "/home/user/", :format => [:png, :svg], :filename => "simple_test" 
+      #  QRCode.image("some text", "/home/user/", :format => :png, :filename => "simple_test" , :unit => 12
+      #
+      def image text, output, options
+        formats = []
+        if options[:format].kind_of? Array
+          formats = options[:format]
+        else
+          formats << options[:format] || :png
+        end
+        filename = options[:filename] || text
+        svg      = self.svg(text, options)
+
+        err_f = formats - IMAGE_FORMATS - [:svg]
+        raise QRCodeError.new("#{err_f.join(', ')} is not supported file formats") unless(err_f.empty?)
+
+        begin 
+          formats.each do |format|
+            if IMAGE_FORMATS.include?(format)
+              image = MiniMagick::Image.read(svg) { |i| i.format "svg" }
+              image.format format.to_s
+              image.write "#{output}/#{filename}.#{format}"
+            else
+              data = svg
+              file = File.new("#{output}/#{filename}.#{format}", "w")
+              file.write(data)
+              file.close
+            end
+          end
+        rescue 
+          raise QRCodeError.new "File saving error"
+        end
+      end
+
+      # Create qr code svg output response 
+      # * text    <tt>String</tt> -- String for qrcode
+      # * options <tt>Hash</tt>   -- Hash with options
+      #
+      # === Options  
+      #
+      # * :format   - Array or symbol. Allowed formats are :png, :bmp, :svg, :jpg, :gif and :tif
+      # * :filename - String for filename without extension. Extension will be added automaticly.
+      # * :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)
+      #
+      def svg text, options ={}
+        size   = options[:size]  || QRCoder.minimum_qr_size_from_string(text)
+        level  = options[:level] || :h
+        qrcode = RQRCode::QRCode.new(text, :size => size, :level => level)
+        QRCoder::Renderers::SVG::render(qrcode, options)
+      end
+
+
+      IMAGE_FORMATS.each do |format| 
+        define_method format.to_s do |text, output, options|
+          options[:format] = [format]
+          self.image text, output, options
+        end
+      end
+    end
+  end
+
+end

data/lib/rqrcoder/renderers/svg.rb

@@ -0,0 +1,46 @@
+module QRCoder
+  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/rqrcoder/size_calculator.rb

@@ -0,0 +1,40 @@
+module QRCoder
+  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
+        QRCoder::QRCode.new(string, :size => i)
+        return i
+      rescue QRCoder::QRCodeRunTimeError
+        retry
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: qrcoder
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Bojan Milosavljevic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: &2153265160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153265160
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: &2153264660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153264660
+description: Creates QR code files in png, bmp, png, jpg, tif and svg file format.
+  This is fork of sam vincent rqrcode-rails3
+email: milboj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rqrcoder/renderers/svg.rb
+- lib/rqrcoder/size_calculator.rb
+- lib/rqrcoder.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.md
+homepage: http://github.com/milboj/rqrcoder
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Creates QR code files
+test_files: []