arena_barby 0.3.2

data/lib/barby/outputter/pdfwriter_outputter.rb

@@ -0,0 +1,83 @@
+require 'barby/outputter'
+
+module Barby
+
+  #Annotates a PDFWriter document with the barcode
+  #
+  #Registers the annotate_pdf method
+  class PDFWriterOutputter < Outputter
+
+    register :annotate_pdf
+
+    attr_accessor :x, :y, :height, :xdim
+
+
+    #Annotate a PDFWriter document with the barcode
+    #
+    #Valid options are:
+    #
+    #x, y   - The point in the document to start rendering from
+    #height - The height of the bars in PDF units
+    #xdim   - The X dimension in PDF units
+    def annotate_pdf(pdf, options={})
+      with_options options do
+
+        xpos, ypos = x, y
+        orig_xpos = xpos
+
+        if barcode.two_dimensional?
+          boolean_groups.reverse_each do |groups|
+            groups.each do |bar,amount|
+              if bar
+                pdf.move_to(xpos, ypos).
+                  line_to(xpos, ypos+xdim).
+                  line_to(xpos+(xdim*amount), ypos+xdim).
+                  line_to(xpos+(xdim*amount), ypos).
+                  line_to(xpos, ypos).
+                  fill
+              end
+              xpos += (xdim*amount)
+            end
+            xpos = orig_xpos
+            ypos += xdim
+          end
+        else
+          boolean_groups.each do |bar,amount|
+            if bar
+              pdf.move_to(xpos, ypos).
+                line_to(xpos, ypos+height).
+                line_to(xpos+(xdim*amount), ypos+height).
+                line_to(xpos+(xdim*amount), ypos).
+                line_to(xpos, ypos).
+                fill
+            end
+            xpos += (xdim*amount)
+          end
+        end
+
+      end
+
+      pdf
+    end
+
+
+    def x
+      @x || 10
+    end
+
+    def y
+      @y || 10
+    end
+
+    def height
+      @height || 50
+    end
+
+    def xdim
+      @xdim || 1
+    end
+
+
+  end
+
+end

data/lib/barby/outputter/png_outputter.rb

@@ -0,0 +1,97 @@
+require 'barby/outputter'
+require 'png'
+
+module Barby
+
+  #Renders the barcode to a PNG image using the "png" gem (gem install png)
+  #
+  #Registers the to_png and to_canvas methods
+  class PngOutputter < Outputter
+
+    register :to_png, :to_canvas
+
+    attr_accessor :xdim, :ydim, :width, :height, :margin
+
+
+    #Creates a PNG::Canvas object and renders the barcode on it
+    def to_canvas(opts={})
+      with_options opts do
+        canvas = PNG::Canvas.new(full_width, full_height, PNG::Color::White)
+
+        if barcode.two_dimensional?
+          x, y = margin, margin
+          booleans.reverse_each do |line|
+            line.each do |bar|
+              if bar
+                x.upto(x+(xdim-1)) do |xx|
+                  y.upto y+(ydim-1) do |yy|
+                    canvas[xx,yy] = PNG::Color::Black
+                  end
+                end
+              end
+              x += xdim
+            end
+            y += ydim
+            x = margin
+          end
+        else
+          x, y = margin, margin
+          booleans.each do |bar|
+            if bar
+              x.upto(x+(xdim-1)) do |xx|
+                y.upto y+(height-1) do |yy|
+                  canvas[xx,yy] = PNG::Color::Black
+                end
+              end
+            end
+            x += xdim
+          end
+        end
+
+        canvas
+      end
+    end
+
+
+    #Renders the barcode to a PNG image
+    def to_png(*a)
+      PNG.new(to_canvas(*a)).to_blob
+    end
+
+
+    def width
+      length * xdim
+    end
+
+    def height
+      barcode.two_dimensional? ? (ydim * encoding.length) : (@height || 100)
+    end
+
+    def full_width
+      width + (margin * 2)
+    end
+
+    def full_height
+      height + (margin * 2)
+    end
+
+    def xdim
+      @xdim || 1
+    end
+
+    def ydim
+      @ydim || xdim
+    end
+
+    def margin
+      @margin || 10
+    end
+
+    def length
+      barcode.two_dimensional? ? encoding.first.length : encoding.length
+    end
+
+
+  end
+
+end

data/lib/barby/outputter/prawn_outputter.rb

@@ -0,0 +1,99 @@
+require 'barby/outputter'
+require 'prawn'
+
+module Barby
+
+  class PrawnOutputter < Outputter
+
+    register :to_pdf, :annotate_pdf
+
+
+    def to_pdf(opts={})
+      opts = options(opts)
+      annotate_pdf(Prawn::Document.new(opts[:document]), opts).render
+    end
+
+
+    def annotate_pdf(pdf, opts={})
+      opts = options(opts)
+      xpos, ypos, height, xdim = opts[:x], opts[:y], opts[:height], opts[:xdim]
+      ydim = opts[:ydim] || xdim
+      orig_xpos = xpos
+
+      if barcode.two_dimensional?
+        boolean_groups.reverse_each do |groups|
+          groups.each do |bar,amount|
+            if bar
+              pdf.move_to(xpos, ypos)
+              pdf.line_to(xpos, ypos+ydim)
+              pdf.line_to(xpos+(xdim*amount), ypos+ydim)
+              pdf.line_to(xpos+(xdim*amount), ypos)
+              pdf.line_to(xpos, ypos)
+              pdf.fill
+            end
+            xpos += (xdim*amount)
+          end
+          xpos = orig_xpos
+          ypos += ydim
+        end
+      else
+        boolean_groups.each do |bar,amount|
+          if bar
+            pdf.move_to(xpos, ypos)
+            pdf.line_to(xpos, ypos+height)
+            pdf.line_to(xpos+(xdim*amount), ypos+height)
+            pdf.line_to(xpos+(xdim*amount), ypos)
+            pdf.line_to(xpos, ypos)
+            pdf.fill
+          end
+          xpos += (xdim*amount)
+        end
+      end
+
+      pdf
+    end
+
+
+  private
+
+    def default_options
+      @default_options ||= {
+        :margin => 5,
+        :height => 100,
+        :xdim => 1
+      }
+    end
+
+    def options(opts={})
+      doc_opts = opts.delete(:document) || {}
+      opts = default_options.merge(opts)
+      opts[:x] ||= opts[:margin]
+      opts[:y] ||= opts[:margin]
+      opts[:document] = document_options(opts, doc_opts)
+      opts
+    end
+
+    def document_options(opts, doc_opts)
+      o = doc_opts.dup
+      #o[:page_size] ||= page_size(opts[:xdim], opts[:height], opts[:margin])
+      #%w(left right top bottom).each{|s| o[:"#{s}_margin"] ||= opts[:margin] }
+      o[:page_size] ||= 'A4' #Prawn doesn't currently support custom page sizes
+      o
+    end
+
+    def page_size(xdim, height, margin)
+      [width(xdim,margin), height(height,margin)]
+    end
+
+    def width(xdim, margin)
+      (xdim * encoding.length) + (margin * 2)
+    end
+
+    def height(height, margin)
+      height + (margin * 2)
+    end
+
+
+  end
+
+end

data/lib/barby/outputter/rmagick_outputter.rb

@@ -0,0 +1,126 @@
+require 'barby/outputter'
+require 'RMagick'
+
+module Barby
+
+
+  #Renders images from barcodes using RMagick
+  #
+  #Registers the to_png, to_gif, to_jpg and to_image methods
+  class RmagickOutputter < Outputter
+  
+    register :to_png, :to_gif, :to_jpg, :to_image
+
+    attr_accessor :height, :xdim, :ydim, :margin
+
+
+    #Returns a string containing a PNG image
+    def to_png(*a)
+      to_blob('png', *a)
+    end
+
+    #Returns a string containint a GIF image
+    def to_gif(*a)
+      to_blob('gif', *a)
+    end
+
+    #Returns a string containing a JPEG image
+    def to_jpg(*a)
+      to_blob('jpg', *a)
+    end
+    
+    def to_blob(format, *a)
+      img = to_image(*a)
+      blob = img.to_blob{|i| i.format = format }
+      
+      #Release the memory used by RMagick explicitly. Ruby's GC
+      #isn't aware of it and can't clean it up automatically
+      img.destroy! if img.respond_to?(:destroy!)
+      
+      blob
+    end
+
+    #Returns an instance of Magick::Image
+    def to_image(opts={})
+      with_options opts do
+        canvas = Magick::Image.new(full_width, full_height)
+        bars = Magick::Draw.new
+
+        x = margin
+        y = margin
+
+        if barcode.two_dimensional?
+          encoding.each do |line|
+            line.split(//).map{|c| c == '1' }.each do |bar|
+              if bar
+                bars.rectangle(x, y, x+(xdim-1), y+(ydim-1))
+              end
+              x += xdim
+            end
+            x = margin
+            y += ydim
+          end
+        else
+          booleans.each do |bar|
+            if bar
+              bars.rectangle(x, y, x+(xdim-1), y+(height-1))
+            end
+            x += xdim
+          end
+        end
+
+        bars.draw(canvas)
+
+        canvas
+      end
+    end
+
+
+    #The height of the barcode in px
+    #For 2D barcodes this is the number of "lines" * ydim
+    def height
+      barcode.two_dimensional? ? (ydim * encoding.length) : (@height || 100)
+    end
+
+    #The width of the barcode in px
+    def width
+      length * xdim
+    end
+
+    #Number of modules (xdims) on the x axis
+    def length
+      barcode.two_dimensional? ? encoding.first.length : encoding.length
+    end
+
+    #X dimension. 1X == 1px
+    def xdim
+      @xdim || 1
+    end
+
+    #Y dimension. Only for 2D codes
+    def ydim
+      @ydim || xdim
+    end
+
+    #The margin of each edge surrounding the barcode in pixels
+    def margin
+      @margin || 10
+    end
+
+    #The full width of the image. This is the width of the
+    #barcode + the left and right margin
+    def full_width
+      width + (margin * 2)
+    end
+
+    #The height of the image. This is the height of the
+    #barcode + the top and bottom margin
+    def full_height
+      height + (margin * 2)
+    end
+
+
+  end
+
+
+end

data/lib/barby/outputter/svg_outputter.rb

@@ -0,0 +1,225 @@
+require 'barby/outputter'
+
+module Barby
+
+  #Renders the barcode to a simple SVG image using pure ruby
+  #
+  #Registers the to_svg, bars_to_path, and bars_to_rects method
+  #
+  #Bars can be rendered as a stroked path or as filled rectangles.  Path
+  #generally yields smaller files, but this doesn't render cleanly in Firefox
+  #3 for odd xdims.  My guess is that the renderer tries to put half a pixel
+  #on one side of the path and half on the other, leading to fuzzy dithering
+  #instead of sharp, clean b&w.
+  #
+  #Therefore, default behavior is to use a path for even xdims, and
+  #rectangles for odd.  This can be overridden by calling with explicit
+  #:use => 'rects' or :use => 'path' options.
+  class SvgOutputter < Outputter
+
+    register :to_svg, :bars_to_rects, :bars_to_path
+
+    attr_writer :title, :xdim, :ydim, :height, :rmargin, :lmargin, :tmargin, :bmargin, :xmargin, :ymargin, :margin
+
+
+    def to_svg(opts={})
+      with_options opts do
+        case opts[:use]
+          when 'rects' then bars = bars_to_rects
+          when 'path'  then bars = bars_to_path
+        else
+          xdim_odd = (xdim % 2 == 1)
+          bars = xdim_odd ? bars_to_rects : bars_to_path
+        end
+
+        <<-"EOT"
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="#{svg_width(opts)}px" height="#{svg_height(opts)}px" viewBox="0 0 #{svg_width(opts)} #{svg_height(opts)}" version="1.1">
+<title>#{escape title}</title>
+<g id="canvas" #{transform(opts)}>
+<rect x="0" y="0" width="#{full_width}px" height="#{full_height}px" fill="white" />
+<g id="barcode" fill="black">
+#{bars}
+</g></g>
+</svg>
+EOT
+      end
+    end
+
+
+    def bars_to_rects(opts={})
+      rects = ''
+      with_options opts do
+        x, y = lmargin, tmargin
+
+        if barcode.two_dimensional?
+          boolean_groups.each do |line|
+            line.each do |bar, amount|
+              bar_width = xdim * amount
+              if bar
+                rects << %Q|<rect x="#{x}" y="#{y}" width="#{bar_width}px" height="#{ydim}px" />\n|
+              end
+              x += bar_width
+            end
+            y += ydim
+            x = lmargin
+          end
+
+        else
+          boolean_groups.each do |bar, amount|
+            bar_width = xdim * amount
+            if bar
+              rects << %Q|<rect x="#{x}" y="#{y}" width="#{bar_width}px" height="#{height}px" />\n|
+            end
+            x += bar_width
+          end
+
+        end
+      end # with_options
+
+      rects
+    end
+
+
+    def bars_to_path(opts={})
+      with_options opts do
+        %Q|<path stroke="black" stroke-width="#{xdim}" d="#{bars_to_path_data(opts)}" />|
+      end
+    end
+
+
+    def bars_to_path_data(opts={})
+      path_data = ''
+      with_options opts do
+        x, y = lmargin+(xdim/2), tmargin
+
+        if barcode.two_dimensional?
+          booleans.each do |line|
+            line.each do |bar|
+              if bar
+                path_data << "M#{x} #{y}V #{y+ydim}"
+              end
+              x += xdim
+            end
+            y += ydim
+            x = lmargin+(xdim/2)
+          end
+
+        else
+          booleans.each do |bar|
+            if bar
+              path_data << "M#{x} #{y}V#{y+height}"
+            end
+            x += xdim
+          end
+
+        end
+      end # with_options
+
+      path_data
+    end
+
+
+    def title
+      @title || barcode.to_s
+    end
+
+
+    def width
+      length * xdim
+    end
+
+    def height
+      barcode.two_dimensional? ? (ydim * encoding.length) : (@height || 100)
+    end
+
+    def full_width
+      width + lmargin + rmargin
+    end
+
+    def full_height
+      height + tmargin + bmargin
+    end
+
+    def xdim
+      @xdim || 1
+    end
+
+    def ydim
+      @ydim || xdim
+    end
+
+    def lmargin
+      @lmargin || _xmargin
+    end
+
+    def rmargin
+      @rmargin || _xmargin
+    end
+
+    def tmargin
+      @tmargin || _ymargin
+    end
+
+    def bmargin
+      @bmargin || _ymargin
+    end
+
+    def xmargin
+      return nil if @lmargin || @rmargin
+      _margin
+    end
+
+    def ymargin
+      return nil if @tmargin || @bmargin
+      _margin
+    end
+
+    def margin
+      return nil if @ymargin || @xmargin || @tmargin || @bmargin || @lmargin || @rmargin
+      _margin
+    end
+
+    def length
+      barcode.two_dimensional? ? encoding.first.length : encoding.length
+    end
+
+
+    def svg_width(opts={})
+      opts[:rot] ? full_height : full_width
+    end
+
+    def svg_height(opts={})
+      opts[:rot] ? full_width : full_height
+    end
+
+
+    def transform(opts={})
+      opts[:rot] ? %Q|transform="rotate(-90) translate(-#{full_width}, 0)"| : nil
+    end
+
+
+  private
+
+    def _xmargin
+      @xmargin || _margin
+    end
+
+    def _ymargin
+      @ymargin || _margin
+    end
+
+    def _margin
+      @margin || 10
+    end
+
+    #Escape XML special characters <, & and >
+    def escape(str)
+      str.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')
+    end
+
+
+  end
+
+
+end