pdf-labels 1.0.1 → 2.0.1

data/init.rb

@@ -0,0 +1,2 @@
+require 'pdf/label'
+PDF_LABELS_ROOT = File.expand_path(File.dirname(__FILE__))

data/lib/pdf/label.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/label/batch')
+
+module Pdf
+  module Label
+    VERSION = '2.0.1'
+  
+    #We want the barcode fonts to be loaded as availible fonts in the font path
+    root = File.expand_path(File.dirname(__FILE__) + "/../../")
+    PDF::Writer::FONT_PATH << (root + "/fonts")
+    PDF::Writer::FontMetrics::METRICS_PATH << (root + "/fonts")
+  end
+end

data/lib/pdf/label/alias.rb

@@ -0,0 +1,11 @@
+require 'xml/mapping'
+require File.expand_path(File.dirname(__FILE__) + '/length_node')
+
+module Pdf
+  module Label
+    class Alias
+    	include XML::Mapping
+    	text_node :name, "@name"
+    end
+  end
+end

data/lib/pdf/label/batch.rb

@@ -0,0 +1,276 @@
+$: << File.expand_path(File.dirname(__FILE__) + "/../../../vendor")
+require 'xml/mapping'
+require File.expand_path(File.dirname(__FILE__) + '/glabel_template')
+require 'pdf/writer'
+#--- require 'breakpoint'
+
+module Pdf
+  module Label
+    class Batch
+      attr_accessor :gt, :template, :label, :pdf, :barcode_font
+      @@gt = nil
+      def initialize(template_name, pdf_opts = {})
+        @@gt || self.class.load_template_set
+        unless @template = @@gt.find_template(template_name)
+          raise "Template not found!"
+        end
+        #if the template specifies the paper type, and the user didn't use it.
+        if @template.size && !pdf_opts.has_key?(:paper)
+          pdf_opts[:paper] = @template.size.gsub(/^.*-/,'')
+        end
+        #TODO figure out how to cope with multiple label types on a page
+        @label = @template.labels["0"]
+        #TODO figure out how to handle multiple layouts
+        @layout = @label.layouts[0]
+        @labels_per_page = @layout.nx * @layout.ny
+        @zero_based_labels_per_page = @labels_per_page - 1
+        
+        @pdf = PDF::Writer.new(pdf_opts)
+        @pdf.margins_pt(0, 0, 0, 0)
+        
+        # Turn off print scaling in the generated PDF to ensure 
+        # that the labels are positioned correctly when printing
+# TODO This goes boom!        @pdf.viewer_preferences('PrintScaling', '/None')
+      end
+
+      def self.load_template_set(template_set_file=nil)
+        template_set_file ||= File.expand_path(File.dirname(__FILE__) + "/../../../templates/avery-us-templates.xml")
+        @@gt = GlabelsTemplate.load_from_file(template_set_file)
+      end
+
+      def self.all_template_names
+        @@gt || self.load_template_set
+        @@gt.find_all_templates
+      end
+  
+      def self.all_barcode_fonts
+        {"Code128.afm" => :translation_needed,
+         "Code2of5interleaved.afm" => :translation_needed,
+         "Code3de9.afm" => :code39,
+         "CodeDatamatrix.afm" => :translation_needed,
+         "CodeEAN13.afm" => :translation_needed,
+         "CodePDF417.afm" => :translation_needed}
+      end
+  
+      def code39(text)
+        out = text.upcase
+        raise "Characters Not Encodable in Code3of9" unless out.match(/^[0-9A-Z\-\. \/\$\+%\*]+$/)
+        out = "*" + out unless out.match(/^\*/)
+        out = out + "*" unless out.match(/\*$/)
+        return out
+      end
+  
+      def translation_needed(text)
+        $stderr.puts("This barcode format does not automatically get formatted yet")
+        #TODO - Rob need to add barcode formatting
+        return text
+      end
+
+=begin rdoc
+      add_label takes an argument hash.
+      [:position]  Which label slot to print.  Positions are top to bottom, left to right so position 1 is the label in the top lefthand corner.  Defaults to 0
+      [:x & :y]  The (x,y) coordinates on the page to print the text.  Ignored if position is specified.
+      [:text] What you want to print in the label.  Defaults to the (x,y) of the top left corner of the label.
+      [:use_margin] If the label has a markupMargin, setting this argument to true will respect that margin when writing text.  Defaults to true.
+      [:justification] Values can be :left, :right, :center, :full.  Defaults to :left
+      [:offset_x, offset_y] If your printer doesn't want to print with out margins you can define these values to fine tune printout.
+=end
+      def add_label(options = {})
+        label_x, label_y, label_width = setup_add_label_options(options)
+
+        text = options[:text] || "[#{label_x / 72}, #{label_y / 72}]"
+        
+        arg_hash = setup_arg_hash(options, label_x, label_y, label_width)
+
+        @pdf.y = label_y
+        @pdf.text(text,arg_hash)
+      end
+  
+=begin rdoc
+      You can add the same text to many labels this way, takes all the arguments of add_label, but must have position instead of x,y. Requires count.
+       [:count] - Number of labels to print
+=end
+      def add_many_labels(options = {})
+        if (options[:x] || options[:y]) && !options[:position]
+          raise "Can't use X,Y with add_many_labels, you must use position"
+        end
+        if !options[:position]
+          options[:position] = 0
+        end
+        raise "Count required" unless options[:count]
+        count = options[:count]
+        count.times do
+          add_label(options)
+          options[:position] = options[:position] + 1
+        end
+      end
+=begin rdoc
+      To facilitate aligning a printer we give a method that prints the outlines of the labels
+=end  
+      def draw_boxes(write_coord = true, draw_markups = true)
+        @layout.nx.times do |x|
+          @layout.ny.times do |y|
+            box_x, box_y = get_x_y(x, y)
+            @pdf.rounded_rectangle(box_x,
+                                   box_y,
+                                   @label.width.as_pts, 
+                                   @label.height.as_pts, 
+                                   @label.round.as_pts).stroke
+            if write_coord
+              text = "#{box_x / 72}, #{box_y / 72}, #{@label.width.number}, #{label.height.number}"
+              add_label(:x => box_x, :y => box_y, :text => text)
+            end
+
+            if draw_markups
+              @label.markupMargins.each {|margin|
+                size = margin.size.as_pts
+                @pdf.rounded_rectangle(box_x + size,
+                                       box_y - margin.size.as_pts,
+                                       @label.width.as_pts - 2*size,
+                                       @label.height.as_pts - 2*size,
+                                       @label.round.as_pts).stroke
+              }
+              @label.markupLines.each {|line|
+                @pdf.line(box_x + line.x1.as_pts,
+                          box_y + line.y1.as_pts,
+                          box_x + line.x2.as_pts,
+                          box_y + line.y2.as_pts).stroke
+              }
+=begin TODO Draw cirles
+              @label.markupCircles.each {|cicle|
+                @pdf.
+=end
+            end
+                                   
+          end
+        end
+      end
+  
+=begin rdoc
+        add_label takes an argument hash.
+        [:position]  Which label slot to print.  Positions are top to bottom, left to right so position 1 is the label in the top lefthand corner.  Defaults to 0
+        [:x & :y]  The (x,y) coordinates on the page to print the text.  Ignored if position is specified.
+        [:text] What you want to print in the label.  Defaults to the (x,y) of the top left corner of the label.
+        [:use_margin] If the label has a markupMargin, setting this argument to true will respect that margin when writing text.  Defaults to true.
+        [:justification] Values can be :left, :right, :center, :full.  Defaults to :left
+        [:offset_x, offset_y] If your printer doesn't want to print with out margins you can define these values to fine tune printout.
+=end
+      def add_barcode_label(options = {})
+        label_x, label_y, label_width = setup_add_label_options(options)
+
+        text = options[:text] || "[#{label_x / 72}, #{label_y / 72}]"
+        
+        bar_text = setup_bar_text(options, text)
+        
+        arg_hash = setup_arg_hash(options, label_x, label_y, label_width)
+               
+        bar_hash = arg_hash.clone
+        bar_hash[:font_size] = options[:bar_size] || 12
+
+        old_font = @pdf.current_font!
+        @pdf.select_font(self.barcode_font)
+
+        @pdf.y = label_y
+        @pdf.text(bar_text,bar_hash)
+  
+        @pdf.select_font(old_font)
+        @pdf.text(text,arg_hash)      
+      end
+
+      def save_as(file_name)
+        @pdf.save_as(file_name)
+      end
+  
+      def barcode_font
+        @barcode_font ||= "Code3de9.afm"
+      end
+  
+      def barcode_font=(value)
+        if Pdf::Label::Batch.all_barcode_fonts.keys.include?(value)
+          @barcode_font = value
+          return @barcode_font
+        else
+          raise "Barcode Font Not Found for #{value}"
+        end
+      end
+
+    protected
+
+=begin rdoc
+      Position is top to bottom, left to right, starting at 1 and ending at the end of the page
+=end
+      def position_to_x_y(position)
+        x = (position * 1.0 / @layout.ny).floor
+        y = position % @layout.ny
+        return get_x_y(x, y)
+      end
+
+      def get_x_y(x, y)
+        label_y = @pdf.absolute_top_margin
+        label_y = label_y + @pdf.top_margin
+        label_y = label_y - @layout.y0.as_pts
+        label_y = label_y - y * @layout.dy.as_pts
+
+        label_x = @pdf.absolute_left_margin
+        label_x = label_x - @pdf.left_margin
+        label_x = label_x + @layout.x0.as_pts
+        label_x = label_x + x * @layout.dx.as_pts
+
+        return label_x, label_y
+      end
+      
+      def setup_add_label_options(options)
+        if position = options[:position]
+          # condition to handle multi-page PDF generation. If true, we're past the first page
+          if position > @zero_based_labels_per_page
+            # if remainder is zero, we're dealing with the first label of a new page
+            @pdf.new_page if ((position) % @labels_per_page) == 0
+            # Translate the position to a value between 1 and the number of labels for a given page
+            position = position - (position/@labels_per_page)*@labels_per_page
+          end    
+          label_x, label_y = position_to_x_y(position)
+        elsif((label_x = options[:x]) && (label_y = options[:y]))
+        else
+          label_x, label_y = position_to_x_y(0)
+        end
+        #line wrap margin
+        label_width = label_x + @label.width.as_pts
+   
+        if (use_margin = options[:use_margin]).nil?
+          use_margin = true
+        end
+        if use_margin
+          @label.markupMargins.each {|margin|
+            label_x = label_x + margin.size.as_pts
+            label_y = label_y - margin.size.as_pts
+            label_width = label_width - margin.size.as_pts
+          }
+        end
+    
+        if offset = options[:offset_x]
+          label_x = label_x + offset
+          label_width = label_width + offset
+        end
+        if offset = options[:offset_y]
+          label_y = label_y + offset
+        end
+        return label_x, label_y, label_width
+      end
+      
+      def setup_arg_hash(options, label_x, label_y, label_width)          
+        arg_hash = {:justification => (options[:justification] || :left),
+                    :font_size => (options[:font_size] || 12)}
+
+        arg_hash = arg_hash.merge :absolute_left => label_x,
+                   :absolute_right => label_width
+
+      end
+      
+      def setup_bar_text(options, text)
+        bar_text = options[:bar_text] || text
+        bar_text = send(Pdf::Label::Batch.all_barcode_fonts[self.barcode_font], bar_text)
+      end
+      
+    end
+  end
+end

data/lib/pdf/label/glabel_template.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/template')
+module Pdf
+  module Label
+    class GlabelsTemplate
+      include XML::Mapping
+  
+      hash_node :templates, "Template", "@name", :class => Template, :default_value => Hash.new
+  
+      def find_all_templates
+        return @t unless @t.nil?
+        @t = []
+        templates.each {|t|
+          @t << "#{t[1].name}"
+          t[1].alias.each {|a|
+            @t << "#{a[1].name}"
+          }
+        }
+        return @t
+      end
+        
+
+      def find_template(t_name)
+        return find_all_with_templates if t_name == :all
+        if t = templates[t_name]
+          return t
+        else
+          templates.each { |t|
+            if t[1].alias[t_name]
+              return t[1]
+            end
+          }
+        end
+        return nil
+      end
+
+    end
+  end
+end

data/lib/pdf/label/label.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/length_node')
+require File.expand_path(File.dirname(__FILE__) + '/layout')
+require File.expand_path(File.dirname(__FILE__) + '/markup')
+
+module Pdf
+  module Label
+
+    class Label
+      include XML::Mapping
+      attr_accessor :shape
+      numeric_node :id, "@id"
+      array_node :markupMargins, "Markup-margin", :class => MarkupMargin, :default_value => nil
+      array_node :markupLines, "Markup-line", :class => MarkupLine, :default_value => nil
+      array_node :markupCircles, "Markup-circle", :class => MarkupCircle, :default_value => nil
+  
+      array_node :layouts, "Layout", :class => Layout
+
+      def markups
+        @markups = Hash.new
+        @markups = @markups.merge @markupMargins
+        @markups = @markups.merge @markupLines
+        @markups = @markups.merge @markupCircles
+        @markups
+      end
+
+    end
+
+
+
+    class LabelRectangle < Label
+      length_node :width, "@width"
+      length_node :height, "@height" 
+      length_node :round, "@round", :default_value => "0 pt"
+      length_node :waste, "@waste", :default_value => "0 pt"
+      length_node :x_waste, "@x_waste", :default_value => "0 pt"
+      length_node :y_waste, "@y_waste", :default_value => "0 pt"
+      @kind = "Rectangle"	
+    end
+
+    class LabelRound < Label
+      length_node :radius, "@radius"
+      length_node :waste, "@radius", :default_value => "0 pt"
+      @kind = "Round"
+    end
+
+    class LabelCD < Label
+      length_node :radius, "@radius" 
+      length_node :hole, "@hole"
+      length_node :width, "@width", :default_value => ""
+      length_node :height, "@height", :default_value => ""
+      length_node :waste, "@waste", :default_value => ""
+      @kind = "CD"		
+    end
+  end
+end

data/lib/pdf/label/layout.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/length_node')
+
+module Pdf
+  module Label
+    class Layout
+    	include XML::Mapping
+    	numeric_node :nx, "@nx"
+    	numeric_node :ny, "@ny"
+    	length_node :x0, "@x0", :default_value => "0 pt"
+    	length_node :y0, "@y0", :default_value => "0 pt"
+    	length_node :dx, "@dx", :default_value => "0 pt"
+    	length_node :dy, "@dy", :default_value => "0 pt"
+    end
+  end
+end

data/lib/pdf/label/length_node.rb

@@ -0,0 +1,52 @@
+require 'xml/mapping/base'
+
+module Pdf
+  module Label
+    class Length
+    	attr_accessor :value, :unit, :number
+	
+    	def initialize(value)
+    		@value = value
+    		@number = value.match(/[\d\.]*/)[0].to_f
+    		@unit = value.delete("#{number}").strip
+    	end
+
+    	#Return the numeric portion as a Points	
+    	def as_pts
+    		if @unit =~ /pt/
+    			return @number
+    		elsif @unit =~ /in/
+    			return @number * 72 #72.270 
+    		elsif @unit =~ /mm/
+    			return @number * 2.83464566929134
+    		elsif @unit =~ /cm/
+    			return @number * 28.3464566929134
+    		elsif @unit =~ /pc/
+    			return 1.0 * @number / 12
+    		elsif @unit == ''
+    			return @number
+    		else
+    			raise "Unit #{unit} unknown"
+    		end
+    	end
+    end
+
+    class LengthNode < XML::Mapping::SingleAttributeNode
+      def initialize_impl(path)
+        @path = XML::XXPath.new(path)
+      end
+
+      def extract_attr_value(xml)
+        @value = default_when_xpath_err{@path.first(xml).text}
+    		Length.new(@value)
+      end
+
+      def set_attr_value(xml, value)
+        raise "Not a Length: #{value}" unless Length===value
+        @path.first(xml,:ensure_created=>true).text = value.value
+      end
+    end
+
+    XML::Mapping.add_node_class LengthNode
+  end
+end