Object
# File lib/pdfkit/configuration.rb, line 51 def self.configure yield(configuration) end
# 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
# 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
# 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
# File lib/pdfkit/pdfkit.rb, line 77 def to_file(path) self.to_pdf(path) File.new(path) end
# 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
# File lib/pdfkit/pdfkit.rb, line 115 def append_stylesheets raise ImproperSourceError.new('Stylesheets may only be added to an HTML source') if stylesheets.any? && !@source.html? stylesheets.each do |stylesheet| if @source.to_s.match(/<\/head>/) @source = Source.new(@source.to_s.gsub(/(<\/head>)/) {|s| style_tag_for(stylesheet) + s }) else @source.to_s.insert(0, style_tag_for(stylesheet)) end end end
# File lib/pdfkit/pdfkit.rb, line 187 def error_handling? @options.key?('--ignore-load-errors') || # wkhtmltopdf v0.10.0 beta4 replaces ignore-load-errors with load-error-handling # https://code.google.com/p/wkhtmltopdf/issues/detail?id=55 %(skip ignore).include?(@options['--load-error-handling']) end
# File lib/pdfkit/pdfkit.rb, line 88 def find_options_in_meta(content) # Read file if content is a File content = content.read if content.is_a?(File) found = {} content.scan(/<meta [^>]*>/) do |meta| if meta.match(/name=["']#{PDFKit.configuration.meta_tag_prefix}/) name = meta.scan(/name=["']#{PDFKit.configuration.meta_tag_prefix}([^"']*)/)[0][0].split found[name] = meta.scan(/content=["']([^"'\\]+)["']/)[0][0] end end tuple_keys = found.keys.select { |k| k.is_a? Array } tuple_keys.each do |key| value = found.delete key new_key = key.shift found[new_key] ||= {} found[new_key][key] = value end found end
# File lib/pdfkit/pdfkit.rb, line 149 def normalize_arg(arg) arg.to_s.downcase.gsub(/[^a-z0-9]/,'-') end
# File lib/pdfkit/pdfkit.rb, line 127 def normalize_options(options) normalized_options = {} options.each do |key, value| next if !value # The actual option for wkhtmltopdf normalized_key = "--#{normalize_arg key}" # If the option is repeatable, attempt to normalize all values if REPEATABLE_OPTIONS.include? normalized_key normalize_repeatable_value(value) do |normalized_key_piece, normalized_value| normalized_options[[normalized_key, normalized_key_piece]] = normalized_value end else # Otherwise, just normalize it like usual normalized_options[normalized_key] = normalize_value(value) end end normalized_options end
# File lib/pdfkit/pdfkit.rb, line 166 def normalize_repeatable_value(value) case value when Hash, Array value.each do |(key, value)| yield [normalize_value(key), normalize_value(value)] end else [normalize_value(value), ''] end end
# File lib/pdfkit/pdfkit.rb, line 153 def normalize_value(value) case value when TrueClass, 'true' #ie, ==true, see http://www.ruby-doc.org/core-1.9.3/TrueClass.html nil when Hash value.to_a.flatten.collect{|x| normalize_value(x)}.compact when Array value.flatten.collect{|x| x.to_s} else value.to_s end end
# File lib/pdfkit/pdfkit.rb, line 111 def style_tag_for(stylesheet) "<style>#{File.read(stylesheet)}</style>" end
# File lib/pdfkit/pdfkit.rb, line 177 def successful?(status) return true if status.success? # Some of the codes: https://code.google.com/p/wkhtmltopdf/issues/detail?id=1088 # returned when assets are missing (404): https://code.google.com/p/wkhtmltopdf/issues/detail?id=548 return true if status.exitstatus == 2 && error_handling? false end
Generated with the Darkfish Rdoc Generator 2.