pdf_tempura 0.0.2

data/lib/pdf_tempura/render/field_set.rb

@@ -0,0 +1,31 @@
+module PdfTempura
+  module Render
+    class FieldSet
+      include OptionAccess
+
+      def initialize(set, data, options = {})
+        @set = set
+        @data = data
+        @options = options
+      end
+
+      def render(pdf)
+        render_debug_annotation(pdf) if draw_outlines?
+
+        pairs = Render::FieldDataMapper.map(@set.fields, @data)
+
+        pairs.each do |(field, value)|
+          Render::Field.generate(field, value, @options).render(pdf)
+        end
+      end
+
+      private
+
+      def render_debug_annotation(pdf)
+        Debug::FieldSetAnnotation.new(@set).render(pdf)
+      end
+
+    end
+  end
+end
+

data/lib/pdf_tempura/render/option_access.rb

@@ -0,0 +1,21 @@
+module PdfTempura
+  module Render
+    module OptionAccess
+
+      private
+
+      def debug_options
+        @options[:debug].kind_of?(Array) ? @options[:debug] : []
+      end
+
+      def draw_grid?
+        debug_options.include?(:grid)
+      end
+
+      def draw_outlines?
+        debug_options.include?(:outlines)
+      end
+
+    end
+  end
+end

data/lib/pdf_tempura/render/page.rb

@@ -0,0 +1,23 @@
+module PdfTempura
+  module Render
+    class Page
+      include OptionAccess
+
+      def initialize(page, options = {})
+        @page = page
+        @options = options
+      end
+
+      def render(pdf)
+        Render::Debug::Grid.new.render(pdf) if draw_grid?
+
+        pairs = Render::FieldDataMapper.map(@page.fields, @page.data)
+
+        pairs.each do |(field, value)|
+          Render::Field.generate(field, value, @options).render(pdf)
+        end
+      end
+
+    end
+  end
+end

data/lib/pdf_tempura/render/table.rb

@@ -0,0 +1,35 @@
+module PdfTempura
+  module Render
+    class Table
+      include OptionAccess
+      include FieldBounds
+
+      def initialize(table, values, options = {})
+        @table = table
+        @options = options
+        @values = values || []
+
+        unless @values.respond_to?(:each)
+          raise ArgumentError.new("Expected value passed to table to be an array but it isn't.")
+        end
+      end
+
+      def render(pdf)
+        render_debug_annotation(pdf) if draw_outlines?
+
+        @table.fields_for(@values) do |field,value|
+          Render::Field.generate(field, value, @options).render(pdf)
+        end
+
+      end
+
+      private
+
+      def render_debug_annotation(pdf)
+        Debug::TableAnnotation.new(@table).render(pdf)
+      end
+
+    end
+  end
+end
+

data/lib/pdf_tempura/render/text_field.rb

@@ -0,0 +1,13 @@
+module PdfTempura
+  module Render
+    class TextField < CharacterField
+
+      private
+
+      def render_debug_annotation(pdf)
+        Debug::TextFieldAnnotation.new(@field).render(pdf)
+      end
+
+    end
+  end
+end

data/lib/pdf_tempura/renderer.rb

@@ -0,0 +1,39 @@
+require 'tempfile'
+require 'prawn'
+
+module PdfTempura
+  class Renderer
+
+    def initialize(template_path, pages, options = {})
+      @template_path = template_path
+      @pages = pages
+      @options = options
+      @template_page_count = options[:template_page_count] || @pages.count
+    end
+
+    def render_into(pdf)
+      @pages.to_enum.with_index(0).each do |page, index|
+        pdf.start_new_page template: @template_path, template_page: ((index % @template_page_count) + 1)
+        Render::Page.new(page,@options).render(pdf)
+      end
+    end
+
+    def render
+      tempfile = Tempfile.new(["render",".pdf"],:encoding => 'ascii-8bit')
+
+      begin
+        pdf = Prawn::Document.new(skip_page_creation: true, margin: 0)
+
+        render_into(pdf)
+
+        tempfile.write pdf.render
+        tempfile.rewind
+
+        yield tempfile
+      ensure
+        tempfile.unlink
+      end
+    end
+
+  end
+end

data/lib/pdf_tempura/version.rb

@@ -0,0 +1,3 @@
+module PdfTempura
+  VERSION = "0.0.2"
+end

