pdf_tempura 0.0.2

data/spec/lib/pdf_tempura/render/field_set_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe PdfTempura::Render::FieldSet do
+
+  let(:group) {
+    PdfTempura::Document::FieldSet.new("group") do
+      text_field :a, [0,0], [10,10]
+      text_field :b, [10,0], [10,10]
+    end
+  }
+  let(:data) { {"a" => "1","b" => "2"} }
+  let(:pdf) { Prawn::Document.new }
+  let(:options) { {} }
+
+  describe "init" do
+    example do
+      expect {
+        described_class.new(group,data)
+      }.not_to raise_exception
+    end
+  end
+
+  describe "render" do
+
+    let(:text_field_1){double(:text_field_1)}
+    let(:text_field_2){double(:text_field_2)}
+
+    it "renders each field with the appropriate data" do
+      PdfTempura::Render::Field.tap do |it|
+        it.should_receive(:generate).with(kind_of(PdfTempura::Document::TextField),"1",{}).and_return(text_field_1)
+        it.should_receive(:generate).with(kind_of(PdfTempura::Document::TextField),"2",{}).and_return(text_field_2)
+      end
+      text_field_1.should_receive(:render).with(pdf)
+      text_field_2.should_receive(:render).with(pdf)
+      described_class.new(group,data).render(pdf)
+    end
+  end
+
+end
+
+

data/spec/lib/pdf_tempura/render/field_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe PdfTempura::Render::Field do
+
+  describe ".generate" do
+    let(:options) { {} }
+
+    context "when passing a text field" do
+      let(:field) { PdfTempura::Document::TextField.new("foo", [0,0], [0,0]) }
+
+      it "returns a TextField object" do
+        object = described_class.generate(field, "foo", options)
+        object.should be_kind_of(PdfTempura::Render::TextField)
+      end
+    end
+    
+    context "when passing a table field" do
+      let(:field) { PdfTempura::Document::Table.new("foo", [0,0], height: 100, number_of_rows: 10) }
+
+      it "returns a Table object" do
+        object = described_class.generate(field,[], options)
+        object.should be_kind_of(PdfTempura::Render::Table)
+      end
+    end
+
+    context "when passing a different field" do
+      let(:field) { double(:different_field, type: "different")}
+
+      it "raises an ArgumentError" do
+        expect {
+          described_class.generate(field, "foo", options)
+        }.to raise_exception(ArgumentError)
+      end
+    end
+  end
+
+end

data/spec/lib/pdf_tempura/render/page_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe PdfTempura::Render::Page do
+
+  let(:page) { PdfTempura::Document::Page.new(1) }
+  let(:data) { { } }
+  let(:pdf) { Prawn::Document.new }
+  let(:options) { {} }
+
+  before do
+    page.data = data
+
+    pdf.stub(:bounding_box) do |&block|
+      block.call
+    end
+  end
+
+  describe "init" do
+    example do
+      expect {
+        described_class.new(page, options)
+      }.not_to raise_exception
+    end
+  end
+
+  describe "render" do
+
+    subject do
+      described_class.new(page, options)
+    end
+
+    let(:page) do
+      page = PdfTempura::Document::Page.new(1)
+      page.text_field "one", [0,0], [0,0]
+      page.text_field "two", [0,0], [0,0]
+      page
+    end
+
+    let(:data) do
+      {
+        "one" => "foo",
+        "two" => "bar",
+      }
+    end
+
+    let(:text_field_1) { double(:text_field_1) }
+    let(:text_field_2) { double(:text_field_2) }
+
+    it "calls renders each field" do
+      PdfTempura::Render::TextField.tap do |it|
+        it.should_receive(:new).with(page.fields[0], "foo", options).and_return(text_field_1)
+        it.should_receive(:new).with(page.fields[1], "bar", options).and_return(text_field_2)
+      end
+      text_field_1.should_receive(:render).with(pdf)
+      text_field_2.should_receive(:render).with(pdf)
+      subject.render(pdf)
+    end
+
+    describe "calling the grid drawing code when enabled" do
+      let(:options) do
+        {
+          :debug => [:grid]
+        }
+      end
+
+      let(:grid_renderer) { double(:grid_renderer) }
+
+      example do
+        PdfTempura::Render::Debug::Grid.should_receive(:new).and_return(grid_renderer)
+        grid_renderer.should_receive(:render).with(pdf)
+        subject.render(pdf)
+      end
+    end
+
+  end
+
+end

