Class: PDFKit
- Inherits:
-
Object
- Object
- PDFKit
- Defined in:
- lib/pdfkit/os.rb,
lib/pdfkit/pdfkit.rb,
lib/pdfkit/source.rb,
lib/pdfkit/version.rb,
lib/pdfkit/middleware.rb,
lib/pdfkit/wkhtmltopdf.rb,
lib/pdfkit/configuration.rb,
lib/pdfkit/html_preprocessor.rb
Defined Under Namespace
Modules: HTMLPreprocessor, OS Classes: Configuration, Error, ImproperSourceError, ImproperWkhtmltopdfExitStatus, Middleware, NoExecutableError, Source, WkHTMLtoPDF
Constant Summary collapse
- VERSION =
'0.8.7.1'
Class Attribute Summary collapse
-
.configuration ⇒ Object
Configure PDFKit someplace sensible, like config/initializers/pdfkit.rb.
Instance Attribute Summary collapse
-
#renderer ⇒ Object
readonly
Returns the value of attribute renderer.
-
#source ⇒ Object
Returns the value of attribute source.
-
#stylesheets ⇒ Object
Returns the value of attribute stylesheets.
Class Method Summary collapse
Instance Method Summary collapse
- #command(path = nil) ⇒ Object
- #executable ⇒ Object
-
#initialize(url_file_or_html, options = {}) ⇒ PDFKit
constructor
A new instance of PDFKit.
- #options ⇒ Object
- #to_file(path) ⇒ Object
- #to_pdf(path = nil) ⇒ Object
Constructor Details
#initialize(url_file_or_html, options = {}) ⇒ PDFKit
Returns a new instance of PDFKit.
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/pdfkit/pdfkit.rb', line 32 def initialize(url_file_or_html, = {}) @source = Source.new(url_file_or_html) @stylesheets = [] = PDFKit.configuration..merge() .delete(:quiet) if PDFKit.configuration.verbose? .merge! (url_file_or_html) unless source.url? @root_url = .delete(:root_url) @protocol = .delete(:protocol) @renderer = WkHTMLtoPDF.new @renderer. raise NoExecutableError unless File.exist?(PDFKit.configuration.wkhtmltopdf) end |
Class Attribute Details
.configuration ⇒ Object
Configure PDFKit someplace sensible, like config/initializers/pdfkit.rb
82 83 84 |
# File 'lib/pdfkit/configuration.rb', line 82 def configuration @configuration end |
Instance Attribute Details
#renderer ⇒ Object (readonly)
Returns the value of attribute renderer.
30 31 32 |
# File 'lib/pdfkit/pdfkit.rb', line 30 def renderer @renderer end |
#source ⇒ Object
Returns the value of attribute source.
29 30 31 |
# File 'lib/pdfkit/pdfkit.rb', line 29 def source @source end |
#stylesheets ⇒ Object
Returns the value of attribute stylesheets.
29 30 31 |
# File 'lib/pdfkit/pdfkit.rb', line 29 def stylesheets @stylesheets end |
Class Method Details
.configure {|configuration| ... } ⇒ Object
86 87 88 |
# File 'lib/pdfkit/configuration.rb', line 86 def self.configure yield(configuration) end |
Instance Method Details
#command(path = nil) ⇒ Object
48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/pdfkit/pdfkit.rb', line 48 def command(path = nil) args = @renderer. shell_escaped_command = [executable, OS::shell_escape_for_os(args)].join ' ' # In order to allow for URL parameters (e.g. https://www.google.com/search?q=pdfkit) we do # not escape the source. The user is responsible for ensuring that no vulnerabilities exist # in the source. Please see https://github.com/pdfkit/pdfkit/issues/164. input_for_command = @source.to_input_for_command output_for_command = path ? Shellwords.shellescape(path) : '-' "#{shell_escaped_command} #{input_for_command} #{output_for_command}" end |
#executable ⇒ Object
66 67 68 |
# File 'lib/pdfkit/pdfkit.rb', line 66 def executable PDFKit.configuration.executable end |
#options ⇒ Object
61 62 63 64 |
# File 'lib/pdfkit/pdfkit.rb', line 61 def # TODO(cdwort,sigmavirus24): Replace this with an attr_reader for @renderer instead in 1.0.0 @renderer. end |
#to_file(path) ⇒ Object
88 89 90 91 |
# File 'lib/pdfkit/pdfkit.rb', line 88 def to_file(path) self.to_pdf(path) File.new(path) end |
#to_pdf(path = nil) ⇒ Object
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/pdfkit/pdfkit.rb', line 70 def to_pdf(path=nil) preprocess_html 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) if path.nil? end # $? is thread safe per # http://stackoverflow.com/questions/2164887/thread-safe-external-process-in-ruby-plus-checking-exitstatus raise ImproperWkhtmltopdfExitStatus, invoke if empty_result?(path, result) || !successful?($?) return result end |