jekyll_asciidoctor_pdf 0.0.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4b11ffb4ac2be03a16972ded5242a70584fa5cd01c7d2b89be82dd723fa1805
+  data.tar.gz: b2f9ab8fb396f227940e2f3bae283f2ef7c5ffd3d88f389a32877594cadf67aa
+SHA512:
+  metadata.gz: 66de845ade0747136063df8d6021187ec0324df2749730b3f7c2afa9fdf2e6a36bb71f3a748766543b4ad9eceebb964b2a7ed3fa5a5813f5716521471716ba70
+  data.tar.gz: e273e68ad8847f1d4ac3f4b8264111595a41b65d2def3fdb7d5b0d3f46207ee0192ba58697cf698f76a4d129bee719bb6691690a3dce52a8525603ed5cff5a95

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swo
+*.swp
+*~

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+dist: trusty
+group: deprecated-2017Q4 # To fix NPM timeout errors
+language: ruby
+rvm:
+- 2.4.3
+before_install: 
+- gem update --system && gem install bundler && gem update bundler
+script:
+- bundle exec rake test
+- bundle exec rake build

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+#git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll_asciidocor_pdf.gemspec
+gemspec

data/README.adoc

@@ -0,0 +1,10 @@
+= Jekyll PDF Generator using AsciiDoctor
+:gem-name: rake_jekyll_asciidoctor_pdf
+:gh-branch: master
+:badge-style: flat
+
+image:https://img.shields.io/gem/v/{gem-name}.svg?style={badge-style}[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+
+toc::[]
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jekyll_asciidoctor_pdf'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll_asciidoctor_pdf.gemspec

@@ -0,0 +1,48 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll_asciidoctor_pdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll_asciidoctor_pdf'
+  spec.version       = JekyllAsciidoctorPdf::VERSION
+  spec.authors       = ['Guido Genzone']
+  spec.email         = ['guido.genzone@netapp.com']
+
+  spec.summary       = 'Rake tasks to convert *.adoc files from Jekyll to PDF using asciidoctor-pdf'
+  spec.description   = 'Rake tasks to convert *.adoc files from Jekyll to PDF using asciidoctor-pdf'
+  spec.homepage      = 'https://github.com/ggenzone/jekyll_asciidoctor_pdf'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #    'public gem pushes.'
+  #end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+
+  #spec.add_runtime_dependency 'rake', '>= 12.3.3'
+   
+  #We shoudn't use this version for a security issue
+  spec.add_runtime_dependency 'rake', '>= 10.0'
+  spec.add_runtime_dependency 'fileutils', '>= 1.1'
+  spec.add_runtime_dependency 'safe_yaml', '>= 1.0.5'
+  spec.add_runtime_dependency 'asciidoctor-pdf', '>= 1.5.1'
+
+end

data/lib/jekyll_asciidoctor_pdf.rb

@@ -0,0 +1,13 @@
+require 'yaml'
+require 'jekyll_asciidoctor_pdf/version'
+require 'jekyll_asciidoctor_pdf/commands'
+
+
+# JekyllAsciidoctorPdf
+#
+# Empty module being initialized.
+# This RubyGem holds examples of how to make Rake tasks for Rake using a
+# RubyGem and some custom stuff. It helps clean up the Rakefile later.
+module JekyllAsciidoctorPdf
+
+end

data/lib/jekyll_asciidoctor_pdf/commands.rb

@@ -0,0 +1,368 @@
+require 'rake'
+require 'rake/tasklib'
+require 'tmpdir'
+
+require 'yaml'
+require 'fileutils'
+require 'asciidoctor-pdf'
+require 'asciidoctor'
+require 'jekyll_asciidoctor_pdf/tree'
+
+
+# Do not touch, this REGEXP is taken from Jekyll source code
+YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
+
+
+module JekyllAsciidoctorPdf
+
+
+    class BuildTask < ::Rake::TaskLib
+
+        ##
+        # @private
+        # Defines attribute accessor with optional default value.
+        # When attribute's value is a +Proc+ with arity 0, then the attribute
+        # reader calls it and returns the result.
+        #
+        # @param attr_name [#to_s] name of the attribute to define.
+        # @param default_value [Object] the default value (optional).
+        # @yield When the block is given, then it's used as a default value.
+        #   It takes precedence over the +default_value+. It's evaluated in an
+        #   instance context.
+        def self.callable_attr(attr_name, default_value = nil, &default_block)
+          var_name = "@#{attr_name}".sub('?', '').to_sym
+
+          define_method attr_name do
+            value = instance_variable_get(var_name)
+
+            if value.nil? && default_block
+              do_in_working_dir { instance_eval &default_block }
+            elsif value.nil?
+              default_value
+            elsif value.is_a?(Proc) && value.arity.zero?
+              do_in_working_dir &value
+            else
+              value
+            end
+          end
+
+          attr_writer attr_name.to_s.sub('?', '')
+        end
+
+        # @return [#to_sym] name of the task.
+        attr_accessor :name
+
+        # @return [#to_s] description of the task.
+        attr_accessor :description
+
+        attr_accessor :parameters
+
+        attr_reader :absolute_temp_path
+        attr_reader :absolute_working_path
+        attr_reader :absolute_source_path
+        attr_reader :absolute_assets_list
+        attr_reader :absolute_config_file
+        attr_reader :absolute_sidebar_file
+        attr_reader :absolute_output_path
+
+        attr_reader :assets_list
+        attr_reader :quiet
+
+        callable_attr :jekyll_config_file, '_config.yml'
+
+        def initialize(name = :build_pdf)
+            @name = name
+            @description = 'Generate PDF files for each *.adoc in the source_list  '
+
+            @absolute_working_path = Dir.pwd
+            @absolute_temp_path    = Dir.mktmpdir 
+
+            @quiet = { verbose: true } 
+
+            #file = __FILE__
+            #file = File.readlink(file) if File.symlink?(file)
+            #@base_dir = File.dirname(file)
+
+            #puts @base_dir 
+
+            yield self if block_given?
+
+            @absolute_config_file  = File.join(@absolute_working_path, jekyll_config_file);
+
+            do_jekyll_config_ok? do |t|
+                @absolute_source_path   = File.join(@absolute_working_path, @parameters['source_path']);
+                @absolute_output_path   = File.join(@absolute_working_path, @parameters['output_path']);
+                @absolute_sidebar_file  = File.join(@absolute_working_path, @parameters['sidebar_file']);
+
+                files = []
+                FileList[@parameters['assets_list']].each do |file|
+                    files << File.join(@absolute_working_path,file)
+                end
+
+                @absolute_assets_list = files
+           
+                define_task!
+            end
+        end
+
+
+
+        def define_task!
+
+            desc "Print information variables"
+            task :info do
+                print_variables
+            end
+
+            desc "Cleaning files & directories"
+            task :clean do
+                clean
+            end
+
+
+            # We can improve it using replace inline and cp
+            desc "Rewriting *.adoc files and generating auxiliary files without front matter"
+            task :generateTempFiles => [ :clean ]  do
+                generate_temp_files
+            end
+
+            desc "Generating PDFs files for each page"
+            task :generatePdf => [:clean, :generateTempFiles] do
+                generate_pdf
+            end
+
+            desc "Generate the fullsite.adoc file"
+            file 'fullsite.adoc' => ['generateTempFiles'] do
+
+                generate_fullsite_adoc
+            end
+
+            desc "Generate the fullsite.pdf file"
+            file 'fullsite.pdf' => 'fullsite.adoc' do
+
+                generate_fullsite_pdf
+            end
+
+
+            desc description
+            task name.to_sym => [:generatePdf, 'fullsite.pdf'] do
+                remove_entry absolute_temp_path
+            end
+
+
+
+
+        end
+
+        ##
+        # Check if Jekyll configuration is Okay
+        #
+        def do_jekyll_config_ok?
+            config = YAML.load_file(absolute_config_file)
+           
+            assert_key(config, 'jap_config', "Expected key 'jap_config' to exist, but does not") 
+
+            @parameters   = config['jap_config']
+
+            assert_key(@parameters, 'source_path' , "Expected key 'jap_config.source_path' to exist, but does not") 
+            assert_key(@parameters, 'assets_list' , "Expected key 'jap_config.assets_list' to exist, but does not") 
+            assert_key(@parameters, 'output_path' , "Expected key 'jap_config.output_path' to exist, but does not") 
+            assert_key(@parameters, 'sidebar_file', "Expected key 'jap_config.sidebar_file' to exist, but does not") 
+
+            yield
+        end
+
+        def assert_key(array, key, message)
+            if not array.has_key? key 
+                output(message)
+                exit 1
+            end
+        end
+
+
+        def print_variables 
+            output("Current directory: "   + absolute_working_path)
+            output("Jekyll Config File: "  + absolute_config_file)
+            output("Source directory: "    + absolute_source_path)
+            output("Assets files: "        + absolute_assets_list.join("\n"))
+            output("Temporary directory: " + absolute_temp_path)
+            output("Building directory: "  + absolute_output_path)
+        end
+
+        def clean
+            output_pages = File.join(absolute_output_path, '/pages')
+            output("Removing files & ouput directories ...")
+            rm_rf(absolute_output_path, quiet)
+            mkdir_p(absolute_output_path, quiet)
+            mkdir_p(output_pages,quiet)
+        end
+
+        def generate_temp_files
+            temp_pages = File.join(absolute_temp_path, '/pages')
+            temp_links = File.join(absolute_temp_path, '/links')
+            
+            output("Creating Temporary Folders and Ouput Directories ...")
+            mkdir_p(temp_pages,quiet)
+            mkdir_p(temp_links, quiet)
+
+            FileList[absolute_assets_list].each do |file|
+                cp_r(file, temp_pages, quiet)
+            end
+
+            output("Rewriting *.adoc files and generating auxiliary files without front matter ...")
+            FileList[absolute_source_path + "/*.adoc"].each do |file|
+
+                filename = SafeYAML.load_file(file)
+                front_matter = {}
+
+                content = File.read(file)
+                if content =~ YAML_FRONT_MATTER_REGEXP
+                    #content = $POSTMATCH
+                    front_matter = SafeYAML.load(Regexp.last_match(1))
+                end
+
+                result = content.gsub(YAML_FRONT_MATTER_REGEXP, '')
+            
+                if front_matter.key?('permalink')  
+                    output = File.join(temp_links, front_matter['permalink'] + '.adoc')
+                else 
+                    output = File.join(temp_links, File.basename(file))
+                end
+                # Write the auxiliary file for combine later in the full pdf file
+                File.write(output, result)
+
+                # Write the auxiliary file for individual pages 
+                output = File.join(temp_pages, File.basename(file))
+                File.write(output, result)
+            end
+        end
+
+        def generate_pdf
+            output("Generating PDFs files for each page ...")
+            temp_pages = File.join(absolute_temp_path, '/pages')
+            pdf_pages  = File.join(absolute_output_path, '/pages') 
+
+            FileList[temp_pages + "/*.adoc"].each do |file|
+                Asciidoctor.convert_file file, backend: 'pdf', doctype: 'article', to_dir: pdf_pages , mkdirs: true,  safe: :safe
+            end
+        end
+
+        def generate_fullsite_adoc
+
+            output("Generating fullside.adoc ...")
+            toc = YAML.load_file(absolute_sidebar_file)
+
+            tree = create_from_menu('Root', toc['entries'], true)
+
+            Tree.printTree(tree,2)
+
+            #tree.traverse_subtree do |node|
+            #    children = node.children.map { |child| child.title}
+            #    puts "#{node.title}: #{children}"
+            #end
+
+            temp_links = File.join(absolute_temp_path, '/links')
+            output = File.join(absolute_temp_path,'fullsite.adoc')
+            File.write(output, Tree.updateContent(tree, temp_links))
+
+            output("Full site AsciiDoc generated in [ " + output +" ]")
+
+        end
+
+        def generate_fullsite_pdf
+
+            FileList[absolute_assets_list].each do |file|
+                cp_r(file, absolute_temp_path, quiet)
+            end
+
+            output = File.join(absolute_output_path,'fullsite_template.pdf')
+            #cp(File.join('fullsite_template.adoc'),build_fullsite_output , quiet)
+            cd(absolute_temp_path)
+            File.open("pdf-theme.yml", "w") { |file| file.write(getPdfTheme() ) }
+            File.open("fullsite_template.adoc", "w") { |file| file.write(getFullsiteTemplate() ) }
+            #content = getFullsiteTemplate()
+
+            Asciidoctor.convert_file 'fullsite_template.adoc', backend: 'pdf', mkdirs: true,  safe: :safe
+            cp_r('fullsite_template.pdf',absolute_output_path, quiet)
+            output("Full site PDF generated in [ " + output +" ]")
+
+        end
+
+        def assert(condition, message)
+            if not condition
+                output(message)
+                exit 1
+            end
+        end
+
+
+        # Print functionallity
+        def output(string)
+            puts ' * ' + string
+        end
+
+        def getFullsiteTemplate()
+            fullsite_config = parameters['fullsite']
+
+            title    = fullsite_config['title']
+            subtitle = fullsite_config['subtitle']
+            authors  = fullsite_config['authors']
+            revision = fullsite_config['revision']
+            background_image = fullsite_config['background_image']
+
+            text = <<~TEXT
+                = #{title} : #{subtitle}
+                #{authors}
+                #{revision}
+                :doctype: book
+                :experimental:
+                :reproducible:
+                :icons: font
+                :listing-caption: Listing
+                :sectnums:
+                :imagesdir: ./media/
+                :toc:
+                :toclevels: 2
+                ifeval::["{asciidoctor-version}" < "1.5.7"]
+                :legacy-footnoteref:
+                endif::[]
+                ifdef::backend-pdf[]
+                :pdf-theme: pdf-theme.yml 
+                :title-page:
+                :title-page-background-image: image:#{background_image}[fit=none,pdfwidth=100%,position=top]
+                :source-highlighter: rouge
+                //:rouge-style: github
+                endif::[]
+                :chapter-label:
+
+                :leveloffset: +1
+                include::fullsite.adoc[]
+                :leveloffset: -1
+            TEXT
+
+            return text
+        end
+
+        def getPdfTheme()
+            return parameters['pdf_theme'].to_yaml
+        end
+
+       def create_from_menu(name, children, root)
+            root_node     = Tree::Node.new(name, '','',root)
+            children.each do |child|
+                if child.key?('entries') 
+                    root_node.add_child(create_from_menu(child['title'], child['entries'],false))
+                else
+                    if child['url'].downcase.start_with?('http:') or child['url'].downcase.start_with?('https:')
+                        output("Absolute links are not supported!")
+                    else 
+                        root_node.add_child(Tree::Node.new(child['title'],child['url'], '', false))
+                    end
+                end
+            end
+
+            return root_node
+       end
+
+    end
+end