data/spec/lib/pdf_tempura/render/table_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe PdfTempura::Render::Table do
+
+  let(:doc_table) {
+    PdfTempura::Document::Table.new(:table,[0,100],:number_of_rows => 10, :height => 100) do
+      text_column :a, 10
+      space 10
+      text_column :b, 10
+      space 5
+      boxed_character_column :c,box_width: 10,box_spacing: 1 do
+        characters 3;space 2;characters 3
+      end
+    end
+  }
+  let(:data) { [{:a => "1",:b => "2",c: "333333"},{:a => "3",:b => "4",c: "555555"}] }
+  let(:pdf) { Prawn::Document.new }
+  let(:options) { {} }
+
+  describe "init" do
+    example do
+      expect {
+        described_class.new(doc_table, data, options)
+      }.not_to raise_exception
+    end
+  end
+
+  describe "render" do
+
+    let(:expected_options) {{"number_of_rows"=>10, "height"=>100}}
+
+    it "renders each field with the appropriate data" do
+      PdfTempura::Document::TextField.tap do |it|
+        it.should_receive(:new).with(:a, [0,100],[10,10], expected_options).and_call_original
+        it.should_receive(:new).with(:b, [20,100],[10,10], expected_options).and_call_original
+        it.should_receive(:new).with(:a, [0,90],[10,10], expected_options).and_call_original
+        it.should_receive(:new).with(:b, [20,90],[10,10], expected_options).and_call_original
+      end
+      described_class.new(doc_table,data,options).render(pdf)
+    end
+  end
+
+end
+

data/spec/lib/pdf_tempura/render/text_field_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe PdfTempura::Render::TextField do
+
+  let(:field) { PdfTempura::Document::TextField.new("foo", [0,0], [100,100]) }
+  let(:options) { {} }
+  let(:pdf) { Prawn::Document.new }
+
+  describe "initialize" do
+    example do
+      expect {
+        described_class.new(field, "foo", options)
+      }.not_to raise_exception
+    end
+  end
+
+  describe "#render" do
+
+    subject { described_class.new(field, "foo", options) }
+
+    describe "calling the annotation drawing code when enabled" do
+      let(:options) do
+        {
+          :debug => [:outlines]
+        }
+      end
+
+      let(:annotation_renderer) { double(:annotation_renderer) }
+
+      example do
+        PdfTempura::Render::Debug::TextFieldAnnotation.should_receive(:new).with(field).and_return(annotation_renderer)
+        annotation_renderer.should_receive(:render).with(pdf)
+        subject.render(pdf)
+      end
+    end
+
+  end
+
+end

