htmldoc-rails 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.tmproj
+.yardoc
+doc
+test/tmp
+test/tmp/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Elliot Winkler
+
+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/README.md

@@ -0,0 +1,69 @@
+# htmldoc-rails
+
+## Summary
+
+Generate PDFs from your Rails views using [HTMLDoc](http://www.htmldoc.org).
+
+## Usage
+
+Let's say we've got this setup:
+
+    # controller
+    class FooController < ApplicationController
+      def bar
+        # render bar.html.erb
+      end
+    end
+    
+    # view - bar.html.erb
+    <p>Some content goes here</p>
+    
+Now let's say we want to give the user a regular HTML view when they go to `/foo/bar`, but a PDF file when they go to `/foo/bar.pdf`. We can use `respond_to` to differentiate between the two course of actions, but as for generating the PDF file itself, `htmldoc-rails` provides a special method called `render_pdf`. This method is responsible for piping a view through HTMLDoc and telling the action to return a PDF file. It also accepts options such as which view you want the PDF to be generated from, whether or not a download box should appear, and so on (you can find the possible options in the [documentation](http://mcmire.github.com/htmldoc-rails/HtmldocRails/Controller.html#render_pdf-instance_method)). Since we want to use the HTML view to generate the PDF, all we have to say is this:
+
+    # controller
+    class FooController < ApplicationController
+      def bar
+        respond_to do |wants|
+          wants.html
+          wants.pdf { render_pdf }
+        end
+      end
+    end
+
+## Prerequisites
+
+* HTMLDoc 1.9.x
+* htmldoc gem
+
+## Installation
+
+First, you'll need to download, compile, and install the htmldoc executable. If you're on Mac or Linux, this is really easy. Just head on over to [the HTMLDoc website](http://www.htmldoc.org/software.php). You'll see a link to download 1.8, but don't even bother with that, since 1.8.27 was released way back in 2006 and doesn't support CSS or tables very well. These days new improvements are being done (however occasionally) on the 1.9.x branch, so you'll want to download the latest developer snapshot instead (it worked fine for us). Once you've done that, you should be able to just
+
+    ./configure
+    make
+    sudo make install
+
+If you happen to be on Windows, well, you aren't so lucky. If you're fine with using 1.8, you can find a pre-compiled copy either from the HTMLDoc website or from Cygwin. If you really want a version of 1.9, you'll have to look around -- possibly someone has been generous enough to put one out there.
+
+Once you've got the htmldoc executable installed, you'll need the htmldoc Ruby gem, which provides a thin wrapper around the executable. Just
+
+    gem install htmldoc
+
+Finally, you can install this gem:
+
+* `gem install htmldoc-rails` (probably as root)
+* Add `config.gem 'htmldoc-rails'` to your environment.rb file
+
+## Compatibility
+
+This gem has been tested successfully on Rails 2.1.2, 2.2.3, and 2.3.5 under Ruby 1.8.6, 1.8.7, and 1.9.1.
+
+## I found a bug!
+
+Great! File a [Github issue](http://github.com/mcmire/htmldoc-rails/issues) so that I am aware of the problem and I will try to fix it as soon as I can. If you're able to figure out a solution on your own, feel free to write a patch and send it to me, or fork the [project on Github](http://github.com/mcmire/htmldoc-rails) and send me a pull request. Bonus points if you write tests -- that helps me out a lot.
+
+If you need to get in contact with me, you can [find me on Twitter](http://twitter.com/mcmire) or [send me an email](mailto:elliot.winkler@gmail.com).
+
+## Author
+
+(c) 2008-2010 Elliot Winkler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'rake'
+
+require File.dirname(__FILE__) + "/lib/htmldoc_rails/version"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.version = HtmldocRails::VERSION
+    gem.name = "htmldoc-rails"
+    gem.summary = %Q{Generate PDFs from your Rails views using HTMLDoc}
+    gem.description = %Q{Generate PDFs from your Rails views using HTMLDoc}
+    gem.email = "elliot.winkler@gmail.com"
+    gem.homepage = "http://github.com/mcmire/htmldoc-rails"
+    gem.authors = ["Elliot Winkler"]
+    gem.add_dependency "htmldoc"
+    unless ENV["AP_VERSION"]
+      gem.add_dependency "actionpack", "< 3.0"
+    end
+    gem.add_development_dependency "mcmire-protest"
+    gem.add_development_dependency "mcmire-matchy"
+    gem.add_development_dependency "mcmire-mocha"
+    gem.add_development_dependency "mocha-protest-integration"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+namespace :test do
+  def run(*cmd)
+    cmd = cmd.flatten
+    options = Hash === cmd.last ? cmd.pop : {}
+    cmd.unshift("sudo") if options[:sudo]
+    puts cmd.join(" ")
+    system(*cmd)
+    exit if $? != 0
+  end
+  def run_gem(*cmd)
+    run "gem", cmd, :sudo => (ENV["GEM_PATH"] !~ /rvm/)
+  end
+  
+  task :all do
+    require File.dirname(__FILE__) + '/test/all'
+  end
+  
+  task :install_dependencies do
+    puts
+    puts "Installing dev test gems..."
+    puts
+    run_gem %w(install jeweler htmldoc mcmire-protest mcmire-matchy mcmire-mocha mocha-protest-integration)
+    for version in %w(2.1.2 2.2.3 2.3.5)
+      puts
+      puts "Installing rails v#{version}..."
+      puts
+      run_gem %w(install rails -v), version
+    end
+    puts
+  end
+end
+
+task :check_platform do
+  if RUBY_PLATFORM !~ /darwin|linux/
+    warn <<-EOT
+Sorry, you can only run the tests if you're on Mac or Linux. This is because the
+tests use the `file` command to detect file type, but to my knowledge this
+command is only available on Mac or Linux.
+EOT
+    exit 1
+  end
+end
+
+task :test => [:check_platform, :check_dependencies, :"check_dependencies:development"]
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ['--no-private']
+  end
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'mcmire/render_htmldoc_pdf'

data/lib/htmldoc-rails.rb

@@ -0,0 +1 @@
+require 'htmldoc_rails'

data/lib/htmldoc_rails.rb

@@ -0,0 +1,20 @@
+require 'htmldoc_rails/htmldoc_ext'
+require 'htmldoc_rails/controller'
+
+module HtmldocRails
+  class << self
+    # @private
+    def action_view
+      ActionPack::VERSION::MAJOR == 1 ? ActionView::Base : ActionView::Template
+    end
+    def debug=(mode)
+      @debug = mode
+    end
+    def debug?
+      @debug
+    end
+  end
+end
+
+ActionController::Base.send(:include, HtmldocRails::Controller)
+Mime::Type.register('application/pdf', :pdf)

data/lib/htmldoc_rails/controller.rb

@@ -0,0 +1,97 @@
+module HtmldocRails
+  module Controller
+    # Runs the given view through HTMLDoc and sends the generated PDF data back
+    # to the browser.
+    #
+    # @param [Hash] options Various options
+    # @option options [Hash, String] :url (nil) The hash/url that represents which
+    #   view you want to render. Passed straight to <tt>render()</tt>.
+    # @option options [Symbol] :as (:inline) The disposition; <tt>:inline</tt>
+    #   renders the PDF in the browser, <tt>:attachment</tt> pops up a download
+    #   box when the page loads. You can also set the disposition at runtime
+    #   by appending <tt>?as=attachment|inline</tt> to the URL.
+    # @option options [String] :filename (nil) The default filename for the file being
+    #   downloaded, assuming <tt>:as => :attachment</tt>.
+    # @option options [Hash] :htmldoc ({}) Options that will be passed to HTMLDoc
+    #   when the PDF is rendered.
+    #
+    # @example Rendering default view of action as PDF
+    #   render_pdf
+    # @example Rendering a specific view as PDF
+    #   render_pdf :action => 'bar'
+    # @example Set a top-margin of 50px in the PDF and force a download box when the page loads
+    #   render_pdf :action => "bar", :as => :attachment, :htmldoc => { :top => 50 }
+    #
+    def render_pdf(options={})
+      filename = options.delete(:filename)
+      disposition = (options.delete(:as) || params[:as] || :inline).to_sym
+      htmldoc_options = options.delete(:htmldoc) || {}
+      render_options = options.merge(options.delete(:url) || {})
+      if !render_options.include?(:layout)
+        render_options[:layout] = false
+      end
+    
+      send_data_options = { :type => content_type }
+      send_data_options[:filename] = filename if filename
+      send_data_options[:disposition] = (disposition == :attachment) ? 'attachment' : 'inline'
+    
+      # Make sure that the rendered PDF isn't cached
+      if request.env['HTTP_USER_AGENT'] =~ /msie/i
+        headers['Pragma'] = ''
+        headers['Cache-Control'] = ''
+      else
+        headers['Pragma'] = 'no-cache'
+        headers['Cache-Control'] = 'no-cache, must-revalidate'
+      end
+    
+      # Run view through PDF::HTMLDoc::View
+      html_content = render_to_string(render_options)
+      pdf_data = run_through_htmldoc(html_content, htmldoc_options)
+      unless pdf_data.blank?
+        send_data(pdf_data, send_data_options) 
+      else
+        render :text => "HTMLDoc had trouble parsing the HTML to create the PDF."
+      end
+    end
+  
+    # Runs the given view through HTMLDoc and writes the generated PDF data
+    # to the file of your choice.
+    #
+    # @param [String] filename The outfile
+    # @param [Hash, String] render_options The hash/url that represents which
+    #   view you want to render. Passed straight to <tt>render()</tt>.
+    # @param [Hash] htmldoc_options Options that will be passed to HTMLDoc
+    #   when the PDF is rendered.
+    #
+    # @example Render the 'blah' view to 'foo.pdf'
+    #   render_pdf_to_file 'foo.pdf', :action => 'blah'
+    # @example Same thing, but set a top-margin of 50px in the PDF
+    #   render_pdf_to_file 'foo.pdf', { :action => 'blah' }, { :top => 50 }
+    #
+    def render_pdf_to_file(filename, render_options={}, htmldoc_options={})
+      if !render_options.include?(:layout)
+        render_options[:layout] = false
+      end
+      headers["Content-Disposition"] = "inline"
+      html_content = render_to_string(render_options)
+      pdf_data = run_through_htmldoc(html_content, htmldoc_options)
+      File.open(filename, 'w') {|f| f.write(pdf_data) }
+    end
+
+  private
+    def run_through_htmldoc(content, htmldoc_options)
+      PDF::HTMLDoc.create do |pdf|
+        PDF::HTMLDoc::DEFAULT_OPTIONS.merge(htmldoc_options).each do |name, value|
+          pdf.set_option(name, value)
+        end
+        # don't know what this does??
+        pdf.set_option :path, Pathname.new(File.join(RAILS_ROOT, 'public')).realpath.to_s
+        pdf << content
+      end
+    end
+  
+    def content_type
+      Mime::Type.lookup_by_extension('pdf')
+    end
+  end
+end

data/lib/htmldoc_rails/htmldoc_ext.rb

@@ -0,0 +1,24 @@
+# Extend 'htmldoc' gem to support the edge releases of the htmldoc executable
+# and to make usage a bit more intuitive
+module PDF
+  class HTMLDoc
+    @@basic_options << :top    unless @@basic_options.include?(:top)
+    @@basic_options << :bottom unless @@basic_options.include?(:bottom)
+    @@all_options = @@basic_options + @@extra_options
+    
+    DEFAULT_OPTIONS = {
+      :bodycolor => 'white',
+      :toc => false,
+      :portrait => true,
+      :continuous => true,
+      :footer => '...',
+      :header => '...',
+      :links => false,
+      :webpage => true,
+      :left => '50',
+      :right => '50',
+      :top => '90',
+      :size => 'Letter'
+    }
+  end
+end

data/lib/htmldoc_rails/version.rb

@@ -0,0 +1,3 @@
+module HtmldocRails
+  VERSION = "0.1.0"
+end

data/test/all.rb

@@ -0,0 +1,32 @@
+require 'pathname'
+
+proj_dir = File.expand_path(File.dirname(__FILE__) + '/..')
+lib_dir  = "#{proj_dir}/lib"
+test_dir = "#{proj_dir}/test"
+
+$:.unshift(lib_dir, test_dir)
+
+files = Dir["#{test_dir}/test_*.rb"]
+
+pids = []
+
+%w(2.1.2 2.2.3 2.3.5).each do |version|
+  (class << $stdout; self; end).class_eval <<-EOT, __FILE__, __LINE__
+    def puts(*str)
+      str = str.flatten
+      str[0] = "#{version})) \#{str[0]}"
+      super(*str)
+    end
+    def print(*str)
+      str = str.flatten
+      str[0] = "#{version})) \#{str[0]}"
+      super(*str)
+    end
+  EOT
+  
+  pids << fork do
+    ENV["AP_VERSION"] = version
+    files.each {|file| require file }
+  end
+end
+pids.each {|pid| Process.wait(pid) }

data/test/helper.rb

@@ -0,0 +1,136 @@
+require 'rubygems'
+
+require 'pp'
+
+gem 'mcmire-protest'
+require 'protest'
+gem 'mcmire-mocha'
+require 'mocha'
+# This must be required before matchy since matchy patches
+# the current test case's #run method, however mocha-protest-integration
+# completely overrides it
+require 'mocha-protest-integration'
+#gem 'mcmire-matchy'
+$:.unshift "/Users/elliot/code/github/forks/matchy/lib"
+require 'matchy'
+
+# Matchy/Protest integration
+Matchy.adapter :protest, "Protest" do
+  def assertions_module; Test::Unit::Assertions; end
+  def test_case_class; Protest::TestCase; end
+  def assertion_failed_error; Protest::AssertionFailed; end
+end
+Matchy.use(:protest)
+
+Protest.report_with :documentation
+Protest::Utils::BacktraceFilter::ESCAPE_PATHS << %r|test/unit| << %r|matchy| << %r|mocha-protest-integration| << %r|actionpack|
+#Protest::Utils::BacktraceFilter::ESCAPE_PATHS.clear
+
+#----
+
+if ENV["AP_VERSION"]
+  gem 'actionpack', "= #{ENV["AP_VERSION"]}"
+end
+
+require 'action_controller'
+
+# Since ActionController::TestCase in 2.3.5 tries to require Mocha
+# and replaces it with a stub on failure we have to save a reference
+# to the current class and then replace the stub Mocha with the real Mocha
+CurrentMocha = Mocha
+require 'action_controller/test_case'
+Object.const_set :Mocha, CurrentMocha
+
+require 'action_controller/integration'
+require 'action_view'
+require 'action_pack/version'
+require 'active_support/version'
+
+puts
+puts " -- Using ActionPack v#{ActionPack::VERSION::STRING}, on Ruby #{RUBY_VERSION}."
+puts
+
+RAILS_ROOT = File.expand_path(File.dirname(__FILE__))
+RAILS_ENV = "test"
+
+#logger = Logger.new(STDOUT)
+#logger.level = Logger::DEBUG
+#ActionController::Base.logger = logger
+
+# Disable sessions so we don't get a 'key is required to write a cookie
+# containing the session data' error
+ActionController::Base.session_store = nil
+
+module Protest
+  module Rails
+    # Copied from ActionController::TestCase
+    class FunctionalTestCase < ::Protest::TestCase
+      include ActionController::TestProcess
+      
+      # When the request.remote_addr remains the default for testing, which is 0.0.0.0, the exception is simply raised inline
+      # (bystepping the regular exception handling from rescue_action). If the request.remote_addr is anything else, the regular
+      # rescue_action process takes place. This means you can test your rescue_action code by setting remote_addr to something else
+      # than 0.0.0.0.
+      #
+      # The exception is stored in the exception accessor for further inspection.
+      module RaiseActionExceptions
+        attr_accessor :exception
+
+        def rescue_action(e)
+          self.exception = e
+
+          if request.remote_addr == "0.0.0.0"
+            raise(e)
+          else
+            super(e)
+          end
+        end
+      end
+
+      @@controller_class = nil
+
+      class << self
+        def controller_class=(new_class)
+          prepare_controller_class(new_class)
+          write_inheritable_attribute(:controller_class, new_class)
+        end
+
+        def controller_class
+          if current_controller_class = read_inheritable_attribute(:controller_class)
+            current_controller_class
+          end
+        end
+
+        def prepare_controller_class(new_class)
+          new_class.send :include, RaiseActionExceptions
+        end
+      end
+      
+      attr_reader :controller, :request, :response
+      
+      setup do
+        @controller = self.class.controller_class.new
+        @controller.request = @request = ActionController::TestRequest.new
+        @response = ActionController::TestResponse.new
+      end
+    end
+  end
+end
+
+require 'htmldoc'
+
+#----
+
+# This is only here so our template handler won't complain
+module ApplicationHelper; end
+
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action'
+end
+
+require 'htmldoc-rails'
+
+# This has to be set after we require htmldoc-rails and consequently
+# after rpdf is added to the template handlers, that way the Template objects
+# have rpdf stored as the extension
+ActionController::Base.view_paths = File.expand_path(File.dirname(__FILE__) + '/views')

data/test/rails_template_process.txt

@@ -0,0 +1,21 @@
+AV::Template#initialize("/full/path/to/render_pdf/doc.rpdf")
+- AV::Template#split("/full/path/to/render_pdf/doc.rpdf")
+  - AV::Template#valid_extension?("rpdf") #=> [base_path = "/full/path/to/render_pdf/", name = "doc", format = nil, extension = "rpdf"]
+
+AC::Base#render(options = {:action => 'doc.rpdf', :layout => false}, extra_options = {}):
+- AC::Base#pick_layout(options = {:action => 'doc.rpdf', :layout => false}) #=> nil
+- AC::Base#default_template_name(action_name = "doc.rpdf") #=> "render_pdf/doc.rpdf"
+- AC::Base#render_for_file(action_name = "render_pdf/doc.rpdf", status = nil, layout = nil, locals = {})
+  - AV::Base#render(options = {:file => "render_pdf/doc.rpdf", :locals => {}, :layout => nil}, local_assigns = {})
+    - AV::Base#_pick_template(template_path = "render_pdf/doc.rpdf") #=> AV::Template.new("/full/path/to/render_pdf/doc.rpdf")
+    - AV::Template#render_template(view, locals = {})
+      - AV::Template#render(view, locals = {})  # in Renderable
+        - AV::Template#compile(locals = {})  # in Renderable
+          - AV::Template#recompile?(render_symbol) #=> true  # in Renderable
+            - AV::PathSet::Path.eager_load_templates? #=> false since config.cache_classes is false
+          - AV::Template#compile!(render_symbol, local_assigns = {})  # in Renderable
+            - AV::Template#compiled_source #=> "the template"  # Renderable
+              - AV::Template#handler
+                - AV::Template.handler_class_for_extension(extension = "rpdf") #=> should return PDF::HTMLDoc::View??  # in TemplateHandlers
+              - PDF::HTMLDoc::View#call #=> "PDF::HTMLDoc::View.new(self).render(template, local_assigns)"
+            - PDF::HTMLDoc::View.new(view).render(template, local_assigns = {})

data/test/test_render_pdf.rb

@@ -0,0 +1,156 @@
+require 'helper'
+
+class RenderPdfController < ActionController::Base
+  def default
+    render_pdf :action => 'doc.html.erb'
+  end
+  def default_with_layout
+    render_pdf :action => 'doc.html.erb', :layout => "layout"
+  end
+  def download
+    render_pdf :url => {:action => 'doc.html.erb'}, :as => :attachment
+  end
+  def download_with_filename
+    render_pdf :url => {:action => 'doc.html.erb'}, :as => :attachment, :filename => "foo.pdf"
+  end
+  def with_just_filename
+    render_pdf :url => {:action => 'doc.html.erb'}, :filename => "foo.pdf"
+  end
+  def inline_with_filename
+    render_pdf :url => {:action => 'doc.html.erb'}, :as => :inline, :filename => "foo.pdf"
+  end
+  def with_htmldoc_options
+    render_pdf :action => 'doc.html.erb', :htmldoc => {:top => 10, :left => 10}
+  end
+  def with_no_url
+    render_pdf
+  end
+  def partial
+    render_pdf :action => 'doc_with_partial.html.erb'
+  end
+  def responder
+    respond_to do |wants|
+      wants.html { render :text => "HTML" }
+      wants.pdf { render_pdf :action => 'doc.html.erb' }
+    end
+  end
+  def no_arguments
+    render_pdf
+  end
+  def rpdf
+    render_pdf :action => 'doc.rpdf'
+  end
+end
+
+module RenderPdfHelper; end
+
+Protest::Rails::FunctionalTestCase.describe("render_pdf") do
+  self.controller_class = RenderPdfController
+  
+  def visit(url, options={})
+    get(url, options)
+    #puts "Headers:"
+    #pp :headers => response.headers
+    #puts "Response body:"
+    #puts response.body unless response.success?
+  end
+  
+  def should_render_a_pdf
+    response.content_type.should == 'application/pdf'
+    tempfile = Tempfile.new("test_htmldoc_rails")
+    tempfile.write(response.body)
+    `file -Ib "#{tempfile.path}"`.chomp.should == "application/pdf"
+  end
+  
+  test "converts a view into a PDF with the right content type" do
+    visit :default
+    should_render_a_pdf
+  end
+  test "returns an error if the PDF file couldn't be generated for some reason" do
+    PDF::HTMLDoc.stubs(:create).returns(nil)
+    visit :default
+    response.body.should =~ /HTMLDoc had trouble parsing the HTML to create the PDF/
+  end
+  test ":url option is required" do
+    lambda { visit :with_no_url }.should raise_error
+  end
+  
+  test "the PDF file is rendered with no layout by default" do
+    controller.stubs(:render_to_string).returns("")
+    visit :default
+    controller.should have_received(:render_to_string).with(has_entry(:layout, false))
+  end
+  test "the PDF file is rendered with a layout if one was specified" do
+    controller.stubs(:render_to_string).returns("")
+    visit :default_with_layout
+    controller.should have_received(:render_to_string).with(has_entry(:layout, "layout"))
+  end
+  
+  test "renders the PDF in the browser by default" do
+    visit :default
+    response.headers["Content-Disposition"].should == "inline"
+  end
+  test ":as => :attachment option gives the user a download box" do
+    visit :download
+    response.headers["Content-Disposition"].should == "attachment"
+  end
+  test ":filename option when disposition is attachment pre-sets the filename that the user will download the PDF as" do
+    visit :download_with_filename
+    response.headers["Content-Disposition"].should == 'attachment; filename="foo.pdf"'
+  end
+  test ":filename option without disposition does not auto-set disposition to attachment" do
+    visit :with_just_filename
+    response.headers["Content-Disposition"].should == 'inline; filename="foo.pdf"'
+  end
+  test ":filename option when disposition is inline sets filename" do
+    visit :inline_with_filename
+    response.headers["Content-Disposition"].should == 'inline; filename="foo.pdf"'
+  end
+  test "?as=attachment in the querystring gives the user a download box" do
+    visit :download, :as => "attachment"
+    response.headers["Content-Disposition"].should == "attachment"
+  end
+  test "?as=inline in the querystring renders the PDF in the browser" do
+    visit :default, :as => "inline"
+    #response.success?.should == true
+    response.headers["Content-Disposition"].should == "inline"
+  end
+  
+  test "sends headers to ensure that the PDF file isn't cached" do
+    visit :default
+    response.headers["Pragma"].should == "no-cache"
+    response.headers["Cache-Control"].should == 'no-cache, must-revalidate'
+  end
+  test "doesn't ensure PDF file isn't cached on IE" do
+    request.env['HTTP_USER_AGENT'] = "msie"
+    visit :default
+    response.headers["Pragma"].should == ""
+    response.headers["Cache-Control"].should == ""
+  end
+  
+  test "forwards :htmldoc options straight to HTMLDoc" do
+    pdf = PDF::HTMLDoc.new
+    pdf.stubs(:set_option)
+    PDF::HTMLDoc.stubs(:create).returns("").yields(pdf)
+    visit :with_htmldoc_options
+    pdf.should have_received(:set_option).with(:left, 10)
+    pdf.should have_received(:set_option).with(:top, 10)
+  end
+  
+  test "rendering a partial within a view works" do
+    visit :partial
+    should_render_a_pdf
+  end
+  
+  test "rendering a view in a responder works" do
+    request.accept = "application/pdf"
+    visit :responder
+    should_render_a_pdf
+  end
+  
+  test "renders a file named after the action if passed no arguments" do
+    visit :no_arguments
+    should_render_a_pdf
+  end
+  
+end

data/test/test_render_pdf_to_file.rb

@@ -0,0 +1,78 @@
+require 'helper'
+
+class RenderPdfToFileController < ActionController::Base
+  def default
+    render_pdf_to_file "/tmp/htmldoc-rails.test.pdf", :action => 'doc.html.erb'
+    render :nothing => true
+  end
+  def default_with_layout
+    render_pdf_to_file "/tmp/htmldoc-rails.test.pdf", :action => 'doc.html.erb', :layout => "layout"
+    render :nothing => true
+  end
+  def with_htmldoc_options
+    render_pdf_to_file "/tmp/htmldoc-rails.test.pdf", {:action => 'doc.html.erb'}, :top => 10, :left => 10
+    render :nothing => true
+  end
+  def partial
+    render_pdf_to_file "/tmp/htmldoc-rails.test.pdf", :action => 'doc_with_partial.html.erb'
+    render :nothing => true
+  end
+  def no_arguments
+    render_pdf_to_file "/tmp/htmldoc-rails.test.pdf"
+    render :nothing => true
+  end
+end
+
+module RenderPdfToFileHelper; end
+
+Protest::Rails::FunctionalTestCase.describe("render_pdf_to_file") do
+  self.controller_class = RenderPdfToFileController
+  
+  def visit(url, options={})
+    get(url, options)
+    #puts "Headers:"
+    #pp :headers => response.headers
+    #puts "Response body:"
+    #puts response.body unless response.success?
+  end
+  
+  def should_render_a_pdf
+    File.exists?("/tmp/htmldoc-rails.test.pdf").should == true
+    `file -Ib "/tmp/htmldoc-rails.test.pdf"`.chomp.should == "application/pdf"
+  end
+  
+  test "writes the rendered PDF to the given file" do
+    visit :default
+    should_render_a_pdf
+  end
+  test "sends the PDF straight to the browser" do
+    visit :default
+    response.headers["Content-Disposition"].should == "inline"
+  end
+  test "forwards :htmldoc options straight to HTMLDoc" do
+    pdf = PDF::HTMLDoc.new
+    pdf.stubs(:set_option)
+    PDF::HTMLDoc.stubs(:create).returns("").yields(pdf)
+    visit :with_htmldoc_options
+    pdf.should have_received(:set_option).with(:left, 10)
+    pdf.should have_received(:set_option).with(:top, 10)
+  end
+  test "renders the PDF in no layout by default" do
+    controller.stubs(:render_to_string).returns("")
+    visit :default
+    controller.should have_received(:render_to_string).with(has_entry(:layout, false))
+  end
+  test "renders the PDF in the layout that's specified" do
+    controller.stubs(:render_to_string).returns("")
+    visit :default_with_layout
+    controller.should have_received(:render_to_string).with(has_entry(:layout, "layout"))
+  end
+  test "rendering a partial within a view works" do
+    visit :partial
+    should_render_a_pdf
+  end
+  test "renders a file named after the action if passed no arguments" do
+    visit :no_arguments
+    should_render_a_pdf
+  end
+end

data/test/views/render_pdf/_foo.html.erb

@@ -0,0 +1 @@
+<p>Some more stuff.</p>

data/test/views/render_pdf/doc.html.erb

@@ -0,0 +1 @@
+<p>This is some <%= "text" %> and stuff</p>

data/test/views/render_pdf/doc.rpdf

@@ -0,0 +1 @@
+<p>This is some <%= "text" %> and stuff</p>

data/test/views/render_pdf/doc_with_partial.html.erb

@@ -0,0 +1,3 @@
+<p>Here is some content.</p>
+
+<%= render :partial => "foo" %>

data/test/views/render_pdf/no_arguments.html.erb

@@ -0,0 +1 @@
+Alright here we go

data/test/views/render_pdf_to_file/_foo.html.erb

@@ -0,0 +1 @@
+<p>Some more stuff.</p>

data/test/views/render_pdf_to_file/doc.html.erb

@@ -0,0 +1 @@
+<p>This is some <%= "text" %> and stuff</p>

data/test/views/render_pdf_to_file/doc_with_partial.html.erb

@@ -0,0 +1,3 @@
+<p>Here is some content.</p>
+
+<%= render :partial => "foo" %>

data/test/views/render_pdf_to_file/no_arguments.html.erb

@@ -0,0 +1 @@
+Alright here we go

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: htmldoc-rails
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Elliot Winkler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: htmldoc
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mcmire-protest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mcmire-matchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mcmire-mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha-protest-integration
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Generate PDFs from your Rails views using HTMLDoc
+email: elliot.winkler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/htmldoc-rails.rb
+- lib/htmldoc_rails.rb
+- lib/htmldoc_rails/controller.rb
+- lib/htmldoc_rails/htmldoc_ext.rb
+- lib/htmldoc_rails/version.rb
+- test/all.rb
+- test/helper.rb
+- test/rails_template_process.txt
+- test/test_render_pdf.rb
+- test/test_render_pdf_to_file.rb
+- test/tmp/out.html
+- test/tmp/out.pdf
+- test/views/render_pdf/_foo.html.erb
+- test/views/render_pdf/doc.html.erb
+- test/views/render_pdf/doc.rpdf
+- test/views/render_pdf/doc_with_partial.html.erb
+- test/views/render_pdf/no_arguments.html.erb
+- test/views/render_pdf_to_file/_foo.html.erb
+- test/views/render_pdf_to_file/doc.html.erb
+- test/views/render_pdf_to_file/doc_with_partial.html.erb
+- test/views/render_pdf_to_file/no_arguments.html.erb
+has_rdoc: true
+homepage: http://github.com/mcmire/htmldoc-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generate PDFs from your Rails views using HTMLDoc
+test_files: 
+- test/all.rb
+- test/helper.rb
+- test/test_render_pdf.rb
+- test/test_render_pdf_to_file.rb