flyingsaucer4r 0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fc5c40751267820b64eae3bc0edce1f8b7e69e8
+  data.tar.gz: c6f8848e36f4107e5f43476af2ba0a9f718a6dfd
+SHA512:
+  metadata.gz: 13417560be87263d1bd60692a3733782546604cbba831a5d79bc3460dc4c733611e62d88bd0c3cbf54af1eea10235d7363591dc3befea703e13340994473f532
+  data.tar.gz: 1abd33645b6acd4696eade70eae6b44920323179c7dad979e26d3f6184c0a60fa2dd359b99db3b8d9731a56003e131e3ff9f67f00c08e7702ced6dfde12a5685

data/History.txt

@@ -0,0 +1,13 @@
+=== 0.6 / 2009-10-13
+
+* Pull out PDF creation from filter
+
+=== 0.2.20081112 / 2008-12-05
+
+* Add debug setting to log the XHTML Flying Saucer sees
+* Treat absolute URIs as relative for better Rails compatibility 
+
+=== 0.1.20081112 / 2008-12-03
+
+* Initial version
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/flying-saucer-core-9.0.2.jar
+lib/flying-saucer-pdf-9.0.2.jar
+lib/flyingsaucer4r.rb
+lib/itext-2.1.7.02.jar
+lib/pdffilter.rb
+test/test_pdffilter.rb

data/README.txt

@@ -0,0 +1,38 @@
+= flyingsaucer4r
+
+== DESCRIPTION:
+
+The Flying Saucer gem gives JRuby access to the Flying Saucer XHTML renderer.
+It also provides Rails integration to simplify sending PDFs generated from
+XHTML to the browser.
+
+== SYNOPSIS:
+
+To add Flying Saucer to the JRuby classpath:
+
+    require 'flyingsaucer4r'
+
+To use within Rails:
+
+    require 'pdffilter'
+
+    class ApplicationController < ActionController::Base
+      after_filter PDFFilter
+
+      ...
+    end
+
+Now any request with a :format of 'pdf' will be turned into a PDF using Flying
+Saucer on the way out to the browser.
+
+== REQUIREMENTS:
+
+* None (but the Rails integration only makes sense if you are using Rails)
+
+== INSTALL:
+
+    jruby -S gem install pbrant-flyingsaucer4r
+
+== LICENSE:
+
+Copyright (c) 2008 Consolidated Court Automation Programs

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'hoe'
+require 'fileutils'
+
+DEPENDENT_JARS = [ 'itext-2_0_8_02.jar' ]
+
+STATIC_JAR_DIR = ENV['STATIC_JAR_DIR'] || "../StaticJars"
+
+Hoe.spec('flyingsaucer4r') do |p|
+  developer 'CCAP Web Team', 'CCAP_Web_Team@wicourts.gov'
+end
+
+desc "Copies dependent JARs from StaticJars"
+task :cp_dependent_jars do
+  rm_f 'lib/*.jar'
+  DEPENDENT_JARS.each do |jar|
+    cp "#{STATIC_JAR_DIR}/#{jar}", 'lib'
+  end
+end
+
+desc "Updates Flying Saucer JAR with the latest drop from StaticJars"
+task :update_fs_jar => :cp_dependent_jars do
+  latest = Dir.glob("#{STATIC_JAR_DIR}/xhtmlrenderer*.jar").sort[-1]
+  cp latest, 'lib'
+end

data/lib/flyingsaucer4r.rb

