hackademic 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfacecaab2ef9d8d0e912d678cae7d156aecd5a2
-  data.tar.gz: 0dd4b487bc8fea19592afb54e99c2648d4994733
+  metadata.gz: 03ddbab38fc0b8902f15efa0443042b5b7553a2c
+  data.tar.gz: f227c94397e739676433b066a110439f8898335d
 SHA512:
-  metadata.gz: 59e40e27994b84796d59c19f58dd6dcf3d81359932d91d65f0bf7e01800e712f6bfe895f59c86339d138afc8bd8f09e3935ddfcc9253748b68a65468b13ee3ef
-  data.tar.gz: a347a1d3f93e31fcf9afb3ca3bae06ed6fcf87b6222633cb50bb9cb18d8aab06f52b44565cc8b51a8d108a27d2156c15254a3c7895580c74f4d43fe0d52f578d
+  metadata.gz: d08c72bb63e5e53fd4f615316b21f07b538e22da437794b1ad734c598bd708ebe81a962f19633d790e7b745da7fc75e17ae4471bfad5aae5bb983304773ab837
+  data.tar.gz: deea42467d8169c25b6305a6c91635b0156c43c735b6d59c907bfd498ee6705daabb52b5766514bfb974da5f8b48b9977cb0f54f8518d5af950efdb738b10abf

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.3.0
+
+* Docx generation now defaults to using LibreOffice as a way to get more control over the output via an odt template.
+* Refactoring and clean-ups.
+
 ## 0.2.9
 
 * Can now specify pandoc variables for pdf generation directly in the Config.yml

data/bin/hackademic

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require_relative '../lib/hackademic'
 
-Hackademic.start
+HackademicCLI.start

data/hackademic.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name          = 'hackademic'
-  s.version       = '0.2.9'
-  s.date          = '2016-01-03'
+  s.version       = '0.3.0'
+  s.date          = '2016-02-28'
   s.summary       = "Create and manage your academic workflow"
   s.description   = "Hackademic manages your plain-text academic workflow."
   s.authors       = ["Matthew Petty"]

data/lib/hackademic.rb

@@ -2,10 +2,15 @@ require "rubygems"
 require "yaml"
 require "thor"
 require 'active_support'
-require_relative 'hackademy/sync'
-require_relative 'hackademy/compile'
+require_relative 'hackademic/config'
+require_relative 'hackademic/sync'
+require_relative 'hackademic/compile'
+require_relative 'hackademic/new'
 
-class Hackademic < Thor
+# TODO: Un-spaghetti-fy this project
+# TODO: Handle missing Config.yml variables nicely
+
+class HackademicCLI < Thor
 
   include Thor::Actions
 
@@ -13,10 +18,10 @@ class Hackademic < Thor
   source_root "#{Pathname.new(__FILE__).dirname}"
 
   register Sync, :sync, "sync [subcommand]", "Synchronize!"
-  register Hackademy::New, :new, "new [PROJECT]", "Create something new!"
+  register Hackademic::New, :new, "new [PROJECT]", "Create something new!"
 
   desc 'compile [FORMAT]', 'Type "hackademic help compile" to see choices'
-  subcommand 'compile', ::Hackademy::Compile
+  subcommand 'compile', ::Hackademic::Compile
 
   desc "list", "List the current projects in #{HACKADEMIC_DIRECTORY}"
   def list
@@ -49,6 +54,7 @@ class Hackademic < Thor
     template "../templates/default.asciidoc", ENV["HOME"] + "/.pandoc/templates/default.asciidoc"
     template "../templates/default.html5", ENV["HOME"] + "/.pandoc/templates/default.html5"
     template "../templates/default.latex", ENV["HOME"] + "/.pandoc/templates/default.latex"
+    template "../templates/default.odt", ENV["HOME"] + "/.pandoc/templates/default.odt"
   end
 
   desc "setup [FOLDER]", "Setup a new Hackademic repository at [FOLDER]"

data/lib/{hackademy → hackademic}/compile.rb

@@ -1,6 +1,4 @@
-require_relative "hackademy"
-
-module Hackademy
+module Hackademic
   class Compile < Thor
 
     include Thor::Actions
@@ -23,16 +21,20 @@ module Hackademy
 
     desc "show_pdf_command", "Show the pandoc command for pdf generation"
     def show_pdf_command
-      p config.pandoc
       say pdf_command, :blue
     end
 
