any2pdf 1.1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dca4201cc2356687f0ac949012ad844f5f924f49
-  data.tar.gz: 519368ebab50329bb7f5debccafeae3e7a9ec6b6
+  metadata.gz: 88abea5eeb8466229a5540bf50f94c2c261fd9da
+  data.tar.gz: c362c3cb62dc9d186bfbfe3500c38695b5bef39b
 SHA512:
-  metadata.gz: 8340cdb68d7c701d5693e47c8ececaa685087dafc0600cd8ed024102b53872b4f7e662b488c66889aa2e3dc3fa80ed1ec98be9ecbf53411541b8b4bbcb6f9bc2
-  data.tar.gz: e7dde001e3ed785d862453cef9024fb5fc608acd8728fe40b07a04b7cccfdcc932f20ebb290b4eeaadb070c09cb016e42a1a26b6c712160b1a2c99237ce91087
+  metadata.gz: f64c048509335cbf727aa1fac4d2c9a685e8da289188bfbbdd2ec1a7f3e10a9c2b9a080b23851d8a1c0fac689273455b0a3d7b87c930b3952e53c76155432e46
+  data.tar.gz: d4488d1ec52a0a7d2920c8af780bd7fb57dddb2eabb68cb19ffd76761abdb2c7c144eacb0fc86c02d3f72cbc616db31048c727f35b6a3617d5ac87d279060a98

data/any2pdf.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name = 'any2pdf'
-  s.version = '1.1.2'
+  s.version = '1.2.1'
   s.platform = Gem::Platform::RUBY
   s.summary = "convert anything to pdf (via pandoc and pdfkit)"
   s.description = s.summary

data/bin/any2pdf

@@ -1,12 +1,9 @@
 #!/usr/bin/env ruby
 
-require 'pdfkit'
 require 'trollop'
-require 'nokogiri'
-require 'css_parser'
-require 'uri'
-require 'erb'
 require 'zlog'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'any2pdf'
 
 opts = Trollop::options do
   banner "usage: any2pdf <file>"
@@ -16,6 +13,7 @@ opts = Trollop::options do
   opt :stylesheet, "stylesheet to load", :default => ""
   opt :input, "input file", :default => ""
   opt :landscape, "if you want landscape instead of portrait"
+  opt :gitinfo, "if you want to add the current commit ID, date, and tag"
   opt :view_cmd, "command used for viewing", :default => "v %s"
   opt :view, "what to view (pdf|html|none)", :default => "none"
   opt :renderer, "what engine to use for pdf creation (pdfkit|xelatex)", default: "pdfkit", type: :string
@@ -23,6 +21,7 @@ opts = Trollop::options do
   opt :toc_level, "which depth if headings to include in ToC", :default => 2, :type => :int
   opt :numbering, "whether to add numbering to all headings"
   opt :embed, "when active embed js/css files instad of just linking to them"
+  opt :clean, "clean up when done"
 end
 
 Zlog.init_stdout loglevel: :warn    if not opts[:verbose] and not opts[:debug]
@@ -37,228 +36,25 @@ Trollop::die :toc_level, "must not be higher than 6" if opts[:toc_level] > 6
 mdfile = ARGV.first
 Trollop::die :input, "must be supplied" if mdfile.nil?
 Trollop::die :input, "#{mdfile} must exist" if not File::exists?(mdfile)
+htmlfile = mdfile.sub(/.md$/,".html")
+tmpmdfile = ".~" + mdfile
 
