prawn-labels 0.11.1

data/examples/shrink_to_fit.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), "example_helper")
+
+one   = "1"
+two   = "2\n2"
+three = (["3"]*3).join("\n")
+four  = (["4"]*4).join("\n")
+five  = (["5"]*5).join("\n")
+six   = (["6"]*6).join("\n")
+seven = (["7"]*7).join("\n")
+eight = (["8"]*8).join("\n")
+nine  = (["9"]*9).join("\n")
+ten   = (["10"]*10).join("\n")
+long  = %{this
+          is
+          thelonglined
+          entrywhereijusttypealottomakeitoverflowthebuffer
+          andthislinetriggersbutitdontkeep }
+long2 = %{this
+          is just
+          the other long line
+          entry where i just type to make it over flow the buffer
+          lol }
+fifty = (["50"]*50).join("\n")
+
+test_names = [one, two, three, four, five, six, seven, eight, nine, ten,
+              "Mike", "Kelly", "Bob", "Greg", "Jordan",  "Chris", "Jon", "Mike",
+              "Kelly", long, long2, "Jordan", "Chris", "Jon", fifty, "Kelly",
+              "Bob", "Greg", "Jordan", "Chris",
+              #these next five should be on the next page.
+              "Jon", "Mike", "Kelly", "Bob", "Greg"]
+
+Prawn::Labels.generate("shrink_to_fit.pdf", test_names, :type => "Avery5160", :shrink_to_fit => true) do |pdf, name|
+  pdf.text name
+end
+

data/lib/prawn/labels.rb

@@ -0,0 +1,99 @@
+# labels.rb :  A simple helper to generate labels for Prawn PDFs
+#
+# Copyright February 2010, Jordan Byron. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+require 'prawn'
+require 'yaml'
+
+module Prawn
+  class Labels
+    attr_reader :document, :type
+
+    def self.generate(file_name, data, options = {}, &block)
+      labels = Labels.new(data, options, &block)
+      labels.document.render_file(file_name)
+    end
+
+    def self.render(data, options = {}, &block)
+      labels = Labels.new(data, options, &block)
+      labels.document.render
+    end
+
+    def initialize(data, options = {}, &block)
+      types_file = File.join(File.dirname(__FILE__), 'types.yaml')
+      types      = YAML.load_file(types_file)
+
+      unless @type = types[options[:type]]
+        raise "Label Type Unknown '#{options[:type]}'"
+      end
+
+      type["paper_size"] ||= "A4"
+      type["top_margin"] ||= 36
+      type["top_margin"] ||= 36
+
+      @document = Document.new  :page_size      => type["paper_size"],
+                                :top_margin     => type["top_margin"],
+                                :bottom_margin  => type["bottom_margin"],
+                                :left_margin    => type["left_margin"],
+                                :right_margin   => type["right_margin"]
+
+      generate_grid @type
+
+      data.each_with_index do |record, i|
+        create_label(i, record, options) do |pdf, record|
+          yield pdf, record
+        end
+      end
+
+    end
+
+    private
+
+    def generate_grid(type)
+      @document.define_grid({ :columns       => type["columns"],
+                              :rows          => type["rows"],
+                              :column_gutter => type["column_gutter"],
+                              :row_gutter    => type["row_gutter"],
+                            })
+    end
+
+    def row_col_from_index(i)
+      page, newi = i.divmod(@document.grid.rows * @document.grid.columns)
+      if newi == 0 and page > 0
+        @document.start_new_page
+        generate_grid @type
+        return [0,0]
+      end
+      return newi.divmod(@document.grid.columns)
+    end
+
+    def create_label(i, record, options = {},  &block)
+      p = row_col_from_index(i)
+
+      shrink_text(record) if options[:shrink_to_fit] == true
+
+      b = @document.grid(p.first, p.last)
+      @document.bounding_box b.top_left, :width => b.width, :height => b.height do
+        yield @document, record
+      end
+    end
+
+    def shrink_text(record)
+      linecount = (split_lines = record.split("\n")).length
+
+      # 30 is estimated max character length per line.
+      split_lines.each {|line| linecount += line.length / 30 }
+
+      # -10 accounts for the overflow margins
+      rowheight = @document.grid.row_height - 10
+
+      if linecount <= rowheight / 12.floor
+        @document.font_size = 12
+      else
+        @document.font_size = rowheight / (linecount + 1)
+      end
+    end
+  end
+end

data/lib/prawn/types.yaml

@@ -0,0 +1,29 @@
+#
+# prawns' basic unit is PostScript-Point        
+# 72 points per inch
+#
+# Avery 7160 family: Mailing labels, 63.5 x 38.1 mm, 21 per sheet
+Avery7160:
+    page_size: A4
+    top_margin: 43.9
+    bottom_margin: 0
+    left_margin: 19.843
+    right_margin: 19.843
+    columns: 3
+    rows: 7
+    column_gutter: 8.504
+    row_gutter: 0
+# Avery 5160 family
+Avery5160:
+    page_size: A4
+    top_margin: 36
+    bottom_margin: 36
+    left_margin: 15.822
+    right_margin: 15.822
+    columns: 3
+    rows: 10
+    column_gutter: 10
+    row_gutter: 0
+TEST:
+    left_margin: 123
+    right_margin: 789

data/prawn-labels.gemspec

@@ -0,0 +1,25 @@
+PRAWN_LABELS_VERSION = "0.11.1"
+
+Gem::Specification.new do |spec|
+  spec.name = "prawn-labels"
+  spec.version = PRAWN_LABELS_VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "Make labels using Prawn"
+  spec.files =  Dir.glob("{examples,lib}/**/**/*") +
+                      ["Rakefile", "prawn-labels.gemspec"]
+  spec.require_path = "lib"
+  spec.required_ruby_version = '>= 1.8.7'
+  spec.required_rubygems_version = ">= 1.3.6"
+
+  spec.extra_rdoc_files = %w{README.md LICENSE COPYING}
+  spec.rdoc_options << '--title' << 'Prawn/Labels Documentation' <<
+                       '--main'  << 'README.md' << '-q'
+  spec.authors = ["Jordan Byron"]
+  spec.email = ["jordan.byron@gmail.com"]
+  spec.rubyforge_project = "prawn-labels"
+  spec.add_dependency('prawn', '~>0.11.1')
+  spec.homepage = "http://github.com/jordanbyron/prawn-labels"
+  spec.description = <<END_DESC
+  Prawn/Labels takes the guess work out of generating labels using Prawn
+END_DESC
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: prawn-labels
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 11
+  - 1
+  version: 0.11.1
+platform: ruby
+authors: 
+- Jordan Byron
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-08 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        - 1
+        version: 0.11.1
+  type: :runtime
+  version_requirements: *id001
+description: "  Prawn/Labels takes the guess work out of generating labels using Prawn\n"
+email: 
+- jordan.byron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+- COPYING
+files: 
+- examples/example_helper.rb
+- examples/hello_labels.pdf
+- examples/hello_labels.rb
+- examples/shrink_to_fit.pdf
+- examples/shrink_to_fit.rb
+- lib/prawn/labels.rb
+- lib/prawn/types.yaml
+- Rakefile
+- prawn-labels.gemspec
+- README.md
+- LICENSE
+- COPYING
+has_rdoc: true
+homepage: http://github.com/jordanbyron/prawn-labels
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Prawn/Labels Documentation
+- --main
+- README.md
+- -q
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: prawn-labels
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Make labels using Prawn
+test_files: []
+