zint 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+pkg/*
+doc/*
+*.gem
+.bundle
+.yardoc/*
+out.png
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in zint.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,47 @@
+= Zint 
+
+-----------
+
+This is a Ruby FFI wrapper for the Zint barcode generation library (http://www.zint.org.uk/zintSite). You must have Zint installed on your system for this gem to work at all. Note that this is an alpha release and just gets the essentials done. fork the code and add tests of more barcode coverage.
+
+
+== Install
+
+As mentioned, you must install the zint project to be able to use this gem. Once that dependency is satisfied, then you can just do the usual gem install.
+  
+  gem install zint
+  
+
+== Usage
+
+Summary 
+
+  require 'zint'
+  # Create a code-128 barcode
+  bc = Zint::Barcode.new("test")
+  bc.print! # file is now on relative path "out.png"
+  bc.path = "my_bc.png"
+  bc.print! # file is now on relative path "my_bc.png"
+  bc.path = "my_bc.svg"
+  bc.print!
+  bc.print! # file is now on relative path "my_bc.svg"
+  
+  # create a qrcode
+  qrcode = Zint::Barcode.new("test", Zint::BARCODE_QRCODE)
+  qrcode.path = "qrcode.png"
+  qrcode.print! # file is now on relative path "qrcode.png"
+  qrcode_string = qrcode.buffer!
+  puts qrcode_string
+  
+  #QRCode with more options, specifically set a high error correction capacity
+  qrcode = Zint::QRCode.new("test", Zint::QRCode::ECC_H)
+  qrcode.path = "qrcode.ecc_h.png"
+  qrcode.print! # file is now on relative path "qrcode.ecc_h.png"
+  # encode barcode as text
+  qrcode.path = "qrcode.ecc_h.txt"
+  puts qrcode.buffer!
+  
+  
+  
+  
+TODO: Add more documentation

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rake'
+require 'rake/testtask'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern =   'test/*_test.rb'
+  t.verbose = false
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', "README.rdoc"]   # optional
+end

data/lib/zint.rb

@@ -0,0 +1,11 @@
+require 'ffi'
+require 'tmpdir'
+require 'zint/version'
+require 'zint/zint_symbol'
+require 'zint/wrapper'
+require 'zint/barcode'
+require 'zint/qrcode'
+require 'zint/upc'
+require 'zint/ean'
+require 'zint/data_matrix'
+require 'zint/exception'

data/lib/zint/barcode.rb

@@ -0,0 +1,62 @@
+module Zint
+  # A base class to represent the barcode being encoded
+  class Barcode
+    # The encoded value of the barcode
+    attr_accessor :value
+    # The type of barcode generated (e.g. UPC, QRCode, Data Matrix)
+    attr_accessor :bctype
+    # The output file path
+    attr_reader :path
+    # Access for the underlying FFI ManagedStruct of the Zint C struct 
+    attr_reader :zint_symbol
+    
+    def initialize(value, bctype=Zint::BARCODE_CODE128, &options)
+      options ||={}
+      @zint_symbol = Zint::Wrapper.create(bctype)
+      @bctype = bctype
+      @value = value
+      @encoded = false
+      if options[:path] 
+        @path = options[:path]
+        @zint_symbol[:outfile]= @path
+      else
+        @path = File.join(Dir.pwd,  "out.png")
+        @zint_symbol[:outfile]= @path
+      end
+    end
+    
+    def path=(fspath)
+      @path = fspath
+      @zint_symbol[:outfile] = @path
+      @encoded = false
+      return @path
+    end
+    
+    def encode!
+      return if @encoded
+      err = Zint::Wrapper.zint_encode(@zint_symbol, @value, 0)
+      if Zint::ERR[:err]
+        raise Zint::Exception.new(@zint_symbol[:errtxt])
+      end
+      @encoded = true
+    end
+    
+    def print!
+      encode!
+      err = Zint::Wrapper.zint_print(@zint_symbol, 0)
+      if Zint::ERR[:err]
+        raise Zint::Exception.new(@zint_symbol[:errtxt])
+      end        
+    end
+    
+    def buffer!
+      tmp = File.join(Dir.tmpdir, File.basename(@path))
+      @zint_symbol[:outfile] = tmp
+      print!
+      @zint_symbol[:outfile] = @path
+      buffer = File.read(tmp)
+      File.unlink(tmp)
+      return buffer
+    end
+  end
+end

data/lib/zint/data_matrix.rb

@@ -0,0 +1,8 @@
+module Zint
+  class DataMatrix < Barcode
+    def initialize(value)
+      super(value, Zint::BARCODE_DATAMATRIX)
+      @zint_symbol[:option_2] = Zint::DM_SQUARE
+    end
+  end
+end

data/lib/zint/ean.rb

@@ -0,0 +1,7 @@
+module Zint
+  class Ean < Barcode
+    def initialize(value)
+      super(value, Zint::BARCODE_EANX)
+    end
+  end
+end

data/lib/zint/exception.rb

@@ -0,0 +1,4 @@
+module Zint
+  class Exception < ::Exception
+  end
+end

data/lib/zint/qrcode.rb

@@ -0,0 +1,14 @@
+module Zint
+  class QRCode < Barcode
+    ECC_L = 1
+    ECC_M = 2
+    ECC_Q = 3
+    ECC_H = 4
+    
+    def initialize(value, ecc=ECC_L)
+      super(value, Zint::BARCODE_QRCODE)
+      @zint_symbol[:option_1] = ecc
+      return self
+    end
+  end
+end

data/lib/zint/upc.rb

@@ -0,0 +1,7 @@
+module Zint
+  class Upc < Barcode
+    def initialize(value)
+      super(value, Zint::BARCODE_UPCA)
+    end
+  end
+end

data/lib/zint/version.rb

@@ -0,0 +1,3 @@
+module Zint
+  VERSION = "0.0.1"
+end

data/lib/zint/wrapper.rb

@@ -0,0 +1,160 @@
+module Zint  
+  
+  # Symbologies
+  BARCODE_CODE11          = 1
+  BARCODE_C25MATRIX       = 2
+  BARCODE_C25INTER        = 3
+  BARCODE_C25IATA         = 4
+  BARCODE_C25LOGIC        = 6
+  BARCODE_C25IND          = 7
+  BARCODE_CODE39          = 8
+  BARCODE_EXCODE39        = 9
+  BARCODE_EANX            = 13
+  BARCODE_EAN128          = 16
+  BARCODE_CODABAR         = 18
+  BARCODE_CODE128         = 20
+  BARCODE_DPLEIT          = 21
+  BARCODE_DPIDENT         = 22
+  BARCODE_CODE16K         = 23
+  BARCODE_CODE49          = 24
+  BARCODE_CODE93          = 25
+  BARCODE_FLAT            = 28
+  BARCODE_RSS14           = 29
+  BARCODE_RSS_LTD         = 30
+  BARCODE_RSS_EXP         = 31
+  BARCODE_TELEPEN         = 32
+  BARCODE_UPCA            = 34
+  BARCODE_UPCE            = 37
+  BARCODE_POSTNET         = 40
+  BARCODE_MSI_PLESSEY     = 47
+  BARCODE_FIM             = 49
+  BARCODE_LOGMARS         = 50
+  BARCODE_PHARMA          = 51
+  BARCODE_PZN             = 52
+  BARCODE_PHARMA_TWO      = 53
+  BARCODE_PDF417          = 55
+  BARCODE_PDF417TRUNC     = 56
+  BARCODE_MAXICODE        = 57
+  BARCODE_QRCODE          = 58
+  BARCODE_CODE128B        = 60
+  BARCODE_AUSPOST         = 63
+  BARCODE_AUSREPLY        = 66
+  BARCODE_AUSROUTE        = 67
+  BARCODE_AUSREDIRECT     = 68
+  BARCODE_ISBNX           = 69
+  BARCODE_RM4SCC          = 70
+  BARCODE_DATAMATRIX      = 71
+  BARCODE_EAN14           = 72
+  BARCODE_CODABLOCKF      = 74
+  BARCODE_NVE18           = 75
+  BARCODE_JAPANPOST       = 76
+  BARCODE_KOREAPOST       = 77
+  BARCODE_RSS14STACK      = 79
+  BARCODE_RSS14STACK_OMNI = 80
+  BARCODE_RSS_EXPSTACK    = 81
+  BARCODE_PLANET          = 82
+  BARCODE_MICROPDF417     = 84
+  BARCODE_ONECODE         = 85
+  BARCODE_PLESSEY         = 86
+  BARCODE_TELEPEN_NUM     = 87
+  BARCODE_ITF14           = 89
+  BARCODE_KIX             = 90
+  BARCODE_AZTEC           = 92
+  BARCODE_DAFT            = 93
+  BARCODE_MICROQR         = 97
+  BARCODE_HIBC_128        = 98
+  BARCODE_HIBC_39         = 99
+  BARCODE_HIBC_DM         = 102
+  BARCODE_HIBC_QR         = 104
+  BARCODE_HIBC_PDF        = 106
+  BARCODE_HIBC_MICPDF     = 108
+  BARCODE_HIBC_BLOCKF     = 110
+  BARCODE_HIBC_AZTEC      = 112
+  BARCODE_AZRUNE          = 128
+  BARCODE_CODE32          = 129
+  BARCODE_EANX_CC         = 130
+  BARCODE_EAN128_CC       = 131
+  BARCODE_RSS14_CC        = 132
+  BARCODE_RSS_LTD_CC      = 133
+  BARCODE_RSS_EXP_CC      = 134
+  BARCODE_UPCA_CC         = 135
+  BARCODE_UPCE_CC         = 136
+  BARCODE_RSS14STACK_CC   = 137
+  BARCODE_RSS14_OMNI_CC   = 138
+  BARCODE_RSS_EXPSTACK_CC = 139
+  BARCODE_CHANNEL         = 140
+  BARCODE_CODEONE         = 141
+  BARCODE_GRIDMATRIX      = 142
+    
+  # barcode output options
+  BARCODE_NO_ASCII    = 1
+  BARCODE_BIND        = 2
+  BARCODE_BOX         = 4
+  
+  # Even thought this an option, it foobar's 
+  # Ruby's $stdout handle. Don't use it. 
+  # BARCODE_STDOUT      = 8
+  BARCODE_READER_INIT = 16
+
+  # input options
+  DATA_MODE    = 0
+  UNICODE_MODE = 1
+  GS1_MODE     = 2
+  KANJI_MODE   = 3
+  SJIS_MODE    = 4
+  DM_SQUARE    = 100
+
+
+  # error codes
+  WARN = {:warn_invalid_option =>  2 }
+  ERR = {:error_too_long         =>  5 ,
+         :error_invalid_data     =>  6 ,
+         :error_invalid_check    =>  7 ,
+         :error_invalid_option   =>  8 ,
+         :error_encoding_problem =>  9 ,
+         :error_file_access      =>  10,
+         :error_memory           =>  11}
+  
+  # This is the FFI wrapper on the Zint C library. You should not use 
+  # this directly. Instead refer to Zint::Barcode and its decendents  
+  module Wrapper
+    extend FFI::Library
+    ffi_lib "libzint"
+
+    #error codes
+    enum :err, [:warn_invalid_option, 2,
+      :error_too_long, 5,
+      :error_invalid_data, 6,
+      :error_invalid_check, 7,
+      :error_invalid_option, 8,
+      :error_encoding_problem, 9,
+      :error_file_access, 10,
+      :error_memory, 11
+    ]
+
+    # some typedef aliases, for better method signatures
+    typedef :pointer, :zint_symbol
+    typedef :int32, :string_max_length
+    typedef :int32, :rotate_angle
+    typedef :string, :input
+
+    attach_function(:zint_create, :ZBarcode_Create, [], :zint_symbol)
+    attach_function(:zint_clear, :ZBarcode_Clear, [:zint_symbol], :void)
+    attach_function(:zint_delete, :ZBarcode_Delete, [:zint_symbol], :void)
+    attach_function(:zint_encode, :ZBarcode_Encode, 
+                    [:zint_symbol, :input, :string_max_length], 
+                    :err)
+    attach_function(:zint_print, :ZBarcode_Print, 
+                    [:zint_symbol, :rotate_angle], 
+                    :err)
+    attach_function(:zint_encode_and_print, :ZBarcode_Encode_and_Print, 
+                    [:zint_symbol, :input, :string_max_length, 
+                    :rotate_angle], :err)
+
+    def self.create(bctype=BARCODE_CODE128)
+      bc = Zint::ZintSymbol.new(self.zint_create())
+      bc[:symbology] = bctype 
+      return bc
+    end
+  end
+end

data/lib/zint/zint_symbol.rb

@@ -0,0 +1,36 @@
+module Zint
+  # An FFI wrapper for the Zint C library zint_symbol struct.
+  # You should not use this directly, use the Zint::Barcode or
+  # its decendents instead.
+  class ZintSymbol < FFI::ManagedStruct
+    layout :symbology, :int32, 
+           :height, :int32,
+           :whitespace_width , :int32,
+           :border_width     , :int32,
+           :output_options   , :int32,
+           :fgcolour, [:char, 10],
+           :bgcolour, [:char, 10],
+           :outfile, [:char, 256],
+           :scale, :float, 
+           :option_1, :int32,
+           :option_2, :int32,
+           :option_3, :int32,
+           :show_hrt, :int32,
+           :input_mode, :int32,
+           :text, [:uchar, 128],
+           :rows, :int32,
+           :width, :int32,
+           :primary, [:char, 128],  	
+           :encoded_data , [:uchar, 178*143],
+           :row_height, [:int32, 178],
+           :errtxt, [:char, 100],
+           :bitmap, :pointer,
+           :bitmap_width, :int32,
+           :bitmap_height, :int32
+  	
+  	# release method required for FFI managed structs
+  	def self.release ptr
+  	  Zint.zint_delete(ptr)
+	  end
+  end 
+end

data/test/fixtures/code128.eps

@@ -0,0 +1,128 @@
+%!PS-Adobe-3.0 EPSF-3.0
+%%Creator: Zint 2.4.0
+%%Title: http://rubygems.org/gems/zint
+%%Pages: 0
+%%BoundingBox: 0 0 354 59
+%%EndComments
+/TL { setlinewidth moveto lineto stroke } bind def
+/TC { moveto 0 360 arc 360 0 arcn fill } bind def
+/TH { 0 setlinewidth moveto lineto lineto lineto lineto lineto closepath fill } bind def
+/TB { 2 copy } bind def
+/TR { newpath 4 1 roll exch moveto 1 index 0 rlineto 0 exch rlineto neg 0 rlineto closepath fill } bind def
+/TE { pop pop } bind def
+newpath
+0.00 0.00 0.00 setrgbcolor
+1.00 1.00 1.00 setrgbcolor
+59.00 0.00 TB 0.00 354.00 TR
+TE
+0.00 0.00 0.00 setrgbcolor
+50.00 9.00 TB 0.00 2.00 TR
+TB 3.00 1.00 TR
+TB 6.00 1.00 TR
+TB 11.00 1.00 TR
+TB 14.00 2.00 TR
+TB 20.00 1.00 TR
+TB 22.00 1.00 TR
+TB 25.00 4.00 TR
+TB 30.00 1.00 TR
+TB 33.00 1.00 TR
+TB 36.00 4.00 TR
+TB 41.00 1.00 TR
+TB 44.00 1.00 TR
+TB 46.00 1.00 TR
+TB 49.00 4.00 TR
+TB 55.00 3.00 TR
+TB 60.00 1.00 TR
+TB 63.00 2.00 TR
+TB 66.00 1.00 TR
+TB 68.00 3.00 TR
+TB 73.00 2.00 TR
+TB 77.00 1.00 TR
+TB 79.00 3.00 TR
+TB 84.00 2.00 TR
+TB 88.00 1.00 TR
+TB 91.00 1.00 TR
+TB 94.00 4.00 TR
+TB 99.00 1.00 TR
+TB 102.00 4.00 TR
+TB 108.00 1.00 TR
+TB 110.00 1.00 TR
+TB 113.00 1.00 TR
+TB 118.00 2.00 TR
+TB 121.00 2.00 TR
+TB 124.00 2.00 TR
+TB 127.00 4.00 TR
+TB 132.00 1.00 TR
+TB 135.00 2.00 TR
+TB 138.00 1.00 TR
+TB 143.00 1.00 TR
+TB 145.00 2.00 TR
+TB 149.00 1.00 TR
+TB 154.00 4.00 TR
+TB 159.00 3.00 TR
+TB 163.00 1.00 TR
+TB 165.00 1.00 TR
+TB 167.00 4.00 TR
+TB 173.00 1.00 TR
+TB 176.00 1.00 TR
+TB 179.00 2.00 TR
+TB 183.00 3.00 TR
+TB 187.00 1.00 TR
+TB 191.00 4.00 TR
+TB 196.00 1.00 TR
+TB 198.00 1.00 TR
+TB 201.00 1.00 TR
+TB 204.00 4.00 TR
+TB 209.00 1.00 TR
+TB 212.00 2.00 TR
+TB 215.00 1.00 TR
+TB 220.00 1.00 TR
+TB 222.00 3.00 TR
+TB 227.00 2.00 TR
+TB 231.00 1.00 TR
+TB 234.00 2.00 TR
+TB 237.00 1.00 TR
+TB 242.00 1.00 TR
+TB 244.00 2.00 TR
+TB 248.00 1.00 TR
+TB 253.00 4.00 TR
+TB 258.00 3.00 TR
+TB 262.00 1.00 TR
+TB 264.00 1.00 TR
+TB 266.00 4.00 TR
+TB 272.00 1.00 TR
+TB 275.00 1.00 TR
+TB 277.00 3.00 TR
+TB 282.00 2.00 TR
+TB 286.00 2.00 TR
+TB 289.00 4.00 TR
+TB 294.00 2.00 TR
+TB 297.00 1.00 TR
+TB 302.00 2.00 TR
+TB 305.00 1.00 TR
+TB 308.00 2.00 TR
+TB 314.00 1.00 TR
+TB 316.00 1.00 TR
+TB 319.00 1.00 TR
+TB 322.00 4.00 TR
+TB 327.00 1.00 TR
+TB 330.00 4.00 TR
+TB 335.00 1.00 TR
+TB 337.00 1.00 TR
+TB 341.00 2.00 TR
+TB 346.00 3.00 TR
+TB 350.00 1.00 TR
+TB 352.00 2.00 TR
+TE
+0.00 0.00 0.00 setrgbcolor
+matrix currentmatrix
+/Helvetica findfont
+8.00 scalefont setfont
+ 0 0 moveto 177.00 0.50 translate 0.00 rotate 0 0 moveto
+ (http://rubygems.org/gems/zint) stringwidth
+pop
+-2 div 0 rmoveto
+ (http://rubygems.org/gems/zint) show
+setmatrix
+
+showpage