-def get_existing( f )
-  path = File::expand_path(f)
-  return path if File::exists?(path)
-  return nil
-end
-
-def get_style( stylename, type = "css" )
-  rel_path = File.expand_path('../Gemfile/../data', File.dirname(__FILE__))
-
-  if not stylename.nil? and not stylename.empty?
-    a =
-      get_existing(stylename) ||
-      get_existing("#{rel_path}/#{stylename}.#{type}") ||
-      get_existing("#{rel_path}/#{stylename}")
-    return a if not a.nil?
-    Log.warn "couldn't find stylesheet #{stylename}. Trying default.\n"
-  end
-
-  # try default, if the user supplied crap...
-  a = get_existing("#{rel_path}/default.#{type}")
-  return a if not a.nil?
-  Log.error "Couldn't find internal stylesheet in #{rel_path}/default.#{type}. Something is seriously wrong! try reinstalling?\n"
-  ""
-end
-
-def embed_html( raw, source )
-  begin
-    require 'websnap'
-    w = WebSnap.new( nil, nil )
-
-    # parse raw html contents
-    Log.info "embedding html via websnap"
-    h = Nokogiri::HTML(raw)
-
-    # embed all parts into the html
-    w.spiderHtmlElements( 'file://'+File::expand_path(source), h )
-
-    # return the resulting html as string
-    h.to_s
-  rescue LoadError
-    return raw
-  end
-end
-
-def md2html(file, opts, stylefile)
-  return nil if not file.end_with?(".md")
-  htmlfile = file.sub(/.md$/,".html")
-  htmlfile_raw = htmlfile+".raw.html"
-
-  rel_path = File.expand_path('../Gemfile/../data', File.dirname(__FILE__))
-
-  # prep-work for including style and script
-  style_e = lambda{|f,o| "<style type=\"text/css\" #{o}>\n#{File::read(f)}\n</style>" }
-  style_l = lambda{|f,o| "<link rel=\"stylesheet\" href=\"#{f}\" #{o} />" }
-  script_e = lambda{|f,o| "<script #{o}>\n#{File::read(f)}\n</script>" }
-  script_l = lambda{|f,o| "<script src=\"#{f}\" #{o} ></script>"}
-  style = opts[:embed] ? style_e : style_l
-  script = opts[:embed] ? script_e : script_l
-
-  # get all fields in the heading
-  raw_heading = [
-    # start with stylesheets
-    style.( rel_path+"/boilerplate.css", ''),
-    style.( File::expand_path(stylefile), '' ),
-    style.( rel_path+"/print.css", 'media="print"'),
-    script.( rel_path+"/jquery-1.9.0.min.js", '' ),
-    ( opts[:toc] ? script.( rel_path+"/toc_generator.js", '' ) : '' )
-    ].join("\n\n")
-
-  # create the html
-  `pandoc "#{file}" -o "#{htmlfile_raw}" --template #{rel_path}/pandoc-template.html --toc`
-  raw_html = File::read htmlfile_raw
-  File.delete htmlfile_raw
-
-  # additional options
-  toc_level = opts[:toc_level]
-  number_headings = (opts[:numbering] == true)
-
-  # actually create the result file
-  renderer = ERB.new(File::read(rel_path + "/template.html.erb"))
-  html = embed_html( renderer.result(binding), file )
-  
-  # save the html to file
-  File::write htmlfile, html
-  htmlfile
-end
-
-def get_style_options style_file
-  return {} unless File::file? style_file
-
-  declarations = []
-
-  css = CssParser::Parser.new
-  css.load_file! style_file
-  css.each_rule_set do |rule|
-    if rule.selectors.include? '#pdf'
-      rule.each_declaration do |id, params|
-        declarations.push [id, params]
-      end
-    end
-  end
-
-  # check all rules
-  opts = {}
-  declarations.each do |field,value|
-    if field == 'margin'
-      vals = value.split(' ');
-      if vals.length == 4
-        opts[:margin_top] = vals[0]
-        opts[:margin_right] = vals[1]
-        opts[:margin_bottom] = vals[2]
-        opts[:margin_left] = vals[3]
-      end
-      if vals.length == 2
-        opts[:margin_top] = vals[0]
-        opts[:margin_right] = vals[1]
-        opts[:margin_bottom] = vals[0]
-        opts[:margin_left] = vals[1]
-      end
-      if vals.length == 1
-        opts[:margin_top] = vals[0]
-        opts[:margin_right] = vals[0]
-        opts[:margin_bottom] = vals[0]
-        opts[:margin_left] = vals[0]
-      end
-    end
-
-  end
+any2pdf = Any2Pdf.new
 
