prawn_cocktail 0.4.0 → 0.5.0

data/README.md

@@ -1,10 +1,12 @@
 # PrawnCocktail
 
-Simple documents, templates and helpers on top of Prawn in Ruby on Rails.
+Simple documents, templates and helpers on top of Prawn.
 
 Because writing Prawn documents PHP 4 style is no fun.
 
-Ruby 1.9 only.
+If you're using this with Ruby on Rails, get [`PrawnCocktailRails`](http://github.com/barsoom/prawn_cocktail_rails).
+
+Ruby 1.9 only since we use and love instance\_exec.
 
 NOTE: Work in progress; well used but untested.
 
@@ -20,33 +22,17 @@ NOTE: Work in progress; well used but untested.
 
 ### Configuration
 
-You can change where PrawnCocktail looks for its templates. This is the default:
+You can change where PrawnCocktail looks for its templates. This is the default (suitable for Ruby on Rails):
 
 ``` ruby
 PrawnCocktail.template_root = "app/views/documents"
 ```
 
-### Controller
-
-Your controllers get a `send_pdf` method:
-
-``` ruby
-class InvoicesController < ApplicationController
-  def show
-    invoice = Invoice.find(params[:id])
-    document = InvoiceDocument.new(invoice)
-    send_pdf document
-  end
-end
-```
-
 ### Document
 
 The document class provides a data hash for the template, and optionally a filename:
 
 ``` ruby
-# app/documents/invoice_document.rb
-
 class InvoiceDocument < PrawnCocktail::Document
   def initialize(invoice)
     @invoice = invoice
@@ -68,9 +54,11 @@ class InvoiceDocument < PrawnCocktail::Document
 end
 ```
 
+In Ruby on Rails, we suggest putting this in `app/documents/invoice_document.rb`. But anywhere is fine as long as the file is loaded, automatically or otherwise.
+
 The document has `render` and `render_file(name)` methods, just like `Prawn::Document`.
 
-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 filename is not required. Other libraries like `PrawnCocktailRails` may make use of it.
 
 The `data` value is passed to the template as an `OpenStruct`.
 
@@ -78,11 +66,11 @@ If the data becomes complex, you are advised to extract one or many builder clas
 
 ### Template
 
-Put the Prawn code in a template named after the document:
+Put the Prawn code in a template in the `PrawnCocktail.template_root` directory, named after the document, with a `.pdf.rb` extension.
 
-``` ruby
-# app/views/documents/invoice_document.pdf.rb
+The defaults (suitable for Ruby on Rails) would make that e.g. `app/views/documents/invoice_document.pdf.rb`.
 
+``` ruby
 meta page_size: "A4"
 
 content do |data|
@@ -103,7 +91,7 @@ The `content` block will be passed the data from the document as an `OpenStruct`
 You are advised to extract any complexity or shared code out of the template and into helpers:
 
 ``` ruby
-# app/documents/invoice_document.rb
+# Document
 
 class InvoiceDocument
   helper BaseDocumentHelper
@@ -112,7 +100,7 @@ end
 ```
 
 ``` ruby
-# app/views/documents/invoice_document.pdf.rb
+# Template
 
 content do |data|
   common_header
@@ -121,7 +109,7 @@ end
 ```
 
 ``` ruby
-# app/documents/helpers/base_document_helper.rb
+# Helper
 
 module BaseDocumentHelper
   def common_header
@@ -130,9 +118,11 @@ module BaseDocumentHelper
 end
 ```
 
-Note that you must explicitly declare the helpers you want. No helpers are automatically included.
+Any loaded module can be used as a helper, as long as its code can be run in the context of a Prawn document.
+
+If you use `PrawnCocktailRails`, you can put modules in `app/documents/helpers`, e.g. `app/documents/helpers/base_document_helper.rb`, and they will be autoloaded.
 
-You can declare base helpers in a base document class, though, and that will be inherited.
+Note that you must explicitly declare the helpers you want. No helpers are automatically included. You can declare base helpers in a base document class, though, and they will be inherited.
 
 ### `initialize_document`
 

data/lib/prawn_cocktail/version.rb

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

data/lib/prawn_cocktail.rb

@@ -1,9 +1,3 @@
 require "prawn_cocktail/version"
 require "prawn_cocktail/configuration"
-require "prawn_cocktail/controller"
 require "prawn_cocktail/document"
-require "prawn_cocktail/railtie"
-
-class ActionController::Base
-  include PrawnCocktail::Controller
-end

data/prawn_cocktail.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = PrawnCocktail::VERSION
   gem.authors       = ["Henrik Nyh"]
   gem.email         = ["henrik@barsoom.se"]
-  gem.summary       = "Simple views, templates and helpers on top of Prawn in Ruby on Rails."
+  gem.summary       = "Simple documents, templates and helpers on top of Prawn."
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)
@@ -17,5 +17,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "prawn"
-  gem.add_dependency "rails"
+  gem.add_dependency "activesupport"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn_cocktail
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.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: &70228826573820 !ruby/object:Gem::Requirement
+  requirement: &70333264743560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70228826573820
+  version_requirements: *70333264743560
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70228826573200 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &70333264742900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70228826573200
+  version_requirements: *70333264742900
 description: 
 email:
 - henrik@barsoom.se
@@ -46,9 +46,7 @@ files:
 - 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
 - lib/prawn_cocktail/renderer.rb
 - lib/prawn_cocktail/version.rb
 - prawn_cocktail.gemspec
@@ -75,6 +73,6 @@ rubyforge_project:
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Simple views, templates and helpers on top of Prawn in Ruby on Rails.
+summary: Simple documents, templates and helpers on top of Prawn.
 test_files: []
 has_rdoc: 

data/lib/prawn_cocktail/controller.rb

@@ -1,14 +0,0 @@
-module PrawnCocktail
-  module Controller
-    private
-
-    def send_pdf(document)
-      send_data(
-        document.render,
-        type: "application/pdf",
-        disposition: "attachment",
-        filename: document.filename
-      )
-    end
-  end
-end

data/lib/prawn_cocktail/railtie.rb

@@ -1,9 +0,0 @@
-require "rails"
-
-module PrawnCocktail
-  class Railtie < Rails::Railtie
-    initializer "prawn_cocktail.autoload", before: :set_autoload_paths do |app|
-      app.config.autoload_paths << "#{app.config.root}/app/documents/helpers"
-    end
-  end
-end