labels 0.0.3

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2-p290@labels --create

data/Gemfile

@@ -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
+
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in labels.gemspec
+gemspec

data/README.md

@@ -0,0 +1,100 @@
+Labels
+======
+
+A RubyGem for creating mailing, shipping, address, barcode and other labels and rendering as PDF's.
+
+Features:
+
+* Design mailing, shipping, address, barcode and other labels!
+* Definition of label layout and design using XML
+* Support for different layer elements (shape, text, image, barcode, date) 
+and layer ordering
+* Dynamic replacement of layer content by providing layer
+data
+* Rendering (and printing) of label documents as PDF
+
+Installation
+------------
+
+Labels is a RubyGem and can be installed using:
+
+    $ gem install labels
+
+Layout / Design
+---------------
+
+Labels uses a special XML document type to define label layouts and data.
+It parses XML documents of this type and creates PDF renderings of the document.
+
+See *example/label.xml* for an example label document and *dtd/label.dtd* for
+the XML document type definition.
+
+Usage
+-----
+
+The simplest way to use the Labels library is to open an existing label XML file
+and render the file to PDF:
+
+    label = Labels.open('/path/to/file.xml')
+    label.to_pdf('/path/to/output.pdf')
+    
+To save the document back to XML just do:
+
+    label.to_file('/path/to/file.xml')
+    
+You can also parse a raw labels XML string:
+    
+    xml = '<?xml...>'
+    
+    label = Labels.parse(xml)
+    label.to_pdf('/path/to/output.pdf')
+    
+Label documents can also be created using the Labels library:
+
+    document = Labels::Document.new
+    
+    paper = Labels::Paper.new(Labels::Paper::LETTER)
+    paper.width = 200
+    paper.height = 1000
+    
+    template = Labels::Template.new
+    template.title = 'My cool template'
+    template.columns = 3
+    template.rows = 4
+    template.width = 100
+    template.height = 100
+    
+    shape = Labels::Shape.new
+    shape.width = 40
+    shape.height = 50
+    shape.fill = true
+    shape.fill_color = '777777'
+    
+    document.paper = paper
+    document.template = template
+    document.layers = [shape]
+    
+    document.to_file('/path/to/label.xml')
+    document.to_pdf('/path/to/label.pdf')
+    
+See the API documentation for more information...
+
+Command Line
+------------
+
+Labels also provides a command line tool for rendering label XML files:
+
+    $ labels -h
+    Usage: labels [OPTIONS] source target
+
+        -v, --version
+        -h, --help
+        
+Example:
+
+    $ labels ./path/to/label.xml ./path/to/output.pdf
+        
+License
+-------
+
+MIT License. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,17 @@
+# 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 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+namespace :labels do
+  desc "Start the console"
+  task :console do
+    sh("irb -rubygems -I lib -r labels.rb")
+  end
+end

data/bin/labels

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'labels/exec'
+
+Labels::Exec.new(ARGV).run

data/dtd/label.dtd