data/spec/lib/pdf_tempura/renderer_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe PdfTempura::Renderer do
+
+  let(:page_1){ PdfTempura::Document::Page.new(1) }
+  let(:pages){ [ page_1 ] }
+  let(:options) { { debug: [] } }
+
+  describe "initialize" do
+    example do
+      expect {
+        described_class.new(sample_pdf_path, pages, options)
+      }.not_to raise_exception
+    end
+  end
+  
+  describe "#render_into" do
+    subject do
+      described_class.new(sample_pdf_path, pages, options)
+    end
+    let(:pdf) {
+      Prawn::Document.new(skip_page_creation: true, margin: 0)
+    }
+    
+    it "renders into the pdf" do
+      expect {
+      subject.render_into(pdf)
+      }.not_to raise_exception
+    end
+  end
+
+  describe "#render" do
+    subject do
+      described_class.new(sample_pdf_path, pages, options)
+    end
+
+    it "yields" do
+      expect { |x|
+        subject.render(&x)
+      }.to yield_control
+    end
+
+    it "yields an object that responds to read" do
+      subject.render do |file|
+        expect(file).to respond_to(:read)
+      end
+    end
+
+    it "yields a file with a pdf in it" do
+      subject.render do |file|
+        tempfile = Tempfile.new("spec")
+        begin
+          tempfile.write file.read
+          tempfile.flush
+          expect(`file -b --mime-type #{tempfile.path.inspect}`.strip).to eq("application/pdf")
+        ensure
+          tempfile.unlink
+        end
+      end
+    end
+
+    describe do
+      let(:page_2){ PdfTempura::Document::Page.new(2) }
+      let(:pages){ [ page_1, page_2 ] }
+      let(:render_page_1) { double(:render_page_1) }
+      let(:render_page_2) { double(:render_page_2) }
+
+      # bit of an implementation test, but can't see a better way to do it right now
+      it "calls render on each page" do
+        PdfTempura::Render::Page.should_receive(:new).with(pages[0], options).and_return(render_page_1)
+        PdfTempura::Render::Page.should_receive(:new).with(pages[1], options).and_return(render_page_2)
+        render_page_1.should_receive(:render)
+        render_page_2.should_receive(:render)
+        subject.render{ |file|; }
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'bundler/setup'
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+def sample_pdf_path
+  "spec/assets/sample_pdf_form.pdf"
+end
+
+require 'pdf_tempura'

data/spec/support/shared_examples/field_examples.rb

