prawn_cocktail 0.6.0 → 0.7.0

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
   - rbx-19mode

data/README.md

@@ -42,7 +42,7 @@ class InvoiceDocument < PrawnCocktail::Document
     {
       number: @invoice.id,
       amount: @invoice.amount,
-      customer_name: @invoice.customer_name
+      customer: { name: @invoice.customer_name }
     }
   end
 end
@@ -54,7 +54,7 @@ The document has `render` and `render_file(name)` methods, just like `Prawn::Doc
 
 The filename is not required. Other libraries like `PrawnCocktailRails` may make use of it.
 
-The `data` value is passed to the template as an `OpenStruct`.
+The `data` value is passed to the template as a recursive `OpenStruct`-like object.
 
 If the data becomes complex, you are advised to extract one or many builder classes like `InvoiceDocument::Data` and call those from `data`.
 
@@ -72,13 +72,15 @@ content do |data|
   move_down 10
   text "Amount: #{data.amount}"
   move_down 10
-  text data.customer_name
+  text data.customer.name
 end
 ```
 
 The `meta` declaration is optional. It takes a hash which will be passed to `Prawn::Document.new`. This is where you specify `page_size`, `page_layout` and such.
 
-The `content` block will be passed the data from the document as an `OpenStruct`, and will be rendered in the context of a `Prawn::Document` instance.
+The `content` block will be passed the data from the document as a recursive `OpenStruct`-type object (actually a `RecursiveClosedStruct` utility class).
+
+The `content` block will be rendered in the context of a `Prawn::Document` instance.
 
 ### Helpers
 

data/lib/prawn_cocktail/document.rb

@@ -1,7 +1,5 @@
-require "prawn"
 require "active_support/core_ext/class/attribute"
 require "active_support/inflector"
-
 require_relative "renderer"
 
 module PrawnCocktail
@@ -33,7 +31,7 @@ module PrawnCocktail
     private
 
     def renderer
-      @renderer ||= Renderer.new(template_name, data, self.class.initializers)
+      @renderer ||= Renderer.new(template_name, data, initializers)
     end
 
     def template_name
@@ -44,5 +42,9 @@ module PrawnCocktail
       # Override in your subclass.
       {}
     end
+
+    def initializers
+      self.class.initializers
+    end
   end
 end

data/lib/prawn_cocktail/renderer.rb

@@ -1,4 +1,6 @@
+require "prawn"
 require_relative "template"
+require_relative "utils/recursive_closed_struct"
 
 module PrawnCocktail
   class Renderer
@@ -37,11 +39,15 @@ module PrawnCocktail
     end
 
     def prawn_document
-      @doc ||= Prawn::Document.new(@prawn_document_options || {})
+      @doc ||= Prawn::Document.new(prawn_document_options)
+    end
+
+    def prawn_document_options
+      @prawn_document_options || {}
     end
 
     def data_object
-      OpenStruct.new(@data)
+      RecursiveClosedStruct.new(@data)
     end
   end
 end

data/lib/prawn_cocktail/utils/recursive_closed_struct.rb

@@ -0,0 +1,22 @@
+class RecursiveClosedStruct
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def method_missing(name, *)
+    value = fetch(name)
+    if value.is_a?(Hash)
+      self.class.new(value)
+    else
+      value
+    end
+  end
+
+  private
+
+  def fetch(name)
+    @hash.fetch(name) do
+      raise NoMethodError.new("undefined method `#{name}' for #{self}")
+    end
+  end
+end

data/lib/prawn_cocktail/version.rb

@@ -1,3 +1,3 @@
 module PrawnCocktail
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/fixtures/document.rb

@@ -15,7 +15,7 @@ class TestDocument < PrawnCocktail::Document
   private
 
   def data
-    { status: @status }
+    { nested: { status: @status } }
   end
 end
 

data/spec/fixtures/sub_test_document.pdf.rb

@@ -2,5 +2,5 @@ meta page_size: "A4"
 
 content do |data|
   text "Sub test document"
-  status_line data.status
+  status_line data.nested.status
 end

data/spec/fixtures/test_document.pdf.rb

@@ -2,5 +2,5 @@ meta page_size: "A4"
 
 content do |data|
   text "Test document"
-  status_line data.status
+  status_line data.nested.status
 end

data/spec/integration_spec.rb

@@ -1,5 +1,4 @@
-require "minitest/autorun"
-require "minitest/pride"
+require_relative "spec_helper"
 require "pdf/inspector"
 
 require "prawn_cocktail"
@@ -14,11 +13,14 @@ describe PrawnCocktail do
 
   describe "#render" do
     it "has the right contents" do
-      assert_document_has_the_right_contents
+      assert_equal(
+        [ "Init works.", "Test document", "Status: success" ],
+        parse_strings(data)
+      )
     end
 
     it "has the right geometry" do
-      assert_document_has_the_right_geometry
+      assert_equal expected_geometry("A4"), parse_geometry(data)
     end
   end
 
@@ -29,11 +31,14 @@ describe PrawnCocktail do
     end
 
     it "has the right contents" do
-      assert_document_has_the_right_contents
+      assert_equal(
+        [ "Init works.", "Test document", "Status: success" ],
+        parse_strings(data)
+      )
     end
 
     it "has the right geometry" do
-      assert_document_has_the_right_geometry
+      assert_equal expected_geometry("A4"), parse_geometry(data)
     end
   end
 
@@ -51,20 +56,6 @@ describe PrawnCocktail do
   end
 end
 
-def assert_document_has_the_right_contents
-  assert_equal(
-    [ "Init works.", "Test document", "Status: success" ],
-    parse_strings(data)
-  )
-end
-
-def assert_document_has_the_right_geometry
-  assert_equal(
-    parse_geometry(data),
-    expected_geometry("A4")
-  )
-end
-
 def parse_strings(pdf_data)
   PDF::Inspector::Text.analyze(pdf_data).strings
 end

data/spec/recursive_closed_struct_spec.rb

@@ -0,0 +1,24 @@
+require_relative "spec_helper"
+
+require_relative "../lib/prawn_cocktail/utils/recursive_closed_struct"
+
+describe RecursiveClosedStruct do
+  it "provides readers from a hash" do
+    subject = RecursiveClosedStruct.new(key: "value")
+    assert_equal "value", subject.key
+  end
+
+  it "raises when there's no such key" do
+    subject = RecursiveClosedStruct.new(key: "value")
+    assert_raises(NoMethodError) do
+      subject.other_key
+    end
+  end
+
+  it "recurses through hashes" do
+    subject = RecursiveClosedStruct.new({
+      one: { two: { three: "four" } }
+    })
+    assert_equal "four", subject.one.two.three
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "minitest/pride"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn_cocktail
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
-  requirement: &70112015079480 !ruby/object:Gem::Requirement
+  requirement: &70266162371220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70112015079480
+  version_requirements: *70266162371220
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70112015095380 !ruby/object:Gem::Requirement
+  requirement: &70266162370800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70112015095380
+  version_requirements: *70266162370800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70112015094900 !ruby/object:Gem::Requirement
+  requirement: &70266162370380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70112015094900
+  version_requirements: *70266162370380
 - !ruby/object:Gem::Dependency
   name: pdf-inspector
-  requirement: &70112015094400 !ruby/object:Gem::Requirement
+  requirement: &70266162369920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70112015094400
+  version_requirements: *70266162369920
 description: 
 email:
 - henrik@barsoom.se
@@ -72,12 +72,15 @@ files:
 - lib/prawn_cocktail/document.rb
 - lib/prawn_cocktail/renderer.rb
 - lib/prawn_cocktail/template.rb
+- lib/prawn_cocktail/utils/recursive_closed_struct.rb
 - lib/prawn_cocktail/version.rb
 - prawn_cocktail.gemspec
 - spec/fixtures/document.rb
 - spec/fixtures/sub_test_document.pdf.rb
 - spec/fixtures/test_document.pdf.rb
 - spec/integration_spec.rb
+- spec/recursive_closed_struct_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -107,4 +110,6 @@ test_files:
 - spec/fixtures/sub_test_document.pdf.rb
 - spec/fixtures/test_document.pdf.rb
 - spec/integration_spec.rb
+- spec/recursive_closed_struct_spec.rb
+- spec/spec_helper.rb
 has_rdoc: