pdf-labels 1.0.0

data/History.txt

@@ -0,0 +1,8 @@
+== 0.2.0 / 2006-04-25
+
+* First published to Rubyforge
+
+== 0.3.0 / 2007-06-23
+
+* PDFLabels library packed for Ruport and general consumption
+

data/LICENCE

@@ -0,0 +1,38 @@
+PDF::Labels, the compilation and the majority of the works, are copyright � 2006 Rob Kaufman and are released under an MIT-style licence, detailed below. There are other portions of PDF::Labels which are derivative works of others under other licences and Adobe holds several patents related to PDF document creation and reading.
+
+PDF::Labels for Ruby Licence
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the *Software*), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+    * The names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission.
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Works Under Other Licences
+All files in the templates/ directory
+
+PDF::Labels includes an XML schema and label discription files from the gLabels project (http://glabels.sourceforge.org).  These gLabels templates are released under the LGPL licence.
+
+Patents Covering the Adobe PDF Format
+ADOBE PATENTS
+
+This software is based on Adobe�s PDF Reference, Third Edition, version 1.6. There may be limitations on the use of this library based on patent restrictions from Adobe. See below for more information.
+UNISYS LZW PATENT
+
+This software does not fully conform to the Adobe PDF specification because no support for LZW is included in this software. At the time of original development of this software (2003), the Unisys LZW patent was still in effect outside of the United States. This will be modified in a future version of this software.
+Patent Clarification Notice: Reading and Writing PDF Files
+
+Adobe has a number of patents covering technology that is disclosed in the Portable Document Format (PDF) Specification, version 1.6 and later, as documented in PDF Reference and associated Technical Notes (the �Specification�. Adobe desires to promote the use of PDF for information interchange among diverse products and applications.
+
+Accordingly, the following patents are licensed on a royalty-free, non-exclusive basis for the term of each patent and for the sole purpose of developing software that produces, consumes, and interprets PDF files that are compliant with the Specification:
+
+    * U.S. Patent Numbers: 5,634,064; 5,737,599; 5,781,785; 5,819,301; 6,028,583; 6,289,364; 6,421,460
+
+In addition, the following patent is licensed on a royalty-free, non-exclusive basis for its term and for the sole purpose of developing software that produces PDF files that are compliant with the Specification (specifically excluding, however, software that consumes and/or interprets PDF files):
+
+    * U.S. Patent Numbers: 5,860,074
+
+The above licenses are limited to only those rights required to implement the Specification and no others. That is to say, Adobe grants only those rights in the above patent(s) necessarily practiced to implement the Specification, and does not grant any rights not required to implement the Specification. The licenses do not grant the right to practice any patent covering other technologies, such as implementation techniques that are not explicitly disclosed in the Specification, nor does it allow the use of any patented feature for any purpose other than as set forth in the applicable license grant. Adobe has other patents in various fields, none of which are hereby licensed.
+

data/Manifest.txt

@@ -0,0 +1,141 @@
+History.txt
+LICENCE
+Manifest.txt
+README.txt
+Rakefile
+lib/alias.rb
+lib/glabel_template.rb
+lib/label.rb
+lib/layout.rb
+lib/length_node.rb
+lib/markup.rb
+lib/pdf_label_page.rb
+lib/pdf_labels.rb
+lib/template.rb
+templates/avery-iso-templates.xml
+templates/avery-other-templates.xml
+templates/avery-us-templates.xml
+templates/glabels-2.0.dtd
+templates/misc-iso-templates.xml
+templates/misc-other-templates.xml
+templates/misc-us-templates.xml
+templates/paper-sizes.xml
+templates/zweckform-iso-templates.xml
+test/test_pdf_label_page.rb
+vendor/color.rb
+vendor/color/cmyk.rb
+vendor/color/css.rb
+vendor/color/grayscale.rb
+vendor/color/hsl.rb
+vendor/color/palette.rb
+vendor/color/palette/gimp.rb
+vendor/color/palette/monocontrast.rb
+vendor/color/rgb-colors.rb
+vendor/color/rgb.rb
+vendor/color/rgb/metallic.rb
+vendor/color/yiq.rb
+vendor/pdf/charts.rb
+vendor/pdf/charts/stddev.rb
+vendor/pdf/grid.rb
+vendor/pdf/math.rb
+vendor/pdf/pagenumbers.rb
+vendor/pdf/quickref.rb
+vendor/pdf/simpletable.rb
+vendor/pdf/techbook.rb
+vendor/pdf/writer.rb
+vendor/pdf/writer/arc4.rb
+vendor/pdf/writer/fontmetrics.rb
+vendor/pdf/writer/fonts/Courier-Bold.afm
+vendor/pdf/writer/fonts/Courier-BoldOblique.afm
+vendor/pdf/writer/fonts/Courier-Oblique.afm
+vendor/pdf/writer/fonts/Courier.afm
+vendor/pdf/writer/fonts/Helvetica-Bold.afm
+vendor/pdf/writer/fonts/Helvetica-BoldOblique.afm
+vendor/pdf/writer/fonts/Helvetica-Oblique.afm
+vendor/pdf/writer/fonts/Helvetica.afm
+vendor/pdf/writer/fonts/Symbol.afm
+vendor/pdf/writer/fonts/Times-Bold.afm
+vendor/pdf/writer/fonts/Times-BoldItalic.afm
+vendor/pdf/writer/fonts/Times-Italic.afm
+vendor/pdf/writer/fonts/Times-Roman.afm
+vendor/pdf/writer/fonts/ZapfDingbats.afm
+vendor/pdf/writer/graphics.rb
+vendor/pdf/writer/graphics/imageinfo.rb
+vendor/pdf/writer/lang.rb
+vendor/pdf/writer/lang/en.rb
+vendor/pdf/writer/object.rb
+vendor/pdf/writer/object/action.rb
+vendor/pdf/writer/object/annotation.rb
+vendor/pdf/writer/object/catalog.rb
+vendor/pdf/writer/object/contents.rb
+vendor/pdf/writer/object/destination.rb
+vendor/pdf/writer/object/encryption.rb
+vendor/pdf/writer/object/font.rb
+vendor/pdf/writer/object/fontdescriptor.rb
+vendor/pdf/writer/object/fontencoding.rb
+vendor/pdf/writer/object/image.rb
+vendor/pdf/writer/object/info.rb
+vendor/pdf/writer/object/outline.rb
+vendor/pdf/writer/object/outlines.rb
+vendor/pdf/writer/object/page.rb
+vendor/pdf/writer/object/pages.rb
+vendor/pdf/writer/object/procset.rb
+vendor/pdf/writer/object/viewerpreferences.rb
+vendor/pdf/writer/ohash.rb
+vendor/pdf/writer/oreader.rb
+vendor/pdf/writer/state.rb
+vendor/pdf/writer/strokestyle.rb
+vendor/transaction/simple.rb
+vendor/transaction/simple/group.rb
+vendor/transaction/simple/threadsafe.rb
+vendor/transaction/simple/threadsafe/group.rb
+vendor/xml-mapping/ChangeLog
+vendor/xml-mapping/LICENSE
+vendor/xml-mapping/README
+vendor/xml-mapping/README_XPATH
+vendor/xml-mapping/Rakefile
+vendor/xml-mapping/TODO.txt
+vendor/xml-mapping/doc/xpath_impl_notes.txt
+vendor/xml-mapping/examples/company.rb
+vendor/xml-mapping/examples/company.xml
+vendor/xml-mapping/examples/company_usage.intin.rb
+vendor/xml-mapping/examples/company_usage.intout
+vendor/xml-mapping/examples/order.rb
+vendor/xml-mapping/examples/order.xml
+vendor/xml-mapping/examples/order_signature_enhanced.rb
+vendor/xml-mapping/examples/order_signature_enhanced.xml
+vendor/xml-mapping/examples/order_signature_enhanced_usage.intin.rb
+vendor/xml-mapping/examples/order_signature_enhanced_usage.intout
+vendor/xml-mapping/examples/order_usage.intin.rb
+vendor/xml-mapping/examples/order_usage.intout
+vendor/xml-mapping/examples/time_augm.intin.rb
+vendor/xml-mapping/examples/time_augm.intout
+vendor/xml-mapping/examples/time_node.rb
+vendor/xml-mapping/examples/xpath_create_new.intin.rb
+vendor/xml-mapping/examples/xpath_create_new.intout
+vendor/xml-mapping/examples/xpath_docvsroot.intin.rb
+vendor/xml-mapping/examples/xpath_docvsroot.intout
+vendor/xml-mapping/examples/xpath_ensure_created.intin.rb
+vendor/xml-mapping/examples/xpath_ensure_created.intout
+vendor/xml-mapping/examples/xpath_pathological.intin.rb
+vendor/xml-mapping/examples/xpath_pathological.intout
+vendor/xml-mapping/examples/xpath_usage.intin.rb
+vendor/xml-mapping/examples/xpath_usage.intout
+vendor/xml-mapping/install.rb
+vendor/xml-mapping/lib/xml/mapping.rb
+vendor/xml-mapping/lib/xml/mapping/base.rb
+vendor/xml-mapping/lib/xml/mapping/standard_nodes.rb
+vendor/xml-mapping/lib/xml/mapping/version.rb
+vendor/xml-mapping/lib/xml/xxpath.rb
+vendor/xml-mapping/test/all_tests.rb
+vendor/xml-mapping/test/company.rb
+vendor/xml-mapping/test/documents_folders.rb
+vendor/xml-mapping/test/fixtures/bookmarks1.xml
+vendor/xml-mapping/test/fixtures/company1.xml
+vendor/xml-mapping/test/fixtures/documents_folders.xml
+vendor/xml-mapping/test/fixtures/documents_folders2.xml
+vendor/xml-mapping/test/multiple_mappings.rb
+vendor/xml-mapping/test/tests_init.rb
+vendor/xml-mapping/test/xml_mapping_adv_test.rb
+vendor/xml-mapping/test/xml_mapping_test.rb
+vendor/xml-mapping/test/xpath_test.rb

data/README.txt

@@ -0,0 +1,72 @@
+PdfLabels
+    by Rob Kaufman
+    http://www.lightning-tree.net
+
+== DESCRIPTION:
+  
+Welcome to the PDF-Labels project.  Our aim is to make creating labels
+programmatically easy in Ruby.  This Library builds on top of
+"PDF::Writer":http://ruby-pdf.rubyforge.org/ and uses the templates
+from "gLabels":http://glabels.sourceforge.org.  What this means is
+easy, clean Ruby code to create many common label types without
+measuring the labels yourself!  All of this in pure Ruby (we use the
+XML templates from gLabels, we do NOT have a dependancy on gLabels,
+nor on Gnome)
+
+== FEATURES/PROBLEMS:
+  
+* Works with all gLabels supported templates for rectangular labels
+* Does not yet work for CD labels (circles)
+
+== SYNOPSIS:
+
+    p = PDFLabelPage.new("Avery  8160") # label is 2 x 10
+    #Some examples of adding labels
+    p.add_label() # should add to col 1, row 1
+    p.add_label(:position => 1) # should add col 1, row 2
+    p.add_label(:text => "Positoin 15", :position => 15) # should add col 2, row 1
+    p.add_label(:text => 'No Margin', :position => 5, :use_margin => false) #this doesn't use a margin
+    p.add_label(:position => 9, :text => "X Offset = 4, Y Offset = -6", :offset_x => 4, :offset_y => -6)
+    p.add_label(:text => "Centered", :position => 26, :justification => :center) # should add col 2, row 15
+    p.add_label(:text => "[Right justified]", :justification => :right, :position => 28)# col 2, row 14, right justified.
+    p.add_label(:position => 29) # should add col 2, row 15
+    p.add_label(:position => 8, :text => "This was added last and has a BIG font", :font_size => 18)
+
+    #If you want to see the boxes around each label (good for printing alignment samples)
+    p.draw_boxes(false, true)
+
+    #Save your PDF when your done
+    p.save_as("../label_output.pdf")
+
+== REQUIREMENTS:
+
+Currently there are no external dependencies, though a version of xml-mapping and pdf-writer (and its dependencies) are provided in vendor
+
+== INSTALL:
+
+sudo gem install pdf-labels
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Rob Kaufman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+# -*- ruby -*-
+
+ENV['RUBY_FLAGS'] = "-I#{%w(lib test vendor).join(File::PATH_SEPARATOR)}"
+require 'rubygems'
+require 'hoe'
+require './lib/pdf_labels.rb'
+
+#Ryan, if you want to have strong opinions thats cool, but if you want to be a prick about it, you'd better be right... and your not
+class Hoe
+  def extra_deps
+    @extra_deps.reject do |x|
+      Array(x).first == 'hoe'
+    end
+  end
+end
+
+Hoe.new('pdf-labels', Pdflabels::VERSION) do |p|    
+  p.rubyforge_name = 'pdf-labels'
+  p.author = 'Rob Kaufman'
+  p.email = 'rgkaufman@gmail.com'
+  p.summary = 'Easy label creation in Ruby through PDF::Writer and using templates from gLabels. Contains the library pdf_labels, the Rails engine LabelPageEngine and an example application FileClerk.'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+task :clean do
+  dir = Dir.new(Dir.pwd)
+  dir.grep(/pdf$/) {|file| rm file}
+end

data/lib/alias.rb

@@ -0,0 +1,8 @@
+require 'xml/mapping'
+require 'length_node'
+
+class Alias
+	include XML::Mapping
+	text_node :name, "@name"
+end
+

data/lib/glabel_template.rb

@@ -0,0 +1,36 @@
+require 'template'
+
+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
+

data/lib/label.rb

@@ -0,0 +1,52 @@
+require 'length_node'
+require 'layout'
+require 'markup'
+
+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
+

data/lib/layout.rb

@@ -0,0 +1,13 @@
+require 'length_node'
+
+
+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
+

data/lib/length_node.rb

@@ -0,0 +1,47 @@
+require 'xml/mapping/base'
+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