data/lib/jekyll_asciidoctor_pdf/tree.rb

@@ -0,0 +1,71 @@
+require 'yaml'
+require 'fileutils'
+
+module Tree
+
+    class Node
+        attr_reader :children, :content, :page, :title, :root
+
+        def initialize(title, page, content, root)
+            @children = []
+            @root  = root
+            @page  = page 
+            @title = title
+            @content = content
+        end
+
+        def add_content(content)
+            @content << "\n"
+            @content << content
+        end
+
+        def add_child(child)
+            @children << child
+        end
+
+
+        def traverse_subtree(&block)
+            node_queue = [self]                             # Step 1
+            until node_queue.empty?                         # Step 2
+                node = node_queue.shift                       # Step 3
+                yield node                                    # Step 4
+                node_queue = node.children.concat(node_queue) # Step 5
+            end
+        end
+
+    end
+
+    def self.updateContent(tree, temp_dir)
+        if tree.page.length > 0 
+            file = File.join(temp_dir, tree.page + '.adoc')
+            tree.add_content(File.read(file))
+        else 
+            if not tree.root 
+                tree.add_content("= " + tree.title)
+            end
+        end
+
+        if not tree.root 
+            tree.add_content(":leveloffset: +1 \n")
+        end
+
+        if tree.children.length > 0 
+            tree.children.map { |child| tree.add_content(updateContent(child, temp_dir)) }
+        end
+
+        if not tree.root 
+            tree.add_content(":leveloffset: -1 \n")
+        end
+        return tree.content
+    end
+    def self.printTree(tree, level) 
+        puts str = ("-" * level) + tree.title
+        if tree.children.length > 0 
+            tree.children.map { |child| printTree(child, level + 1) }
+        end
+    end
+
+end
+
+
+

data/lib/jekyll_asciidoctor_pdf/version.rb

@@ -0,0 +1,3 @@
+module JekyllAsciidoctorPdf
+  VERSION = '0.0.14'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_asciidoctor_pdf
+version: !ruby/object:Gem::Version
+  version: 0.0.14
+platform: ruby
+authors:
+- Guido Genzone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+description: Rake tasks to convert *.adoc files from Jekyll to PDF using asciidoctor-pdf
+email:
+- guido.genzone@netapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll_asciidoctor_pdf.gemspec
+- lib/jekyll_asciidoctor_pdf.rb
+- lib/jekyll_asciidoctor_pdf/commands.rb
+- lib/jekyll_asciidoctor_pdf/tree.rb
+- lib/jekyll_asciidoctor_pdf/version.rb
+homepage: https://github.com/ggenzone/jekyll_asciidoctor_pdf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Rake tasks to convert *.adoc files from Jekyll to PDF using asciidoctor-pdf
+test_files: []