rqrcode_png 0.0.1 → 0.1.0

data/README.markdown

@@ -1,19 +1,53 @@
 # rqrcode_png
+**Problem:** You need to generate your own QR code images  
+**Solution:** rqrcode_png
 
 ## Overview
-rQRcode is a great library that generates the 2D sequence of a QR code, and chunky_png is a great pure ruby library for generating and manipulating images.
+rqrcode_png extends [rqrcode](https://github.com/whomwah/rqrcode), adding one simple method to instances of QRCode, **\#to_img**. [ChunkyPNG](https://github.com/wvanbergen/chunky_png) is used to generate the image itself in pure Ruby. As few assumptions are made as possible regarding the image itself.
 
-rqrcode_png ties the two libraries together. rqrcode_png assumes as little as possible.
 
 ## Usage
-qrqcode_png extends RQRCode::QRCode with one simple method, #to_img.
-
-\#to_img returns an instance of ChunkyPNG. The image itself is 37x37 pixels which includes a 2 pixel border, which can easily be resized and saved.
 
 ```ruby
+require 'rqrcode_png'
+
 qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
-png = qr.to_img
-png.resize(90, 90).save("really_cool_qr_image.png")			# ChunkyPNG methods
+png = qr.to_img												# returns an instance of ChunkyPNG
+png.resize(90, 90).save("really_cool_qr_image.png")
+```
+
+### Bundler
+```ruby
+gem 'rqrcode_png'
+```
+
+### Rails
+
+#### With [DragonFly](https://github.com/markevans/dragonfly)
+
+```ruby
+# app/models/product.rb
+class Product < ActiveRecord::Base
+  image_accessor :qr_code
+end
+```
+
+```ruby
+# somewhere
+qr_code_img = RQRCode::QRCode.new('http://www.google.com/').to_img
+@product.update_attribute :qr_code, qr_code_img.to_string
+```
+
+```ruby
+# app/controllers/products.rb
+def show
+	@product = Product.find(params[:id])
+end
+```
+
+```ruby
+# app/views/products/show.html.erb
+<%= image_tag @product.qr_code.url %>
 ```
 
 ## Contributing
@@ -22,6 +56,5 @@ png.resize(90, 90).save("really_cool_qr_image.png")			# ChunkyPNG methods
 * Don't touch the .gemspec, I'll do that when I release a new version
 
 ## Copyright
-
 MIT Licence (http://www.opensource.org/licenses/mit-license.html)
 

data/lib/rqrcode_png.rb

@@ -1,8 +1,9 @@
-require "chunky_png"
+require 'chunky_png'
 require 'rqrcode'
 
-require "rqrcode_png/version"
-require "rqrcode_png/image"
-require "rqrcode_png/qrcode_extensions"
+require 'rqrcode_png/version'
+require 'rqrcode_png/sequence'
+require 'rqrcode_png/image'
+require 'rqrcode_png/qrcode_extensions'
 
 RQRCode::QRCode.send :include, RQRCodePNG::QRCodeExtensions

data/lib/rqrcode_png/image.rb

@@ -6,10 +6,8 @@ module RQRCodePNG
 		BLACK					 = ::ChunkyPNG::Color::BLACK
 		WHITE					 = ::ChunkyPNG::Color::WHITE
 
-		attr_accessor :qr_code
-		
 		def initialize(qr_code)
-			self.qr_code = qr_code
+			@sequence = Sequence.new(qr_code)
 		end
 
 		#
@@ -18,7 +16,7 @@ module RQRCodePNG
 		def render
 			png = blank_img()
 
-			qr_code().dark_squares_only do |x, y|
+			@sequence.dark_squares_only do |x, y|
 				png[y + BORDER, x + BORDER] = BLACK
 			end
 

data/lib/rqrcode_png/qrcode_extensions.rb

@@ -1,25 +1,13 @@
 module RQRCodePNG
 	
 	module QRCodeExtensions 
+		
+		#
 		# This method returns a 33x33 .png of the code
 		#
 		def to_img
 			return Image.new(self).render()
 		end
-
-		#
-		# This method yields the vertices of the dark squares
-		#
-		def dark_squares_only(&block)
-			self.modules.each_index do |row|
-				self.modules.each_index do |column|
-					if self.dark?(row, column)
-						yield row, column
-					end
-				end 
-			end
-
-		end
 	
 	end
 end

data/lib/rqrcode_png/sequence.rb

@@ -0,0 +1,24 @@
+module RQRCodePNG
+
+	class Sequence
+		
+		def initialize(qr_code)
+			@qr_code = qr_code
+		end
+
+		#
+		# This method yields the vertices of the dark squares
+		#
+		def dark_squares_only(&block)
+			@qr_code.modules.each_index do |row|
+				@qr_code.modules.each_index do |column|
+					if @qr_code.dark?(row, column)
+						yield row, column
+					end
+				end 
+			end
+
+		end
+
+	end
+end

data/lib/rqrcode_png/version.rb

@@ -1,3 +1,3 @@
 module RqrcodePng
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode_png
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-08 00:00:00.000000000Z
+date: 2011-10-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
-  requirement: &2157538300 !ruby/object:Gem::Requirement
+  requirement: &2156140160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157538300
+  version_requirements: *2156140160
 - !ruby/object:Gem::Dependency
   name: rqrcode
-  requirement: &2157537880 !ruby/object:Gem::Requirement
+  requirement: &2156139740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157537880
+  version_requirements: *2156139740
 description: Glues rQRCode together with chunky_png
 email:
 - dcarper@dreamagile.com
@@ -48,6 +48,7 @@ files:
 - lib/rqrcode_png.rb
 - lib/rqrcode_png/image.rb
 - lib/rqrcode_png/qrcode_extensions.rb
+- lib/rqrcode_png/sequence.rb
 - lib/rqrcode_png/version.rb
 - rqrcode_png.gemspec
 homepage: ''