jekyll_asciidoctor_pdf 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88586c97b2eadf108ff201a33b5c1a56123e13011134f3abf86aa8733f71e72d
-  data.tar.gz: 14aff1159ef1f74bf8f64be4fcfa5324ff521d856f2a64233636150f48a2fd67
+  metadata.gz: df0c08936771991bbd479c0660e3894ff098f90a8622b2a08388c75a74c7c8c8
+  data.tar.gz: eca5423777312dd5426656a1c295dd2c3a770fb2fabd59b0afaa686a21eb9e43
 SHA512:
-  metadata.gz: b46c60ae81a4122c1198025424122a73c917bd5de39bb93a3555c83db5c003a5a70ab3681e262000f735e8a9eb5c26a3d00be70b5040b3423bbc7eed7e48ea85
-  data.tar.gz: b33d0ee11c17f0d9cde69a42fbb3fbc10e68584bb408aeeaa2615d9bd71292b10403575976d0f60060db978921b125114bac8b66fe1a364a84966f98ab719fd6
+  metadata.gz: 66bf3b9a3be30eb7007f1bfbb0c373453037113f3e36b2390cc3bd2edd0bef5f51d1c969ee3d052e119fa3bd055f1622bb21588110e49ca525fa18d4f246fd2e
+  data.tar.gz: ca588094ef6072e4dd5ae6ed4cac5c6e2543981287a2a137e483be7ac5edf32ffc92eeef854695be93f4087591a44a2753c34a1d07ed8fa36a292d101007d94d

data/jekyll_asciidoctor_pdf.gemspec

@@ -45,6 +45,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'safe_yaml', '>= 1.0.5'
   spec.add_runtime_dependency 'json', '>= 2.1.0'
   spec.add_runtime_dependency 'rest-client', '>= 2.0.0'
+  spec.add_runtime_dependency 'prawn', '>= 2.2.2'
   spec.add_runtime_dependency 'asciidoctor-pdf', '>= 1.5.1'
 
 end

data/lib/jekyll_asciidoctor_pdf/adoc.rb

@@ -1,13 +1,50 @@
 require 'yaml'
 require 'fileutils'
+require 'prawn'
 require 'asciidoctor-pdf'
 require 'asciidoctor'
 
 # Do not touch, this REGEXP is taken from Jekyll source code
 YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
+RELATIVE_LINK_REGEXP     = /(^|\s)link:(?!(http:|https:))/
+CHECK_REGEXP             = /✓/
 
 module JekyllAsciidoctorPdf
     class ADoc 
