labels 0.0.3

data/lib/labels/image.rb

@@ -0,0 +1,24 @@
+# A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+require 'tempfile'
+require 'base64'
+require 'uuid'
+
+require 'labels/layer'
+
+module Labels
+  
+  # This class represents date layers.
+  class Image < Layer
+    
+    # Whether or not to fit image to layer width and height
+    attr_accessor :fit
+    
+    # Whether or not to stretch image to layer width and height
+    attr_accessor :stretch
+  end
+end

data/lib/labels/layer.rb

@@ -0,0 +1,58 @@
+# A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+require 'prawn'
+
+require 'labels/layer'
+
+module Labels
+  
+  # This class represents the base class for all layer types.
+  class Layer < Element
+    
+    # Title of layer
+    attr_accessor :title
+    
+    # Type of layer
+    attr_accessor :type
+    
+    # Column from data set to use as replacement content
+    attr_accessor :column
+    
+    # Whether or not layer is locked
+    attr_accessor :locked
+    
+    # Whether or not layer is visible
+    attr_accessor :visible
+    
+    # Whether or not layer is resizable
+    attr_accessor :resizable
+    
+    # X position of layer in pixels
+    attr_accessor :x
+    
+    # Y position of layer in pixels
+    attr_accessor :y
+    
+    # Z position of layer in pixels
+    attr_accessor :z
+    
+    # Width of layer in pixels
+    attr_accessor :width
+    
+    # Height of layer in pixels
+    attr_accessor :height
+    
+    # Alpha (transparency) of layer 
+    attr_accessor :alpha
+    
+    # Rotation of layer in degrees
+    attr_accessor :rotation
+    
+    # Data content of layer
+    attr_accessor :content
+  end
+end

data/lib/labels/paper.rb

@@ -0,0 +1,29 @@
+# A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+require 'labels/element'
+
+module Labels
+  
+  # This class represents paper types and dimensions.
+  class Paper < Element
+    LETTER = {:title => 'Letter', :width => 612, :height => 792}
+    LEGAL = {:title => 'Legal', :width => 612, :height => 1008}
+    LEDGER = {:title => 'Ledger', :width => 792, :height => 1224}
+    A5 = {:title => 'A5', :width => 420, :height => 595}
+    A4 = {:title => 'A4', :width => 595, :height => 842}
+    A3 = {:title => 'A3', :width => 842, :height => 1191}
+    
+    # Title of paper type
+    attr_accessor :title
+    
+    # Width of paper in pixels
+    attr_accessor :width
+    
+    # Height of paper in pixels
+    attr_accessor :height
+  end
+end

data/lib/labels/pdf/builder.rb

@@ -0,0 +1,332 @@
+# A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+require 'labels/document'
+require 'labels/paper'
+require 'labels/template'
+require 'labels/shape'
+require 'labels/text'
+require 'labels/image'
+require 'labels/barcode'
+require 'labels/date'
+
+require 'prawn'
+
+module Labels
+  module PDF
+    
+    # This class builds a PDF document from the given Labels::Document
+    class Builder
+      
+      # The document instance
+      attr_accessor :document
+      
+      # Creates a new Labels::PDF::Builder instance
+      def initialize(document=nil)
+        @document = document
+      end
+      
+      # Renders the PDF and optionally saves to given filename
+      def render(filename=nil)
+        unless filename.nil?
+          self.pdf.render_file filename
+        else
+          self.pdf.render
+        end
+      end
+      
+      # Returns the rendered PDF document
+      def pdf
+        unless @document.nil?
+          paper = @document.paper
+          template = @document.template
+          data = @document.data
+        
+          if paper && template
+            document_options = {
+              :page_size => [paper.width, paper.height],
+              :left_margin => template.left_margin,
+              :right_margin => template.right_margin,
+              :top_margin => template.top_margin,
+              :bottom_margin => template.bottom_margin
+            }
+            
+            page_cell_count = template.columns * template.rows
+            page_number_count = (data.length / page_cell_count).ceil
+            cell = 0
+            
+            if page_number_count == 0
+              page_number_count += 1
+            end
+            
+            Prawn::Document.new document_options do |pdf|
+              page_number_count.times do |page|
+                if page > 0
+                  pdf.start_new_page
+                end
+                
+                pdf.define_grid({
+                  :columns => template.columns,
+                  :rows => template.rows,
+                  :column_gutter => template.vertical_gutter,
+                  :row_gutter => template.horizontal_gutter
+                })
+                
+                # Draw template
+                pdf.grid.rows.times do |i|
+                  pdf.grid.columns.times do |j|
+                    box = pdf.grid(i,j)
+                    pdf.bounding_box box.top_left, :width => box.width, :height => box.height do
+                      self._draw_template(pdf, template)
+                    end
+                  end
+                end
+                
+                # Draw layers
+                pdf.grid.rows.times do |i|
+                  pdf.grid.columns.times do |j|
+                    box = pdf.grid(i,j)
+                    pdf.bounding_box box.top_left, :width => box.width, :height => box.height do
+                      layers = @document.layers.sort {|x,y| x.z <=> y.z}
+                      layers.each do |layer|
+                        
+                        draw = false
+                        content = nil
+                        if data.length > 0
+                          if cell < data.length
+                            if data[cell].has_key?(layer.column)
+                              content = data[cell][layer.column]
+                            end
+                            draw = true
+                          end
+                        else
+                          draw = true
+                        end
+                        
+                        if draw
+                          case layer
+                          when Labels::Barcode
+                            self._draw_barcode(pdf, layer, content)
+                          when Labels::Date
+                            self._draw_date(pdf, layer, content)
+                          when Labels::Image
+                            self._draw_image(pdf, layer, content)
+                          when Labels::Shape
+                            self._draw_shape(pdf, layer, content)
+                          when Labels::Text
+                            self._draw_text(pdf, layer, content)
+                          end
+                        end
+                      end
+                    end
+                    cell += 1
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+        
+      private
+      
+      # Draws the given barcode layer with optional content
+      def _draw_barcode(pdf, layer, content=nil)
+        if pdf.kind_of?(Prawn::Document) && layer.visible
+          pdf.save_graphics_state
+
+          origin = {:x => layer.x, :y => pdf.bounds.top - layer.y}
+          center = {:x => origin[:x] + (layer.width * 0.5), :y => origin[:y] - (layer.height * 0.5)}
+
+          pdf.rotate(layer.rotation, :origin => [center[:x], center[:y]]) do 
+            pdf.transparent layer.alpha do
+              begin
+                options = {
+                  :bar_width => layer.bar_width,
+                  :bar_height => layer.bar_height,
+                  :color => layer.color,
+                  :caption_height => layer.caption_height,
+                  :caption_size => layer.caption_size,
+                  :captioned => layer.captioned
+                }
+                
+                unless content.nil?
+                  options[:data] = content
+                else
+                  options[:data] = layer.content
+                end
+                  
+                barcode = Barcodes.create(layer.symbology, options)
+                renderer = Barcodes::Renderer::Pdf.new(barcode)
+
+                barcode_width = ((barcode.width * 0.001) * 72.0)
+                barcode_height = ((barcode.height * 0.001) * 72.0)
+
+                pdf.bounding_box [origin[:x], origin[:y]], :width => layer.width, :height => layer.height do
+                  renderer.draw(pdf)
+                end
+              rescue
+                # Barcode error... render nothin
+              end
+            end
+          end
+
+          pdf.restore_graphics_state
+        end
+      end
+
+      # Draws the given date layer with optional content
+      def _draw_date(pdf, layer, content=nil)
+        if content.nil?
+          content = layer.content
+        end
+
+        begin
+          content = Time.parse(content).strftime(layer.format)
+        rescue
+          content = Time.now.strftime(layer.format)
+        end
+
+        self._draw_text(pdf, layer, content)
+      end
+      
+      # Draws the given image layer with optional content
+      def _draw_image(pdf, layer, content=nil)
+        if pdf.kind_of?(Prawn::Document) && layer.visible
+          pdf.save_graphics_state
+
+          origin = {:x => layer.x, :y => pdf.bounds.top - layer.y}
+          center = {:x => origin[:x] + (layer.width * 0.5), :y => origin[:y] - (layer.height * 0.5)}
+
+          pdf.rotate(layer.rotation, :origin => [center[:x], center[:y]]) do 
+            pdf.transparent layer.alpha do
+              begin
+                unless content.nil?
+                  content = Base64.decode64(content)
+                else
+                  content = Base64.decode64(layer.content)
+                end
+
+                temp = Tempfile.new(UUID.generate)
+                temp.write(content)
+                temp.rewind
+
+                options = {
+                  :at => [origin[:x], origin[:y]]
+                }
+                if layer.fit
+                  options[:fit] = [layer.width, layer.height]
+                end
+                if layer.stretch
+                  options[:width] = layer.width
+                  options[:height] = layer.height
+                end
+                pdf.image temp, options
+
+                temp.close
+                temp.unlink
+              rescue
+                # Image error... render nothin
+              end
+            end
+          end
+
+          pdf.restore_graphics_state
+        end
+      end
+      
+      # Draws the given shape layer with optional content
+      def _draw_shape(pdf, layer, content=nil)
+        if pdf.kind_of?(Prawn::Document) && layer.visible
+          pdf.save_graphics_state
+
+          pdf.fill_color layer.fill_color
+          pdf.stroke_color layer.stroke_color
+          pdf.line_width layer.stroke_weight
+
+          origin = {:x => layer.x, :y => pdf.bounds.top - layer.y}
+          center = {:x => origin[:x] + (layer.width * 0.5), :y => origin[:y] - (layer.height * 0.5)}
+
+          pdf.rotate(layer.rotation, :origin => [center[:x], center[:y]]) do 
+            pdf.transparent layer.alpha do
+              unless layer.elliptical
+                pdf.rounded_rectangle([origin[:x], origin[:y]], layer.width, layer.height, layer.corner_radius)
+              else
+                pdf.ellipse([center[:x], center[:y]], layer.width * 0.5, layer.height * 0.5)
+              end
+
+              pdf.fill_and_stroke if layer.fill && layer.stroke
+              pdf.stroke if layer.stroke
+              pdf.fill if layer.fill
+            end
+          end
+
+          pdf.restore_graphics_state
+        end
+      end
+      
+      # Draws the given template
+      def _draw_template(pdf, template)
+        if pdf.kind_of?(Prawn::Document) && template.visible
+          pdf.save_graphics_state
+
+          if template.visible
+            pdf.stroke do
+              unless template.elliptical
+                pdf.rounded_rectangle(pdf.bounds.top_left, template.width, template.height, template.corner_radius)
+              else
+                x = pdf.bounds.left + (pdf.bounds.width * 0.5)
+                y = pdf.bounds.bottom + (pdf.bounds.height * 0.5)
+                pdf.ellipse([x, y], template.width * 0.5, template.height * 0.5)
+              end
+            end
+          end
+
+          pdf.restore_graphics_state
+        end
+      end
+      
+      # Draws the given text layer with optional content
+      def _draw_text(pdf, layer, content=nil)
+        if pdf.kind_of?(Prawn::Document) && layer.visible
+          pdf.save_graphics_state
+
+          pdf.font layer.font_family
+          pdf.fill_color layer.font_color
+
+          origin = {:x => layer.x, :y => pdf.bounds.top - layer.y}
+          center = {:x => origin[:x] + (layer.width * 0.5), :y => origin[:y] - (layer.height * 0.5)}
+
+          pdf.rotate(layer.rotation, :origin => [center[:x], center[:y]]) do 
+            pdf.transparent layer.alpha do
+              style = :normal
+              style = :bold if layer.bold
+              style = :italic if layer.italic
+              style = :bold_italic if layer.bold && layer.italic
+
+              options = {
+                :at => [origin[:x], origin[:y]],
+                :width => layer.width, 
+                :height => layer.height,
+                :overflow => :truncate,
+                :size => layer.font_size,
+                :align => layer.justification.to_sym,
+                :style => style
+              }
+              unless content.nil?
+                pdf.text_box content, options
+              else
+                pdf.text_box layer.content, options
+              end
+            end
+          end
+
+          pdf.restore_graphics_state
+        end
+      end
+    end
+  end
+end

data/lib/labels/shape.rb

@@ -0,0 +1,35 @@
+# A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+require 'labels/layer'
+
+module Labels
+  
+  # This class represents shape layers.
+  class Shape < Layer
+    
+    # Whether or not the shape is elliptical
+    attr_accessor :elliptical
+    
+    # Corner radius in pixels
+    attr_accessor :corner_radius
+    
+    # Whether or not to fill the shape
+    attr_accessor :fill
+    
+    # Whether or not to stroke the shape
+    attr_accessor :stroke
+    
+    # Fill color in hex
+    attr_accessor :fill_color
+    
+    # Stroke color in hex
+    attr_accessor :stroke_color
+    
+    # Stroke weight in pixels
+    attr_accessor :stroke_weight
+  end
+end

data/lib/labels/template.rb

@@ -0,0 +1,68 @@
+# A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+require 'prawn'
+
+require 'labels/element'
+
+module Labels
+  
+  # This class represents template types and properties
+  class Template < Element
+    DEFAULT = {:title => 'Default', :description => 'Default template', :manufacturer => 'none', :category => 'Default', :visible => false, :width => 288, :height => 144, :columns => 2, :rows => 5, :left_margin => 13, :right_margin => 13, :top_margin => 36, :bottom_margin => 36, :horizontal_gutter => 0, :vertical_gutter => 10, :elliptical => false, :corner_radius => 18}
+    
+    # Title of template
+    attr_accessor :title
+    
+    # Description of template
+    attr_accessor :description
+    
+    # Manufacturer of template
+    attr_accessor :manufacturer
+    
+    # Category of template
+    attr_accessor :category
+    
+    # Whether or not the template is visible when printed
+    attr_accessor :visible
+    
+    # Width of template canvas area in pixels
+    attr_accessor :width
+    
+    # Height of template canvas area in pixels
+    attr_accessor :height
+    
+    # Number of columns in template
+    attr_accessor :columns
+    
+    # Number of rows in template
+    attr_accessor :rows
+    
+    # Left margin of template in pixels
+    attr_accessor :left_margin
+    
+    # Right margin of template in pixels
+    attr_accessor :right_margin
+    
+    # Top margin of template in pixels
+    attr_accessor :top_margin
+    
+    # Bottom margin of template in pixels
+    attr_accessor :bottom_margin
+    
+    # Horizontal gutter of template in pixels
+    attr_accessor :horizontal_gutter
+    
+    # Vertical gutter of template in pixels
+    attr_accessor :vertical_gutter
+    
+    # Whether or not the template canvas area is elliptical
+    attr_accessor :elliptical
+    
+    # Corner radius of template canvas area in pixels
+    attr_accessor :corner_radius
+  end
+end

data/lib/labels/text.rb

@@ -0,0 +1,32 @@
+# A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+require 'labels/layer'
+
+module Labels
+  
+  # This class represents text layers.
+  class Text < Layer
+    
+    # Font family name
+    attr_accessor :font_family
+    
+    # Font size in pixels
+    attr_accessor :font_size
+    
+    # Font color in hex
+    attr_accessor :font_color
+    
+    # Whether or not text is bolded
+    attr_accessor :bold
+    
+    # Whether or not text is italicized
+    attr_accessor :italic
+    
+    # Justification of text
+    attr_accessor :justification
+  end
+end

data/lib/labels/version.rb

@@ -0,0 +1,10 @@
+# A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+# 
+module Labels
+  VERSION = "0.0.3"
+end