rprince 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+tmp

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1 @@
+WARNING: This assumes you have Prince 7.0 and considerably modifies the API found in Princely.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rprince"
+    gem.summary = %Q{A minimal Rails/gem wrapper for the PrinceXML PDF generation library.}
+    gem.description = %Q{A minimal wrapper for the PrinceXML PDF generation library.}
+    gem.email = "timon.karnezos@gmail.com"
+    gem.homepage = "http://github.com/timonk/rprince"
+    gem.authors = ["Timon Karnezos"]
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo 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
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "princely #{version}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

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

data/lib/rprince/pdf_helper.rb

@@ -0,0 +1,50 @@
+module PdfHelper
+  require 'rprince'
+  
+  def rprince_pdf(options = {})
+    options[:stylesheets] ||= []
+    options[:layout]      ||= false
+    options[:template]    ||= File.join(controller_path, action_name)
+
+    unless options.has_key?(:normalize_sources)
+      options[:normalize_sources] = true
+    end
+
+    prince = RPrince.new()
+
+    # Sets style sheets on PDF renderer
+    prince.style_sheets = options[:stylesheets].map{|style| stylesheet_file_path(style) }
+    html_string = render_to_string(:template => options[:template], :layout => options[:layout])
+
+    if options[:normalize_sources]
+      # Make all paths relative, on disk paths...
+      html_string.gsub!( /src=["']+([^:]+?)["']/i ) { |m| %{src="#{RAILS_ROOT}/public/#{$1}"} }
+    end
+    
+    # Remove asset ids
+    html_string.gsub!( /src=["'](\S+\?\d*)["']/i ) { |m| %{src="#{$1.split('?').first}"} }
+
+
+    # Send the generated PDF file from our html string.
+    if options[:file]
+      prince.html_string_to_pdf_file(html_string, options[:file])
+    else
+      prince.html_string_to_pdf_string(html_string)
+    end
+  end
+  
+  def send_rprince_pdf(pdf_name, options = {})
+    options.delete(:file)
+    send_data(rprince_pdf(options),
+      :filename => "#{pdf_name}.pdf",
+      :type => 'application/pdf'
+    )
+  end
+  
+  private
+  
+  def stylesheet_file_path(stylesheet)
+    stylesheet = stylesheet.to_s.gsub(".css","")
+    File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR, "#{stylesheet}.css")
+  end
+end

data/lib/rprince/rails.rb

@@ -0,0 +1,6 @@
+require 'rprince'
+require 'rprince/pdf_helper'
+
+Mime::Type.register 'application/pdf', :pdf
+
+ActionController::Base.send(:include, PdfHelper)

data/lib/rprince.rb

@@ -0,0 +1,93 @@
+$:.unshift(File.dirname(__FILE__))
+require 'logging'
+
+class RPrince
+  attr_accessor :style_sheets
+  
+  class << self
+    attr_reader :executable_path
+    attr_reader :executable_log_path
+    attr_accessor :allow_network_access
+    attr_accessor :verbose_executable_logging
+    
+    def executable_log_path=(path)
+      @executable_log_path = File.expand_path(path)
+    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 prince command-line app in $PATH" unless @executable_path
+      @executable_path.strip!
+    end
+  end
+  
+  def initialize()
+    @logger = Logging::Logger[RPrince]
+    @style_sheets = []
+  end
+  
+  # Since the prince CLI has trouble with long input file paths, we create this method to buffer
+  # them through Ruby and to the stdin of our prince process.
+  def html_files_to_pdf_file(files, output_file)
+    command = build_command(output_file)
+    logger.info("Calling Prince executable with: `#{command}`")
+    pdf = IO.popen(command, "w+")
+    buffer = ""
+    files.each do |path|
+      File.open(File.expand_path(path), "r") do |f|
+        while ( f.read(1024, buffer) )
+          pdf.write(buffer)
+        end
+      end
+    end
+    pdf.close
+  end
+
+  def html_string_to_pdf_string(html_string_input)
+    command = build_command
+    logger.info("Calling Prince executable with: `#{command}`")
+    pdf = IO.popen(command, "w+")
+    pdf.puts(html_string_input)
+    pdf.close_write
+    result = pdf.gets(nil)
+    pdf.close_read
+    
+    result
+  end
+
+  def html_string_to_pdf_file(html_string_input, output_file)
+    command = build_command(output_file)
+    logger.info("Calling Prince executable with: `#{command}`")
+    pdf = IO.popen(command, "w+")
+    pdf.puts(html_string_input)
+    pdf.close
+  end
+  
+  private
+  
+  def build_flags
+    flags = style_sheets.map{|s| "--style='#{File.expand_path(s)}'" }
+    flags << "--input=html"
+    if RPrince.verbose_executable_logging
+      flags << '--verbose'
+    else
+      flags << '--silent'
+    end
+    flags << "--no-network" unless RPrince.allow_network_access
+    flags << "--log='#{RPrince.executable_log_path}'" if RPrince.executable_log_path
+    flags.join(' ')
+  end
+  
+  def build_command(output_file='-')
+    # we're always passing the input on stdin, so we use a dash for that arg, per Prince's CLI spec
+    [RPrince.executable_path, build_flags, "-", "-o '#{output_file}'"].join(' ')
+  end
+  
+  def logger
+    @logger
+  end
+end

data/rails/init.rb

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

data/rprince.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rprince}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Timon Karnezos"]
+  s.date = %q{2010-04-09}
+  s.description = %q{A minimal wrapper for the PrinceXML PDF generation library.}
+  s.email = %q{timon.karnezos@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/rprince.rb",
+     "lib/rprince/pdf_helper.rb",
+     "lib/rprince/rails.rb",
+     "rails/init.rb",
+     "rprince.gemspec",
+     "sample/sample.html",
+     "sample/sample.rb"
+  ]
+  s.homepage = %q{http://github.com/timonk/rprince}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A minimal Rails/gem wrapper for the PrinceXML PDF generation library.}
+
+  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
+    else
+    end
+  else
+  end
+end
+

data/sample/sample.html

@@ -0,0 +1,5 @@
+<html>
+<body>
+The content of the body element is displayed in your pdf.
+</body>
+</html>

data/sample/sample.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+this_dir = File.dirname(__FILE__)
+require File.join(this_dir, "..", "lib", "rprince")
+
+Logging::Logger.root.clear_appenders
+Logging::Logger.root.add_appenders(Logging::Appenders::Stdout.new)
+
+RPrince.detect_executable_path
+RPrince.executable_log_path = 'prince_executable.log'
+RPrince.verbose_executable_logging = true
+
+p = RPrince.new
+
+example_html_file = File.join(this_dir, "sample.html")
+example_html = File.read(example_html_file)
+          
+to_file_outfile = File.join(this_dir, "to_file.pdf")
+p.html_string_to_pdf_file(example_html, to_file_outfile)
+
+to_string_outfile = File.join(this_dir, "to_string.pdf")
+pdf_string = p.html_string_to_pdf_string(example_html)
+File.open(to_string_outfile, "w+") {|f| f.write(pdf_string) }
+
+files_to_file_outfile = File.join(this_dir, "fs2f.pdf")
+p.html_files_to_pdf_file([example_html_file, example_html_file], files_to_file_outfile)

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: rprince
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Timon Karnezos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A minimal wrapper for the PrinceXML PDF generation library.
+email: timon.karnezos@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/rprince.rb
+- lib/rprince/pdf_helper.rb
+- lib/rprince/rails.rb
+- rails/init.rb
+- rprince.gemspec
+- sample/sample.html
+- sample/sample.rb
+has_rdoc: true
+homepage: http://github.com/timonk/rprince
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A minimal Rails/gem wrapper for the PrinceXML PDF generation library.
+test_files: []
+