princely 1.2.5 → 1.3.0

data/README.rdoc

@@ -16,8 +16,9 @@ respond_to blocks.
           format.pdf do
             render :pdf => "file_name", 
                    :template => "controller/action.pdf.erb",
-                   :stylesheets => ["application","prince"]
-                   :layout => "pdf"
+                   :stylesheets => ["application","prince"],
+                   :layout => "pdf",
+                   :disposition => "inline" # PDF will be sent inline, means you can load it inside an iFrame or Embed
           end
         end
       end
@@ -37,6 +38,7 @@ The defaults for the render options are as follows:
     layout:      false
     template:    the template for the current controller/action
     stylesheets: none
+    disposition: attachment (created PDF file will be sent as download)
 
 == Contributors
 

data/Rakefile

@@ -1,42 +1 @@
-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.}
-    gem.email = "michael@intridea.com"
-    gem.homepage = "http://github.com/mbleigh/princely"
-    gem.authors = ["Michael Bleigh"]
-    # 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
+require "bundler/gem_tasks"

data/VERSION

@@ -1 +1 @@
-1.2.5
+1.2.6

data/lib/princely.rb

@@ -16,21 +16,43 @@
 #
 $:.unshift(File.dirname(__FILE__))
 require 'logger'
+require 'princely/rails' if defined?(Rails)
 
 class Princely
-  VERSION = "1.0.0" unless const_defined?("VERSION")
-  
   attr_accessor :exe_path, :style_sheets, :log_file, :logger
 
   # Initialize method
   #
-  def initialize()
+  def initialize(options={})
     # Finds where the application lives, so we can call it.
-    @exe_path = `which prince`.chomp
+    @exe_path = options[:path] || find_prince_executable
     raise "Cannot find prince command-line app in $PATH" if @exe_path.length == 0
-  	@style_sheets = ''
-  	@log_file = "#{RAILS_ROOT}/log/prince.log"
-  	@logger = RAILS_DEFAULT_LOGGER
+    raise "Cannot find prince command-line app at #{@exe_path}" if @exe_path && !File.executable?(@exe_path)
+    @style_sheets = ''
+    @log_file = options[:log_file]
+    @logger = options[:logger]
+  end
+
+  def logger
+    @logger ||= defined?(Rails) ? Rails.logger : StdoutLogger
+  end
+
+  def log_file
+    @log_file ||= defined?(Rails) ? 
+            Rails.root.join("log/prince.log") :
+            File.expand_path(File.dirname(__FILE__) + "/log/prince.log")
+  end
+
+  def ruby_platform
+    RUBY_PLATFORM
+  end
+
+  def find_prince_executable
+    if ruby_platform =~ /mswin32/
+      "C:/Program Files/Prince/Engine/bin/prince"
+    else
+      `which prince`.chomp
+    end
   end
   
   # Sets stylesheets...
@@ -47,7 +69,7 @@ class Princely
   #
   def exe_path
     # Add any standard cmd line arguments we need to pass
-    @exe_path << " --input=html --server --log=#{@log_file} "
+    @exe_path << " --input=html --server --log=#{log_file} "
     @exe_path << @style_sheets
     return @exe_path
   end
@@ -74,6 +96,7 @@ class Princely
     pdf.close_write
     result = pdf.gets(nil)
     pdf.close_read
+    result.force_encoding('BINARY') if RUBY_VERSION >= "1.9"
     return result
   end
 
@@ -81,7 +104,7 @@ class Princely
     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 #{output_file} >> #{@log_file} 2>> #{@log_file}"
+    path << " --silent - -o '#{output_file}' >> '#{log_file}' 2>> '#{log_file}'"
     
     # Show the command used...
     logger.info "\n\nPRINCE XML PDF COMMAND"
@@ -93,4 +116,10 @@ class Princely
     pdf.puts(string)
     pdf.close
   end
-end
+
+  class StdoutLogger
+    def self.info(msg)
+      puts msg
+    end
+  end
+end

data/lib/princely/pdf_helper.rb

@@ -25,16 +25,11 @@ module PdfHelper
     
     prince = Princely.new()
     # Sets style sheets on PDF renderer
