prawn-rails 1.0.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6ba5a030e5ed002fe37dbc7639962f1cf925649c
-  data.tar.gz: f2efee0ca9bc3c78882a1ed529bc4379a65c9bcb
+SHA256:
+  metadata.gz: 8d84ee700167e6fe6cde67e0abad0c2310a74131e1cd7cb302e7fca00a4d0081
+  data.tar.gz: 3517d341b40d496f2692d545d7573c2b95ea335799d012e9b5455ea1ee2c8ede
 SHA512:
-  metadata.gz: 2d05c397717c70f5898062126854ecd21414730b16fdb95168cdb3908984d7997237cf4efd39311f73dc47145f19df04aef9d212b2b08612b23f8091e1a54625
-  data.tar.gz: f1226cbf7cd6c3dc7736bcfd76e4537570e1c234b4b8d437e8d994000e0e3ce2b07e9207b779b59641af894629f28c96770f0db68ead2fc7936ac2f771a88515
+  metadata.gz: a555d4e0bfc9e416dbe6bce1205a2cc714995b44f9f18e9575dbc788ffe24d0faa8d543c5dc7478871cb405d1d67e393ad81db698e0597d741679e0ed7af2a8b
+  data.tar.gz: b816eaa0601c5192c4ef522393c641a0f4a7843b16456a375feaefad81b42d5406d424a9ae72a9dbb1ff6d267e77b0d240f6c5eb4c54f80efe61489bd23a1fdb

data/CHANGELOG.md

@@ -1,15 +1,39 @@
 # Changelog
 