-  opts
-end
-
-def pdfkit_html2pdf( file, outfile, opts )
-  styles = []
-  styles << opts.stylesheet
-
-  style_opts = get_style_options opts.stylesheet
-
-  # find css files
-  dom = Nokogiri::parse( File::open(file).read() )
-  dom.css("link").each do |e| 
-    styles << e.attr("href")
-  end
-
-  # update the html links to make sure that local links (relative) work
-  ( dom.css("@src") + dom.css("@href") ).
-    find_all{|src| (src.value =~ URI::regexp) == nil }.
-    each{|src| src.value = File::expand_path(src.value) }
-
-  options = {
-    footer_right:   "[page]/[topage]",
-    orientation:    (( opts[:landscape] ) ? "landscape" : "portrait" ),
-    page_size:      'A4',
-  }.merge(style_opts)
-  html = dom.to_s
-  kit = PDFKit.new(html, options)
-
-  styles.compact.each do |style| 
-    kit.stylesheets << style if File::exists?(style)
-  end
-
-  kit.to_file(outfile)
-end
-
-def xelatex_html2pdf( file, outfile, opts )
-  puts outfile
-  texfile = "#{outfile}".sub(/[.]pdf$/, '.tex')
-
-  cmd = "pandoc \"#{file}\" --listings -o \"#{texfile}\""
-  Log.debug "convert html to tex: #{cmd}"
-  `#{cmd}`
-
-  verb_opts = "mathescape,
-               linenos,
-               numbersep=5pt,
-               frame=single,
-               framesep=1mm,
-               bgcolor=colorcode_bg".gsub("\n",'')
+# Metadata
+mdfile = any2pdf.fill_in_metadata(mdfile, tmpmdfile) if opts[:gitinfo]
 
-  tex = File::read(texfile).
-    # all verbatim stuff is in lstlistings like this:
-    # \begin{lstlisting}[language=bash]
-    # convert it to minted
-    gsub(/\\begin{lstlisting}\[language=([^\]]*)\]/){'\begin{minted}['+verb_opts+']{'+$1+'}'}.
-    gsub(/\\begin{lstlisting}/, '\begin{minted}['+verb_opts+']{bash}').
-    gsub(/\\lstinline(.)(.*?)\1/){ '\colorbox{colorcode_bg}{\lstinline'+$1+$2+$1+'}' }.
-    gsub(/\\end{lstlisting}/, '\end{minted}')
-
-  tex_style = get_style( opts[:stylesheet], 'tex' )
-  File::write texfile, File::read(tex_style).sub(/CONTENT/, tex)
-
-  cmd = "xelatex -shell-escape \"#{texfile}\""
-  Log.debug "convert tex to pdf: #{cmd}"
-  `#{cmd}`
-end
-
-def html2pdf(file, opts)
-  Log.debug "running html2pdf on '#{file}'"
-  return nil if not file.end_with?(".html")
-  pdffile = file.sub(/.html$/,".pdf")
-  pdffile = opts.output if not opts.output.nil? and not opts.output.empty?
-  Log.debug "output pdf will be '#{pdffile}'"
-
-  case opts[:renderer]
-  when 'pdfkit'
-    pdfkit_html2pdf file, pdffile, opts
-  when 'xelatex'
-    xelatex_html2pdf file, pdffile, opts
-  else
-    Log.abort "Can't find renderer '#{opts[:renderer]}'. Please use a supported renderer!"
-  end
-
-  pdffile
-end
-
-style = get_style( opts[:stylesheet] )
+# Stylesheet
+style = any2pdf.get_style( opts[:stylesheet] )
 Log.info "using stylesheet: #{style}\n"