@@ -0,0 +1,74 @@
+<!ELEMENT label (paper,template,layers,data)>
+
+<!ATTLIST paper title CDATA #IMPLIED>
+<!ELEMENT paper (width,height)>
+
+<!ATTLIST template title CDATA #IMPLIED>
+<!ATTLIST template description CDATA #IMPLIED>
+<!ATTLIST template manufacturer CDATA #IMPLIED>
+<!ATTLIST template category CDATA #IMPLIED>
+<!ATTLIST template visible (false|true) #REQUIRED>
+<!ELEMENT template (width,height,columns,rows,left-margin,right-margin,top-margin,bottom-margin,horizontal-gutter,vertical-gutter,elliptical,corner-radius)>
+
+<!ELEMENT layers (layer+)>
+
+<!ATTLIST layer title CDATA #IMPLIED>
+<!ATTLIST layer type CDATA #REQUIRED>
+<!ATTLIST layer column CDATA #IMPLIED>
+<!ATTLIST layer locked (false|true) #REQUIRED>
+<!ATTLIST layer visible (false|true) #REQUIRED>
+<!ATTLIST layer resizable CDATA #REQUIRED>
+<!ELEMENT layer (x,y,width,height,alpha,rotation,content,corner-radius?,elliptical?,fill?,stroke?,fill-color?,stroke-color?,stroke-weight?,font-family?,font-size?,font-color?,bold?,italic?,justification?,fit?,stretch?,symbology?,bar-width?,bar-height?,color?,caption-height?,caption-size?,captioned?,format?)>
+
+<!ELEMENT data (item+)>
+
+<!ELEMENT item (key+)>
+
+<!ATTLIST key name CDATA #REQUIRED>
+<!ATTLIST key type (string|integer|float|boolean|date) #REQUIRED>
+<!ELEMENT key (#PCDATA)>
+
+<!ELEMENT width (#PCDATA)>
+<!ELEMENT height (#PCDATA)>
+<!ELEMENT columns (#PCDATA)>
+<!ELEMENT rows (#PCDATA)>
+<!ELEMENT left-margin (#PCDATA)>
+<!ELEMENT right-margin (#PCDATA)>
+<!ELEMENT top-margin (#PCDATA)>
+<!ELEMENT bottom-margin (#PCDATA)>
+<!ELEMENT horizontal-gutter (#PCDATA)>
+<!ELEMENT vertical-gutter (#PCDATA)>
+<!ELEMENT elliptical (#PCDATA)>
+<!ELEMENT corner-radius (#PCDATA)>
+
+<!ELEMENT x (#PCDATA)>
+<!ELEMENT y (#PCDATA)>
+<!ELEMENT alpha (#PCDATA)>
+<!ELEMENT rotation (#PCDATA)>
+<!ELEMENT content (#PCDATA)>
+
+<!ELEMENT fill (#PCDATA)>
+<!ELEMENT stroke (#PCDATA)>
+<!ELEMENT fill-color (#PCDATA)>
+<!ELEMENT stroke-color (#PCDATA)>
+<!ELEMENT stroke-weight (#PCDATA)>
+
+<!ELEMENT font-family (#PCDATA)>
+<!ELEMENT font-size (#PCDATA)>
+<!ELEMENT font-color (#PCDATA)>
+<!ELEMENT bold (#PCDATA)>
+<!ELEMENT italic (#PCDATA)>
+<!ELEMENT justification (#PCDATA)>
+
+<!ELEMENT fit (#PCDATA)>
+<!ELEMENT stretch (#PCDATA)>
+
+<!ELEMENT symbology (#PCDATA)>
+<!ELEMENT bar-width (#PCDATA)>
+<!ELEMENT bar-height (#PCDATA)>
+<!ELEMENT color (#PCDATA)>
+<!ELEMENT caption-height (#PCDATA)>
+<!ELEMENT caption-size (#PCDATA)>
+<!ELEMENT captioned (#PCDATA)>
+
+<!ELEMENT format (#PCDATA)>

data/example/label.xml

@@ -0,0 +1,168 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE label SYSTEM "label.dtd">
+<label>
+  
+  <!-- Paper -->
+  <paper title="Letter">
+    <width>612</width>
+    <height>792</height>
+  </paper>
+  
+  <!-- Template -->  
+  <template title='Avery 2" x 4" Shipping Labels' description="5163/5263..." manufacturer="Avery" category="Shipping Labels" visible="true">
+    <width>288</width>
+    <height>144</height>
+    <columns>2</columns>
+    <rows>5</rows>
+    <left-margin>13</left-margin>
+    <right-margin>13</right-margin>
+    <top-margin>36</top-margin>
+    <bottom-margin>36</bottom-margin>
+    <horizontal-gutter>0</horizontal-gutter>
+    <vertical-gutter>10</vertical-gutter>
+    <elliptical>false</elliptical>
+    <corner-radius>18</corner-radius>
+  </template>
+  
+  <!-- Layers -->
+  <layers>
+    
+    <!-- Layer -->
+    <layer title="Shape" type="shape" column="string" locked="false" visible="true" resizable="true">
+      <x>10</x>
+      <y>20</y>
+      <z>0</z>
+      <width>100</width>
+      <height>100</height>
+      <alpha>1.0</alpha>
+      <rotation>35.0</rotation>
+      <content></content>
+      
+      <!-- Layer Type - Shape-->
+      <corner-radius>10</corner-radius>
+      <elliptical>false</elliptical>
+      <fill>true</fill>
+      <stroke>true</stroke>
+      <fill-color>666666</fill-color>
+      <stroke-color>000000</stroke-color>
+      <stroke-weight>5</stroke-weight>
+    </layer>
+    
+    <layer title="Shape" type="shape" column="string" locked="false" visible="true" resizable="true">
+      <x>15</x>
+      <y>30</y>
+      <z>0</z>
+      <width>120</width>
+      <height>100</height>
+      <alpha>1.0</alpha>
+      <rotation>45</rotation>
+      <content></content>
+      
+      <!-- Layer Type - Shape-->
+      <corner-radius>10</corner-radius>
+      <elliptical>false</elliptical>
+      <fill>true</fill>
+      <stroke>true</stroke>
+      <fill-color>3B67A4</fill-color>
+      <stroke-color>7B34A4</stroke-color>
+      <stroke-weight>5</stroke-weight>
+    </layer>
+    
+    <!-- Layer -->
+    <layer title="Text" type="text" column="string" locked="false" visible="true" resizable="true">
+      <x>20.0</x>
+      <y>20.0</y>
+      <z>10</z>
+      <width>300.0</width>
+      <height>120.0</height>
+      <alpha>1.0</alpha>
+      <rotation>0.0</rotation>
+      <content>Donec ullamcorper</content>
+      
+      <!-- Layer Type - Text-->
+      <font-family>Helvetica</font-family>
+      <font-size>10.0</font-size>
+      <font-color>4F6E7A</font-color>
+      <bold>false</bold>
+      <italic>false</italic>
+      <justification>right</justification> <!-- left|right|center|justify -->
+    </layer>
+    
+    <!-- Layer -->
+    <layer title="Image" type="image" column="data" locked="false" visible="true" resizable="true">
+      <x>1.0</x>
+      <y>2.0</y>
+      <z>0</z>
+      <width>20.0</width>
+      <height>10.0</height>
+      <alpha>0.5</alpha>
+      <rotation>10.0</rotation>
+      <content>iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==</content>
+      
+      <!-- Layer Type - Image-->
+      <fit>false</fit>
+      <stretch>true</stretch>
+    </layer>
+    
+    <!-- Layer -->
+    <layer title="Barcode" type="barcode" column="string" locked="false" visible="true" resizable="true">
+      <x>100.0</x>
+      <y>100.0</y>
+      <z>0</z>
+      <width>200.0</width>
+      <height>40.0</height>
+      <alpha>1.0</alpha>
+      <rotation>0.0</rotation>
+      <content>123456</content>
+      
+      <!-- Layer Type - Barcode-->
+      <symbology>Codabar</symbology>
+      <bar-width>20</bar-width>
+      <bar-height>500</bar-height>
+      <color>000000</color>
+      <caption-height>180</caption-height>
+      <caption-size>167</caption-size>
+      <captioned>true</captioned>
+    </layer>
+    
+    <!-- Layer -->
+    <layer title="Date" type="date" column="date" locked="0" visible="1" resizable="1">
+      <x>1.0</x>
+      <y>2.0</y>
+      <z>0</z>
+      <width>100.0</width>
+      <height>10.0</height>
+      <alpha>1.0</alpha>
+      <rotation>0.0</rotation>
+      <content>2007-03-01T13:00:00Z</content>
+      
+      <!-- Layer Type - Date-->
+      <font-family>Helvetica</font-family>
+      <font-size>10.0</font-size>
+      <font-color>333333</font-color>
+      <bold>false</bold>
+      <italic>false</italic>
+      <underline>false</underline>
+      <justification>left</justification> <!-- left|right|center|justified -->
+      <format>%Y-%m-%d %H:%M:%S</format>
+    </layer>
+    
+    <!-- More layers... -->
+  </layers>
+  
+  <!-- Data -->
+  <data>
+    
+    <!-- Item -->
+    <item>
+      <key name="string">000222111</key>
+      <key name="data">iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==</key>
+      <key name="date">2007-06-01T13:00:00Z</key>
+      <key name="integer">123</key>
+      <key name="float">1.23</key>
+      <key name="boolean">false</key>
+    </item>
+    
+    <!-- More items... -->
+  </data>
+</label>

data/labels.gemspec

@@ -0,0 +1,36 @@
+# 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
+
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "labels/version"
+
+Gem::Specification.new do |s|
+  s.name        = "labels"
+  s.version     = Labels::VERSION
+  s.authors     = ["Aaron Wright"]
+  s.email       = ["acwrightdesign@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{PDF label creation using Ruby}
+  s.description = %q{Labels can help you build and render labels as PDF}
+
+  s.rubyforge_project = "labels"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_runtime_dependency 'prawn'
+  s.add_runtime_dependency 'nokogiri'
+  s.add_runtime_dependency 'uuid'
+  s.add_runtime_dependency 'barcodes'
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,15 @@
+# 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
+
+# 
+class String
+  # Convert string to bool
+  def to_bool
+    return true   if self == true   || self =~ (/(true|t|yes|y|1)$/i)
+    return false  if self == false  || self.empty? || self =~ (/(false|f|no|n|0)$/i)
+    return false
+  end
+end

data/lib/labels/barcode.rb

@@ -0,0 +1,39 @@
+# 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'
+
+require 'barcodes'
+
+module Labels
+  
+  # This class represents barcode layers.
+  # For available symbologies and option descriptions
+  # see the Barcodes RubyGem library.
+  class Barcode < Layer
+    
+    # Symbology
+    attr_accessor :symbology
+    
+    # Bar width in mils
+    attr_accessor :bar_width
+    
+    # Bar height in mils
+    attr_accessor :bar_height
+    
+    # Color in hex
+    attr_accessor :color
+    
+    # Caption height in mils
+    attr_accessor :caption_height
+    
+    # Caption font size in mils
+    attr_accessor :caption_size
+    
+    # Whether or not to print caption
+    attr_accessor :captioned
+  end
+end

data/lib/labels/date.rb

@@ -0,0 +1,19 @@
+# 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 'time'
+
+require 'labels/text'
+
+module Labels
+  
+  # This class represents date layers.
+  class Date < Text
+    
+    # The date formatting
+    attr_accessor :format
+  end
+end

data/lib/labels/document.rb

@@ -0,0 +1,64 @@
+# 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 'fileutils'
+
+require 'labels/paper'
+require 'labels/template'
+require 'labels/xml/builder'
+require 'labels/pdf/builder'
+
+module Labels
+  
+  # This class represents a Labels document.
+  class Document
+    
+    # The document Labels::Paper instance
+    attr_accessor :paper
+    
+    # The document Labels::Template instance
+    attr_accessor :template
+    
+    # An array of document Labels::Layer instances
+    attr_accessor :layers
+    
+    # An array of document data
+    attr_accessor :data
+    
+    # Creates a new Labels::Document instance with optional content
+    def initialize(paper=nil, template=nil, layers=[], data=[])
+      unless paper.nil?
+        @paper = paper
+      else
+        @paper = Labels::Paper.new(Labels::Paper::LETTER)
+      end
+      
+      unless template.nil?
+        @template = template
+      else
+        @template = Labels::Template.new(Labels::Template::DEFAULT)
+      end
+      
+      @layers = layers
+      @data = data
+    end
+    
+    # Writes document to filename as XML
+    def write(filename)
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.open(filename, 'w') do |file|
+        file.write Labels::XML::Builder.new(self).xml
+      end
+    end
+    alias_method :to_file, :write
+    
+    # Render document to filename or string
+    def render(filename=nil)
+      Labels::PDF::Builder.new(self).render(filename)
+    end
+    alias_method :to_pdf, :render
+  end
+end

data/lib/labels/element.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
+
+module Labels
+  
+  # This class is a base class for all document content types
+  class Element
+    
+    # Creates a new Labels::Element instance with given arguments
+    def initialize(args=nil)
+      unless args.nil?
+        args.each do |k,v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+      end
+    end
+    
+    # Converts instance variables to hash
+    def to_h
+      hash = {}
+      self.instance_variables.each {|var| hash[var.to_s.delete("@").to_sym] = self.instance_variable_get(var) }
+      hash
+    end
+    alias_method :to_hash, :to_h
+  end
+end

data/lib/labels/exec.rb

@@ -0,0 +1,92 @@
+# 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 'optparse'
+
+require 'labels'
+require 'labels/version'
+
+module Labels
+  
+  # This class is the main handler for the command line tool interface.
+  # It takes command line arguments and options and renders a barcode 
+  # using those options.
+  class Exec
+    
+    # Array of command line arguments
+    attr_reader :argv
+    
+    # The parser instance
+    attr_reader :parser
+    
+    # Hash of parsed options
+    attr_reader :options
+    
+    # The input source
+    attr_reader :source
+    
+    # The output target
+    attr_reader :target
+    
+    # Creates a new instance with given command line arguments and options
+    def initialize(argv)
+      @argv = argv
+      @options = {}
+      self._init_parser
+      self._parse!
+    end
+    
+    # Runs the command and renders label
+    def run
+      begin
+        document = Labels.open(self.source)
+      
+        unless document.nil?
+          unless self.target.nil?
+            document.render(self.target)
+          else
+            puts document.render
+          end
+        end
+      rescue Exception => e
+        puts e.message
+      end
+    end
+    
+    protected
+    
+    # Initializes the option parser instance
+    def _init_parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: labels [OPTIONS] source target"
+        opts.separator ""
+        opts.on('-v', '--version')                              { puts self._version ; exit }
+        opts.on('-h', '--help')                                 { puts opts ; exit }
+        opts.separator ""
+      end
+      
+    end
+    
+    # Parses the command line arguments
+    def _parse!
+      
+      begin
+        self.parser.parse!(@argv)
+      rescue
+        puts self.parser.help
+        exit 1
+      end
+      
+      @source = self.argv.shift
+      @target = self.argv.shift
+    end
+
+    # Returns the current version
+    def _version
+      "labels #{Labels::VERSION}"
+    end
+  end
+end