zbar 0.2.0 → 0.2.1

data/README.rdoc

@@ -1,13 +1,13 @@
-= zbar
+= zbar {<img src="https://travis-ci.org/willglynn/ruby-zbar.png?branch=travis" alt="Build Status" />}[https://travis-ci.org/willglynn/ruby-zbar]
 by Will Glynn
 
 http://github.com/willglynn/ruby-zbar
 
-== DESCRIPTION:
+== Description:
 
 Ruby bindings for ZBar, a barcode recognition library.
 
-== SYNOPSIS:
+== Synopsis:
 
   require 'zbar'
   
@@ -19,40 +19,41 @@ Ruby bindings for ZBar, a barcode recognition library.
     @quality=15,
     @symbology="EAN-13">]
 
-== REQUIREMENTS:
+== Download/install:
 
-* FFI
-* ZBar, probably 0.10 or more
+Add to your Gemfile:
 
-ZBar can be obtained from http://zbar.sourceforge.net.
+  gem "zbar"
 
-== DOWNLOAD/INSTALL:
+Otherwise:
 
-From gemcutter:
+  $ [sudo] gem install zbar
 
-  [sudo] gem install zbar
-  
-From github:
+You'll also need the +zbar+ C library to make it work. This might be available from your package manager:
+
+  $ sudo apt-get install libzbar0    # on Debian or Ubuntu
+  $ sudo emerge zbar                 # on Gentoo
+  $ brew install zbar                # on Mac OS X with Homebrew
 
-  git clone git://github.com/delta407/ruby-zbar.git
-  cd ruby-zbar
-  rake install
+Alternately, install from source at http://zbar.sf.net/.
 
-== LIMITATIONS:
+== Limitations:
 
 Doesn't expose all ZBar functionality, including:
 * No video functions
 * No low-level interfaces (scanner, decoder)
 