+
+        ##  
+        #  Search and replace expression to clean up the original file
+        #
+        # Common Issues:
+        #  - Relative links:    link:relative.html   -> link:<BASE_URL>.html
+        #  - Checkmark symbol:  &check;              -> icon:check[]
+        #  - Remove YAML front matter   (we could use skip-front-matter attribute)
+        #
+        #
+        #  Previous code
+        #
+        #    subs = {
+        #        YAML_FRONT_MATTER_REGEXP => '',
+        #        RELATIVE_LINK_REGEXP     => '\1link:' + base_url,
+        #        CHECK_REGEXP             => 'icon:check[]'
+        #    }
+        #
+        #    combined_regexp = Regexp.union(subs.keys)
+        #
+        #    return content.gsub(combined_regexp, subs)
+        #
+        # Previous code didn't work properly
+        #
+        # TODO: We should try to perform mutilple regexp subs at once.
+        #
+        def self.fixCommonIssues(content, base_url)
+            temp = content.gsub(YAML_FRONT_MATTER_REGEXP, '')
+            temp = temp.gsub(RELATIVE_LINK_REGEXP, '\1link:' + base_url )
+            temp = temp.gsub(CHECK_REGEXP, ' icon:check[] ')
+
+            return temp
+        end
+
         def self.getAuthorsList(file)
             names = %x[ git log --pretty=format:"%an" #{file} | sort | uniq ]
             # last_commit_date can be nil iff the file was not committed.
@@ -22,9 +59,12 @@ module JekyllAsciidoctorPdf
         # Generate a PDF of an individual page
         #
         #  - Remove the jekyll frontmatter 
+        #  - Read the content
+        #  - Execute regexp to fix issues
         #  - Execute the convert process 
         #  - Let the caller to collect information from the front_matter and from the file itself
         #
+        #
         def self.generatePdf(product_name, file, output_path, parameters, cover_page, theme_pdf, revision, authors, base_url)
 
             front_matter = {}
@@ -35,7 +75,7 @@ module JekyllAsciidoctorPdf
                 front_matter = SafeYAML.load(Regexp.last_match(1))
             end
 
-            stream_adoc = content.gsub(YAML_FRONT_MATTER_REGEXP, '').gsub(/(^|\s)link:(?!(http:|https:))/,'\1link:' + base_url)
+            stream_adoc = fixCommonIssues(content, base_url)
 
             # We should think about the performance of get the title in that way
             adoc = Asciidoctor.load stream_adoc
@@ -44,7 +84,6 @@ module JekyllAsciidoctorPdf
             filename = File.basename(file,'.*') + '.pdf'
             filename_path = output_path
             base_path = File.dirname(file)
-            #authors = getAuthorsList(file)
 
             generateBookTypePdf(filename, filename_path, product_name, title, base_path, stream_adoc, parameters, cover_page, theme_pdf, revision, authors)
 
@@ -111,10 +150,15 @@ module JekyllAsciidoctorPdf
                 revision_s = revision.strftime('%m/%d/%Y') 
             end
 
+            temp_pdf = File.join(File.dirname(cover_page), 'temp-cover.pdf')
+
+            generateCoverPage(title, product_name, authors_s, revision_s, '', cover_page, temp_pdf)
+
             text = <<~TEXT
                     = #{title} : #{product_name}
                     #{authors_s}
                     #{revision_s}
+                    :notitle:
                     :doctype: book
                     :experimental:
                     :reproducible:
@@ -129,7 +173,7 @@ module JekyllAsciidoctorPdf
                     ifdef::backend-pdf[]
                     :pdf-theme: #{theme_pdf}
                     :title-page:
-                    :title-page-background-image: image:#{cover_page}[fit=none,pdfwidth=100%,position=top]
+                    :front-cover-image: image:#{temp_pdf}[]
                     :source-highlighter: rouge
                     endif::[]
                     :chapter-label:
@@ -143,6 +187,52 @@ module JekyllAsciidoctorPdf
             return text
         end
 
+        def self.generateCoverPage(title, subtitle, authors, revision, abstract, background_image, file)
+
+            info = {
+                 :Title => title,
+                 :Author => authors,
+                 :Subject => subtitle,
+                 :Keywords => "",
+                 :Creator => "NetApp",
+                 :Producer => "NetApp",
+                 :CreationDate => Time.now
+            }
+
+            Prawn::Document.generate(file, :page_size => 'A4', :margin => 0, :info => info) do
+              stroke_bounds
+              image background_image, :position => :left, :vposition => :top, :fit => [680,3508]
+
+                bounding_box([60, 700], :width => 500, :height => 650) do
+                    font "Times-Roman"
+                    #stroke_bounds
+                    #stroke_circle [0, 0], 10
+
+                    move_down 120
+
+                    text "Technical Report", size: 12, color: "4B4b4b"
+                    move_down 10
+
+                    text title, size: 20, font: 'Times-Roman', color: "1667c5"
+                    move_down 5
+                    text subtitle, size: 16, font: 'Times-Roman', color: "999999"
+
+                    move_down 10
+
+                    text authors, size: 12, font: 'Times-Roman', color: "4B4b4b"
+                    text revision, size: 12, font: 'Times-Roman', color: "4B4b4b"
+
+
+                    #move_down 300
+                    #text "Abstract", size: 14, font: "Times-Roman", color: "0000FF"
+                    #move_down 10
+                    #font_size(12) { text abstract, font: "Times-Roman" }
+
+                end
+            end
+        end
+
+
         def self.getCopyright()
             text = <<~TEXT
                 <<<

data/lib/jekyll_asciidoctor_pdf/commands.rb

@@ -186,14 +186,12 @@ module JekyllAsciidoctorPdf
         #
         def init
             output("Initialize files & output directories ...")
-            output_fullsite = File.join(absolute_output_path, '/fullsite')
             output_pages    = File.join(absolute_output_path, '/pages')
             output_assets   = File.join(absolute_output_path, '/assets')
 
             mkdir_p(absolute_output_path, quiet)
             mkdir_p(output_pages,quiet)
             mkdir_p(output_assets,quiet)
-            mkdir_p(output_fullsite,quiet)
 
             fullsite_config         = parameters['fullsite']
             background_image        = File.join(absolute_working_path, fullsite_config['background_image'])

data/lib/jekyll_asciidoctor_pdf/gitinfo.rb

@@ -49,7 +49,7 @@ module JekyllAsciidoctorPdf
                     userResponse = response.body
                     unless userResponse.nil? || userResponse.empty?
                         hash = JSON.parse(userResponse)
-                        if (hash.key?('name'))
+                        if (hash.key?('name') and (not hash['name'].nil?))
                             authors_hash[login_name] = hash['name']
                             return hash['name']
                         end
@@ -101,7 +101,7 @@ module JekyllAsciidoctorPdf
             rescue => e
                 puts "Error Message: #{e.to_s}";
             end
-
+            
             authors = contributors.sort_by{|name, commits| [-commits, name]}.transpose[0]
 
             if (authors.nil? || authors.empty? )

data/lib/jekyll_asciidoctor_pdf/sidebar.rb

@@ -48,7 +48,7 @@ module JekyllAsciidoctorPdf
     #
     class SidebarYAML 
     
-        attr_reader :product_name, :name, :file, :permalinks, :parameters, :section_output_path, :sidebar_output_path, :base_path, :cover_page, :theme_pdf
+        attr_reader :product_name, :name, :file, :permalinks, :parameters, :section_output_path, :sidebar_output_path, :base_path, :cover_page, :theme_pdf, :prefix
 
 
         def initialize(product_name, name, file, permalinks, parameters, output_path, base_path, cover_page, theme_pdf )
@@ -57,9 +57,10 @@ module JekyllAsciidoctorPdf
             @file         = file
             @permalinks   = permalinks
             @parameters   = parameters
-            @base_path    = base_path
             @cover_page   = cover_page
             @theme_pdf    = theme_pdf
+            @base_path    = base_path
+            @prefix       = nil
 
             @section_output_path = File.join(output_path,name)
             @sidebar_output_path = File.join(output_path,'/fullsite-' + name)
@@ -68,7 +69,27 @@ module JekyllAsciidoctorPdf
             FileUtils::mkdir_p(sidebar_output_path)
 
             toc = YAML.load_file(file)
-            loadAndProcess('Root', toc['entries'], true)
+
+
+            ##
+            #   In the more general structure this prefix is important
+            # We use in two ways
+            # 
+            # - Move the base path to execute the asciidoctor process
+            # - Use prefix + url to find in the permalinks hash
+            #
+            if toc and toc.key?('prefix') 
+                @prefix       = toc['prefix']
+                @base_path    = File.join(base_path, @prefix)
+            end
+
+            ##
+            #   A few repositories may have sidebar.yml empty.
+            # we should ignore it
+            #
+            if toc and toc.key?('entries')
+                loadAndProcess('Root', toc['entries'], true)
+            end
 
         end
 
@@ -120,6 +141,10 @@ module JekyllAsciidoctorPdf
                         # We ignore absolute links
                         output("Absolute links are not supported!")
                     else 
+                        if not prefix.nil?
+                            page = '/' + prefix + child['url']
+                        end
+
                         if permalinks.key?(page) 
                             # We have the content
                             node.add_child(JekyllAsciidoctorPdf::SidebarEntry.new(title,page, permalinks[page].content, false))

data/lib/jekyll_asciidoctor_pdf/version.rb

@@ -1,3 +1,3 @@
 module JekyllAsciidoctorPdf
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_asciidoctor_pdf
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Guido Genzone
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement