prawn_cocktail 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prawn_cocktail.gemspec
+gemspec

data/README.md

@@ -0,0 +1,188 @@
+# PrawnCocktail
+
+Simple views, templates and helpers on top of Prawn in Ruby on Rails.
+
+Because writing Prawn documents PHP 4 style is no fun.
+
+Ruby 1.9 only.
+
+NOTE: Work in progress; well used but untested.
+
+![](http://upload.wikimedia.org/wikipedia/commons/f/f8/Cocktail_1_bg_060702.jpg)
+
+## TODO
+
+* Tests.
+* Look into what dependencies to declare. Rails? Active Support?
+* Include instead of inherit? Consider `class_attribute`.
+
+## Usage
+
+### Controller
+
+Your controllers get a `send_pdf` method:
+
+``` ruby
+class InvoiceController < ApplicationController
+  def show
+    invoice = Invoice.find(params[:id])
+    document = InvoiceDocument.new(invoice)
+    send_pdf document
+  end
+end
+```
+
+### 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".
+
+Build your view data in a document class:
+
+``` ruby
+# app/documents/invoice_document.rb
+
+class InvoiceDocument < PrawnCocktail::Document
+  def initialize(invoice)
+    @invoice = invoice
+  end
+
+  def filename
+    "invoice_#{@invoice.id}"
+  end
+
+  private
+
+  def data
+    {
+      number: @invoice.id,
+      amount: @invoice.amount,
+      customer_name: @invoice.customer_name
+    }
+  end
+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`.
+
+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:
+
+``` ruby
+# app/documents/views/invoice_document.pdf.rb
+
+meta page_size: "A4"
+
+content do |data|
+  text "Invoice #{data.number}"
+  move_down 1.cm
+  text "Amount: #{data.amount}"
+  move_down 1.cm
+  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.
+
+### Helpers
+
+You are advised to extract any complexity or shared code out of the template and into helpers:
+
+``` ruby
+# app/documents/invoice_document.rb
+
+class InvoiceDocument
+  helper BaseDocumentHelper
+  helper InvoiceDocumentHelper
+end
+```
+
+``` ruby
+# app/documents/views/invoice_document.pdf.rb
+
+content do |data|
+  common_header
+  text "Yo."
+end
+```
+
+``` ruby
+# app/documents/helpers/base_document_helper.rb
+
+module BaseDocumentHelper
+  def common_header
+    text "Document generated #{Time.now}."
+  end
+end
+```
+
+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 that will be inherited.
+
+### `initialize_document`
+
+If you want to run some code in every document, use an `initialize_document` block:
+
+``` ruby
+class BaseDocument < PrawnCocktail::Document
+  initialize_document do
+    FONT_DIR ||= Rails.root.join("app/views/documents/fonts")
+
+    font_families.update(
+      "Helvetica Neue" => {
+        bold:   FONT_DIR.join("HelveticaNeueLTCom-Md.ttf").to_s,
+        normal: FONT_DIR.join("HelveticaNeueLTCom-Lt.ttf").to_s
+    })
+
+    font "Helvetica Neue"
+  end
+end
+```
+
+This is incidentally how helper modules are implemented. They simply extend the document instance in such a block.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'prawn_cocktail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prawn_cocktail
+
+## License
+
+Copyright (c) 2013 [Barsoom AB](http://barsoom.se)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/prawn_cocktail.rb

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

data/lib/prawn_cocktail/controller.rb

@@ -0,0 +1,16 @@
+module PrawnCocktail
+  module Controller
+    private
+
+    def send_pdf(document)
+      filename = document.respond_to?(:filename) ? "#{document.filename}.pdf" : nil
+
+      send_data(
+        document.render,
+        type: "application/pdf",
+        disposition: "attachment",
+        filename: filename
+      )
+    end
+  end
+end

data/lib/prawn_cocktail/document.rb

@@ -0,0 +1,37 @@
+require "prawn"
+require "active_support/core_ext/class/attribute"
+
+require_relative "renderer"
+
+module PrawnCocktail
+  class Document
+    def render
+      renderer.render_data
+    end
+
+    def render_file(file)
+      renderer.render_file(file)
+    end
+
+    private
+
+    def renderer
+      @renderer ||= Renderer.new(template, data, self.class.doc_initializers)
+    end
+
+    def template
+      self.class.name.underscore
+    end
+
+    class_attribute :doc_initializers
+    self.doc_initializers ||= []
+
+    def self.initialize_document(&block)
+      self.doc_initializers << block
+    end
+
+    def self.helper(mod)
+      initialize_document { extend mod }
+    end
+  end
+end

data/lib/prawn_cocktail/railtie.rb

@@ -0,0 +1,9 @@
+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

data/lib/prawn_cocktail/renderer.rb

@@ -0,0 +1,58 @@
+module PrawnCocktail
+  class Renderer
+    def initialize(template, data, doc_initializers)
+      @template = template
+      @data = data
+      @doc_initializers = doc_initializers
+    end
+
+    def meta(opts)
+      @prawn_document_options = opts
+    end
+
+    def content(&block)
+      @doc_initializers.each do |proc|
+        doc.instance_eval(&proc)
+      end
+
+      doc.instance_exec(data_object, &block)
+    end
+
+    def render_data
+      render
+      doc.render
+    end
+
+    def render_file(file)
+      render
+      doc.render_file(file)
+    end
+
+    private
+
+    def render
+      # We pass the filename for better backtraces.
+      instance_eval(read_template, template_path)
+    end
+
+    def doc
+      @doc ||= Prawn::Document.new(@prawn_document_options || {})
+    end
+
+    def data_object
+      OpenStruct.new(@data)
+    end
+
+    def read_template
+      File.read(File.join(app_root, template_path))
+    end
+
+    def template_path
+      "app/documents/views/#{@template}.pdf.rb"
+    end
+
+    def app_root
+      Rails.root
+    end
+  end
+end

data/lib/prawn_cocktail/version.rb

@@ -0,0 +1,3 @@
+module PrawnCocktail
+  VERSION = "0.0.1"
+end

data/prawn_cocktail.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prawn_cocktail/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "prawn_cocktail"
+  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.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "prawn"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: prawn_cocktail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Henrik Nyh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: &70234014918140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70234014918140
+description: 
+email:
+- henrik@barsoom.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/prawn_cocktail.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
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files: []
+has_rdoc: