plans 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f36f44001dbc8ddb84a61c9095b71c3e24fc69a7
-  data.tar.gz: 7ebd2e8cd146d988773051f9cfd45a8b23c756e6
+  metadata.gz: 7ac32cb6c1b729bd93cf76a59f72e6ef8b52fc01
+  data.tar.gz: b8e4e7780348f4534fa8b7d3b4c450be6191e235
 SHA512:
-  metadata.gz: 8c2c886d74043230a8b91e53ad529b1d47123b5f1fdf7b98540e90282d7b3a14cbc69ecb58860bdb23766760bb72752ab5b8e3312c752c57806efbf760fc39c7
-  data.tar.gz: 76c9b7a979b23e11b020a3df2619a8ea152c044c862860fc11beb3150426f0245ed4edfec0341eedcb4da84cb63ed90c4b1100661aeced923ea20d1b71deccc2
+  metadata.gz: 3ca5d8a0a21ca4b9948ea5fb49100ddbd2d5af82e78ec9cbb69537015b7f67cd05528f44e9b06b3a57164f82552ec6ff28dad0339681c86c0219517a4946d4bc
+  data.tar.gz: d6042203795eb8036ff9f4fa83fb8d019b04d6595171966e3c2a5fdb5fded404c0f99a3d20657acbcc7137d2f78c1a54b5e9f13eabc6047d1913781de7f9ad37

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plans (0.1.0)
+    plans (0.2.0)
       thor
 
 GEM

data/README.md

@@ -34,6 +34,10 @@ ImageMagick works pretty much the same way.
 
 You also need Microsoft Word. :)
 
+Plans can also create PDFs. If you want to create PDFs of your markdown documents you will need to install a XeLaTeX engine for use by Pandoc. [BasicTex](https://tug.org/mactex/morepackages.html) will work. You can also install this with homebrew.
+
+    $ brew install Caskroom/cask/basictex
+
 ## Installation
 
 Install it:

data/lib/plans/cli.rb

@@ -4,6 +4,7 @@ require 'plans/list'
 require 'plans/init'
 require 'plans/publish'
 require 'plans/thumbs'
+require 'plans/pdf'
 
 module Plans
   class CLI < Thor
@@ -114,6 +115,30 @@ module Plans
       Thumbs.new(shell, options).do(path)
     end
 
+
+    desc 'pdf', 'Create an PDF version of the document'
+    long_desc <<-PDF
+    `plans pdf` will create a PDF version of the document.
+
+    The document type is determined by inspecting the template.yml.
+
+    Overwrites any previously published versions of the PDF document.
+
+    > $ plans pdf
+    PDF
+    method_option :toc,
+                  {:type => :boolean,
+                   :default => false,
+                   :desc => 'Add a table of contents to the PDF document. Not included by default.'}
+    method_option :open,
+                  {:type => :boolean,
+                   :default => true,
+                   :desc => 'Open the published document after it has been rendered by Pandoc.'}
+
+    def pdf (path = '.')
+      Pdf.new(shell, options).do(path)
+    end
+
   end
 end
 

data/lib/plans/pdf.rb

@@ -0,0 +1,43 @@
+require 'plans/publish'
+
+module Plans
+  class Pdf < Publish
+
+    def do(path)
+      # Create the thumbnails first.
+      say 'Updating thumbnails.'
+      Thumbs.new(shell, options).do(path)
+
+      path = pathname(path)
+      toc_flag = options[:toc] ? "--toc" : ""
+      open_flag = options[:open]
+
+      source_file = path + 'README.md'
+      check_source_file(source_file)
+
+      doc_type = get_doctype(path)
+
+      output_dir = path + 'publish'
+      # Make the publish directory if it does not exist.
+      FileUtils.mkdir output_dir unless Dir.exist? output_dir
+      output_file = output_dir + "#{doc_type}.pdf"
+
+      # We need to set the current working directory to where the markdown file is so
+      # the images render correctly.
+      # Pandoc only looks in the current working directory.
+      Dir.chdir(path) do
+        `pandoc #{toc_flag} #{source_file} --standalone --latex-engine=xelatex -o #{output_file}`
+      end
+
+      # Get the return code from pandoc.
+      pandoc_return = $?.to_i
+      check_pandoc_return(pandoc_return)
+
+      say "#{doc_type} published as PDF.", :green
+
+      # Open the PDF if requested
+      `open #{output_file}` if open_flag
+    end
+
+  end
+end

data/lib/plans/version.rb

@@ -1,3 +1,3 @@
 module Plans
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plans
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gabriel Cook
@@ -152,6 +152,7 @@ files:
 - lib/plans/init.rb
 - lib/plans/list.rb
 - lib/plans/new.rb
+- lib/plans/pdf.rb
 - lib/plans/publish.rb
 - lib/plans/thumbs.rb
 - lib/plans/version.rb