RubyGems - mdown2pdf - Versions diffs - 0.1.0 - Mend

mdown2pdf 0.1.0

Files changed (17) hide show

checksums.yaml +7 -0
data/Gemfile +4 -0
data/Gemfile.lock +26 -0
data/LICENSE +21 -0
data/README.md +63 -0
data/Rakefile +11 -0
data/assets/output.html +12 -0
data/assets/style.css +762 -0
data/assets/toc.xsl +66 -0
data/bin/console +14 -0
data/exe/md2pdf +69 -0
data/lib/mdown2pdf.rb +112 -0
data/lib/mdown2pdf/pseudo_code_lexer.rb +84 -0
data/lib/mdown2pdf/render.rb +49 -0
data/lib/mdown2pdf/version.rb +3 -0
data/mdown2pdf.gemspec +38 -0
metadata +130 -0

data/assets/toc.xsl ADDED

@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsl:stylesheet version="2.0"
+                xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+                xmlns:outline="http://wkhtmltopdf.org/outline"
+                xmlns="http://www.w3.org/1999/xhtml">
+  <xsl:output doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN"
+              doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
+              indent="yes" />
+  <xsl:template match="outline:outline">
+    <html>
+      <head>
+        <title>Table of Contents</title>
+        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+        <style>
+          body {
+            color: #333;
+          }
+          h1 {
+            text-align: center;
+            font-size: 20px;
+            font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
+          }
+          div {
+            border-bottom: 1px dotted #555;
+          }
+          span {float: right;}
+          li {list-style: none;}
+          ul {
+            font-size: 15px;
+            font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
+          }
+          ul {padding-left: 0em;}
+          ul ul { padding-left: 1em; }
+          a {text-decoration:none; color: #4078c0;}
+        </style>
+      </head>
+      <body>
+        <h1>Table des matières</h1>
+        <ul><xsl:apply-templates select="outline:item/outline:item"/></ul>
+      </body>
+    </html>
+  </xsl:template>
+  <xsl:template match="outline:item">
+    <li>
+      <xsl:if test="@title!=''">
+        <div>
+          <a>
+            <xsl:if test="@link">
+              <xsl:attribute name="href"><xsl:value-of select="@link"/></xsl:attribute>
+            </xsl:if>
+            <xsl:if test="@backLink">
+              <xsl:attribute name="name"><xsl:value-of select="@backLink"/></xsl:attribute>
+            </xsl:if>
+            <xsl:value-of select="@title" />
+          </a>
+          <span> <xsl:value-of select="@page" /> </span>
+        </div>
+      </xsl:if>
+      <ul>
+        <xsl:comment>added to prevent self-closing tags in QtXmlPatterns</xsl:comment>
+        <xsl:apply-templates select="outline:item"/>
+      </ul>
+    </li>
+  </xsl:template>
+</xsl:stylesheet>

data/bin/console ADDED

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "mdown2pdf"
+# 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/exe/md2pdf ADDED

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "mdown2pdf"
+class MD2PDFConvert
+  def self.convert(args)
+    if args.include?('-h') || args.include?('--help')
+      help
+      exit
+    end
+    @@args = args
+    Mdown2PDF.temporary_html_files_for(file) do |output, cover|
+      Mdown2PDF.output(
+        file: output,
+        name: destination,
+        cover: cover,
+        toc: toc
+      )
+    end
+  end
+  def self.help
+    puts "Usage: md2pdf file [options]"
+    puts
+    puts "Available options:"
+    puts
+    puts "-o, [--output]      Specify the output file name. By default it"
+    puts "                    is inferred with the given Markdown file name."
+    puts
+    puts "--skip-toc          Flag to specify whether the table of contents"
+    puts "                    should be skipped from the output. Disabled by"
+    puts "                    default."
+  end
+  def self.args
+    @@args
+  end
+  def self.destination
+    @@destination ||= begin
+      if args.include?('--output') || args.include?('-o')
+        position = (args.index('--output') || args.index('-o')) + 1
+        args[position]
+      else
+        file
+      end
+    end
+  end
+  def self.file
+    @@file ||= begin
+      if !args[0]
+        puts "No input file given. The path to a Markdown file is required."
+        exit
+      end
+      args[0]
+    end
+  end
+  def self.toc
+    !args.include?('--skip-toc')
+  end
+end
+MD2PDFConvert.convert(ARGV)

data/lib/mdown2pdf.rb ADDED

@@ -0,0 +1,112 @@
+require "mdown2pdf/pseudo_code_lexer"
+require "mdown2pdf/render"
+require "mdown2pdf/version"
+module Mdown2PDF
+  extend self
+  # Creates two temporary files:
+  #
+  #  * One to represent the eventual cover of the PDF file.
+  #  * One with the document translated to HTML.
+  #
+  # These two temporary files will be used by Wkhtmltopdf to
+  # generate the final PDF file.
+  #
+  # This method requires a block that will yield a path for each
+  # file. For example:
+  #
+  #   temporary_files_for("a_file.md") do |output, cover|
+  #     # Here `output` and `cover` are paths.
+  #   end
+  #
+  # To distinguish the cover from the rest of the document, the
+  # user must put an h-rule inside their document and the first
+  # one will be used as a separator.
+  def temporary_html_files_for(file)
+    seed        = (rand * 100).round
+    output_file = "/tmp/output-#{seed}.html"
+    cover_file  = "/tmp/cover-#{seed}.html"
+    document = markdown_for(file)
+    first_hr = document.index('<hr>')
+    if first_hr
+      cover    = document[0...first_hr]
+      document = document[first_hr+4..-1]
+    end
+    File.open(output_file, "w") do |f|
+      f.write(File.read(asset('output.html')) % { content: document })
+    end
+    if cover
+      File.open(cover_file, "w") do |f|
+        f.write(File.read(asset('output.html')) % { content: cover })
+      end
+      yield(output_file, cover_file)
+    else
+      yield(output_file, nil)
+    end
+  ensure
+    File.delete(output_file)
+    File.delete(cover_file) if File.exist?(cover_file)
+  end
+  # Actually outputs a given HTML file as a PDF for a given name
+  # through the `wkhtmltopdf` command line tool.
+  #
+  #  - The given `:file` key represents the HTML file to translate
+  #    to PDF.
+  #  - `:name` will be used to infer the PDF file's name.
+  #  - `:cover` can be used if a document should be used as a cover.
+  #  - `:toc` specifies whether a table of contents should be generated
+  #     or not for the document.
+  def output(file: , name: , cover: nil, toc: false)
+    stylesheet = ["--user-style-sheet", asset('style.css')]
+    arguments  = ["wkhtmltopdf"]
+    if cover
+      arguments.push("cover", cover)
+      arguments.push(*stylesheet)
+    end
+    arguments.push("toc", "--xsl-style-sheet", asset("toc.xsl")) if toc
+    arguments.push(
+      file,
+      "--include-in-outline",
+      "--enable-internal-links",
+      *stylesheet,
+      name.sub(/.(md|mdwon)/, '.pdf')
+    )
+    `#{arguments.join(" ")}`
+  end
+  # Converts a given Markdown file to an HTML document. The underlying
+  # implementation uses Redcarpet but you should check out the +Render+
+  # class for further information.
+  def markdown_for(file)
+    html_for(File.read(file))
+  end
+  # Converts a given Markdown string to HTML.
+  def html_for(markdown)
+    parser = Redcarpet::Markdown.new(Render, {
+      fenced_code_blocks: true,
+      tables:             true,
+      superscript:        true,
+      strikethrough:      true,
+      autolink:           true
+    })
+    parser.render(markdown)
+  end
+  # Returns an absolute path for a given asset.
+  def asset(name)
+    File.expand_path(File.join(__dir__, '..', 'assets', name))
+  end
+end

data/lib/mdown2pdf/pseudo_code_lexer.rb ADDED

@@ -0,0 +1,84 @@
+require 'rouge'
+module Mdown2PDF
+  class PseudoCodeLexer < Rouge::RegexLexer
+    tag 'pseudo'
+    title 'Pseudo Code'
+    def self.keywords
+      @keywords ||= Set.new %w(
+        fonction programme tant que faire si alors sinon fin jusqu à
+        ce début procédure pour allant de pas et chaque non dans
+      )
+    end
+    def self.declaration_keywords
+      @declaration_keywords ||= Set.new %w(
+        var Entrée Sortie
+      )
+    end
+    def self.types
+      @types ||= Set.new %w(
+        Graphe Sommet
+      )
+    end
+    state :whitespace do
+      rule /\s+/m, Text
+      rule %r{(//).*$\n}, Comment::Single
+    end
+    state :literal do
+      rule /"(\\.|.)*?"/, Str::Double
+      rule /'(\\.|.)*?'/, Str::Single
+      rule /(\.\.)/,  Punctuation
+      rule %r((\d+[.]\d+)), Num::Float
+      rule /\d+/, Num
+      rule /(\+|\-|\*|\/\/?|\*\*?)/, Operator
+      rule /(<=?|>=?|==|!=)/, Operator
+      rule %r{∞}, Operator
+      rule /,/,  Punctuation
+      rule /:/,  Punctuation
+      rule /\[/, Punctuation
+      rule /\]/, Punctuation
+      rule /\(/, Punctuation
+      rule /\)/, Punctuation
+      rule /;/, Punctuation
+      rule /\|\_/, Punctuation
+      rule /\_\|/, Punctuation
+      rule /\|/, Punctuation
+      rule %r{'}, Punctuation
+      rule %r{=}, Punctuation
+      rule %r{\{|\}}, Punctuation
+      rule /(\+|\-|\*|\/\/?|\*\*?)/, Operator
+    end
+    state :root do
+      mixin :whitespace
+      mixin :literal
+      rule /(vrai|faux|nul|Nil)\b/i, Name::Builtin
+      rule /([[:alpha:]]([[:alnum:]](_[[:alnum:]])?)*)/ do |m|
+        name = m[0]
+        if self.class.keywords.include? name
+          token Keyword
+        elsif self.class.declaration_keywords.include? name
+          token Keyword::Declaration
+        elsif self.class.types.include? name
+          token Keyword::Type
+        else
+          token Name
+        end
+      end
+    end
+  end
+end

data/lib/mdown2pdf/render.rb ADDED

@@ -0,0 +1,49 @@
+require 'redcarpet'
+module Mdown2PDF
+  # Custom Redcarpet render object that adds the following to the
+  # default stack:
+  #
+  #  * Code highlighting (through Rouge).
+  #  * Automatic expanding for image paths (since Wkhtmltopdf requires
+  #    absolute paths).
+  #  * Anchor generation for titles.
+  #  * Possibility to use "`#hexcode`" to generate a div with the specified
+  #    value as the background color.
+  #
+  # It is a drop-in replacement for any Redcarpet render object that procuces
+  # HTML.
+  class Render < Redcarpet::Render::HTML
+    def block_code(code, lang)
+      lexer = Rouge::Lexer.find_fancy(lang, code) || Rouge::Lexers::PlainText
+      if lexer.tag == 'make'
+        code.gsub! /^  /, "\t"
+      end
+      %(<div class="highlight"><pre>#{Rouge::Formatters::HTML.new.format(lexer.lex(code))}</pre></div>)
+    end
+    def codespan(code)
+      if code.start_with?("#")
+        %(<div style="height: 20px; margin: auto; width: 40px; background: #{code}"></div>)
+      else
+        %(<code>#{code}</code>)
+      end
+    end
+    def header(text, level)
+      alphabet = ['a'..'z'] + []
+      anchor = text.chars.keep_if do |c|
+        c =~ /[[:alpha:]]/ || c == ''
+      end.join("")
+      %(<h#{level} id="#{anchor.downcase.gsub(' ', '-')}">#{text}</h#{level}>)
+    end
+    def image(link, title, text)
+      %(<img src="#{Dir.pwd}/#{link}">)
+    end
+  end
+end

data/lib/mdown2pdf/version.rb ADDED

@@ -0,0 +1,3 @@
+module Mdown2PDF
+  VERSION = "0.1.0"
+end

data/mdown2pdf.gemspec ADDED

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mdown2pdf/version"
+Gem::Specification.new do |spec|
+  spec.name          = "mdown2pdf"
+  spec.version       = Mdown2PDF::VERSION
+  spec.authors       = ["Robin Dupret"]
+  spec.email         = ["robin.dupret@gmail.com"]
+  spec.summary       = %q{Easily convert Markdown documents to PDF files.}
+  spec.homepage      = "https://github.com/robin850/mdown2pdf"
+  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.add_runtime_dependency "rouge", "~> 2.1.0"
+  spec.add_runtime_dependency "redcarpet", "~> 3.4.0"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata ADDED

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: mdown2pdf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robin Dupret
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2017-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description:
+email:
+- robin.dupret@gmail.com
+executables:
+- md2pdf
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- assets/output.html
+- assets/style.css
+- assets/toc.xsl
+- bin/console
+- exe/md2pdf
+- lib/mdown2pdf.rb
+- lib/mdown2pdf/pseudo_code_lexer.rb
+- lib/mdown2pdf/render.rb
+- lib/mdown2pdf/version.rb
+- mdown2pdf.gemspec
+homepage: https://github.com/robin850/mdown2pdf
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.12
+signing_key:
+specification_version: 4
+summary: Easily convert Markdown documents to PDF files.
+test_files: []