-* `v1.0.1` - UNRELEASED
+* `Unreleased`
+  - Nothing yet
+
+* `v1.4.0`
+  - [PR #41](https://github.com/cortiz/prawn-rails/pull/41) - Depend on `railsties` instead of `rails` gem to avoid pulling in unnecessary dependencies such as action_cable, etc.
+
+* `v1.3.0`
+  - [PR #40](https://github.com/cortiz/prawn-rails/pull/40) - Add `:filename` and `:disposition` options for `prawn_document
+  - [PR #40](https://github.com/cortiz/prawn-rails/pull/40) - Do not override existing`Content-Disposition` headers
+
+* `v1.2.1`
+  - [PR #39](https://github.com/cortiz/prawn-rails/pull/39) - Fix Rails 6 deprecation warning for single arity template handlers
+  - Remove unnecessary option logic from `prawn_document` method
+
+* `v1.2.0`
+  - [PR #31](https://github.com/cortiz/prawn-rails/pull/31) - Use Prawn::Document.extensions in favor of custom plug-in loading. This removes all changes made in PR #29 and should behave much more appropriately now.
+  - [Undo PR #29](https://github.com/cortiz/prawn-rails/pull/31) - Use Prawn::Document.extensions in favor of custom plug-in loading
+  - [PR #30](https://github.com/cortiz/prawn-rails/pull/30) -  Allow rendering in ActionMailer
+
+* `v1.1.0`
+  - [PR #29](https://github.com/cortiz/prawn-rails/pull/29) - Require all installed prawn extensions
+  - Removed unnecessary `html_strip` helper method. If you were using this feature, instead use Rails built in `strip_tags(html_str)` or `ActionView::Base.full_sanitizer.sanitize(html_str)`
+  - Add legitimate tests
+
+* `v1.0.1`
   - Fix error when using `ActionController.render_to_string`
 
-* `v1.0.0` - January 21, 2017
+* `v1.0.0`
   - Support `@filename`
   - Set PDF Title metadata based on `@filename` if not specified
   - Fix for Ruby 1.9.3+
   - Cleanup
 
-* `v0.1.1` - January 12, 2015 
-* `v0.1.0` - October 7, 2014 
-* `v0.0.2` - February 22, 2012 
-* `v0.0.1` - February 21, 2012
+* `v0.1.1`
+* `v0.1.0`
+* `v0.0.2`
+* `v0.0.1`

data/README.md

@@ -1,15 +1,18 @@
-# Prawn-Rails [![Gem Version](https://badge.fury.io/rb/prawn-rails.svg)](http://badge.fury.io/rb/prawn-rails)
-<a href='http://ko-fi.com/A552JBK' target='_blank'><img height='32' style='border:0px;height:32px;' src='https://az743702.vo.msecnd.net/cdn/kofi1.png?v=a' border='0' alt='Buy Me a Coffee' /></a> 
+# Prawn-Rails
+<a href="https://badge.fury.io/rb/prawn-rails" target="_blank"><img height="21" style='border:0px;height:21px;' border='0' src="https://badge.fury.io/rb/prawn-rails.svg" alt="Gem Version"></a>
+<a href='https://github.com/cortiz/prawn-rails/actions' target='_blank'><img src="https://github.com/cortiz/prawn-rails/workflows/Tests/badge.svg" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
+<a href='https://rubygems.org/gems/prawn-rails' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://ruby-gem-downloads-badge.herokuapp.com/prawn-rails?label=rubygems&type=total&total_label=downloads&color=brightgreen' border='0' alt='RubyGems Downloads' /></a>
 
-## Install
+
+# Install
 ```ruby
 gem 'prawn-rails'
 ```
 
 Note: `prawn` and `prawn-table` are dependencies of `prawn-rails` so there is no need to mention it in the projects Gemfile unless you want to use a specific version of either of those libraries.
 
-## Usage
-Create a view with `pdf` as format and `prawn` as handler so filename should look like `example.pdf.prawn`
+# Usage
+Create a view with `pdf` as format and `prawn` as handler so filename should look like `example.pdf.prawn`.
 
 It provides a helper called `prawn_document` which builds a PrawnRails::Document with default options. You can override any options as you please. Example:
 
@@ -19,23 +22,41 @@ prawn_document do |pdf|
 end
 ```
 
-No need to call `pdf.render`, it is called by `prawn_document`
+No need to call `pdf.render`, it is called by `prawn_document`.
+
+You can customize the name of the generated PDF and the file's delivery format with the `:filename` and `:disposition` keys:
+
+```ruby
+prawn_document(filename: "my-file.pdf", disposition: "attachment") do |pdf|
+  pdf.text "Direct download incoming!"
+end
+```
+
+You can also override the content disposition using the [`Content-Disposition` HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#As_a_response_header_for_the_main_body). If you've already set this, `prawn-rails` will *not* override it. Here's an example of setting the header directly:
 
-If you want to customize the name of the file should a user try to save it, you can specify the filename in your action:
+```ruby
+def download
+  respond_to do |format|
+    format.pdf do
+      headers["Content-Disposition"] = "attachment; filename=\"charts-#{Time.now.to_i}.pdf\""
+    end
+  end
+end
+```
+
+You can also override the file's name from the controller via `@filename`:
 
 ```ruby
 def show
-  @filename = 'my_report.pdf'
+  @filename = "my_report.pdf"
 end
 ```
 
-## Built-in Helpers
-* *html_strip(html)*:
-Removes the html tags from a string
+If no options are given, the file's name will match to your browser's default and the delivery format will default to `inline`.
 
-## Default configuration
+# Default configuration
 
-Add a `prawn-rails.rb` config to your Rails app under `config/initializers` like this
+Add a `prawn-rails.rb` config to your Rails app under `config/initializers` like this:
 
 ```ruby
 PrawnRails.config do |config|
@@ -45,11 +66,11 @@ PrawnRails.config do |config|
 end
 ```
 
-Please note that these are the defaults. 
+Please note that these are the defaults.
 
-For a list of all available options: [http://www.rubydoc.info/gems/prawn/Prawn%2FDocument:initialize](http://www.rubydoc.info/gems/prawn/Prawn%2FDocument:initialize). 
+For a list of all available options: [http://www.rubydoc.info/gems/prawn/Prawn%2FDocument:initialize](http://www.rubydoc.info/gems/prawn/Prawn%2FDocument:initialize).
 
-For a list of all metadata the the `:info` option supports, please see [https://github.com/prawnpdf/prawn/blob/master/manual/document_and_page_options/metadata.rb](https://github.com/prawnpdf/prawn/blob/master/manual/document_and_page_options/metadata.rb) 
+For a list of all metadata the the `:info` option supports, please see [https://github.com/prawnpdf/prawn/blob/master/manual/document_and_page_options/metadata.rb](https://github.com/prawnpdf/prawn/blob/master/manual/document_and_page_options/metadata.rb).
 
 If `skip_page_creation` is set to true then you have to create the first page yourself. Example:
 
@@ -59,11 +80,11 @@ pdf.start_new_page
 pdf.start_new_page size: "A4", page_layout: :portrait
 ```
 
-## Examples
+# Examples
 
-1. **Hello World**
+#### Hello World
 
-```ruby	
+```ruby
 # hello.pdf.prawn
 
 prawn_document do |pdf|
@@ -71,7 +92,7 @@ prawn_document do |pdf|
 end
 ```
 
-2. ** Using Active Record **
+#### Using Active Record
 
 ```ruby
 # myproducts.pdf.prawn
@@ -82,7 +103,7 @@ prawn_document do |pdf|
   pdf.table @products.collect{|p| [p.name,p.price]}
 end
 ```
-3. ** Using Custom options **
+#### Using Custom options
 
 ```ruby
 # landscape.pdf.prawn
@@ -92,12 +113,8 @@ prawn_document(page_layout: :landscape) do |pdf|
 end
 ```
 
-## Credits
-
-Created by Carlos Ortiz - @cortiz 
-
-<a href='http://ko-fi.com/A552JBK' target='_blank'><img height='32' style='border:0px;height:32px;' src='https://az743702.vo.msecnd.net/cdn/kofi1.png?v=a' border='0' alt='Buy Me a Coffee' /></a> 
+# Credits
 
 Maintained by Weston Ganger - @westonganger
 
-Special thanks to @rwilliams, @sigmike, @smber1, @iffyuva
+Created by Carlos Ortiz - @cortiz

data/lib/prawn-rails/document.rb

@@ -1,22 +1,26 @@
 require 'prawn'
 require 'prawn/table'
-require "prawn-rails/extension"
 
 module PrawnRails
 
-  # This derives from Prawn::Document in order to override defaults. Note that the Prawn::Document behaviour itself shouldn't be changed.
+  # This derives from Prawn::Document in order to override defaults. 
+  # Note that the Prawn::Document behaviour itself shouldn't be changed.
   class Document < Prawn::Document
-    def initialize(opts = {})
+    def self.extensions
+      Prawn::Document.extensions
+    end
+
+    def initialize(options = {})
       if PrawnRails.config.respond_to?(:to_h)
-        default = PrawnRails.config.to_h.merge(opts)
+        options.reverse_merge!(PrawnRails.config.to_h)
       else
-        default = PrawnRails.config.marshal_dump.merge(opts)
+        options.reverse_merge!(PrawnRails.config.marshal_dump)
       end
-      super(default)
+
+      super(options)
     end
 
-    # Typically text expects a string. But rails views have this interesting concept that they implicitly call 
-    # `to_s` on all the variables before rendering. So, passing an integer to text fails:
+    # Typically text expects a string. But Rails views have this interesting concept that they implicitly call `to_s` on all the variables before rendering. So, passing an integer to text fails:
     #
     # pdf.text 10       #=> fails because 10 is not a string
     # pdf.text 10.to_s  #=> works
@@ -27,5 +31,4 @@ module PrawnRails
     end
   end
 
-  Document.extensions << Extension
 end

data/lib/prawn-rails/rails_helper.rb

@@ -2,20 +2,37 @@ require 'prawn-rails/document'
 
 module PrawnRails
   module RailsHelper
+
     def prawn_document(options={})
-      options.reverse_merge!(page_layout: PrawnRails.config.page_layout,
-                             page_size: PrawnRails.config.page_size,
-                             info: {
-                               Title: @filename.sub(/\.(p|P)(d|D)(f|F)$/, '')
-                             })
+      @filename ||= options[:filename]
 
-      options.reverse_merge!(skip_page_creation: true) if PrawnRails.config.skip_page_creation
+      options.reverse_merge!(get_metadata)
 
       pdf = PrawnRails::Document.new(options)
 
+      # Ignore headers when we're not rendering from an ActionController context.
+      if defined?(controller) && controller.respond_to?(:response) && !controller.response.nil?
+        disposition = options[:disposition] || "inline"
+        disposition += "; filename=\"#{@filename}\"" if @filename
+
+        # Don't override 'Content-Disposition' if we've chosen to set it elsewhere.
+        controller.response.headers['Content-Disposition'] ||= disposition
+      end
+
       yield pdf if block_given?
 
       pdf.render
     end
+
+    def get_metadata
+      return {} unless @filename
+
+      {
+        info: {
+          Title: @filename.sub(/\.pdf$/i, '')
+        }
+      }
+    end
+
   end
 end

data/lib/prawn-rails/renderer.rb

@@ -2,16 +2,10 @@ require "prawn-rails/document"
 
 module PrawnRails
   class Renderer
-    def self.call(template)
-      %{
-        @filename ||= "\#{controller.action_name}.pdf"
 
-        unless controller.response.nil?
-          controller.response.headers['Content-Disposition'] = "inline; filename=\\\"\#{@filename}\\\""
-        end
-
-        #{template.source.strip}
-      }
+    def self.call(template, source = nil)
+      (source || template.source).strip
     end
+
   end
 end

data/lib/prawn-rails/version.rb

@@ -1,3 +1,3 @@
 module PrawnRails
-  VERSION = "1.0.1"
+  VERSION = "1.4.0"
 end

data/test/dummy_app/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy_app/app/assets/stylesheets/application.css

@@ -0,0 +1,3 @@
+/*
+ *= require_self
+*/

data/test/dummy_app/app/controllers/reports_controller.rb

@@ -0,0 +1,37 @@
+class ReportsController < ApplicationController
+
+  def sample
+    @items = [
+      {name: "Hello"},
+      {name: "World"},
+    ]
+  end
+
+  def table
+    @items = [
+      [1,2,3],
+      [4,5,6],
+      [7,8,9],
+    ]
+  end
+
+  def custom_filename
+  end
+
+  def custom_disposition
+  end
+
+  def custom
+  end
+
+  def ivar_filename
+    @filename = "ivar-filename.pdf"
+    render :custom
+  end
+
+  def custom_headers
+    headers['Content-Disposition'] = "attachment;filename=\"custom-headers.pdf\""
+    render :custom
+  end
+
+end

data/test/dummy_app/app/mailers/reports_mailer.rb

@@ -0,0 +1,18 @@
+class ReportsMailer < ActionMailer::Base
+  def send_report
+    @items = [
+      {name: "Hello"},
+      {name: "World"},
+    ]
+
+    attachments["report.pdf"] = {
+      mime_type: "application/pdf",
+      content: render_to_string("reports/sample", formats: [:pdf]),
+    }
+
+    mail({
+      to: "user@example.com",
+      subject: "Reports",
+    })
+  end
+end

data/test/{dummy → dummy_app}/app/views/layouts/application.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Dummy</title>
+  <title>Dummy App</title>
   <%= stylesheet_link_tag    "application" %>
   <%= javascript_include_tag "application" %>
   <%= csrf_meta_tags %>

data/test/dummy_app/app/views/reports/custom.pdf.prawn

@@ -0,0 +1,3 @@
+prawn_document(filename: "from-options.pdf", disposition: "attachment") do |pdf|
+  pdf.text "Hello World!"
+end

data/test/dummy_app/app/views/reports/custom_disposition.pdf.prawn

@@ -0,0 +1,3 @@
+prawn_document(disposition: "attachment") do |pdf|
+  pdf.text "Hello World!"
+end

data/test/dummy_app/app/views/reports/custom_filename.pdf.prawn

@@ -0,0 +1,3 @@
+prawn_document(filename: "from-options.pdf") do |pdf|
+  pdf.text "Hello World!"
+end

data/test/dummy_app/app/views/reports/sample.html.erb

@@ -0,0 +1 @@
+<h1>Hello World!</h1>

data/test/{dummy/app/views/pdf/render_pdf.pdf.prawn → dummy_app/app/views/reports/sample.pdf.prawn}

@@ -1,13 +1,15 @@
 prawn_document(page_layout: :portrait) do |pdf|
-  pdf.text "Hello There :D"
+  pdf.text "Hello World!"
   pdf.text "now it is here: #{pdf.cursor}"
-  pdf.text "Items are #{@items.inspect}"
+  pdf.text "Number of Items: #{@items.count}"
+
   pdf.font("Courier") do
     pdf.text "Written in Courier because we are inside the block."
   end
 
   pdf.text "with html<bold></bold>"
-  pdf.text pdf.html_strip("without html <bold>LD</bold>")
+  pdf.text strip_tags("without html <bold>LD</bold>")
+
   pdf.text "Let's see which is the current font_size: #{pdf.font_size.inspect}"
   pdf.move_down 10
   pdf.font_size 16
@@ -17,20 +19,22 @@ prawn_document(page_layout: :portrait) do |pdf|
   pdf.move_down 10
   pdf.text "Back to 16 again."
   pdf.move_down 10
-  pdf.text "Single line on 20 using the :size option.", :size => 20
+  pdf.text "Single line on 20 using the :size option.", size: 20
   pdf.move_down 10
   pdf.text "Back to 16 once more."
   pdf.move_down 10
-  pdf.font("Courier", :size => 10) do
+
+  pdf.font("Courier", size: 10) do
     pdf.text "Yeah, using Courier 10 courtesy of the font method."
   end
-  pdf.font("Helvetica", :size => 12) # back to normal
+
+  pdf.font("Helvetica", size: 12) # back to normal
 
   pdf.text "Default color is black"
   pdf.move_down 25
-  pdf.text "Changed to red", :color => "FF0000"
+  pdf.text "Changed to red", color: "FF0000"
   pdf.move_down 25
-  pdf.text "CMYK color", :color => [22, 55, 79, 30]
+  pdf.text "CMYK color", color: [22, 55, 79, 30]
   pdf.move_down 25
-  pdf.text "Also works with <color rgb='ff0000'>inline</color> formatting", :color => "0000FF", :inline_format => true
+  pdf.text "Also works with <color rgb='ff0000'>inline</color> formatting", color: "0000FF", inline_format: true
 end