data/pdf_tempura.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pdf_tempura/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pdf_tempura"
+  spec.version       = PdfTempura::VERSION
+  spec.authors       = ["Dane Natoli"]
+  spec.email         = ["dnatoli@payrollhero.com"]
+  spec.description   = %q{A gem for overlaying text and other fields onto PDF templates using Prawn.}
+  spec.summary       = %q{A gem for overlaying text and other fields onto PDF templates using Prawn.}
+  spec.homepage      = "https://github.com/payrollhero/pdf_tempura"
+  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 "prawn", "~> 0.12.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/integration_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require_relative '../example/my_pdf'
+
+describe PdfTempura do
+
+  describe "integration" do
+
+    let(:data) do
+      {
+        1 => {
+          "name" => (["John Doe"] * 10).join(' '),
+          "email" => "john@doe.com",
+          "accept" => true,
+          "pin" => "2233322",
+          "reason" => "
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris ultrices tortor leo. Nunc convallis erat vitae lorem elementum, vel blandit odio scelerisque. Maecenas a cursus nunc. Duis lectus velit, porta eget rhoncus ut, posuere eu nisl. Maecenas imperdiet eget sem sit amet pellentesque. Mauris eu sodales est. Mauris quis quam eu nisl luctus scelerisque sit amet faucibus urna. Morbi sagittis, ligula quis ullamcorper tempus, ante mi gravida urna, ac facilisis tortor nisl ac turpis.
+
+          Nam adipiscing urna mauris, sed mollis enim malesuada non. Praesent non tellus blandit, rhoncus elit non, semper sem. Nam mollis tristique velit vehicula dignissim. Donec adipiscing, odio a ornare ultricies, tortor dolor condimentum sem, sed consectetur mi lorem in nunc. Aliquam at accumsan urna, ut dapibus dolor. In bibendum vitae velit quis tristique. Duis cursus pulvinar arcu, in mollis augue eleifend eget. Nam et est non ipsum congue placerat euismod eu justo. Aenean facilisis eu mi sed condimentum. Maecenas posuere lorem lectus, eu condimentum justo mattis ut. In fringilla feugiat tortor nec elementum.
+          ",
+        },
+        2 => {
+          "form" => {
+            "id" => "123",
+          },
+          "table" => [
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+          ]
+        },
+        3 => {
+          "name" => (["John Doe"] * 10).join(' '),
+          "email" => "john@doe.com",
+          "accept" => true,
+          "pin" => "2233322",
+          "reason" => "
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris ultrices tortor leo. Nunc convallis erat vitae lorem elementum, vel blandit odio scelerisque. Maecenas a cursus nunc. Duis lectus velit, porta eget rhoncus ut, posuere eu nisl. Maecenas imperdiet eget sem sit amet pellentesque. Mauris eu sodales est. Mauris quis quam eu nisl luctus scelerisque sit amet faucibus urna. Morbi sagittis, ligula quis ullamcorper tempus, ante mi gravida urna, ac facilisis tortor nisl ac turpis.
+
+          Nam adipiscing urna mauris, sed mollis enim malesuada non. Praesent non tellus blandit, rhoncus elit non, semper sem. Nam mollis tristique velit vehicula dignissim. Donec adipiscing, odio a ornare ultricies, tortor dolor condimentum sem, sed consectetur mi lorem in nunc. Aliquam at accumsan urna, ut dapibus dolor. In bibendum vitae velit quis tristique. Duis cursus pulvinar arcu, in mollis augue eleifend eget. Nam et est non ipsum congue placerat euismod eu justo. Aenean facilisis eu mi sed condimentum. Maecenas posuere lorem lectus, eu condimentum justo mattis ut. In fringilla feugiat tortor nec elementum.
+          ",
+        },
+        4 => {
+          "form" => {
+            "id" => "123",
+          },
+          "table" => [
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+            {"id" => "1","name" => "one", "email" => "one@theone.com"},
+            {"id" => "2","name" => "two", "email" => "two@theone.com"},
+          ]
+        }
+      }
+    end
+
+    example do
+      FileUtils.mkdir_p("tmp")
+      MyPdf.new(data).render do |file|
+        File.open("tmp/integration.pdf", "w") do |fh|
+          fh.write(file.read)
+        end
+      end
+    end
+
+  end
+
+end

