rqrcode-rails3 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,19 +1,23 @@
-Render QR Codes easily from your Rails 3 controllers. This gem can return SVG and PNG files.
+= Render QR codes easily from your Rails 3 application
+
+This gem supports rendering either SVG or PNG format.
+
+SVG, because of it's vector nature, will scale easily when intended for print. Offering QR endpoints enables others to integrate with your service in possibly interesting ways.
 
 == Installation
 
-Add the gem to your Gemfile
+Add the following to your +Gemfile+.
 
-  gem "rqrcode-rails3"
+  gem 'rqrcode-rails3'
 
-If you want to use the PNG format, you will have to have ImageMagick installed on your system.
-You will also want to add the "mini_magick" gem to your Gemfile
+If you want to use the PNG 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"
+  gem 'mini_magick'
 
 == How to use
 
-In your controller actions, you can return a QRCode that links to the current page like this:
+In your controller actions, you could return a QR code that links to the current page like this:
 
   respond_to do |format|
     format.html
@@ -21,11 +25,8 @@ In your controller actions, you can return a QRCode that links to the current pa
     format.png { render :qrcode => request.url }
   end
   
-----------------------------------------
-
-This project was inspired by the first chapter in José Valim's book "Crafting Rails Applications."
-QR Codes are encoded by 'rqrcode' [https://github.com/whomwah/rqrcode]
+== About
 
-----------------------------------------
+This project was inspired by the first chapter in José Valim's book {Crafting Rails Applications}[http://pragprog.com/titles/jvrails/crafting-rails-applications]
 
-This project rocks and uses MIT-LICENSE.
+QR codes are encoded by {rqrcode}[https://github.com/whomwah/rqrcode]

data/lib/{rqrcode_rails3.rb → rqrcode-rails3.rb}

@@ -1,6 +1,6 @@
 require 'action_controller'
 require 'rqrcode'
-require 'rqrcode_rails3/renderers/svg.rb'
+require 'rqrcode-rails3/renderers/svg.rb'
 
 module RQRCode
   Mime::Type.register "image/svg+xml", :svg
@@ -10,7 +10,7 @@ module RQRCode
     format = self.request.format.symbol
     
     qrcode = RQRCode::QRCode.new(string)
-    svg    = RQRCode::Renderers::SVG::render(qrcode)
+    svg    = RQRCode::Renderers::SVG::render(qrcode, options)
     
     data = \
     if format == :png

data/lib/{rqrcode_rails3 → rqrcode-rails3}/renderers/svg.rb

@@ -2,9 +2,15 @@ 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)
+        #   fill   - Background color (e.g "ffffff" or :white)
+        #   color  - Foreground color for the code (e.g. "000000" or :black)
+
         def render(qrcode, options={})
-          # Padding around the qrcode 
-          offset = options[:offset] || 0
+          offset  = options[:offset].to_i || 0
+          color   = options[:color]       || "000"
 
           # height and width dependent on offset and QR complexity
           dimension = (qrcode.module_count*11) + (2*offset)
@@ -20,13 +26,16 @@ module RQRCode
               y = c*11 + offset
               x = r*11 + offset
 
-              next unless qrcode.is_dark(c, r) || options[:fill]
-
-              color = qrcode.is_dark(c, r) ? "000" : "fff"
+              next unless qrcode.is_dark(c, r)
               tmp << %{<rect width="11" height="11" 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rqrcode-rails3
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
+  hash: 31
+  prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Sam Vincent
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-22 00:00:00 -07:00
+date: 2011-06-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 0.3.3
   type: :runtime
   version_requirements: *id001
-description: Render QR Codes with Rails 3
+description: Render QR codes with Rails 3
 email: sam.vincent@mac.com
 executables: []
 
@@ -43,8 +43,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/rqrcode_rails3/renderers/svg.rb
-- lib/rqrcode_rails3.rb
+- lib/rqrcode-rails3/renderers/svg.rb
+- lib/rqrcode-rails3.rb
 - MIT-LICENSE
 - Rakefile
 - Gemfile
@@ -79,9 +79,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Render QR Codes with Rails 3
+summary: Render QR codes with Rails 3
 test_files: []