-== Note on Patches/Pull Requests
+Additionally, there is a zbar <= 0.10 issue with JPEG decoding; see {lib/zbar/jpeg.rb}[https://github.com/willglynn/ruby-zbar/blob/master/lib/zbar/jpeg.rb] for more. You can check your ZBar::JPEG.bugged? status if you're curious. Otherwise, just try using it, and see if you get a warning on stderr.
+
+== Contributing
  
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Commit. Don't change +VERSION+, or if you do, do it in a separate commit.
 * Send me a pull request. Bonus points for topic branches.
+* Watch the Travis-CI build status on your pull request. Fix any problems.
 
 == Copyright
 

data/Rakefile

@@ -19,6 +19,7 @@ Jeweler::Tasks.new do |gem|
   gem.email = "will@willglynn.com"
   gem.homepage = "http://github.com/delta407/ruby-zbar"
   gem.authors = ["Will Glynn"]
+  gem.post_install_message = "\nzbar: This gem depends on the \"zbar\" C library.\n      If it's not installed, `require \"zbar\"` will fail.\n\n"
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/zbar.rb

@@ -1,6 +1,7 @@
 require 'ffi'
 
 require 'zbar/lib'
+require 'zbar/library_version'
 require 'zbar/symbol'
 require 'zbar/processor'
 require 'zbar/image'

data/lib/zbar/lib.rb

@@ -11,7 +11,7 @@ module ZBar
   rescue LoadError => le
     raise LoadError, [
       "Didn't find libzbar on your system",
-      "Please install zbar (http://zbar.sourceforge.net/) or ZBAR_LIB if it's in a weird place",
+      "Please install zbar (http://zbar.sourceforge.net/) or set ZBAR_LIB if it's in a weird place",
       "FFI::Library::ffi_lib() failed with error: #{le}"
     ].join("\n")
   end
@@ -24,7 +24,7 @@ module ZBar
   attach_function :zbar_symbol_get_loc_x, [:pointer, :uint], :int
   attach_function :zbar_symbol_get_loc_y, [:pointer, :uint], :int
   attach_function :zbar_symbol_next, [:pointer], :pointer
-    
+  
   attach_function :zbar_image_create, [], :pointer
   attach_function :zbar_image_destroy, [:pointer], :void
   attach_function :zbar_image_first_symbol, [:pointer], :pointer
@@ -34,16 +34,17 @@ module ZBar
   attach_function :zbar_image_get_height, [:pointer], :int
   attach_function :zbar_image_set_size, [:pointer, :uint, :uint], :void
   attach_function :zbar_image_set_data, [:pointer, :buffer_in, :uint, :pointer], :void
-
+  
   attach_function :zbar_processor_create, [:int], :pointer
   attach_function :zbar_processor_destroy, [:pointer], :void
   attach_function :zbar_processor_init, [:pointer, :string, :int], :int
   attach_function :zbar_processor_set_config, [:pointer, :int, :int, :int], :int
   
   attach_function :zbar_process_image, [:pointer, :pointer], :int
-
+  
   attach_function :zbar_parse_config, [:string, :pointer, :pointer, :pointer], :int
-
+  
+  attach_function :zbar_version, [:pointer, :pointer], :int
   attach_function :zbar_set_verbosity, [:int], :void
   attach_function :zbar_get_symbol_name, [:int], :string
   attach_function :zbar_get_addon_name, [:int], :string

data/lib/zbar/library_version.rb

@@ -0,0 +1,41 @@
+module ZBar
+  # Returns a ZBar::LibraryVersion representing the currently loaded library.
+  def self.library_version
+    @library_version ||= begin
+      major = FFI::MemoryPointer.new :uint
+      minor = FFI::MemoryPointer.new :uint
+      rv = zbar_version(major, minor)
+      if rv == 0
+        LibraryVersion.new(major.read_uint, minor.read_uint)
+      else
+        raise "zbar_version failed, returning #{rv}"
+      end
+    end
+  end
+  
+  # Represents a version of the ZBar library, e.g. as returned by
+  # ZBar.library_version.
+  class LibraryVersion
+    def initialize(major, minor) #:nodoc:
+      @major, @minor = major, minor
+    end
+    
+    # Major version number
+    attr_reader :major
+    
+    # Minor version number
+    attr_reader :minor
+    
+    # Compare this version to another LibraryVersion
+    def <=>(other)
+      [major, minor] <=> [other.major, other.minor]
+    end
+    
+    include Comparable
+    
+    # Format the library version as a string
+    def to_s
+      "#{major}.#{minor}"
+    end
+  end
+end

data/spec/zbar/library_version_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ZBar::LibraryVersion do
+  let(:major) { 10 }
+  let(:minor) { 99 }
+  let(:library_version) { described_class.new(major, minor) }
+  subject { library_version }
+  
+  its(:major) { should be_kind_of Fixnum }
+  its(:minor) { should be_kind_of Fixnum }
+  
+  describe "to_s" do
+    subject { library_version.to_s }
+    it { should be_kind_of String }
+    it "is formatted as major.minor" do
+      should == "#{major}.#{minor}"
+    end
+  end
+  
+  describe "comparisons" do
+    let(:bigger_major) { described_class.new(major + 1, minor)}
+    let(:bigger_minor) { described_class.new(major, minor + 1)}
+    let(:equal) { described_class.new(major, minor)}
+    
+    it { should be_kind_of Comparable }
+    
+    it "compares minors" do
+      library_version.should < bigger_minor
+      bigger_minor.should > library_version
+    end
+    it "compares majors" do
+      library_version.should < bigger_major
+      bigger_major.should > library_version
+    end
+    it "compares equally" do
+      library_version.should == equal
+      equal.should == library_version
+    end
+  end
+end

data/spec/zbar_spec.rb

@@ -2,4 +2,15 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe ZBar do
   it { should be_kind_of Module }
+  
+  describe "library_version" do
+    it "calls zbar_version(uint*, uint*)" do
+      ZBar.should_receive(:zbar_version).with(anything, anything).and_return(0)
+      ZBar.library_version
+    end
+    
+    it "returns LibraryVersion" do
+      ZBar.library_version.should be_kind_of ZBar::LibraryVersion
+    end
+  end
 end

data/zbar.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "zbar"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Will Glynn"]
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "lib/zbar/image.rb",
     "lib/zbar/jpeg.rb",
     "lib/zbar/lib.rb",
+    "lib/zbar/library_version.rb",
     "lib/zbar/processor.rb",
     "lib/zbar/symbol.rb",
     "spec/spec_helper.rb",
@@ -36,11 +37,13 @@ Gem::Specification.new do |s|
     "spec/support/test.jpg",
     "spec/support/test.pgm",
     "spec/zbar/image_spec.rb",
+    "spec/zbar/library_version_spec.rb",
     "spec/zbar/processor_spec.rb",
     "spec/zbar_spec.rb",
     "zbar.gemspec"
   ]
   s.homepage = "http://github.com/delta407/ruby-zbar"
+  s.post_install_message = "\nzbar: This gem depends on the \"zbar\" C library.\n      If it's not installed, `require \"zbar\"` will fail.\n\n"
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.25"
   s.summary = "Ruby bindings for ZBar, a barcode recognition library"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zbar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -128,6 +128,7 @@ files:
 - lib/zbar/image.rb
 - lib/zbar/jpeg.rb
 - lib/zbar/lib.rb
+- lib/zbar/library_version.rb
 - lib/zbar/processor.rb
 - lib/zbar/symbol.rb
 - spec/spec_helper.rb
@@ -135,12 +136,14 @@ files:
 - spec/support/test.jpg
 - spec/support/test.pgm
 - spec/zbar/image_spec.rb
+- spec/zbar/library_version_spec.rb
 - spec/zbar/processor_spec.rb
 - spec/zbar_spec.rb
 - zbar.gemspec
 homepage: http://github.com/delta407/ruby-zbar
 licenses: []
-post_install_message: 
+post_install_message: ! "\nzbar: This gem depends on the \"zbar\" C library.\n      If
+  it's not installed, `require \"zbar\"` will fail.\n\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -152,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4088186622936310540
+      hash: 481266142629962502
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: