make_pdf-jekyll 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97065b7cf75979dc847f0d82e96bf54229ea7dc4329eab0216a899ac6c72496a
-  data.tar.gz: cc8b2e3a7a25fb598079829a4198679214ac9a9e672a20c7e4fd1ea71f8cbf0e
+  metadata.gz: 1d09dc6c6f9822fd4b47f10deded424f1cbe2f7766de5fc928ff3a9dd6a6469b
+  data.tar.gz: 06c2c69b10b75f5034629c315a376cd7c47f3606df2f77fb2f3405cbec12d092
 SHA512:
-  metadata.gz: 5926bb93054a88d248eef00b4c5aa06d00768f3c7ced9d1b79fdcb713de3e732922406f4d0b365cc933d956a912992307e18ee0ac1cbc6fc612f1feb1bf3033a
-  data.tar.gz: 18ecbb2c38aabde9c0994fd6a4fb295a23d7b0cf1ef7c3cb7eabc5c508e0e587f7fc3484955f6a5248b0a24c0c8ca332295947ac263fd4803d7c9d3c3675fdc8
+  metadata.gz: 862703fcd0e8f7d88ec5a2e25ed96b3ad9b96411556863656d5f3b367d8de08d87ccfe51ca9e38918d1a0d3fb4d66dac69d8c5cd2917c461cbf8492ed8f4fa23
+  data.tar.gz: de78393e5aed6ae9543b6f9ea799675a795ee65c4472802f8e9602277e373173900bf8376841526c269812f7fbc5e1839af70e40579140f3289819f011e95eb2

data/lib/make_pdf/chrome.rb

@@ -3,9 +3,48 @@ require "make_pdf/command_based"
 module MakePDF
   class Chrome < CommandBased::Writer
     COMMAND = 'chrome-headless-render-pdf'
+    DEFAULT_OPTIONS = { # options from 'chrome-headless-render-pdf --help'
+      "chrome-binary": nil,
+      "chrome-option": nil,
+      "remote-host": nil,
+      "remote-port": nil,
+      "no-margins": true,
+      "include-background": true,
+      "landscape": false,
+      "window-size": nil,
+      "paper-width": nil,
+      "paper-height": nil,
+      "page-ranges": nil,
+      "scale": nil,
+      "display-header-footer": false,
+      "header-template": nil,
+      "footer": nil,
+      "js-time-budget": nil,
+      "animation-time-budget": nil,
+    } 
 
-    def initialize(source_url, output_dif, **options)
-      super(source_url, output_dif, command: COMMAND, **options)
+    def initialize(source_url, output_dir, **options)
+      super(source_url, output_dir, command: COMMAND, **options.merge(DEFAULT_OPTIONS))
+    end
+
+    def map_key(key, value)
+      case key
+      when 'source_url'
+        [ "--url", value ]
+      when 'output_filename'
+        [ "--pdf", value ]
+      when DEFAULT_OPTIONS.keys.method(:include?)
+        case value
+        when false, nil?
+          []
+        when true, ""
+          [ "--#{key.to_s}" ]
+        else
+          [ "--#{key.to_s}", value ]
+        end
+      else
+        []
+      end
     end
   end
 end

data/lib/make_pdf/command_based.rb

@@ -7,8 +7,12 @@ module MakePDF
     module Arguments
       attr_reader :base
 
-      def make_arguments(options = [], **more)
-        options.concat(more.map { |key, value| "#{self.class.prefix}#{key}#{"=#{value}" unless value == true || value.nil?}" })
+      def make_arguments(*options, **more)
+        [ options, more.map do |key, value|
+          map_key(key.to_s, value)
+        end ].flatten.map do |arg| 
+          arg.to_s
+        end
       end
     end
 
@@ -26,26 +30,25 @@ module MakePDF
         @options = options
       end
 
-      def write(file, base_path:, **options)
-        logger.info("pdf-writer (#{command}): converting #{file}")
-
-        url = source_url(file, base_path:, **options),
-        output = output_for(file, base_path:, **options)
+      def write(source_url, output_filename, base_path:, **options)
+        logger.info("converting #{source_url} with #{@command}")
         arguments = make_arguments(
           command: @command,
-          url:,
-          pdf: output
+          source_url:,
+          output_filename:,
+          **options
         )
-        IO.popen([@command] + arguments, {:err =>[ :child, :out]}) do |pipe| 
-          std_out = pipe.read
+        logger.debug("Executing #{@command} #{arguments}")
+        std_out = IO.popen([@command] + arguments, {:err =>[ :child, :out]}) do |pipe| 
+          pipe.read
         end
-
-        raise std_out if ($? != 0)
-        logger.info("pdf-writer (#{command}): Wrote #{output}")
+        status = $?
+        raise RuntimeError.new("Failure executing #{command} with #{arguments}.\n\noutput:\n\n---\n#{std_out}\n---\n") if status != 0
+        logger.info("pdf-writer: Wrote #{output_filename}")
       end
 
       def output_for(file, base_path:, version: [], **options)
-        if @output.nil?
+        if @output_dir.nil?
           path = File.dirname(file)
         else
           path = File.expand_path(relative_path(file, base_path), @output)

data/lib/make_pdf/jekyll.rb

@@ -3,9 +3,33 @@ require 'make_pdf'
 
 module MakePDF
 
+  LOG_NAME = "make_pdf:"
   # MakePDF Jekyll plugin
   class Jekyll
 
+    class Logger
+
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def message(*args, **options)
+        @logger.message(LOG_NAME, *args, **options)
+      end
+
+      def warn(*args, **options)
+        @logger.warn(LOG_NAME, *args, **options)
+      end
+
+      def info(*args, **options)
+        @logger.info(LOG_NAME, *args, **options)
+      end
+
+      def debug(*args, **options)
+        @logger.debug(LOG_NAME, *args, **options)
+      end
+    end
+
     class << self
       include PathManip
       attr_reader :file, :site, :current_doc, :options, :command, :output
@@ -15,16 +39,17 @@ module MakePDF
           @site        = current_doc.site
           @options     = @site.config['make-pdf'] || {}
           @opt_in      = @options['write-by-default'] || false
-          @base_url    = @options['source'] || "file:/"
+          @base_url    = @options['source'] || "file:"
           @base_source = @site.dest
+          @logger      = Logger.new(::Jekyll.logger)
 
-          ::Jekyll.logger.debug("make_pdf:", "Initialized with #{@options}. #{@base_source}")
+          @logger.debug("Initialized with #{@options}. #{@base_source}")
         end
-          
+
         current_options = @options.merge(current_doc.data)
-        ::Jekyll::logger.debug("make-pdf", current_options)
+        @logger.debug(current_options)
         bail = lambda do |error|
-          ::Jekyll.logger.debug("make_pdf:", error)
+          @logger.debug(error)
           false
         end
 
@@ -40,15 +65,15 @@ module MakePDF
         return bail.call("#{current_doc.name} has not opted in") if current_doc.data['make-pdf'].nil? && !@opt_in
         return bail.call("#{current_doc.name} has opted out")if current_doc.data['make-pdf'] == false
 
-        ::Jekyll.logger.info("make_pdf:", " processing #{current_doc.name}")
+        @logger.info(" processing #{current_doc.name}")
 
-        @writer.new(file, output, logger: ::Jekyll.logger, **current_options)
+        @writer.new(file, output_dir, base_source: @base_source, logger: @logger, **current_options)
       end
 
       def process(current_doc)
         writer = setup(current_doc)
 
-        ::Jekyll::logger.debug("make_pdf:", " Ignoring #{current_doc.destination("")}")
+        @logger.debug(" Ignoring #{current_doc.destination("")}")
         return if writer === false
 
         options = current_doc.data['targets']&.split(';') || []
@@ -59,21 +84,22 @@ module MakePDF
       end
 
       def render_option(writer, file, **options)
-        ::Jekyll.logger.debug('MakePDF options:', options)
+        @logger.debug("MakePDF options: #{options}")
 
         raise "File #{file} is not accessible" unless File.readable?(file)
 
         attempted = 0
+        
         begin
           writer.write(file, **options)
         rescue => error
           attempted += 1
           if attempted <= 2
-            ::Jekyll.logger.warn("MakePDF: Failed to generate #{file} retrying #{attempted}")
-            ::Jekyll.logger.warn("MakePDF: ERROR: #{error}")
+            @logger.warn("Failed to generate #{file} retrying #{attempted}")
+            @logger.warn("ERROR: #{error}")
             retry
           else
-            ::Jekyll.logger.error("MakePDF: Skipping generation of #{file} with #{options}")
+            @logger.warn("Skipping generation of #{file} with #{options}")
             raise error
           end
         end
@@ -81,7 +107,7 @@ module MakePDF
     end
   end
 
-  ::Jekyll.logger.info('MakePDF:', "loaded")
+  ::Jekyll.logger.info(LOG_NAME, "loaded")
   ::Jekyll::Hooks.register [:pages, :documents, :posts], :post_write do |doc|
     MakePDF::Jekyll.process(doc)
   end

data/lib/make_pdf.rb

@@ -40,30 +40,37 @@ module MakePDF
       @logger = logger
       @options = options
     end
+    
+    def make_source_url(file, base_path:, base_url: nil, **options)
+      base_path = Pathname.new(base_path).realpath
+      target_file = Pathname.new(file).realpath.relative_path_from(base_path)
+      if (base_url != "file:")
+        return base_url + target_file.to_s
+      else
+        return base_path + target_file.to_s
+      end
+    end
 
-    def source_url(file, base_path:Pathname.new("."), base_url: "file:/", version: [], separator: ",", **options)
-      file_path = path_of(file)
-
-      options = unless version.empty? 
-                  "##{version.join(separator)}"
-                else
-                  ""
-                end 
-      "#{base_url}#{relative_path(file_path, base_path)}/#{file_path.basename}#{options}"
+    def make_pdf_filename(file, **options)
+      path_of(file).basename.sub_ext(".pdf")
     end
 
-    def output_for(file, version, **options)
-      output = path_of(file).basename(".pdf").to_s
-      path_of(@output_dir, output + version.join("_") + ".pdf")
+    def make_output_filename(file, base_path:, **options)
+      filename = make_pdf_filename(file, base_path:, **options) 
+      output = @output_dir / filename
+      @logger.debug("filenane : #{filename} output_dir: #{output_dir} output_filename: #{output}")
+      output
     end
 
     def process(file, version: [], **options)
       options = @options.merge(options)
+      output_filename = make_output_filename(file, version: version, **options)
       write(
-        source_url(file, vesrsion: version, **options),
-        output_for(file, version: version, **options),
+        make_source_url(file, vesrsion: version, **options),
+        output_filename,
         **options
       )
+      output_filename
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: make_pdf-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Victor Bogado da Silva Lins