qrencoder 1.0.0 → 1.2.0

data/lib/qrencoder/qrcode.rb

@@ -0,0 +1,54 @@
+require 'png'
+
+module QREncoder
+  # Stores and represents data, points, and/or pixels for a QRCode
+  class QRCode
+    ##
+    # Shortcut to save the QRcode as a PNG at +path+ using default options.
+    #
+    # For more control, or to specify non-default options, see QRCode#png
+    def save_png(path)
+      png.save(path)
+    end
+
+    ##
+    # Returns an instance of PNG, which can be saved to a file with PNG#save or
+    # converted to a blob for inline file transfer with PNG#to_blob. For more
+    # information, see http://seattlerb.rubyforge.org/png/
+    #
+    # Options:
+    #
+    # [:margin] A pixel value for the margin around each side of the code. This should be 4 or greater. (default: +4+)
+    # [:transparent] Background transparency. Can be true or false. (default: +false+)
+    #
+    def png(options={})
+      PNG.new(canvas(options))
+    end
+
+    ##
+    # Returns an instance of PNG::Canvas
+    #
+    # Takes an optional hash of options. See QRCode#png for details.
+    def canvas(options={})
+      @margin = options[:margin] || 4
+      background = options[:transparent] ? PNG::Color::Background : PNG::Color::White
+      png_width = width + (2 * @margin)
+
+      canvas = PNG::Canvas.new(png_width, png_width, background)
+
+      points.each do |p|
+        x, y = png_coordinates_for_point(p)
+        canvas[x,y] = PNG::Color::Black
+      end
+
+      canvas
+    end
+
+    private
+    def png_coordinates_for_point(point)
+      x = point[0] + @margin
+      y = width - 1 - point[1] + @margin
+      [x,y]
+    end
+  end
+end

data/lib/qrencoder/version.rb

@@ -0,0 +1,3 @@
+module QREncoder
+  VERSION = '1.2.0'
+end