data/spec/lib/pdf_tempura/document/boxed_characters_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe PdfTempura::Document::BoxedCharacters do
+
+  context "valid options" do
+    let(:options) {{box_width: 10, box_spacing: 0}}
+    let(:height){ 100 }
+    subject{ described_class.new(name, coordinates, height,options) { characters 20} }
+    it_behaves_like "a document field"
+  end
+  
+  let(:options) {{box_width: 10, box_spacing: 1}}
+  let(:name){ :text_field }
+  let(:coordinates){ [0, 0] }
+  let(:height){ 10 }
+  
+  describe ".characters" do
+    let(:subject) {described_class.new(name, coordinates, height, options)}
+    
+    context "when passed valid number of characters" do
+      it "adds supported characters" do
+        subject.characters 5
+        subject.supported_characters.should == 5
+        subject.characters 2
+        subject.supported_characters.should == 7
+      end
+    end
+    
+    context "when passed invalid number of characters" do
+      it "fails to add characters" do
+       expect{
+            subject.characters "a"
+       }.to raise_error ArgumentError, "Characters must be of type Numeric." 
+      end
+    end
+  end
+  
+  describe ".space" do
+    let(:subject) {described_class.new(name, coordinates, height, options)}
+    
+    context "when passed a valid length" do
+      it "adds space groups" do
+        subject.space 2
+        subject.groups.count.should == 1
+        subject.supported_characters.should == 0
+        subject.space 3
+        subject.groups.count.should == 2
+        subject.supported_characters.should == 0
+      end
+    end
+    
+    context "when passed an invalid length" do
+      it "fails with an error" do
+         expect{
+            subject.space "a"
+       }.to raise_error ArgumentError, "Spacing must be of type Numeric."
+      end
+    end
+  end
+  
+  describe ".fields" do
+    let(:options) {{box_width: 10, box_spacing: 1}}
+    let(:subject) do 
+      described_class.new(name,coordinates,height,options) do
+        characters 2
+        space 2
+        characters 2
+      end
+    end
+    
+    it "returns correct number of fields at correct coordinates" do
+      PdfTempura::Document::CharacterField.tap do |it|
+        it.should_receive(:new).with(name.to_s, [0,0],[10,10], {}).and_call_original
+        it.should_receive(:new).with(name.to_s, [11,0],[10,10], {}).and_call_original
+        it.should_receive(:new).with(name.to_s, [23,0],[10,10], {}).and_call_original
+        it.should_receive(:new).with(name.to_s, [34,0],[10,10], {}).and_call_original
+      end
+      subject.fields.count.should == 4
+    end
+  end
+
+  describe "validation" do
+    context "when passed valid attributes" do
+      it "returns a field object" do
+        described_class.new(name, coordinates, height, options).should be_a(described_class)
+      end
+      it "should yield" do
+        expect { |b| described_class.new(name, coordinates, height, options,&b)}.to yield_control
+      end
+    end
+
+    context "when passed invalid options" do
+      context "without required options" do
+        let(:options){ {} }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, height, options)
+          }.to raise_error ArgumentError, "Box_width is required."
+        end
+      end
+
+      context "with box spacing and width not numeric" do
+        let(:options){ {box_width: "foo",box_spacing: "bar"} }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, height, options)
+          }.to raise_error ArgumentError, "Box_width must be of type Numeric."
+        end
+      end
+      
+      context "with bad truncate option" do
+        let(:options){ {box_width: 1,box_spacing: 2, truncate: "foo"} }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, height, options)
+          }.to raise_error ArgumentError, "Truncate must be of type boolean."
+        end
+      end
+    end
+  end
+
+end

data/spec/lib/pdf_tempura/document/checkbox_field_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe PdfTempura::Document::CheckboxField do
+
+  it_behaves_like "a document field"
+
+  let(:name){ :checkbox_field }
+  let(:coordinates){ [10, 20] }
+  let(:dimensions){ [10, 10] }
+  let(:default_value){ true }
+  let(:padding){ [1,1,1,1]}
+  let(:options){ { default_value: default_value, padding: padding} }
+
+  subject{ described_class.new(name, coordinates, dimensions, options) }
+
+  its(:default_value){ should be_true }
+
+  describe "defaults" do
+    subject{ described_class.new(name, coordinates, dimensions) }
+
+    its(:default_value){ should be_false }
+  end
+
+  describe "validation" do
+    context "when passed valid attributes" do
+      it "returns a field object" do
+        described_class.new(name, coordinates, dimensions, options).should be_a(described_class)
+      end
+    end
+
+    context "when passed invalid options" do
+      context "default_value" do
+        let(:default_value){ 3 }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Default_value must be one of the following values: true, false."
+        end
+      end
+      
+      context "padding" do
+        let(:padding){[3,2,1]}
+        
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Padding must contain 4 values."
+        end
+      end
+    end
+  end
+
+end