drnic-princely 1.0.0

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

@@ -0,0 +1,50 @@
+Princely
+========
+
+Princely is a simple wrapper for the Prince XML PDF generation library 
+(http://www.princexml.com). It is almost entirely based on the SubImage 
+Prince library found on this blog post:
+
+http://sublog.subimage.com/articles/2007/05/29/html-css-to-pdf-using-ruby-on-rails 
+
+I have taken the helpers and made them a little bit more generalized and 
+reusable, and created a render option set for pdf generation. The plugin
+will also automatically register the PDF MimeType so that you can use
+pdf in controller respond_to blocks.
+
+Example
+=======
+
+class Provider::EstimatesController < Provider::BaseController
+  def show
+    respond_to do |format|
+      format.html
+      format.pdf do
+        render :pdf => "file_name", 
+               :template => "controller/action.pdf.erb", 
+               :stylesheets => ["application","prince"]
+               :layout => "pdf"
+      end
+    end
+  end
+  
+  def pdf
+    make_and_send_pdf("file_name")
+  end
+end
+
+Render Defaults
+===============
+
+The defaults for the render options are as follows:
+
+layout:      false
+template:    the template for the current controller/action
+stylesheets: none
+
+Resources
+=========
+
+Trac: http://trac.intridea.com/trac/public/
+
+Copyright (c) 2007 Michael Bleigh and Intridea, Inc., released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "princely"
+    gem.summary = %Q{A simple Rails wrapper for the PrinceXML PDF generation library.}
+    gem.description = %Q{A wrapper for the PrinceXML PDF generation library based on article by Seth from Subimage Interactive at http://sublog.subimage.com/2007/05/29/html-css-to-pdf-using-ruby-on-rails}
+    gem.email = "michael@intridea.com"
+    gem.homepage = "http://github.com/drnic/princely"
+    gem.authors = ["Michael Bleigh", "Seth from Subimage Interactive"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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,6 @@
+require 'prince'
+require 'pdf_helper'
+
+Mime::Type.register 'application/pdf', :pdf
+
+ActionController::Base.send(:include, PdfHelper)

data/lib/pdf_helper.rb

@@ -0,0 +1,55 @@
+module PdfHelper
+  require 'prince'
+  
+  def self.included(base)
+    base.class_eval do
+      alias_method_chain :render, :princely
+    end
+  end
+  
+  def render_with_princely(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_princely(options, *args, &block)
+    end
+  end  
+    
+  private
+  
+  def make_pdf(options = {})
+    options[:stylesheets] ||= []
+    options[:layout] ||= false
+    options[:template] ||= File.join(controller_path,action_name)
+    
+    prince = Prince.new()
+    # Sets style sheets on PDF renderer
+    prince.add_style_sheets(*options[:stylesheets].collect{|style| stylesheet_file_path(style)})
+    
+    html_string = render_to_string(:template => options[:template], :layout => options[:layout])
+    
+    # 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 + '"' }
+    
+    # Send the generated PDF file from our html string.
+    return prince.pdf_from_string(html_string)
+  end
+
+  def make_and_send_pdf(pdf_name, options = {})
+    send_data(
+      make_pdf(options),
+      :filename => pdf_name + ".pdf",
+      :type => 'application/pdf'
+    ) 
+  end
+  
+  def stylesheet_file_path(stylesheet)
+    stylesheet = stylesheet.to_s.gsub(".css","")
+    File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR,"#{stylesheet}.css")
+  end
+end

data/lib/prince.rb

@@ -0,0 +1,77 @@
+# Prince XML Ruby interface. 
+# http://www.princexml.com
+#
+# Library by Subimage Interactive - http://www.subimage.com
+#
+#
+# USAGE
+# -----------------------------------------------------------------------------
+#   prince = Prince.new()
+#   html_string = render_to_string(:template => 'some_document')
+#   send_data(
+#     prince.pdf_from_string(html_string),
+#     :filename => 'some_document.pdf'
+#     :type => 'application/pdf'
+#   )
+#
+require 'logger'
+
+class Prince
+  VERSION = "1.0.0"
+  
+  attr_accessor :exe_path, :style_sheets, :log_file, :logger
+
+  # Initialize method
+  #
+  def initialize()
+    # Finds where the application lives, so we can call it.
+    @exe_path = `which prince`.chomp
+  	@style_sheets = ''
+  	@log_file = "#{RAILS_ROOT}/log/prince.log"
+  	@logger = RAILS_DEFAULT_LOGGER
+  end
+  
+  # Sets stylesheets...
+  # Can pass in multiple paths for css files.
+  #
+  def add_style_sheets(*sheets)
+    for sheet in sheets do
+      @style_sheets << " -s #{sheet} "
+    end
+  end
+  
+  # Returns fully formed executable path with any command line switches
+  # we've set based on our variables.
+  #
+  def exe_path
+    # Add any standard cmd line arguments we need to pass
+    @exe_path << " --input=html --server --log=#{@log_file} "
+    @exe_path << @style_sheets
+    return @exe_path
+  end
+  
+  # Makes a pdf from a passed in string.
+  #
+  # Returns PDF as a stream, so we can use send_data to shoot
+  # it down the pipe using Rails.
+  #
+  def pdf_from_string(string)
+    path = self.exe_path()
+    # Don't spew errors to the standard out...and set up to take IO 
+    # as input and output
+    path << ' --silent - -o -'
+    
+    # Show the command used...
+    logger.info "\n\nPRINCE XML PDF COMMAND"
+    logger.info path
+    logger.info ''
+    
+    # Actually call the prince command, and pass the entire data stream back.
+    pdf = IO.popen(path, "w+")
+    pdf.puts(string)
+    pdf.close_write
+    result = pdf.gets(nil)
+    pdf.close_read
+    return result
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: drnic-princely
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Michael Bleigh
+- Seth from Subimage Interactive
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A wrapper for the PrinceXML PDF generation library based on article by Seth from Subimage Interactive at http://sublog.subimage.com/2007/05/29/html-css-to-pdf-using-ruby-on-rails
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- lib/pdf_helper.rb
+- lib/prince.rb
+has_rdoc: false
+homepage: http://github.com/drnic/princely
+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: A simple Rails wrapper for the PrinceXML PDF generation library.
+test_files: []
+