jmcnevin-rghost_barcode 0.8.5 → 0.8.8

data/lib/rghost_barcode/rghost_barcode_adapter.rb

@@ -0,0 +1,248 @@
+
+
+RGhost::Config::GS[:extensions] << File.join(File.dirname(__FILE__),'ps')
+RGhost::Config::GS[:preload] << :barcode
+
+class RGhost::Document 
+  
+  #Facade for RGhost::Barcode::Isbn
+  def barcode_isbn(barcode_string,options={})
+    set RGhost::Barcode::Isbn.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Code11
+  def barcode_code11(barcode_string,options={})
+    set RGhost::Barcode::Code11.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Code2of5
+  def barcode_code2of5(barcode_string,options={})
+    set RGhost::Barcode::Code2of5.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Ean8
+  def barcode_ean8(barcode_string,options={})
+    set RGhost::Barcode::Ean8.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Postnet
+  def barcode_postnet(barcode_string,options={})
+    set RGhost::Barcode::Postnet.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Rssexpanded
+  def barcode_rssexpanded(barcode_string,options={})
+    set RGhost::Barcode::Rssexpanded.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Auspost
+  def barcode_auspost(barcode_string,options={})
+    set RGhost::Barcode::Auspost.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Code39
+  def barcode_code39(barcode_string,options={})
+    set RGhost::Barcode::Code39.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Upce
+  def barcode_upce(barcode_string,options={})
+    set RGhost::Barcode::Upce.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Azteccode
+  def barcode_azteccode(barcode_string,options={})
+    set RGhost::Barcode::Azteccode.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Ean5
+  def barcode_ean5(barcode_string,options={})
+    set RGhost::Barcode::Ean5.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Plessey
+  def barcode_plessey(barcode_string,options={})
+    set RGhost::Barcode::Plessey.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Raw
+  def barcode_raw(barcode_string,options={})
+    set RGhost::Barcode::Raw.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Rss14
+  def barcode_rss14(barcode_string,options={})
+    set RGhost::Barcode::Rss14.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Royalmail
+  def barcode_royalmail(barcode_string,options={})
+    set RGhost::Barcode::Royalmail.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Datamatrix
+  def barcode_datamatrix(barcode_string,options={})
+    set RGhost::Barcode::Datamatrix.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Code128
+  def barcode_code128(barcode_string,options={})
+    set RGhost::Barcode::Code128.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Upca
+  def barcode_upca(barcode_string,options={})
+    set RGhost::Barcode::Upca.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Qrcode
+  def barcode_qrcode(barcode_string,options={})
+    set RGhost::Barcode::Qrcode.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Maxicode
+  def barcode_maxicode(barcode_string,options={})
+    set RGhost::Barcode::Maxicode.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Rationalizedcodabar
+  def barcode_rationalizedcodabar(barcode_string,options={})
+    set RGhost::Barcode::Rationalizedcodabar.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Code93
+  def barcode_code93(barcode_string,options={})
+    set RGhost::Barcode::Code93.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Msi
+  def barcode_msi(barcode_string,options={})
+    set RGhost::Barcode::Msi.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Rsslimited
+  def barcode_rsslimited(barcode_string,options={})
+    set RGhost::Barcode::Rsslimited.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Ean13
+  def barcode_ean13(barcode_string,options={})
+    set RGhost::Barcode::Ean13.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Onecode
+  def barcode_onecode(barcode_string,options={})
+    set RGhost::Barcode::Onecode.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Ean2
+  def barcode_ean2(barcode_string,options={})
+    set RGhost::Barcode::Ean2.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Interleaved2of5
+  def barcode_interleaved2of5(barcode_string,options={})
+    set RGhost::Barcode::Interleaved2of5.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Symbol
+  def barcode_symbol(barcode_string,options={})
+    set RGhost::Barcode::Symbol.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Pdf417
+  def barcode_pdf417(barcode_string,options={})
+    set RGhost::Barcode::Pdf417.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Kix
+  def barcode_kix(barcode_string,options={})
+    set RGhost::Barcode::Kix.new(barcode_string,options)
+  end
+
+  #Facade for RGhost::Barcode::Pharmacode
+  def barcode_pharmacode(barcode_string,options={})
+    set RGhost::Barcode::Pharmacode.new(barcode_string,options)
+  end
+
+  
+end
+
+module RGhost::Config
+  BARCODE_EXAMPLES={
+    'plessey' => ['01234ABCD',{ :text => {:size => 10}}],
+    'isbn' => ['978-1-56592-479',{:text => {:size => 10}, :guard=>{:whitespace => true }}],
+    'rsslimited' => ['00978186074271',{:height => 1 , :text => {:size => 10}}],
+    'pdf417' => ['^453^178^121^239',{:text => {:size => 10}, :columns => 2,  :rows=> 10}],
+    'royalmail' => ['LE28HS9Z',{:text => {:size => 10}}],
+    'ean13' => ['977147396801',{ :guard=>{:whitespace => true }}],
+    'code11' => ['0123456789',{:text => {:size => 10}}],
+    'symbol' => ['fima',{:text => {:size => 10}}],
+    'qrcode' => ['000100000010000000001100010101100110000110000',{:text => {:size => 10}}],
+    'msi' => ['0123456789',{:text => {:size => 10}}],
+    'upca' => ['78858101497',{:text => {:size => 10}}],
+    'pharmacode' => ['117480',{:text => {:size => 10}}],
+    'kix' => ['1231FZ13XHS',{:text => {:size => 10}}],
+    'datamatrix' => ['^142^164^186',{:columns => 32,  :rows=> 32}],
+    'rssexpanded' => ['000000010011001010100001000000010000',{:text => {:size => 10}}],
+    'ean2' => ['05',{:text => {:size => 10}}],
+    'rationalizedcodabar' => ['A0123456789B',{:text => {:size => 10}}],
+    'upce' => ['0123456',{:text => {:size => 10}}],
+    'ean5' => ['90200',{:text => {:size => 10}}],
+    'code2of5' => ['01234567',{:text => {:size => 10}}],
+    'code93' => ['THIS IS CODE 93',{:text => {:size => 10}}],
+    'postnet' => ['012345',{:text => {:size => 10}}],
+    'maxicode' => ['^059^042^041^059^040^03001^02996152382802^029840^029001^0291Z00004951^029UPSN^02906X610^029159^0291234567^0291^0471^029^029Y^029634 ALPHA DR^029PITTSBURGH^029PA^030^062^004^063', {:mode=> 2, :text => {:size => 10}}],
+    'raw' => ['331132131313411122131311333213114131131221323',{:text => {:size => 10}}],
+    'onecode' => ['0123456709498765432101234567891',{:text => {:size => 10}}],
+    'code39' => ['THIS IS CODE 39',{:text => {:size => 10}}],
+    'auspost' => ['5956439111ABA 9',{:text => {:size => 10}}],
+    'azteccode' => ['00100111001000000101001101111000010100111100101000000110',{:text => {:size => 10}, :format=> :compact}],
+    'ean8' => ['01335583',{:text => {:size => 10}}],
+    'interleaved2of5' => ['24012345678905',{
+        :text => {:size => 10, :offset => [0,-10], :enable => [:text, :check, :checkintext] }, 
+        :border => {:width => 4, :left => 15, :right => 15, :show => true}, 
+        :height => 2
+      }],
+    'code128' => ['^104^102Count^0990123456789^101!',{:text => {:size => 10}}],
+    'rss14' => ['24012345678905',{:text => {:size => 10}}]
+
+
+  }
+  #Generates catalog of barcodes.
+  #
+  # RGhost::Config.barcode_examples.render :pdf, :filename => "/tmp/barcode_catalog.pdf"
+  #
+  def self.barcode_examples() #(options={:text => {:size => 10}})
+    d=RGhost::Document.new :paper => [15,8], :margin_left => 2
+    #d.set RGhost::Barcode::Code39.new("ASDHAJSDF", :x => 1, :y => 5, :color => 'FF0000', :border =>{:color => '00FF00'}, :text =>{:size => 10, :color => '553297' }, :height => 1,  :width => 4.545)
+    #d.barcode_isbn("978-1-56592-479", :x => 1, :y => 5, :color => 'FF0000', :border =>{:color => '00FF00'}, :text =>{:size => 10, :color => '553297' }, :height => 1,  :width => 4.545)
+    #d.barcode_isbn("978-1-56592-479", :x => 1, :y => 10, :text =>{:size => 10})
+    d.define_template :barcode_template,  File.join(File.dirname(__FILE__),'ps',"barcode_template.eps")
+    d.before_page_create do
+      use_template :barcode_template
+    end
+    RGhost::Config::BARCODE_EXAMPLES.each do |k,v|
+      
+      d.show "Barcode Name: #{k}"
+      d.jump_rows 6
+      #opt=v[1][:text][:size]=10
+      opt=v[1]
+      d.send "barcode_#{k}".to_sym,v[0],opt.dup
+      d.jump_rows 2
+      d.show "Code String: #{v[0]}"
+      d.next_row
+      d.text("Options: #{opt.inspect}",false)
+      d.next_page
+    end
+    license=%Q{<big>Barcode Writer License</big><br/>Anybody is free to use and develop this code as they see fit, under the terms of the permissive MIT/X-Consortium license(http://postscriptbarcode.googlecode.com/svn/trunk/LICENSE), which requires that developers attribute any derivative code to this project in both the source code and documentation. As such I take no liability for its use or misuse.<br/><br/>Thanks a lot Terry!<br/> <i>Shairon Toledo</i>   }
+    d.text license
+    d.next_row
+    d.show "RGhost::VERSION #{RGhost::VERSION::STRING}" , :align => :page_right, :tag => :b
+    d.next_row
+    d.show "RGhost::Barcode::VERSION #{RGhost::Barcode::VERSION::STRING}" , :align => :page_right, :tag => :b
+    d
+  end
+  
+end
+

data/lib/rghost_barcode/rghost_barcode_base.rb

@@ -0,0 +1,210 @@
+module RGhost::Barcode
+  
+  class Parameter < RGhost::PsObject
+    
+    def initialize(options=nil)
+      @options=options
+      @params=[]
+      make() if options
+    end
+    def map
+      @params.join(" ")
+    end
+    
+    def add(key,value)
+      @params << "#{key}=#{value}" if value
+    end
+    	
+    def add_color(key,value)
+      add(key, value.to_s.gsub(/[^0-9A-F]/,'') )
+    end
+    def add_single(entry)
+      @params << entry
+    end
+    
+    #using the framework unit
+    def add_with_unit(key,value)
+     
+    
+    
+      v=if RGhost::Config::GS[:unit] == RGhost::Units::Cm
+        (value.to_f/2.545)
+      end
+      add(key, v || value )
+    end
+    
+    def inspect
+      "#{self.class} - #{map}"
+    end
+    def to_s
+      map
+    end
+    def make() end #prototype
+    
+    
+  end
+  
+  
+  #Enables properties of text. It's used on the contructor of the class RGhost::Barcode::Base(parent of all barcodes) by Hash :text.
+  #Between parenthesis the original parameter.
+  #* <tt>:size</tt> - (textsize) - size of text in points.
+  #* <tt>:font</tt> - (textfont) - name of font, see the font catalog.
+  #* <tt>:offset</tt> - (textxoffset, textyoffset) - Used as array. Example :offset => [10,8], textxoffset[0] and textyoffset[1]
+  #* <tt>:x and :y</tt> - (textxalign, textyalign) - Align of X and Y. Example :x => 0.2, :y => 5
+  #* <tt>:color</tt> - (textcolor) - Color of text. Only rgb hex. Example: :color => 'FF0000'
+  #* <tt>:enable </tt> Array 
+  #Enables 
+  #* <tt>:text</tt>  - (includetext) - Show human readable text for data in symbol.
+  #* <tt>:check</tt> - (includecheck) - Generate check digit(s), where relevant.
+  #* <tt>:checkintext</tt> - (includecheckintext) - Generate check digit(s), where relevant.
+  #Example:
+  # doc=Document.new
+  # doc.barcode_interleaved2of5('0123456789', :text => {:size => 10, :offset => [0,-10], :enable => [:text, :check, :checkintext] })
+  class Text < RGhost::Barcode::Parameter
+    
+    def make
+      add_single("includetext")
+      @options.each do |key,value| 
+        case key
+        when :enable then  value.each{|item| add_single("include#{item}")   }
+        when :offset 
+          add("textxoffset", value[0])
+          add("textyoffset", value[1])
+        when :color then add_color("textcolor", value)          
+        when :x, :y then add("text#{key}align",value) 
+        else
+          add("text#{key}",value)
+        end
+      end
+    end
+  end
+  
+  #Display whitespace guards or the specified width and height, in points. (Most useful for EANs). It's used on the contructor of the class RGhost::Barcode::Base(parent of all barcodes) by Hash :guard.
+  #Between parenthesis the original parameter.
+  #* <tt>:whitespace</tt>(guardwhitespace) - Enabled by true. Example: :whitespace => true
+  #* <tt>:height and :width </tt>(guardwidth and guardheight) 
+  #Amount of whitespace to guard to left and right of the symbol and vertical position of the guard symbols, in points.
+  #* <tt>:left,right,:left_y, :right_y </tt>(guardleftpos, guardrightpos, guardleftypos and guardrightypos)
+  #
+  #Example:
+  # doc=Document.new
+  # doc.barcode_ean13('977147396801', :guard=>{:whitespace => true, :width => 0.2 })
+  class Guard < RGhost::Barcode::Parameter
+    def make
+      #
+      @options.each do |key,value| 
+        case key
+        when :left,:right,:left_y, :right_y then add("guard#{key.to_s.gsub(/_/,'')}pos",value)  
+        when :whitespace then add_single("guardwhitespace")
+        else
+          add("guard#{key}",value)
+        end
+      end
+      
+    end
+    
+    
+  end
+  #Display border properties. It's used on the contructor of the class RGhost::Barcode::Base(parent of all barcodes) by Hash :border.
+  #Between parenthesis the original parameter.
+  #* <tt>:show</tt>(showborder) - Enabled by true. Example: :show => true
+  #* <tt>:width</tt>(borderwidth) - Width of border in points.
+  #* <tt>:left, :right, :top, :bottom</tt>( borderleft, borderright, bordertop, borderbottom) - specifies the width of the each side of border.
+  #* <tt>:color</tt>(textcolor) - Color of text. Only rgb hex. Example: :color => 'FF0000'
+  #
+  #Example:
+  # doc=Document.new
+  # doc.barcode_interleaved2of5('0123456789', :border => {:width => 4, :left => 15, :right => 15, :show => true} )
+  class Border < RGhost::Barcode::Parameter
+
+    def make
+      
+      @options.each do |key,value| 
+        case key
+        when :color then add_color("bordercolor", value) 
+        when :show then add_single("showborder")
+        else
+          add("border#{key}",value)
+        end
+      end
+      
+    end
+    
+    
+  end
+
+  #Base of all kinds of barcodes. It's used to creates barcode.  For more details about options see http://groups.google.com/group/postscriptbarcode/web/Options
+  #
+  #==Options
+  #Facades 
+  #* <tt>:text</tt>   RGhost::Barcode::Text
+  #* <tt>:guard</tt>  RGhost::Barcode::Guard
+  #* <tt>:border</tt> RGhost::Barcode::Border
+  #Options. Between parenthesis the original parameter.
+  #* <tt>:scale</tt> Scale in Array([x,y]). Example for twice the original size, :scale => [2,2]
+  #* <tt>:rotate</tt> Rotate angle.
+  #* <tt>:color</tt>(barcolor) Foreground color.
+  #* <tt>:background</tt>(backgroundcolor) 
+  #* <tt>:x and :y</tt> Position. RGhost::Config::GS[:unit] will be used. Default :current_row and :limit_left
+  #* <tt>:width and :height</tt>(width and height). Width and height of barcode,  RGhost::Config::GS[:unit] will be used.
+  #
+  #Example:
+  # doc=Document.new
+  # doc.barcode_interleaved2of5('0123456789',
+  #      :text => {:size => 10, :offset => [0,-10], :enable => [:text, :check, :checkintext] }, 
+  #      :border => {:width => 4, :left => 15, :right => 15, :show => true}, 
+  #      :height => 2
+  #    )
+  #Without options
+  # doc=Document.new
+  # doc.barcode_code39('0123456789')
+  class Base <RGhost::Barcode::Parameter
+
+    attr_reader :text, :guard, :border ,:point
+  
+    def initialize(barcode_string,options={})
+      options||={}
+      
+      @options=options.dup
+      @options[:x]||= :limit_left
+      @options[:y]||= :current_row
+      @barcode=barcode_string
+      @text   = RGhost::Barcode::Text.new(@options[:text])
+      
+      @guard  = RGhost::Barcode::Guard.new(@options[:guard])
+      @border = RGhost::Barcode::Border.new(@options[:border])
+      @point=RGhost::Cursor.translate(@options)
+      @rotate=RGhost::Cursor.rotate @options[:rotate]
+      @scale=RGhost::Scale.new @options[:scale][0],@options[:scale][1] if @options[:scale]
+      [:scale, :enable, :text,:guard,:border, :x, :y, :rotate].each{|v| @options.delete v}
+      super(@options)
+      @self_name=self.class.to_s.downcase.split(/::/).last
+      # RGhost::Config::GS[:preload] << @self_name
+    end
+  
+    def make
+      
+      [:x,:y].each{|v| @options.delete v}
+      
+      @options.each do |key,value| 
+        case key
+        when :color then add_color("barcolor", value) 
+        when :background then add_color("backgroundcolor", value) 
+        when :width, :height then add_with_unit(key,value)
+          #when :inkspread then  add(key,value)
+        else   add(key,value)
+        end
+      end
+      
+    end
+    
+    def ps
+      formated_params=[ @text.map, @border.map, @guard.map, self.map].join(" ")
+      
+      "gsave newpath #{@point.ps} #{@rotate} #{@scale} 0 0 moveto (#{@barcode}) (#{formated_params}) #{@self_name} closepath grestore"
+    end
+    
+    
+  end
+
+end