Class: PDFKit

Inherits:
Object
  • Object
show all
Defined in:
lib/pdfkit/pdfkit.rb,
lib/pdfkit/source.rb,
lib/pdfkit/version.rb,
lib/pdfkit/middleware.rb,
lib/pdfkit/configuration.rb

Defined Under Namespace

Classes: Configuration, ImproperSourceError, Middleware, NoExecutableError, Source

Constant Summary collapse

VERSION = 
"0.6.2"

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url_file_or_html, options = {}) ⇒ PDFKit

Returns a new instance of PDFKit.

Raises:



22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/pdfkit/pdfkit.rb', line 22

def initialize(url_file_or_html, options = {})
  @source = Source.new(url_file_or_html)

  @stylesheets = []

  @options = PDFKit.configuration.default_options.merge(options)
  @options.delete(:quiet) if PDFKit.configuration.verbose?
  @options.merge! find_options_in_meta(url_file_or_html) unless source.url?
  @options = normalize_options(@options)

  raise NoExecutableError.new unless File.exists?(PDFKit.configuration.wkhtmltopdf)
end

Class Attribute Details

.configuration ⇒ Object

Configure PDFKit someplace sensible, like config/initializers/pdfkit.rb

Examples:

PDFKit.configure do |config|
  config.wkhtmltopdf = '/usr/bin/wkhtmltopdf'
  config.verbose     = true
end


47
48
49
 
# File 'lib/pdfkit/configuration.rb', line 47

def configuration
  @configuration
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



20
21
22
 
# File 'lib/pdfkit/pdfkit.rb', line 20

def options
  @options
end

#source ⇒ Object

Returns the value of attribute source.



19
20
21
 
# File 'lib/pdfkit/pdfkit.rb', line 19

def source
  @source
end

#stylesheets ⇒ Object

Returns the value of attribute stylesheets.



19
20
21
 
# File 'lib/pdfkit/pdfkit.rb', line 19

def stylesheets
  @stylesheets
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Yields:



51
52
53
 
# File 'lib/pdfkit/configuration.rb', line 51

def self.configure
  yield(configuration)
end

Instance Method Details

#command(path = nil) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/pdfkit/pdfkit.rb', line 35

def command(path = nil)
  args = [executable]
  args += @options.to_a.flatten.compact

  if @source.html?
    args << '-' # Get HTML from stdin
  else
    args << @source.to_s
  end

  args << (path || '-') # Write to file or stdout

  args.shelljoin
end

#executable ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/pdfkit/pdfkit.rb', line 50

def executable
  default = PDFKit.configuration.wkhtmltopdf
  return default if default !~ /^\// # its not a path, so nothing we can do
  if File.exist?(default)
    default
  else
    default.split('/').last
  end
end

#to_file(path) ⇒ Object 



77
78
79
80
 
# File 'lib/pdfkit/pdfkit.rb', line 77

def to_file(path)
  self.to_pdf(path)
  File.new(path)
end

#to_pdf(path = nil) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/pdfkit/pdfkit.rb', line 60

def to_pdf(path=nil)
  append_stylesheets

  invoke = command(path)

  result = IO.popen(invoke, "wb+") do |pdf|
    pdf.puts(@source.to_s) if @source.html?
    pdf.close_write
    pdf.gets(nil)
  end
  result = File.read(path) if path

  # $? is thread safe per http://stackoverflow.com/questions/2164887/thread-safe-external-process-in-ruby-plus-checking-exitstatus
  raise "command failed (exitstatus=#{$?.exitstatus}): #{invoke}" if result.to_s.strip.empty? or !successful?($?)
  return result
end