data/spec/qrcode_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+require 'fixtures'
+
+describe QREncoder::QRCode do
+
+  describe "#data" do
+    context "with default options and 'String'" do
+      subject { QREncoder.encode("String").data }
+      it { should be_kind_of(Array) }
+      it "generates the correct data array" do
+        subject.should == QREncoder::Fixtures::String1
+      end
+    end
+    context "with version 4 and 'String'" do
+      subject { QREncoder.encode("String", :version => 4).data }
+      it { should be_kind_of(Array) }
+      it "generates the correct data array" do
+        subject.should == QREncoder::Fixtures::String4
+      end
+    end
+  end
+
+  describe "#dup" do
+    subject { QREncoder.encode("something").dup }
+    its(:width) { should == 21 } 
+  end
+
+  describe "#width" do
+    subject { QREncoder.encode("something").width }
+    it { should == 21 } 
+  end
+
+  describe "#version" do
+
+    context "when not specified" do
+      subject { QREncoder.encode(string).version }
+      context "and string fits within version 1" do
+        let(:string) { "hello" }
+        it { should == 1 }
+      end
+      context "and string is too large for version 1" do
+        let(:string) { "hello" }
+        it { should == 1 }
+      end
+    end
+
+    context "when specified" do
+      subject { QREncoder.encode(string, :version => 2).version }
+      context "and string fits within specified version" do
+        let(:string) { "hello" }
+        it { should == 2 }
+      end
+      context "and string is too large for specified version" do
+        let(:string) { "Lorem ipsum dolor et al and then some more content" }
+        it { should == 3 }
+      end
+    end
+
+  end
+
+  describe "#width" do
+    subject { QREncoder.encode("test", :version => version).width }
+    context "with version 1" do
+      let(:version) { 1 }
+      it { should == 21 }
+    end
+    context "with version 2" do
+      let(:version) { 2 }
+      it { should == 25 }
+    end
+    context "with version 3" do
+      let(:version) { 3 }
+      it { should == 29 }
+    end
+    context "with version 4" do
+      let(:version) { 4 }
+      it { should == 33 }
+    end
+    context "with version 5" do
+      let(:version) { 5 }
+      it { should == 37 }
+    end
+    context "with version 6" do
+      let(:version) { 6 }
+      it { should == 41 }
+    end
+    context "with version 11" do
+      let(:version) { 11 }
+      it { should == 61 }
+    end
+    context "with version 15" do
+      let(:version) { 15 }
+      it { should == 77 }
+    end
+    context "with version 40 (the maximum)" do
+      let(:version) { 40 }
+      it { should == 177 }
+    end
+  end
+
+  describe "#height" do
+    subject { QREncoder.encode("test") }
+    it "should be the same as the width" do
+      subject.height.should == subject.width
+    end
+  end
+
+  describe "#pixels" do
+    let(:qrcode) { QREncoder.encode("hi") }
+    let(:pixels) do
+      arr = []
+      qrcode.data.each_slice(qrcode.width) do |a|
+        arr << a.map { |p| p & 0x1 }
+      end
+      arr
+    end
+
+    it "provides pixel data" do
+      qrcode.pixels.should == pixels
+    end
+  end
+
+  describe "#points" do
+    let(:qrcode) { QREncoder.encode("hi") }
+    let(:points) do
+      arr = []
+      y = 0
+      qrcode.data.each_slice(qrcode.width) do |r|
+        x = 0;
+        r.each do |p|
+          if (p & 0x1) == 1
+            arr << [x, y]
+          end
+          x += 1
+        end
+        y += 1
+      end
+      arr
+    end
+
+    it "provides point data" do
+      qrcode.points.should == points
+    end
+  end
+
+  describe "#canvas" do
+    let(:qrcode) { QREncoder.encode("hi") }
+
+    it "returns an instance of PNG::Canvas" do
+      qrcode.canvas.should be_kind_of(PNG::Canvas)
+    end
+
+    context "with no options specified" do
+      subject { qrcode.canvas }
+      its(:width) { should == qrcode.width + (4 * 2) }
+      specify "background should be white" do
+        subject.data.first.first.should == PNG::Color::White
+      end
+    end
+
+    context "with margin option of 8" do
+      subject { qrcode.canvas(:margin => 8) }
+      its(:width) { should == qrcode.width + (8 * 2) }
+    end
+
+    context "with transparent set to true" do
+      subject { qrcode.canvas(:transparent => true) }
+      specify "background should be transparent" do
+        subject.data.first.first.should == PNG::Color::Background
+      end
+    end
+  end
+
+  describe "#png" do
+    let(:qrcode) { QREncoder.encode("hi") }
+
+    it "returns an instance of PNG" do
+      qrcode.png.should be_kind_of(PNG)
+    end
+
+    it "sends options to #canvas" do
+      canvas = PNG::Canvas.new(1,1)
+      options = { :margin => 5, :transparent => true }
+      qrcode.should_receive(:canvas).with(options).and_return(canvas)
+      qrcode.png(options)
+    end
+  end
+
+  describe "#save_png" do
+    let(:qrcode) { QREncoder.encode("hi") }
+    let(:path) do
+      File.expand_path("../../tmp/test.png", __FILE__)
+    end
+
+    before { File.unlink(path) if File.file?(path) }
+
+    it "saves a png image to path specified" do
+      qrcode.save_png(path)
+      File.open(path) { true }
+      File.size(path).should_not be_zero
+    end
+  end
+
+end