@@ -0,0 +1,90 @@
+require 'java'
+require 'enumerator'
+
+Dir.glob(File.join(File.dirname(__FILE__), "*.jar")) { |jar| require File.basename(jar) }
+
+module FlyingSaucer4R
+  VERSION = '0.7'
+
+  class UserAgent < org.xhtmlrenderer.pdf.ITextUserAgent
+    def initialize(output_device)
+      super
+    end
+
+    def resolveURI(uri)
+      if uri =~ /^\//
+        super(uri[1..uri.length])
+      else
+        super(uri)
+      end
+    end
+    alias :resolve_uri :resolveURI
+  end
+
+  def self.create_pdf(xhtml, base_path, logger = nil)
+    estimated_pdf_length = xhtml.length
+    output = java.io.ByteArrayOutputStream.new(estimated_pdf_length)
+
+    begin
+      dom = create_java_dom(xhtml, logger)
+      render_pdf(dom, base_path, output)
+    ensure
+      output.close
+    end
+  end
+
+  private
+  def self.provide_context(doc, line_no)
+    mark_selected = line_no != -1
+    line_no = 1 if line_no == -1
+    result = doc.enum_for(:each_line).enum_for(:each_with_index).inject([]) do |memo, pair|
+      line, current = pair
+      current += 1
+      diff = line_no - current
+      if diff.abs < 20
+        format_string = if line_no == current && mark_selected
+                          "==> %4d %s"
+                        else
+                          "    %4d %s"
+                        end
+        memo << sprintf(format_string, current, line)
+      elsif current > line_no
+        break memo
+      end
+
+      memo
+    end
+
+    result.join('')
+  end
+
+  def self.create_java_dom(s, logger)
+    begin
+      builder = javax.xml.parsers.DocumentBuilderFactory.new_instance.new_document_builder
+      builder.parse(java.io.ByteArrayInputStream.new(s.to_java_bytes))
+    rescue NativeException => e
+      java_e = e.cause
+      if java_e.is_a?(org.xml.sax.SAXParseException)
+        context = provide_context(s, java_e.line_number)
+        logger.info("Unable to parse XHTML at line #{java_e.line_number}, column #{java_e.column_number}: #{java_e.message}\n#{context}") if logger
+      end
+      raise e
+    end
+  end
+
+  def self.render_pdf(dom, base_path, output)
+    renderer = org.xhtmlrenderer.pdf.ITextRenderer.new
+    agent = UserAgent.new(renderer.output_device)
+    agent.shared_context = renderer.shared_context
+    renderer.shared_context.user_agent_callback = agent
+    renderer.set_document(dom, path_to_url(base_path))
+    renderer.layout
+
+    renderer.create_pdf(output)
+    String.from_java_bytes(output.to_byte_array)
+  end
+
+  def self.path_to_url(path)
+    java.io.File.new(path).to_uri.to_url.to_string
+  end
+end

data/lib/pdffilter.rb

@@ -0,0 +1,37 @@
+require 'flyingsaucer4r'
+require 'java'
+require 'enumerator'
+
+class PDFFilter
+  class <<self
+    def debug=(b)
+      @debug = b
+    end
+    
+    def debug?
+      @debug
+    end
+
+    def filter(controller)
+      format = controller.request.parameters[:format]
+      return unless format && format.to_sym == :pdf
+
+      controller.logger.debug("Rendering XHTML to PDF:\n" + controller.response.body) if debug?
+
+      pdf = FlyingSaucer4R.create_pdf(
+        controller.response.body,
+        File.join(Rails.public_path, 'placeholder.html'),
+        controller.logger)
+
+      controller.response.content_type = 'application/pdf'
+      add_ie6_pdf_over_ssl_headers(controller.response.headers)
+      controller.response.body = pdf
+    end
+
+    private
+    def add_ie6_pdf_over_ssl_headers(headers)
+      headers["Cache-Control"] ||= 'maxage=3600'
+      headers["Pragma"] ||= 'public'
+    end
+  end
+end

data/test/test_pdffilter.rb