-    prince.add_style_sheets(*options[:stylesheets].collect{|style| stylesheet_file_path(style)})
+    prince.add_style_sheets(*options[:stylesheets].collect{|style| asset_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 + '"' }
+    html_string = localize_html_string(html_string)
     
     # Send the generated PDF file from our html string.
     if filename = options[:filename] || options[:file]
@@ -44,16 +39,46 @@ module PdfHelper
     end
   end
 
+  def localize_html_string(html_string) 
+    # 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.public_path}/#{$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}\"" }
+    html_string
+  end
+
+  def asset_file_path(asset)
+    stylesheet = stylesheet.to_s.gsub(".css","")
+    File.join(config.stylesheets_dir, "#{stylesheet}.css")
+  end
+  alias_method :stylesheet_file_path, :asset_file_path
+
   def make_and_send_pdf(pdf_name, options = {})
+    options[:disposition] ||= 'attachment'
     send_data(
       make_pdf(options),
       :filename => pdf_name + ".pdf",
-      :type => 'application/pdf'
+      :type => 'application/pdf',
+      :disposition => options[:disposition]
     ) 
   end
-  
-  def stylesheet_file_path(stylesheet)
-    stylesheet = stylesheet.to_s.gsub(".css","")
-    File.join(ActionView::Helpers::AssetTagHelper::STYLESHEETS_DIR,"#{stylesheet}.css")
+
+  module AssetSupport
+    def localize_html_string(html_string)
+      # 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=\"#{asset_file_path($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 + '"' }
+      html_string
+    end
+
+    def asset_file_path(asset)
+      # Remove /assets/ from generated names and try and find a matching asset
+      Rails.application.assets.find_asset(asset.gsub(/\/assets\//, "")).try(:pathname) || asset
+    end
   end
 end

data/lib/princely/rails.rb

@@ -1,6 +1,8 @@
-require 'princely'
 require 'princely/pdf_helper'
 
-Mime::Type.register 'application/pdf', :pdf
+if Mime::Type.lookup_by_extension(:pdf) != 'application/pdf'
+  Mime::Type.register 'application/pdf', :pdf
+end
 
-ActionController::Base.send(:include, PdfHelper)
+ActionController::Base.send(:include, PdfHelper)
+ActionController::Base.send(:include, PdfHelper::AssetSupport) if Rails::VERSION::MINOR > 0

data/lib/princely/version.rb

@@ -0,0 +1,3 @@
+class Princely
+  VERSION = "1.3.0"
+end

metadata

@@ -1,65 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: princely
-version: !ruby/object:Gem::Version 
-  version: 1.2.5
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Michael Bleigh
+- Jared Fraser
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-09-19 00:00:00 -04:00
-default_executable: 
+date: 2012-01-25 00:00:00.000000000 Z
 dependencies: []
-
 description: A wrapper for the PrinceXML PDF generation library.
-email: michael@intridea.com
+email:
+- michael@intridea.com
+- dev@jsf.io
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
-- .gitignore
+files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
-- init.rb
 - lib/princely.rb
 - lib/princely/pdf_helper.rb
 - lib/princely/rails.rb
-- princely.gemspec
-- rails/init.rb
-has_rdoc: true
+- lib/princely/version.rb
 homepage: http://github.com/mbleigh/princely
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+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: 
+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: 
-rubygems_version: 1.3.3
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple Rails wrapper for the PrinceXML PDF generation library.
 test_files: []
-

data/.gitignore

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

data/init.rb

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

data/princely.gemspec

@@ -1,46 +0,0 @@
-# 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{princely}
-  s.version = "1.2.5"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Michael Bleigh"]
-  s.date = %q{2009-09-19}
-  s.description = %q{A wrapper for the PrinceXML PDF generation library.}
-  s.email = %q{michael@intridea.com}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "MIT-LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lib/princely.rb",
-     "lib/princely/pdf_helper.rb",
-     "lib/princely/rails.rb",
-     "princely.gemspec",
-     "rails/init.rb"
-  ]
-  s.homepage = %q{http://github.com/mbleigh/princely}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.3}
-  s.summary = %q{A simple Rails 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/rails/init.rb

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