-htmlfile = md2html(mdfile, opts, style)
-Log.warn "ww input was not an md-file, trying to convert it as html..." if htmlfile.nil?
+
+# HTML
+htmlfile = any2pdf.md2html(mdfile, htmlfile, opts, style)
+Log.warn "ww input was not an md-file, trying to convert it to pdf as html..." if htmlfile.nil?
 Log.ok "htmlfile: #{htmlfile}\n" if not htmlfile.nil?
-pdffile = html2pdf(mdfile, opts) || html2pdf(htmlfile, opts)
+
+# PDF
+pdffile = any2pdf.html2pdf(mdfile, opts) || any2pdf.html2pdf(htmlfile, opts)
 Log.abort "couldn't convert file from html to pdf..." if pdffile.nil?
 Log.ok "output: #{pdffile}\n" if not pdffile.nil?
 
@@ -277,3 +73,8 @@ if not cmd.empty?
   Log.info "view with: '#{cmd}'"
   system cmd
 end
+
+if opts[:clean]
+  File::delete( tmpmdfile ) if File::file? tmpmdfile
+  File::delete( htmlfile ) if File::file? htmlfile
+end

data/data/pandoc-template.html

@@ -14,6 +14,14 @@ $if(title)$
   $if(date)$
   <h3 class="date fixed-heading">$date$</h3>
   $endif$
+  $if(git_commit)$
+  <h3 class="git-info fixed-heading">
+    $if(git_tag)$<span class="git-tag">$git_tag$</span>$endif$$if(git_commit)$<span class="git-commit">$git_commit$</span>$endif$$if(git_date)$<span class="git-date">$git_date$</span>$endif$
+  </h3>
+  $endif$
+  $if(copyright)$
+  <h5 class="copyright">$copyright$</h5>
+  $endif$
 </header>
 $endif$
 

data/lib/any2pdf.rb

@@ -0,0 +1,4 @@
+require 'any2pdf/metadata'
+require 'any2pdf/style'
+require 'any2pdf/md2html'
+require 'any2pdf/html2pdf'

data/lib/any2pdf/html2pdf.rb