@@ -0,0 +1,167 @@
+require 'rubygems'
+require 'shoulda'
+require 'test/unit'
+require 'mocha'
+
+lib_dir = "#{File.dirname(__FILE__)}/../lib"
+$: << lib_dir unless $:.include?(lib_dir)
+require 'pdffilter'
+
+class Rails
+  def self.public_path
+    File.dirname(__FILE__) + "/public"
+  end
+end
+
+class LoggerStub
+  def debug(message)
+    @debug_message = message
+  end
+
+  def last_debug_message
+    @debug_message
+  end
+
+  def info(message)
+    @info_message = message
+  end
+
+  def last_info_message
+    @info_message
+  end
+end
+
+class PDFFilterTest < Test::Unit::TestCase
+  def setup
+    @controller = Struct.new(:request, :response, :logger).new
+  end
+
+  context "An HTML request" do
+    should "exit right away" do 
+      @controller.request = stub(:parameters => { :format => "html" })
+      assert_nil PDFFilter.filter(@controller)
+    end
+  end
+
+  context "An request with no specified format" do
+    should "exit right away" do 
+      @controller.request = stub(:parameters => {})
+      assert_nil PDFFilter.filter(@controller)
+    end
+  end
+
+  context "A PDF request with an image" do
+    setup do
+      standard_pdf("<html><body><h1><img src='images/apple.jpg' />Hello from Flying Saucer!</h1></body></html>")
+    end
+
+    should "render something" do
+      assert_not_nil PDFFilter.filter(@controller)
+    end
+  end
+
+  def standard_pdf(content)
+    @controller.request = stub(:parameters => { :format => "pdf" })
+    response_mock = mock()
+    @controller.response = response_mock
+    @controller.logger = LoggerStub.new
+    response_mock.expects(:body).returns(content).at_least_once
+    response_mock.expects(:content_type=).with('application/pdf').once
+    @headers = {}
+    response_mock.expects(:headers).returns(@headers).once
+    response_mock.expects(:body=).once
+  end
+
+  def invalid_xhtml(content)
+    @controller.request = stub(:parameters => { :format => "pdf" })
+    response_mock = mock()
+    @controller.response = response_mock
+    @controller.logger = LoggerStub.new
+    response_mock.expects(:body).returns(content).at_least_once
+  end
+
+  context "Malformed XHTML" do
+    should "report the line number of invalid XHTML with context" do
+      invalid_xhtml(<<-EOF)
+<html>
+  <body>
+    <h1>Hello from Flying Saucer!
+  </body>
+</html>
+      EOF
+      assert_raise NativeException do
+        PDFFilter.filter(@controller)
+      end
+      assert_match %r[Unable to parse XHTML at line 4], @controller.logger.last_info_message
+      assert_match %r[==>\s+4], @controller.logger.last_info_message
+    end
+
+    should "complain about XML that isn't" do
+      invalid_xhtml(<<-EOF)
+some text
+that
+really
+isn't XML
+      EOF
+      assert_raise NativeException do
+        PDFFilter.filter(@controller)
+      end
+      assert_match %r[==>\s+1 some text], @controller.logger.last_info_message
+    end
+  end
+
+  context "A PDF request" do
+    setup do
+      standard_pdf("<html><body><h1>Hello from Flying Saucer!</h1></body></html>")
+    end
+
+    should "render something" do
+      assert_not_nil PDFFilter.filter(@controller)
+    end
+    
+    should("render something that looks like a PDF") do
+      assert_match(/%PDF/, PDFFilter.filter(@controller))
+    end
+
+    should "add headers for ie6" do
+      PDFFilter.filter(@controller)
+      assert_equal 'public', @headers["Pragma"]
+      assert_equal 'maxage=3600', @headers["Cache-Control"]
+    end
+
+    should "not overwrite existing ie6 header" do
+      @headers['Pragma'] = 'private'
+      PDFFilter.filter(@controller)
+      assert_equal 'private', @headers["Pragma"]
+    end
+
+    should "not log debug message if debug turned off" do
+      PDFFilter.filter(@controller)
+      assert_nil @controller.logger.last_debug_message
+    end
+
+    should "log XHTML content if debug turned on" do
+      old_debug = PDFFilter.debug?
+      PDFFilter.debug = true
+      begin
+        PDFFilter.filter(@controller)
+        assert_match(/<html>/, @controller.logger.last_debug_message)
+      ensure
+        PDFFilter.debug = old_debug
+      end
+    end
+  end
+
+  context FlyingSaucer4R::UserAgent do
+    setup { @user_agent = FlyingSaucer4R::UserAgent.new(org.xhtmlrenderer.pdf.ITextOutputDevice.new(1)) }
+
+    should "treat absolute URIs as relative (Java method name)" do
+      assert_equal @user_agent.resolveURI('stylesheets/aim.css'), @user_agent.resolveURI('/stylesheets/aim.css')
+    end
+
+    should "treat absolute URIs as relative (Ruby method name)" do
+      assert_equal @user_agent.resolve_uri('stylesheets/aim.css'), @user_agent.resolve_uri('/stylesheets/aim.css')
+    end
+  end
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: flyingsaucer4r
+version: !ruby/object:Gem::Version
+  version: '0.7'
+platform: ruby
+authors:
+- CCAP Web Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: hoe
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  prerelease: false
+  type: :development
+description: |-
+  The Flying Saucer gem gives JRuby access to the Flying Saucer XHTML renderer.
+  It also provides Rails integration to simplify sending PDFs generated from
+  XHTML to the browser.
+email:
+- CCAP_Web_Team@wicourts.gov
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/flying-saucer-core-9.0.2.jar
+- lib/flying-saucer-pdf-9.0.2.jar
+- lib/flyingsaucer4r.rb
+- lib/itext-2.1.7.02.jar
+- lib/pdffilter.rb
+- test/test_pdffilter.rb
+- .gemtest
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: The Flying Saucer gem gives JRuby access to the Flying Saucer XHTML renderer
+test_files: []