@@ -0,0 +1,265 @@
+require 'spec_helper'
+
+shared_examples_for "a document field" do
+  let(:name){ :name }
+  let(:coordinates){ [10, 20] }
+  let(:dimensions){ [200, 100] }
+
+  its(:name){ should == "name" }
+  its(:coordinates){ should == [10, 20] }
+  its(:dimensions){ should == [200, 100] }
+  its(:x){ should == 10 }
+  its(:y){ should == 20 }
+  its(:width){ should == 200 }
+  its(:height){ should == 100 }
+
+end
+
+
+shared_examples_for "a document field with a standard constructor" do
+  let(:name){ :name }
+  let(:coordinates){ [10, 20] }
+  let(:dimensions){ [200, 100] }
+
+  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 an invalid name" do
+      let(:name){ [] }
+
+      it "throws an error" do
+        expect{
+          described_class.new(name, coordinates, dimensions, options)
+        }.to raise_error ArgumentError, "Name must be of type String."
+      end
+    end
+
+    context "when passed invalid coordinates" do
+      context "as an object other than Array" do
+        let(:coordinates){ "1x1" }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Coordinates must be of type Array."
+        end
+      end
+
+      context "by passing an invalid x or y coordinate" do
+        let(:coordinates){ ["a", "b" ] }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Coordinates must contain only Numeric values."
+        end
+      end
+
+      context "by passing not enough coordinates" do
+        let(:coordinates){ [1] }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Coordinates must contain 2 values."
+        end
+      end
+
+      context "by passing too many coordinates" do
+        let(:coordinates){ [1, 2, 3] }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Coordinates must contain 2 values."
+        end
+      end
+    end
+
+    context "when passed invalid dimensions" do
+      context "as an object other than Array" do
+        let(:dimensions){ "width200 height100" }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Dimensions must be of type Array."
+        end
+      end
+
+      context "by passing an invalid width or height" do
+        let(:dimensions){ ["one hundred", "two_hundred" ]}
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Dimensions must contain only Numeric values."
+        end
+      end
+
+      context "by passing not enough dimensions" do
+        let(:dimensions){ [1] }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Dimensions must contain 2 values."
+        end
+      end
+
+      context "by passing too many dimensions" do
+        let(:dimensions){ [1, 2, 3] }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Dimensions must contain 2 values."
+        end
+      end
+
+    end
+
+    context "when passed invalid options" do
+      context "as an object other than a hash" do
+        let(:options){ "these are bogus options" }
+
+        it "throws an error" do
+          expect{
+            described_class.new(name, coordinates, dimensions, options)
+          }.to raise_error ArgumentError, "Options must be a hash."
+        end
+      end
+    end
+  end
+
+end
+
+shared_examples "a field that accepts default commands" do
+  describe ".table" do
+
+    it "adds a table field to the field list" do
+      subject.fields.should == []
+      subject.table(:foo, [0,0], height: 100, number_of_rows: 10) { }
+      subject.fields.first.should be_a(PdfTempura::Document::Table)
+    end
+
+    it "yields" do
+      expect { |b|
+        subject.table(:foo, [0,0], height: 100, number_of_rows: 10, &b)
+      }.to yield_control
+    end
+
+  end
+
+  describe ".with_default_options" do
+    it "yields a block that changes the default options" do
+      subject.with_default_options :alignment => "center" do
+        text_field :one, [0,0], [50,50]
+      end
+      subject.text_field :two, [100,100], [50,50]
+      subject.fields.first.alignment.should == "center"
+      subject.fields[1].alignment.should_not == "center"
+    end
+
+    it "cascades to field_set" do
+      subject.with_default_options :alignment => "center" do
+        text_field :one, [0,0], [50,50]
+        field_set "three" do
+          text_field :four, [0,0], [60,60]
+        end
+      end
+      subject.text_field :two, [100,100], [50,50]
+      subject.fields.first.alignment.should == "center"
+      subject.fields[1].fields.first.alignment.should == "center"
+    end
+
+    it "cascades to table" do
+      subject.with_default_options :alignment => "center" do
+        table :two,[5,5],:number_of_rows => 20,:row_height => 10 do
+          text_column :three, 60
+        end
+      end
+
+      subject.fields.first.columns.first.options["alignment"].should == "center"
+    end
+  end
+
+  describe ".text_field" do
+    let(:name){ :text_field }
+    let(:coordinates){ [10, 20] }
+    let(:dimensions){ [200, 100] }
+
+    context "when not passed a type" do
+      it "adds a field object given valid attributes" do
+        expect{
+          subject.text_field(name, coordinates, dimensions)
+        }.to change(subject.fields, :count).by (1)
+      end
+
+      it "creates the correct field object" do
+        subject.text_field(name, coordinates, dimensions)
+        field = subject.fields.first
+        field.should be_a(PdfTempura::Document::TextField)
+        field.name.should == "text_field"
+        field.coordinates.should == [10, 20]
+        field.dimensions.should == [200, 100]
+      end
+    end
+  end
+
+  describe ".boxed_characters" do
+    let(:name){ :pin_code}
+    let(:height) {20}
+    let(:coordinates) {[50,20]}
+    let(:options) {{box_spacing: 1, box_width: 10}}
+
+    context "when passed appropriate parameters" do
+      it "adds a field to the subject" do
+        expect{
+          subject.boxed_characters(name, coordinates, height, options) do
+            characters 4
+          end
+        }.to change(subject.fields, :count).by (1)
+      end
+    end
+  end
+
+  describe ".field_set" do
+    let(:name) { :group }
+
+    context "when called" do
+      it "adds a field" do
+        expect {
+          subject.field_set "group"
+        }.to change(subject.fields,:count).by (1)
+      end
+    end
+  end
+
+  describe ".checkbox_field" do
+    let(:name){ :checkbox_field}
+    let(:coordinates){ [10, 20] }
+    let(:dimensions){ [20, 20] }
+
+    context "when not passed a type" do
+      it "adds a field object given valid attributes" do
+        expect{
+          subject.checkbox_field(name, coordinates, dimensions)
+        }.to change(subject.fields, :count).by (1)
+      end
+
+      it "creates the correct field object" do
+        subject.checkbox_field(name, coordinates, dimensions)
+        field = subject.fields.first
+        field.should be_a(PdfTempura::Document::CheckboxField)
+        field.name.should == "checkbox_field"
+        field.coordinates.should == [10, 20]
+        field.dimensions.should == [20, 20]
+      end
+    end
+  end
+end