data/spec/qrencoder_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe QREncoder do
+
+  describe ".encode" do
+    context "when passed a string" do
+      subject { QREncoder.encode("string") }
+
+      it { should be_a_kind_of(QREncoder::QRCode) }
+    end
+
+    context "when passed a string and version option" do
+      subject { QREncoder.encode("string", :version => 2) }
+
+      it { should be_a_kind_of(QREncoder::QRCode) }
+      it "encodes using the specified version" do
+        QREncoder::QRCode.should_receive(:new).with("string",
+                                                    2,
+                                                    QREncoder::QR_ECLEVEL_L,
+                                                    QREncoder::QR_MODE_8,
+                                                    1)
+        subject
+      end
+    end
+
+    context "when passed a string and correction option" do
+      subject { QREncoder.encode("string", :correction => :high) }
+
+      it { should be_a_kind_of(QREncoder::QRCode) }
+      it "encodes using the specified correction mode" do
+        QREncoder::QRCode.should_receive(:new).with("string",
+                                                    1,
+                                                    QREncoder::QR_ECLEVEL_H,
+                                                    QREncoder::QR_MODE_8,
+                                                    1)
+        subject
+      end
+    end
+
+    context "when passed a string and mode option" do
+      subject { QREncoder.encode("string", :mode => :alphanumeric) }
+
+      it { should be_a_kind_of(QREncoder::QRCode) }
+      it "encodes using the specified mode" do
+        QREncoder::QRCode.should_receive(:new).with("string",
+                                                    1,
+                                                    QREncoder::QR_ECLEVEL_L,
+                                                    QREncoder::QR_MODE_AN,
+                                                    1)
+        subject
+      end
+    end
+
+    context "when passed a string and case_sensitive option" do
+      subject { QREncoder.encode("string", :case_sensitive => false) }
+
+      it { should be_a_kind_of(QREncoder::QRCode) }
+      it "encodes using the specified case sensitivity" do
+        QREncoder::QRCode.should_receive(:new).with("string",
+                                                    1,
+                                                    QREncoder::QR_ECLEVEL_L,
+                                                    QREncoder::QR_MODE_8,
+                                                    0)
+        subject
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+root = File.expand_path('../..', __FILE__)
+Dir["#{root}/spec/support/**/*.rb"].each {|f| require f}
+
+Bundler.require

metadata

@@ -1,78 +1,159 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.1
-specification_version: 1
 name: qrencoder
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2007-01-24 00:00:00 -05:00
-summary: A gem for creating 2-dimensional barcodes following the QR Code specification.
-require_paths: 
-- lib
-email: harrisj@schizopolis.net
-homepage: http://nycrb.rubyforge.org/qrencoder
-rubyforge_project: nycrb
-description: The author was too lazy to write a description
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Jacob Harris
-files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- bin/qrencoder
-- lib/qrencoder.rb
-- test/test_qrencoder.rb
-test_files: 
-- test/test_qrencoder.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: 
-- qrencoder
-extensions: []
-
-requirements: []
+- Joshua Davey
+- Wesley Moore
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2010-11-23 00:00:00 -06:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: RubyInline
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.6.2
-    version: 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 5
+        version: 0.7.5
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 20
+        version: 0.2.20
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: png
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.0.0
-    version: 
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  name: RubyInline
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.7
-    version: 
+        segments: 
+        - 3
+        - 6
+        - 2
+        version: 3.6.2
+  type: :runtime
+  version_requirements: *id005
+description: |-
+  This Gem is a wrapper around an useful open-source library for creating QR
+    Codes, a two-dimensional bar code format popular in Japan created by the Denso-Wave Corporation in 1994.
+email: 
+- harrisj@schizopolis.net
+- josh@joshuadavey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- ext/qrencoder_ext/qrencoder_ext.c
+files: 
+- lib/qrencoder/qrcode.rb
+- lib/qrencoder/qrencoder_ext.bundle
+- lib/qrencoder/version.rb
+- lib/qrencoder.rb
+- ext/qrencoder_ext/extconf.rb
+- ext/qrencoder_ext/qrencoder_ext.c
+- History.txt
+- README.rdoc
+- spec/qrcode_spec.rb
+- spec/qrencoder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://nycrb.rubyforge.org/qrencoder
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper around the C qrencode library for creating QR Codes
+test_files: 
+- spec/qrcode_spec.rb
+- spec/qrencoder_spec.rb
+- spec/spec_helper.rb