to_pdf 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.rdoc

@@ -0,0 +1,98 @@
+= ToPDF
+
+A no frills PDF render for Rails (>= 3.0) and {PrinceXML}[http://princexml.com/].
+
+== Installation 
+
+In your Gemfile:
+
+  gem 'to_pdf'
+
+== Usage
+
+Create your PDF template like so:
+
+  app/views/jobs/show.pdf.haml
+
+Then in your controller it’s just like responding to HTML or JSON etc.:
+
+  class JobController < ApplicationController
+    respond_to :pdf
+
+    def show
+      @job = Job.find(params[:id])
+      respond_with(@job)
+    end
+  end
+
+PrinceXML cares not for fluff that comes with HTML, treat it like XML and jump straight to the content:
+
+  .job
+    .name
+      = job.name
+
+You can though define CSS at the top of the document:
+
+  %style
+    :sass
+      @page
+        margin: 2cm
+      body
+        color: #000
+        font-family: "DejaVu Sans"
+
+Or you can link to a stylesheet:
+
+  = stylesheet_link_tag 'pdf', media: 'print'
+
+  .job
+      .name
+        = job.name
+
+This will work with the Rails 3.1 asset pipeline in production, however for it to work in development mode you will need to add this line of configuration to development.rb:
+
+  MyProject::Application.configure do
+    ...
+
+    config.prince_xml_asset_domain = "http://myproject.dev"
+  end
+
+Another configuration option available is the path to the PrinceXML executable. Again, this can optionally be set on a per environment basis:
+
+  MyProject::Application.configure do
+    ...
+
+    config.prince_xml_executable_path = '/opt/bin/prince'
+  end
+
+== Caveats
+
+* Only sends PDFs inline
+* Does not use layouts
+
+== Maintainers
+
+* {Hugh Evans}[http://github.com/hughevans]
+
+== License
+
+Copyright 2011 Hugh Evans
+
+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,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+desc "Run specs."
+RSpec::Core::RakeTask.new do |t|
+end

data/lib/to_pdf/prince_xml.rb

@@ -0,0 +1,48 @@
+class PrinceXML
+  class << self
+    attr_writer :executable_path, :asset_domain
+
+    def asset_domain=(domain)
+      @asset_domain = domain
+    end
+
+    def executable_path=(path)
+      @executable_path = File.expand_path(path)
+    end
+
+    def detect_executable_path
+      IO.popen('which prince') { |pipe| @executable_path = pipe.gets }
+      raise 'Cannot find command `prince` in $PATH' unless @executable_path
+      @executable_path.strip!
+    end
+
+    def string_to_pdf(string)
+      detect_executable_path unless @executable_path
+
+      pdf = IO.popen(prince_command, 'w+')
+      pdf.puts(localise_paths(string))
+      pdf.close_write
+      result = pdf.gets(nil)
+      pdf.close_read
+
+      result
+    end
+
+    def prince_command
+      "#{@executable_path} --input=html --silent - -o '-'"
+    end
+
+    def localise_paths(string)
+      string.gsub!('src="/', "src=\"#{Rails.public_path}/")
+
+      if @asset_domain
+        string.gsub!('link href="/', "link href=\"#{@asset_domain}/")
+      elsif defined?(Rails)
+        string.gsub!('link href="/', "link src=\"#{Rails.public_path}/")
+        string.gsub!('url(/', "url(#{Rails.public_path}/")
+      end
+
+      string
+    end
+  end
+end

data/lib/to_pdf/railtie.rb

@@ -0,0 +1,32 @@
+module ToPDF
+  class Railtie < Rails::Railtie
+    initializer 'to_pdf.configure_prince_xml' do
+      if Rails.application.config.prince_xml_asset_domain
+        PrinceXML.asset_domain = Rails.application.config.prince_xml_asset_domain
+      end
+
+      if Rails.application.config.prince_xml_executable_path
+        PrinceXML.executable_path = Rails.application.config.prince_xml_executable_path
+      end
+    end
+
+    initializer 'to_pdf.init_mime_types' do
+      Mime::Type.register 'application/pdf', :pdf
+    end
+
+    initializer 'to_pdf.insert_into_action_controller' do
+      ActiveSupport.on_load :action_controller  do
+        ActionController::Renderers.add :pdf do |template, options|
+          string = render_to_string template, options
+          send_data PrinceXML.string_to_pdf(string), :type => :pdf, :disposition => 'inline'
+        end
+
+        class ActionController::Responder
+          def to_pdf
+            controller.render :pdf => controller.action_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/to_pdf/version.rb

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

data/lib/to_pdf.rb

@@ -0,0 +1,3 @@
+autoload :PrinceXML, 'to_pdf/prince_xml'
+
+require 'to_pdf/railtie' if defined?(Rails::Railtie)

data/to_pdf.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'to_pdf/version'
+
+Gem::Specification.new do |s|
+  s.name              = 'to_pdf'
+  s.version           = ToPDF::VERSION
+  s.authors           = ['Hugh Evans']
+  s.email             = 'hugh@artpop.com.au'
+  s.homepage          = 'https://github.com/hughevans/to_pdf'
+  s.summary           = %q{Render rails actions as a PDF using PrinceXML.}
+  s.description       = %q{Render rails actions as a PDF using PrinceXML.}
+
+  s.rubyforge_project = 'to_pdf'
+
+  s.files             = `git ls-files`.split("\n")
+  s.require_path      = 'lib'
+
+  s.add_dependency 'rails', '>= 3.0.0'
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: to_pdf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Hugh Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70266974647220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70266974647220
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70266974646620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70266974646620
+description: Render rails actions as a PDF using PrinceXML.
+email: hugh@artpop.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/to_pdf.rb
+- lib/to_pdf/prince_xml.rb
+- lib/to_pdf/railtie.rb
+- lib/to_pdf/version.rb
+- to_pdf.gemspec
+homepage: https://github.com/hughevans/to_pdf
+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: to_pdf
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Render rails actions as a PDF using PrinceXML.
+test_files: []