@@ -0,0 +1,137 @@
+require 'uri'
+require 'nokogiri'
+require 'css_parser'
+require 'pdfkit'
+
+class Any2Pdf
+  def pdfkit_html2pdf( file, outfile, opts )
+    styles = []
+    styles << opts.stylesheet
+
+    style_opts = get_style_options opts.stylesheet
+
+    # find css files
+    dom = Nokogiri::parse( File::open(file).read() )
+    dom.css("link").each do |e| 
+      styles << e.attr("href")
+    end
+
+    # update the html links to make sure that local links (relative) work
+    ( dom.css("@src") + dom.css("@href") ).
+      find_all{|src| (src.value =~ URI::regexp) == nil }.
+      each{|src| src.value = File::expand_path(src.value) }
+
+    options = {
+      footer_right:   "[page]/[topage]",
+      orientation:    (( opts[:landscape] ) ? "landscape" : "portrait" ),
+      page_size:      'A4',
+    }.merge(style_opts)
+    html = dom.to_s
+    kit = PDFKit.new(html, options)
+
+    styles.compact.each do |style| 
+      kit.stylesheets << style if File::exists?(style)
+    end
+
+    kit.to_file(outfile)
+  end
+
+  def xelatex_html2pdf( file, outfile, opts )
+    puts outfile
+    texfile = "#{outfile}".sub(/[.]pdf$/, '.tex')
+
+    cmd = "pandoc \"#{file}\" --listings -o \"#{texfile}\""
+    Log.debug "convert html to tex: #{cmd}"
+    `#{cmd}`
+
+    verb_opts = "mathescape,
+                 linenos,
+                 numbersep=5pt,
+                 frame=single,
+                 framesep=1mm,
+                 bgcolor=colorcode_bg".gsub("\n",'')
+
+    tex = File::read(texfile).
+      # all verbatim stuff is in lstlistings like this:
+      # \begin{lstlisting}[language=bash]
+      # convert it to minted
+      gsub(/\\begin{lstlisting}\[language=([^\]]*)\]/){'\begin{minted}['+verb_opts+']{'+$1+'}'}.
+      gsub(/\\begin{lstlisting}/, '\begin{minted}['+verb_opts+']{bash}').
+      gsub(/\\lstinline(.)(.*?)\1/){ '\colorbox{colorcode_bg}{\lstinline'+$1+$2+$1+'}' }.
+      gsub(/\\end{lstlisting}/, '\end{minted}')
+
+    tex_style = get_style( opts[:stylesheet], 'tex' )
+    File::write texfile, File::read(tex_style).sub(/CONTENT/, tex)
+
+    cmd = "xelatex -shell-escape \"#{texfile}\""
+    Log.debug "convert tex to pdf: #{cmd}"
+    `#{cmd}`
+  end
+
+  def html2pdf(file, opts)
+    Log.debug "running html2pdf on '#{file}'"
+    return nil if not file.end_with?(".html")
+    pdffile = file.sub(/.html$/,".pdf")
+    pdffile = opts.output if not opts.output.nil? and not opts.output.empty?
+    Log.debug "output pdf will be '#{pdffile}'"
+
+    case opts[:renderer]
+    when 'pdfkit'
+      pdfkit_html2pdf file, pdffile, opts
+    when 'xelatex'
+      xelatex_html2pdf file, pdffile, opts
+    else
+      Log.abort "Can't find renderer '#{opts[:renderer]}'. Please use a supported renderer!"
+    end
+
+    pdffile
+  end
+
+private
+
+  def get_style_options style_file
+    return {} unless File::file? style_file
+
+    declarations = []
+
+    css = CssParser::Parser.new
+    css.load_file! style_file
+    css.each_rule_set do |rule|
+      if rule.selectors.include? '#pdf'
+        rule.each_declaration do |id, params|
+          declarations.push [id, params]
+        end
+      end
+    end
+
+    # check all rules
+    opts = {}
+    declarations.each do |field,value|
+      if field == 'margin'
+        vals = value.split(' ');
+        if vals.length == 4
+          opts[:margin_top] = vals[0]
+          opts[:margin_right] = vals[1]
+          opts[:margin_bottom] = vals[2]
+          opts[:margin_left] = vals[3]
+        end
+        if vals.length == 2
+          opts[:margin_top] = vals[0]
+          opts[:margin_right] = vals[1]
+          opts[:margin_bottom] = vals[0]
+          opts[:margin_left] = vals[1]
+        end
+        if vals.length == 1
+          opts[:margin_top] = vals[0]
+          opts[:margin_right] = vals[0]
+          opts[:margin_bottom] = vals[0]
+          opts[:margin_left] = vals[0]
+        end
+      end
+
+    end
+
+    opts
+  end
+
+end

data/lib/any2pdf/md2html.rb

@@ -0,0 +1,65 @@
+require 'erb'
+
+class Any2Pdf
+  def embed_html( raw, source )
+    begin
+      require 'websnap'
+      w = WebSnap.new( nil, nil )
+
+      # parse raw html contents
+      Log.info "embedding html via websnap"
+      h = Nokogiri::HTML(raw)
+
+      # embed all parts into the html
+      w.spiderHtmlElements( 'file://'+File::expand_path(source), h )
+
+      # return the resulting html as string
+      h.to_s
+    rescue LoadError
+      return raw
+    end
+  end
+
+  def md2html(file, outfile, opts, stylefile)
+    return nil if not file.end_with?(".md")
+    outfile_raw = outfile+".raw.html"
+
+    rel_path = File.expand_path('../../data', File.dirname(__FILE__))
+
+    # prep-work for including style and script
+    style_e = lambda{|f,o| "<style type=\"text/css\" #{o}>\n#{File::read(f)}\n</style>" }
+    style_l = lambda{|f,o| "<link rel=\"stylesheet\" href=\"#{f}\" #{o} />" }
+    script_e = lambda{|f,o| "<script #{o}>\n#{File::read(f)}\n</script>" }
+    script_l = lambda{|f,o| "<script src=\"#{f}\" #{o} ></script>"}
+    style = opts[:embed] ? style_e : style_l
+    script = opts[:embed] ? script_e : script_l
+
+    # get all fields in the heading
+    raw_heading = [
+      # start with stylesheets
+      style.( rel_path+"/boilerplate.css", ''),
+      style.( File::expand_path(stylefile), '' ),
+      style.( rel_path+"/print.css", 'media="print"'),
+      script.( rel_path+"/jquery-1.9.0.min.js", '' ),
+      ( opts[:toc] ? script.( rel_path+"/toc_generator.js", '' ) : '' )
+      ].join("\n\n")
+
+    # create the html
+    `pandoc "#{file}" -o "#{outfile_raw}" --template #{rel_path}/pandoc-template.html --toc`
+    raw_html = File::read outfile_raw
+    File.delete outfile_raw
+
+    # additional options
+    toc_level = opts[:toc_level]
+    number_headings = (opts[:numbering] == true)
+
+    # actually create the result file
+    renderer = ERB.new(File::read(rel_path + "/template.html.erb"))
+    html = embed_html( renderer.result(binding), file )
+    
+    # save the html to file
+    File::write outfile, html
+    outfile
+  end
+
+end

data/lib/any2pdf/metadata.rb

@@ -0,0 +1,41 @@
+class Any2Pdf
+
+  def fill_in_metadata( path, tmpfile )
+    tag = `git describe --tags --abbrev=0`.chomp
+    gitlog = `git log -1 --pretty=format:'%h %ct'`
+    commit, date = gitlog.split(" ")
+    if commit == "" || date == nil
+      Log.warn "Can't find git info for latest commit. Ignoring."
+      return path
+    end
+    Log.info "Adding git metadata: #{tag} #{commit} #{date}"
+
+    time = Time.at( date.to_i )
+    timestamp = "%04d-%02d-%02d" % [ time.year, time.month, time.day ]
+
+    content = File::read(path)
+    info = ["---",
+      "git_commit: #{commit}",
+      "git_date: #{timestamp}",
+      (tag == "" ) ? nil : "git_tag: #{tag}"
+      ].compact.join("\n") + "\n"
+
+    if content.start_with?("---\n")
+      nu = content.sub("---\n",info)
+    else
+      nu = info + "---\n" + content
+    end
+
+    File::write( tmpfile, nu )
+    tmpfile
+  end
+
+  private
+
+  def get_existing( f )
+    path = File::expand_path(f)
+    return path if File::exists?(path)
+    return nil
+  end
+
+end

data/lib/any2pdf/style.rb

@@ -0,0 +1,21 @@
+class Any2Pdf
+  def get_style( stylename, type = "css" )
+    rel_path = File.expand_path('../../data', File.dirname(__FILE__))
+
+    if not stylename.nil? and not stylename.empty?
+      a =
+        get_existing(stylename) ||
+        get_existing("#{rel_path}/#{stylename}.#{type}") ||
+        get_existing("#{rel_path}/#{stylename}")
+      return a if not a.nil?
+      Log.warn "couldn't find stylesheet #{stylename}. Trying default.\n"
+    end
+
+    # try default, if the user supplied crap...
+    a = get_existing("#{rel_path}/default.#{type}")
+    return a if not a.nil?
+    Log.error "Couldn't find internal stylesheet in #{rel_path}/default.#{type}. Something is seriously wrong! try reinstalling?\n"
+    ""
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: any2pdf
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.1
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pdfkit
@@ -104,6 +104,11 @@ files:
 - data/telekom.css
 - data/template.html.erb
 - data/toc_generator.js
+- lib/any2pdf.rb
+- lib/any2pdf/html2pdf.rb
+- lib/any2pdf/md2html.rb
+- lib/any2pdf/metadata.rb
+- lib/any2pdf/style.rb
 homepage: 
 licenses: []
 metadata: {}