timriley-saucerly 0.5.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tim Riley
+
+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,38 @@
+Saucerly
+========
+
+Saucerly provides PDF rendering for your Rails app using the Java-based [FlyingSaucer](https://xhtmlrenderer.dev.java.net/) library.
+
+It is based on [Princely](http://github.com/mbleigh/princely/). The benefit of Saucerly is that it provides competent XHTML to PDF rendering without the $4k PrinceXML pricetag.
+
+Example
+-------
+
+Rendering from a template:
+
+    class ExamplesController < ApplicationController::Base
+      def show
+        @document = Document.find(params[:id])
+      
+        respond_to do |format|
+          format.html
+          format.pdf { render :pdf => 'file_name', :template => 'controller/action.pdf.haml', :layout => 'pdf' }
+        end
+      end
+    end
+          
+Rendering from an inline string:
+
+    render :pdf => 'file_name', :inline => 'XHTML goes here'
+
+Installation
+------------
+
+1. Install [JRuby](http://jruby.org/)
+2. Register the flying_saucer gem dependency: add `config.gem 'flying_saucer'` to `config/environment.rb`
+3. Install flying_saucer: `jruby -S rake gems:install`
+4. Install Saucerly: `jruby script/plugin install git://github.com/timriley/saucerly`
+5. You're ready to go! Add some code to your controllers like the examples above.
+6. If you're developing on OS X and you don't want a Java icon to appear in your dock, put `java.lang.System.set_property("java.awt.headless", "true")` in `environment.rb` or an initializer
+
+Copyright (c) 2009 Tim Riley & RentMonkey Pty Ltd, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "saucerly"
+    gemspec.summary = "PDF rending plugin for Rails using FlyingSaucer."
+    gemspec.email = "tim@openmonkey.com"
+    gemspec.homepage = "http://github.com/timriley/saucerly"
+    gemspec.authors = ["Tim Riley"]
+    
+    gemspec.add_dependency('flying_saucer')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the saucerly plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the saucerly plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Saucerly'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,3 @@
+- turn into a gemplugin
+- stop flying_saucer from polluting the logs
+- add support for saving the pdf to a file?

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/lib/saucerly/pdf_helper.rb

@@ -0,0 +1,60 @@
+module Saucerly
+  module PdfHelper
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :render, :saucerly
+      end
+    end
+  
+    def render_with_saucerly(options = nil, *args, &block)
+      if options.is_a?(Hash) && options.has_key?(:pdf)
+        options[:name] ||= options.delete(:pdf)
+        make_and_send_pdf(options.delete(:name), options)
+      else
+        render_without_saucerly(options, *args, &block)
+      end
+    end
+  
+    private
+    
+    def pdf_from_string(str)
+      # These lines are extracted from ITextRenderer's #setDocumentFromString, which doesn't
+      # seem to exist in the flying_saucer gem
+      is = org.xml.sax.InputSource.new(java.io.BufferedReader.new(java.io.StringReader.new(str)))
+      dom = org.xhtmlrenderer.resource.XMLResource.load(is).getDocument()
+
+      renderer = org.xhtmlrenderer.pdf.ITextRenderer.new
+      renderer.setDocument(dom, nil)
+      renderer.layout
+
+      output = java.io.ByteArrayOutputStream.new
+      renderer.createPDF(output, true)
+      
+      String.from_java_bytes(output.to_byte_array)
+    end
+  
+    def make_pdf(options = {})
+      html_string = if options[:inline]
+        render_to_string(:inline => options[:inline])
+      else
+        render_to_string(:template => options[:template], :layout => options[:layout])
+      end
+    
+      # Make all paths relative, on disk paths...
+      html_string.gsub!(".com:/",".com/") # strip out bad attachment_fu URLs
+      html_string.gsub!(/src=["']+([^:]+?)["']/i) { |m| "src=\"#{Rails.root}/public/" + $1 + '"' } # re-route absolute paths
+    
+      # Remove asset ids on images with a regex
+      html_string.gsub!(/src=["'](\S+\?\d*)["']/i) { |m| 'src="' + $1.split('?').first + '"' }
+      pdf_from_string(html_string)
+    end
+  
+    def make_and_send_pdf(pdf_name, options = {})
+      send_data_options = {:filename => pdf_name + ".pdf", :type => 'application/pdf'}
+      disposition       = options.delete(:disposition)
+      send_data_options[:disposition] = disposition if disposition
+      
+      send_data(make_pdf(options), send_data_options) 
+    end
+  end
+end

data/lib/saucerly/rails.rb

@@ -0,0 +1,7 @@
+require 'java'
+require 'flying_saucer'
+
+require 'saucerly/pdf_helper'
+
+Mime::Type.register 'application/pdf', :pdf
+ActionController::Base.send(:include, Saucerly::PdfHelper)

data/rails/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../lib/saucerly/rails"

data/saucerly.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{saucerly}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Riley"]
+  s.date = %q{2009-09-25}
+  s.email = %q{tim@openmonkey.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "init.rb",
+     "lib/saucerly/pdf_helper.rb",
+     "lib/saucerly/rails.rb",
+     "rails/init.rb",
+     "saucerly.gemspec"
+  ]
+  s.homepage = %q{http://github.com/timriley/saucerly}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{PDF rending plugin for Rails using FlyingSaucer.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<flying_saucer>, [">= 0"])
+    else
+      s.add_dependency(%q<flying_saucer>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<flying_saucer>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: timriley-saucerly
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Tim Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flying_saucer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: tim@openmonkey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- TODO
+- VERSION
+- init.rb
+- lib/saucerly/pdf_helper.rb
+- lib/saucerly/rails.rb
+- rails/init.rb
+- saucerly.gemspec
+has_rdoc: false
+homepage: http://github.com/timriley/saucerly
+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: PDF rending plugin for Rails using FlyingSaucer.
+test_files: []
+