label_factory 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 691b28eda19c88eb8c0f074dac652f0178ebd637
+  data.tar.gz: 0360afa4f29142106e5c9c548713515898dc2d3a
+SHA512:
+  metadata.gz: bf3367d7084305e573827599dab927d93e47633011d194c6ae6b9b43b93b4f4bc6fb673ad59a19bcf275cc7601f88022a76b6217b566b21b4ee5cc29fb9f4c31
+  data.tar.gz: 554c74b041dac1da6eeeb80ee0cff1256aa6d17d5b3c5350e37a236b1e140d10409b55873560986c247fc015037ccc09657bf98e6a0888993f667feda1f974b9

data/.gitignore

@@ -0,0 +1,19 @@
+*.pdf
+.rbenv-version
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'http://gems.github.com'
+
+# Specify your gem's dependencies in label_factory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 gagoar
+
+MIT License
+
+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/README.md

@@ -0,0 +1,67 @@
+# LabelFactory
+
+create pdf labels with pure ruby
+
+you can load your templates in [Glabels](http://www.glabels.org/) format or use the ones that we have already included
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'label_factory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install label_factory
+
+## Usage
+
+this example is taken from tests suit:
+
+``` ruby
+    p = LabelFactory::Batch::Base.new("Avery 8160") # label is 2 x 10
+    p.draw_boxes(false, true)
+    p.add_label("&*\%Positoin 15", position: 15) # should add col 2, row 1
+    p.add_label('With Margin', use_margin: true, position: 4)
+    p.add_label('No Margin', position: 5, use_margin: false)
+    p.add_label('This is the song that never ends, yes it goes on and on my friends', position: 7 )
+    p.add_label('X Offset = 4, Y Offset = -6', position: 9,  offset_x: 4, offset_y: -6)
+    p.add_label('Centered', position: 26, justification: :center) # should add col 2, row 15
+    p.add_label('[Right justified]', justification: :right, position: 28) # col 2, row 14, right justified.
+    p.add_label('col 2 row 15', position: 29) # should add col 2, row 15
+    p.add_label('This was added first and has a BIG font', position: 8,  font_size: 16)
+    p.add_label('This was added last and has a small font', position: 8, font_size: 8, offset_y: -40)
+    p.save_as('labels.pdf')
+```
+
+or multiple lines and fonts per line in a single label!
+
+``` ruby
+    pdf = LabelFactory::Batch::Base.new('Avery 8160')
+    pdf.draw_boxes(false, false)
+    contents = [];
+    contents << {text: 'This', justification: :center, font_size: 8, font_type: 'Courier'}
+    contents << {text: 'Is a', justification: :right, font_size: 8, font_type: 'Helvetica-BoldOblique'}
+    contents << {text: 'Test', font_type: 'Times-Roman'}
+    5.times do |i|
+      pdf.add_multiline_label(contents,i)
+    end
+
+    pdf.save_as('other_labels.pdf')
+```
+
+## Credits
+
+this gem is inspirated in [PDF-labels](http://rubyforge.org/projects/pdf-labels/)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/label_factory.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'label_factory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'label_factory'
+  spec.version       = LabelFactory::VERSION
+  spec.authors       = ['gagoar']
+  spec.email         = ['xeroice@gmail.com']
+  spec.description   = %q{pdf label creation in ruby}
+  spec.summary       = %q{http://github.com/eventioz/label_factory}
+  spec.homepage      = "http://github.com/eventioz/label_factory"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'metaskills-pdf-writer'
+  spec.add_dependency 'xml-mapping' , '0.8.1'
+
+  #development
+  spec.add_development_dependency "bundler", ">= 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/label_factory/batch/base.rb

@@ -0,0 +1,248 @@
+module LabelFactory
+  module Batch
+    class Base
+
+
+      DEFAULTS = { justification: :left, font_size: 12, font_type: 'Helvetica' }
+      attr_accessor :template, :label, :pdf, :manual_new_page
+      attr_reader :labels_per_page
+
+      @@gt = nil
+
+      def initialize(template_name, pdf_opts = {})
+
+        @template = gt.find_template(template_name)
+
+        if @template
+
+          #if the template specifies the paper type, and the user didn't use it.
+          pdf_opts[:paper] = @template.size.gsub(/^.*-/,'') if @template.size && !pdf_opts.has_key?(:paper)
+
+          @label = @template.labels['0']
+          @layout = @label.layouts.first
+          @labels_per_page = [ @layout.nx, @layout.ny ].reduce(:*)
+          @zero_based_labels_per_page = @labels_per_page - 1
+
+          # set font_dir if needed
+          font_dir = pdf_opts.delete(:font_dir)
+          PDF::Writer::FONT_PATH << font_dir if font_dir && ! PDF::Writer::FONT_PATH.include?( font_dir )
+          # set afm_dir if needed
+          afm_dir = pdf_opts.delete(:afm_dir)
+          PDF::Writer::FontMetrics::METRICS_PATH << afm_dir if afm_dir && ! PDF::Writer::FontMetrics::METRICS_PATH.include?( font_dir )
+
+          @pdf = PDF::Writer.new(pdf_opts)
+
+          @pdf.margins_pt(0, 0, 0, 0)
+
+        else
+          raise 'Template not found!'
+        end
+      end
+
+      def self.gt
+        @@gt || self.load_template_set
+      end
+
+      def gt
+        self.class.gt
+      end
+
+      def self.load_template_set(template_set_file=nil)
+        template_set_file ||= File.join(TEMPLATES_PATH, Template::Base::DEFAULT)
+        @@gt = Template::Glabel.load_from_file(template_set_file)
+      end
+
+      def self.all_template_names
+        gt.all_avaliable_templates
+      end
+
+      def self.all_templates
+        gt.templates.values
+      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(text, options = {})
+        unless options.delete(:skip)
+          label_x, label_y, label_width = setup_add_label_options(options)
+          opts = setup(label_x, label_width, options)
+          @pdf.y = label_y
+        end
+        opts ||= options
+        @pdf.select_font options[:font_type] if options[:font_type]
+        text.force_encoding('UTF-8')
+        @pdf.text(text, opts)
+        opts
+      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(text, options = {})
+        if !( options[:x] || options[:y] )
+          options[:position] ||= 0
+          if options[:count]
+            options[:count].times do
+              add_label(text, options)
+              options[:position] += 1
+            end
+          else
+            raise 'Count required'
+          end
+        else
+          raise "Can't use X,Y with add_many_labels, you must use position"
+        end
+      end
+
+=begin rdoc
+    we needed something handy to write several lines into a single label, so we provide an array with hashes inside, each hash must contain a [:text] key and
+    could contain optional parameters such as :justification, and :font_size if not DEFAULTS options are used.
+=end
+      def add_multiline_label(content = [], position = 0)
+        opts = {}
+        content.each_with_index do |options, i|
+          options = DEFAULTS.merge(options)
+          if i.zero?
+            opts = options
+            opts[:position] = position
+          else
+            opts[:skip] = true
+            opts.merge!(options)
+          end
+          text = opts.delete(:text)
+          opts = add_label(text, opts)
+        end
+      end
+
+=begin rdoc
+      To facilitate aligning a printer we give a method that prints the outlines of the labels
+=end
+      def do_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(text, x: box_x, y: box_y )
+            end
+
+            if draw_markups
+              @label.markupMargins.each do |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
+              end
+              @label.markupLines.each do |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
+              end
+            end
+          end
+        end
+      end
+
+      private :do_draw_boxes
+
+      def draw_boxes(write_coord = true, draw_markups = true)
+        pdf.open_object do |heading|
+          pdf.save_state
+          do_draw_boxes(write_coord, draw_markups)
+          pdf.restore_state
+          pdf.close_object
+          pdf.add_object(heading, :all_pages)
+        end
+      end
+
+      def save_as(file_name)
+        @pdf.save_as(file_name)
+      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
+        get_x_y(x, y)
+      end
+
+      def get_x_y(x, y)
+        label_y = @pdf.absolute_top_margin
+        label_y += @pdf.top_margin
+        label_y -= @layout.y0.as_pts
+        label_y -= [y, @layout.dy.as_pts].reduce(:*)
+
+        label_x = @pdf.absolute_left_margin
+        label_x -=  @pdf.left_margin
+        label_x +=  @layout.x0.as_pts
+        label_x +=  [x, @layout.dx.as_pts ].reduce(:*)
+
+        [ 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
+            position = position % @labels_per_page
+            # if remainder is zero, we're dealing with the first label of a new page
+            @pdf.new_page if ( position.zero? && manual_new_page.nil? )
+          end
+          label_x, label_y = position_to_x_y(position)
+        else
+          label_x, label_y = position_to_x_y(0) unless ( label_x = options[:x] ) && ( label_y = options[:y] )
+        end
+
+        label_width = label_x + @label.width.as_pts
+
+        if options[:use_margin].nil?
+          @label.markupMargins.each do |margin|
+            label_x += margin.size.as_pts
+            label_y -= margin.size.as_pts
+            label_width -= margin.size.as_pts
+          end
+        end
+
+        if options[:offset_x]
+          label_x += options[:offset_x]
+          label_width += options[:offset_x]
+        end
+
+        label_y +=  options[:offset_y] if options[:offset_y]
+
+        [ label_x, label_y, label_width ]
+
+      end
+
+      def setup(label_x, label_width, options)
+        config = DEFAULTS.merge( { absolute_left: label_x, absolute_right: label_width } )
+        config.merge! options
+        config.delete(:position)
+        config
+      end
+
+    end
+  end
+end

data/lib/label_factory/label/alias.rb

@@ -0,0 +1,10 @@
+module LabelFactory
+  module Label
+    class Alias
+    	include XML::Mapping
+
+    	text_node :name, '@name'
+
+    end
+  end
+end

data/lib/label_factory/label/base.rb

@@ -0,0 +1,22 @@
+module LabelFactory
+  module Label
+    class Base
+      include XML::Mapping
+
+      attr_accessor :shape
+
+      numeric_node :id, '@id'
+
+      array_node :markupMargins,  'Markup-margin',  class: Layout::Margin,  default_value: nil
+      array_node :markupCircles,  'Markup-circle',  class: Layout::Circle,  default_value: nil
+      array_node :markupLines,    'Markup-line',    class: Layout::Line,    default_value: nil
+
+      array_node :layouts, 'Layout', class: Layout::Base
+
+      def markups
+        @markups ||= [@markupMargins, @markupLines, @markupCircles ].reduce(:merge)
+      end
+
+    end
+  end
+end

data/lib/label_factory/label/cd.rb

@@ -0,0 +1,11 @@
+module LabelFactory
+  module Label
+
+    class Cd < Base
+      length_node :radius, '@radius'
+      length_node :waste, '@radius', default_value: '0 pt'
+      @kind = 'Round'
+    end
+
+  end
+end

data/lib/label_factory/label/rectangle.rb

@@ -0,0 +1,15 @@
+module LabelFactory
+  module Label
+
+    class Rectangle < Base
+      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
+  end
+end

data/lib/label_factory/label/round.rb

@@ -0,0 +1,12 @@
+module LabelFactory
+  module Label
+    class Round < Base
+
+      length_node :radius, '@radius'
+      length_node :waste, '@radius', default_value: '0 pt'
+      @kind = 'Round'
+
+    end
+
+  end
+end

data/lib/label_factory/layout/base.rb

@@ -0,0 +1,17 @@
+module LabelFactory
+  module Layout
+    class Base
+
+    	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/label_factory/layout/circle.rb

@@ -0,0 +1,11 @@
+module LabelFactory
+  module Layout
+    class Circle
+    	include XML::Mapping
+
+    	length_node :x0, '@x0'
+    	length_node :y0, '@y0'
+    	length_node :radius, '@radius'
+    end
+  end
+end

data/lib/label_factory/layout/length.rb

@@ -0,0 +1,33 @@
+module LabelFactory
+  module Layout
+    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
+  end
+end

data/lib/label_factory/layout/line.rb

@@ -0,0 +1,12 @@
+module LabelFactory
+  module Layout
+    class Line
+    	include XML::Mapping
+
+    	length_node :x1, '@x1'
+    	length_node :y1, '@y1'
+    	length_node :x2, '@x2'
+    	length_node :y2, '@y2'
+    end
+  end
+end

data/lib/label_factory/layout/margin.rb

@@ -0,0 +1,9 @@
+module LabelFactory
+  module Layout
+    class Margin
+    	include XML::Mapping
+
+    	length_node :size, '@size'
+    end
+  end
+end

data/lib/label_factory/template/base.rb

@@ -0,0 +1,53 @@
+module LabelFactory
+  module Template
+    class Base
+      include XML::Mapping
+
+      DEFAULT = 'avery-us-templates.xml'
+
+      attr_accessor :labels
+
+      text_node   :name,         '@name'
+      text_node   :size,         '@size'
+      text_node   :description,  '@description',  default_value: ''
+      text_node   :_description, '@_description', default_value: ''
+
+      length_node :width,        '@width',        default_value: nil
+      length_node :height,       '@height',       default_value: nil
+
+      #TODO this could be cleaner, but I'm not sure how yet
+      hash_node :rectangles, 'Label-rectangle', '@id', class: Label::Rectangle, default_value: nil
+      hash_node :rounds,     'Label-round',     '@id', class: Label::Round,     default_value: nil
+      hash_node :cds,        'Label-cd',        '@id', class: Label::Cd,        default_value: nil
+
+      hash_node :alias, 'Alias', '@name', class: Label::Alias, default_value: Hash.new
+
+      def initialize
+
+      end
+
+      def labels
+        @labels ||= [ @rectangles, @rounds, @cds ].reduce(:merge)
+      end
+
+      def nx
+        first_layout.nx if first_layout
+      end
+
+      def ny
+        first_layout.ny if first_layout
+      end
+
+      def find_description
+        _description || description
+      end
+
+      private
+
+      def first_layout
+        label = labels['0']
+        label.layouts.first if label
+      end
+    end
+  end
+end

data/lib/label_factory/template/glabel.rb

@@ -0,0 +1,32 @@
+module LabelFactory
+  module Template
+    class Glabel
+      include XML::Mapping
+
+      hash_node :templates, 'Template', '@name', class: Base, default_value: Hash.new
+
+      def find_all_templates
+        unless @templates
+          @templates = []
+          templates.each do |template|
+           template = template[1]
+            @templates << template.name
+            template.alias.each do |aliases|
+              @templates << aliases[1].name
+            end
+          end
+        end
+        @templates
+      end
+
+      def find_template(template_name)
+        template = templates.find{|k,v| k == template_name || v.alias[template_name]}
+        template[1] if template
+      end
+
+      def all_avaliable_templates
+        templates.values.map(&:name) + templates.values.map(&:alias).map(&:keys).flatten
+      end
+    end
+  end
+end

data/lib/label_factory/util/length_node.rb

@@ -0,0 +1,22 @@
+module LabelFactory
+  module Util
+    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}
+    		Layout::Length.new(@value)
+      end
+
+      def set_attr_value(xml, value)
+        raise "Not a Length: #{value}" unless value.is_a? Layout::Length
+        @path.first(xml, ensure_created: true).text = value.value
+      end
+    end
+
+    XML::Mapping.add_node_class LengthNode
+  end
+end

data/lib/label_factory/version.rb

@@ -0,0 +1,3 @@
+module LabelFactory
+  VERSION = '1.0.0'
+end