+    desc "show_docx_command", "Show the pandoc command for docx generation"
+    def show_docx_command
+      say docx_command, :blue
+    end
+
     desc "docx", "compile a docx"
     def docx
       check_installation
       read_draft_file
       write_master_markdown_file
-      %x[pandoc #{config.output_directory}/#{config.transcluded_draft} --from=markdown+#{pandoc_from_options.join("+")} --filter pandoc-citeproc --bibliography=#{config.bibliography} --csl=#{config.citation_style} --reference-docx=#{config.docx_template} -s -o "#{config.output_directory}/#{config.draft_name.gsub(/\..*$/,'')}.docx"]
+      system docx_command
       say "Writing out DOCX file: #{config.output_directory}/#{config.draft_name.gsub(/\..*$/, '')}.docx"
     end
 
@@ -51,6 +53,29 @@ module Hackademy
         "#{config.output_directory}/#{config.draft_name.gsub(/\..*$/,'')}.tex"
       end
 
+      def libre_office_binary
+        config.libre_office_binary || "/Applications/LibreOffice.app/Contents/MacOS/soffice"
+      end
+
+      def docx_command
+        if File.exists?(libre_office_binary)
+          command = ""
+          # Use pandoc to create an ODT file"
+          command << %[pandoc #{config.output_directory}/#{config.transcluded_draft} --from=markdown+#{pandoc_from_options.join("+")} --filter pandoc-citeproc --bibliography=#{config.bibliography} --csl=#{config.citation_style} -s -o temp.odt]
+          command << " && "
+          # Use LibreOffice to create a DOCX file"
+          command << "#{libre_office_binary} --invisible --convert-to docx temp.odt"
+          command << " && "
+          # Remove the un-necessary odt file
+          command << "rm temp.odt"
+          command << " && "
+          # Rename the temp.docx and move it into the Versions directory
+          command << "mv temp.docx #{config.output_directory}/#{config.draft_name.gsub(/\..*$/,'')}.docx"
+        else
+          %[pandoc #{config.output_directory}/#{config.transcluded_draft} --from=markdown+#{pandoc_from_options.join("+")} --filter pandoc-citeproc --bibliography=#{config.bibliography} --csl=#{config.citation_style} --reference-docx=#{config.docx_template} -s -o "#{config.output_directory}/#{config.draft_name.gsub(/\..*$/,'')}.docx"]
+        end
+      end
+
       def pdf_command
         cmd = %{pandoc \
           --template=#{config.pdf_template} \
@@ -61,8 +86,10 @@ module Hackademy
           -o "#{config.output_directory}/#{config.draft_name.gsub(/\..*$/,'')}.pdf" \
           #{config.output_directory}/#{config.transcluded_draft} \
         }
-        config.pandoc_variables.each do |key, val|
-          cmd << %{-V #{key}="#{val}"}
+        if config.pandoc_variables.is_a? Hash
+          config.pandoc_variables.each do |key, val|
+            cmd << %{-V #{key}="#{val}"}
+          end
         end
         cmd.gsub(/\s+/, ' ')
       end
@@ -100,7 +127,7 @@ module Hackademy
           contents.scan(/{{(.*)}}/).flatten.each do |f|
             original_f = f
             f = f[config.drafts_dir] ? f.gsub(config.drafts_dir, '') : "#{config.drafts_dir}/#{f}"
-            Hackademic.new.say "...Including #{f}...", :cyan
+            HackademicCLI.new.say "...Including #{f}...", :cyan
             if File.exists?(f)
               content = File.open(f).read + "\n"
               @draft = @draft.gsub("{{#{original_f}}}", content)
@@ -139,7 +166,7 @@ module Hackademy
         ]
       end
 
-      def config; Hackademy.config; end
+      def config; Hackademic.config; end
     }
 
   end

data/lib/{hackademy/hackademy.rb → hackademic/config.rb}

@@ -1,6 +1,4 @@
-require_relative 'new'
-
-module Hackademy
+module Hackademic
 
   def self.config;
     @config ||= Config.new

data/lib/{hackademy → hackademic}/new.rb

@@ -1,6 +1,6 @@
 require 'pathname'
 
-module Hackademy
+module Hackademic
 
   class New < Thor
 

data/templates/default.odt

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<office:document-content xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0" xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0" xmlns:math="http://www.w3.org/1998/Math/MathML" xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0" xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0" xmlns:ooo="http://openoffice.org/2004/office" xmlns:ooow="http://openoffice.org/2004/writer" xmlns:oooc="http://openoffice.org/2004/calc" xmlns:dom="http://www.w3.org/2001/xml-events" xmlns:xforms="http://www.w3.org/2002/xforms" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" office:version="1.2">
+  <office:font-face-decls>
+    <style:font-face style:name="Courier New" style:font-family-generic="modern" style:font-pitch="fixed" svg:font-family="'Courier New'" />
+  </office:font-face-decls>
+  <office:styles>
+    <style:style style:name="Italic" style:family="text"><style:text-properties fo:font-style="italic" style:font-style-asian="italic" style:font-style-complex="italic" /></style:style>
+    <style:style style:name="Bold" style:family="text"><style:text-properties fo:font-weight="bold" style:font-weight-asian="bold" style:font-weight-complex="bold" /></style:style>
+  </office:styles>
+  
+  $automatic-styles$
+
+  $for(header-includes)$
+    $header-includes$
+  $endfor$
+
+  <office:body>
+    <office:text>
+
+      $if(memo)$
+
+        <text:p text:style-name="Memo header">To:<text:tab/>$to$</text:p>
+        <text:p text:style-name="Memo header">From:<text:tab/>$for(author)$$author.name$$if(author.email)$ ($author.email$)$endif$$sep$, $endfor$</text:p>
+        <text:p text:style-name="Memo header">Date:<text:tab/>$date$</text:p>
+        <text:p text:style-name="Memo header last">Subject:<text:tab/><text:span text:style-name="Bold">$title$</text:span></text:p>
+
+      $else$
+
+        $if(published)$
+          <text:h text:style-name="Published message">$published$</text:h>
+        $endif$
+
+        $if(title)$
+          <text:h text:style-name="Title">$title$</text:h>
+        $endif$
+
+        $if(blinded)$
+
+          <!-- Blinded by the light -->
+
+        $else$
+
+          $for(author)$
+            <text:p text:style-name="Author">$author.name$</text:p>
+            <text:p text:style-name="Affiliation">$author.affiliation$</text:p>
+            <text:p text:style-name="Email">$author.email$</text:p>
+          $endfor$
+
+        $endif$
+
+        $if(date)$
+          <text:p text:style-name="Date">$date$</text:p>
+        $endif$
+
+        $if(abstract)$
+          <text:p text:style-name="Abstract"><text:span text:style-name="Bold">Abstract:</text:span> $abstract$</text:p>
+        $endif$
+
+      $endif$
+
+      $for(include-before)$
+        $include-before$
+      $endfor$
+
+      $body$
+
+      $for(include-after)$
+        $include-after$
+      $endfor$
+
+    </office:text>
+  </office:body>
+</office:document-content>

data/test/Resources/Config.yml

@@ -0,0 +1,17 @@
+---
+hackademic:
+  bibliography: Resources/References.bib
+  drafts_dir: "_WORKING_"
+  draft_name: DRAFT.md
+  pandoc:
+    variables:
+        date: <%= Time.now.strftime("%m/%d/%Y") %>
+  transcluded_draft: DRAFT-COMPLETE.md
+  output_directory: Versions
+  citation_style: Resources/csl/american-sociological-association.csl
+  docx_template: Resource/templates/pandoc-word-template.docx
+  latex_template: Resources/templates/xelatex.template
+  html_template: Resources/templates/default.html5
+  pdf_template: Resources/templates/default.html5
+  support_directory: Resources
+  libre_office_binary: /Applications/LibreOffice.app/Contents/MacOS/soffice

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hackademic
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthew Petty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies: []
 description: Hackademic manages your plain-text academic workflow.
 email: matt@kizmeta.com
@@ -25,10 +25,11 @@ files:
 - bin/hackademic
 - hackademic.gemspec
 - lib/hackademic.rb
-- lib/hackademy/compile.rb
-- lib/hackademy/hackademy.rb
-- lib/hackademy/new.rb
-- lib/hackademy/sync.rb
+- lib/hackademic/.compile.rb.swp
+- lib/hackademic/compile.rb
+- lib/hackademic/config.rb
+- lib/hackademic/new.rb
+- lib/hackademic/sync.rb
 - templates/CHANGELOG.md.tt
 - templates/Config.yml.tt
 - templates/DRAFT.md.tt
@@ -38,8 +39,10 @@ files:
 - templates/default.asciidoc
 - templates/default.html5
 - templates/default.latex
+- templates/default.odt
 - templates/pandoc-word-template.docx
 - templates/xelatex.template
+- test/Resources/Config.yml
 homepage: http://github.com/kizmeta/hackademic
 licenses:
 - MIT