prawn_cocktail 0.3.1 → 0.4.0

data/README.md

@@ -1,6 +1,6 @@
 # PrawnCocktail
 
-Simple views, templates and helpers on top of Prawn in Ruby on Rails.
+Simple documents, templates and helpers on top of Prawn in Ruby on Rails.
 
 Because writing Prawn documents PHP 4 style is no fun.
 
@@ -18,6 +18,14 @@ NOTE: Work in progress; well used but untested.
 
 ## Usage
 
+### Configuration
+
+You can change where PrawnCocktail looks for its templates. This is the default:
+
+``` ruby
+PrawnCocktail.template_root = "app/views/documents"
+```
+
 ### Controller
 
 Your controllers get a `send_pdf` method:
@@ -32,11 +40,9 @@ class InvoicesController < ApplicationController
 end
 ```
 
-### Document/view
-
-Against Rails conventions, but in line with the idea of [two-step views](http://martinfowler.com/eaaCatalog/twoStepView.html), we think of these as "views" as opposed to "templates".
+### Document
 
-Build your view data in a document class:
+The document class provides a data hash for the template, and optionally a filename:
 
 ``` ruby
 # app/documents/invoice_document.rb
@@ -64,13 +70,15 @@ end
 
 The document has `render` and `render_file(name)` methods, just like `Prawn::Document`.
 
-The filename, if defined, is used when generating the document. The `data` value is passed to the template as an `OpenStruct`.
+The filename, if defined, is used by `send_pdf` in the controller. You might also want to use it with mail attachments, scripts etc.
+
+The `data` value is passed to the template as an `OpenStruct`.
 
 If the data becomes complex, you are advised to extract one or many builder classes like `InvoiceDocument::Data` and call those from `data`.
 
 ### Template
 
-Put the Prawn code in a template named after the view:
+Put the Prawn code in a template named after the document:
 
 ``` ruby
 # app/views/documents/invoice_document.pdf.rb

data/lib/prawn_cocktail/configuration.rb

@@ -0,0 +1,9 @@
+module PrawnCocktail
+  class << self
+    attr_accessor :template_root
+  end
+
+  # Defaults.
+
+  self.template_root = "app/views/documents"
+end

data/lib/prawn_cocktail/renderer.rb

@@ -31,7 +31,6 @@ module PrawnCocktail
     private
 
     def render
-      # We pass the filename for better backtraces.
       instance_eval(read_template, template_path)
     end
 
@@ -44,15 +43,15 @@ module PrawnCocktail
     end
 
     def read_template
-      File.read(File.join(app_root, template_path))
+      File.read(template_path)
     end
 
     def template_path
-      "app/views/documents/#{@template}.pdf.rb"
+      File.join(template_root, "#{@template}.pdf.rb")
     end
 
-    def app_root
-      Rails.root
+    def template_root
+      PrawnCocktail.template_root
     end
   end
 end

data/lib/prawn_cocktail/version.rb

@@ -1,3 +1,3 @@
 module PrawnCocktail
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/prawn_cocktail.rb

@@ -1,4 +1,5 @@
 require "prawn_cocktail/version"
+require "prawn_cocktail/configuration"
 require "prawn_cocktail/controller"
 require "prawn_cocktail/document"
 require "prawn_cocktail/railtie"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn_cocktail
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
-  requirement: &70270245325880 !ruby/object:Gem::Requirement
+  requirement: &70228826573820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70270245325880
+  version_requirements: *70228826573820
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70270245325220 !ruby/object:Gem::Requirement
+  requirement: &70228826573200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70270245325220
+  version_requirements: *70228826573200
 description: 
 email:
 - henrik@barsoom.se
@@ -45,6 +45,7 @@ files:
 - README.md
 - Rakefile
 - lib/prawn_cocktail.rb
+- lib/prawn_cocktail/configuration.rb
 - lib/prawn_cocktail/controller.rb
 - lib/prawn_cocktail/document.rb
 - lib/prawn_cocktail/railtie.rb