markdown_to_word 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1aebc5c422638946e64c141ef66b1063c57d428
+  data.tar.gz: 7b860590d0bb62e09a38cc92056fbe0866083063
+SHA512:
+  metadata.gz: 49baff6b92f2766652264923192f41a287bca5ec7a94ab32e950675f93a77316dc79518c975352da26e909bf3c5ba984eb0ccc471342dac3ef5f4c1c90e8f933
+  data.tar.gz: 93e2c8e90b98bb4a546d75e71ab58595cc7cb14b021e1113d91735291ea946999e57bc2919490140eb22522046bc57eee90258285c93ff48270b13b91e20748d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.travis.yml

@@ -0,0 +1,18 @@
+langauage: ruby
+script: "script/cibuild"
+rvm:
+  - 2.1
+before_install:
+  - sudo add-apt-repository -y ppa:libreoffice/ppa
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq libreoffice-writer
+  - "soffice --version"
+  - "which soffice"
+
+cache:
+  - bundler
+  - apt
+
+env:
+  global:
+    NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in markdown_to_word.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Ben Balter
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Markdown to Word
+
+Converts GitHub-flavored Markdown to a Word document
+
+[![Build Status](https://travis-ci.org/benbalter/markdown_to_word.svg)](https://travis-ci.org/benbalter/markdown_to_word)
+
+## Why
+
+While Markdown is the *lingua franca* of the development world, the rest of the world still sees Word documents as the *de facto* way to share text. Rather than try to convert the rest of the world, just work in Markdown, and convert things to Word before sending to others.
+
+## Demo
+
+You can see it in action with [this demo](https://markdown-to-word.herokuapp.com/)
+
+## Installation
+
+Add the following to your project's Gemfile:
+
+```ruby
+gem 'markdown_to_word'
+```
+
+## Usage
+
+```ruby
+MarkdownToWord.convert("# Some Markdown").path
+=> "/path/to/the/file.docx"
+```
+
+## Command line usage
+
+```
+m2w "# Some Markdown" > foo.docx
+```
+
+(Returns the contents of the docx to STDOUT)
+
+## How it works
+
+1. We use [HTML Pipeline](https://github.com/jch/html-pipeline) to convert the Markdown to HTML
+2. We use [HTML to Word](https://github.com/karnov/htmltoword) to convert the HTML to a Word doc
+
+## Why not just use Pandoc?
+
+While Pandoc is great on the desktop, it's hard to install on servers or use on Heroku.
+
+## Need to go the other way?
+
+See [Word to Markdown](https://github.com/benbalter/word-to-markdown).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["--order", "rand", "--color"]
+end

data/bin/m2w

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/markdown_to_word'
+
+if ARGV.size != 1 || ARGV[0] == "--help"
+  puts "Usage: bundle exec m2w [markdown]"
+  exit 1
+end
+
+if ARGV[0] == "--version"
+  puts "MarkdownToWord v#{MarkdownToWord::VERSION}"
+else
+  puts MarkdownToWord.convert(ARGV[0]).contents
+end

data/lib/markdown_to_word.rb

@@ -0,0 +1,18 @@
+require 'html/pipeline'
+require 'htmltoword'
+require 'digest'
+
+require_relative "markdown_to_word/version"
+require_relative "markdown_to_word/document"
+
+module MarkdownToWord
+  def self.convert(markdown)
+    Document.new(markdown)
+  end
+
+  def self.default_templates_path
+    File.expand_path "./markdown_to_word", File.dirname(__FILE__)
+  end
+end
+
+Htmltoword.config.default_templates_path = MarkdownToWord.default_templates_path

data/lib/markdown_to_word/document.rb

@@ -0,0 +1,35 @@
+module MarkdownToWord
+  class Document
+
+    attr_accessor :template, :html
+
+    # https://github.com/jekyll/jekyll/blob/master/lib/jekyll/document.rb#L9
+    YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
+
+    def initialize(markdown="")
+      @raw_markdown = markdown
+    end
+
+    def markdown
+      @raw_markdown.split(YAML_FRONT_MATTER_REGEXP).last
+    end
+
+    def html
+      @html ||= Nokogiri::HTML(raw_html).to_html
+    end
+
+    def hash
+      @hash ||= Digest::MD5.hexdigest(html)
+    end
+
+    def contents
+      @contents ||= Htmltoword::Document.create(html, template, true)
+    end
+
+    private
+
+    def raw_html
+      @raw_html ||= HTML::Pipeline::MarkdownFilter.new(markdown).call
+    end
+  end
+end

data/lib/markdown_to_word/template/[Content_Types].xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">
+  <Default Extension="xml" ContentType="application/xml"/>
+  <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/>
+  <Default Extension="jpeg" ContentType="image/jpeg"/>
+  <Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/>
+  <Override PartName="/word/numbering.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml"/>
+  <Override PartName="/word/styles.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml"/>
+  <Override PartName="/word/stylesWithEffects.xml" ContentType="application/vnd.ms-word.stylesWithEffects+xml"/>
+  <Override PartName="/word/settings.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml"/>
+  <Override PartName="/word/webSettings.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.webSettings+xml"/>
+  <Override PartName="/word/fontTable.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml"/>
+  <Override PartName="/word/theme/theme1.xml" ContentType="application/vnd.openxmlformats-officedocument.theme+xml"/>
+  <Override PartName="/docProps/core.xml" ContentType="application/vnd.openxmlformats-package.core-properties+xml"/>
+  <Override PartName="/docProps/app.xml" ContentType="application/vnd.openxmlformats-officedocument.extended-properties+xml"/>
+</Types>

data/lib/markdown_to_word/template/_rels/.rels

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+  <Relationship Id="rId3" Type="http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" Target="docProps/core.xml"/>
+  <Relationship Id="rId4" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" Target="docProps/app.xml"/>
+  <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/>
+  <Relationship Id="rId2" Type="http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail" Target="docProps/thumbnail.jpeg"/>
+</Relationships>

data/lib/markdown_to_word/template/docProps/app.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/extended-properties" xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"/>

data/lib/markdown_to_word/template/docProps/core.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<cp:coreProperties xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:dcmitype="http://purl.org/dc/dcmitype/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

data/lib/markdown_to_word/template/word/_rels/document.xml.rels

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+  <Relationship Id="rId3" Type="http://schemas.microsoft.com/office/2007/relationships/stylesWithEffects" Target="stylesWithEffects.xml"/>
+  <Relationship Id="rId4" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" Target="settings.xml"/>
+  <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings" Target="webSettings.xml"/>
+  <Relationship Id="rId6" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" Target="fontTable.xml"/>
+  <Relationship Id="rId7" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" Target="theme/theme1.xml"/>
+  <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" Target="numbering.xml"/>
+  <Relationship Id="rId2" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" Target="styles.xml"/>
+</Relationships>

data/lib/markdown_to_word/template/word/document.xml

@@ -0,0 +1,127 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:document xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:mo="http://schemas.microsoft.com/office/mac/office/2008/main" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:mv="urn:schemas-microsoft-com:mac:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" mc:Ignorable="w14 wp14">
+  <w:body>
+    <w:p w14:paraId="33B77DDD" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="Heading1"/>
+      </w:pPr>
+      <w:r>
+        <w:t>Heading1</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="21645D3B" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="Heading2"/>
+      </w:pPr>
+      <w:r>
+        <w:t>HEADING2</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="22596106" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="Heading3"/>
+      </w:pPr>
+      <w:r w:rsidRPr="00E01725">
+        <w:t>HEADING3</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="59EBECAF" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="Heading4"/>
+      </w:pPr>
+      <w:r>
+        <w:t>HEADING4</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="4AE3D6AE" w14:textId="77777777" w:rsidR="00E01725" w:rsidRPr="00AC30E1" w:rsidRDefault="00E01725" w:rsidP="00E01725"/>
+    <w:p w14:paraId="21AFBAA3" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:r>
+        <w:t>normal</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="6D97C87E" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="ListParagraph"/>
+        <w:numPr>
+          <w:ilvl w:val="0"/>
+          <w:numId w:val="2"/>
+        </w:numPr>
+      </w:pPr>
+      <w:r>
+        <w:t>one</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="72F37C56" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="ListParagraph"/>
+        <w:numPr>
+          <w:ilvl w:val="0"/>
+          <w:numId w:val="2"/>
+        </w:numPr>
+      </w:pPr>
+      <w:r>
+        <w:t>two</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="01F5E51C" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="ListParagraph"/>
+        <w:numPr>
+          <w:ilvl w:val="0"/>
+          <w:numId w:val="2"/>
+        </w:numPr>
+      </w:pPr>
+      <w:r>
+        <w:t>three</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="51630C02" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:r>
+        <w:t>normal</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="5FD08257" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="ListParagraph"/>
+        <w:numPr>
+          <w:ilvl w:val="0"/>
+          <w:numId w:val="3"/>
+        </w:numPr>
+      </w:pPr>
+      <w:r>
+        <w:t>one</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="5D253DBD" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="ListParagraph"/>
+        <w:numPr>
+          <w:ilvl w:val="0"/>
+          <w:numId w:val="3"/>
+        </w:numPr>
+      </w:pPr>
+      <w:r>
+        <w:t>two</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="78BE5858" w14:textId="77777777" w:rsidR="00E01725" w:rsidRDefault="00E01725" w:rsidP="00E01725">
+      <w:pPr>
+        <w:pStyle w:val="ListParagraph"/>
+        <w:numPr>
+          <w:ilvl w:val="0"/>
+          <w:numId w:val="3"/>
+        </w:numPr>
+      </w:pPr>
+      <w:r>
+        <w:t>three</w:t>
+      </w:r>
+    </w:p>
+    <w:p w14:paraId="39501C42" w14:textId="77777777" w:rsidR="00187EAF" w:rsidRPr="00E01725" w:rsidRDefault="00187EAF" w:rsidP="00E01725"/>
+    <w:sectPr w:rsidR="00187EAF" w:rsidRPr="00E01725">
+      <w:pgSz w:w="12240" w:h="15840"/>
+      <w:pgMar w:top="1440" w:right="1440" w:bottom="1440" w:left="1440" w:header="708" w:footer="708" w:gutter="0"/>
+      <w:cols w:space="708"/>
+      <w:docGrid w:linePitch="360"/>
+    </w:sectPr>
+  </w:body>
+</w:document>

data/lib/markdown_to_word/template/word/fontTable.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:fonts xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" mc:Ignorable="w14">
+  <w:font w:name="Symbol">
+    <w:panose1 w:val="00000000000000000000"/>
+    <w:charset w:val="02"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="00000000" w:usb1="10000000" w:usb2="00000000" w:usb3="00000000" w:csb0="80000000" w:csb1="00000000"/>
+  </w:font>
+  <w:font w:name="Times New Roman">
+    <w:panose1 w:val="02020603050405020304"/>
+    <w:charset w:val="00"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="E0002AEF" w:usb1="C0007841" w:usb2="00000009" w:usb3="00000000" w:csb0="000001FF" w:csb1="00000000"/>
+  </w:font>
+  <w:font w:name="Courier New">
+    <w:panose1 w:val="02070309020205020404"/>
+    <w:charset w:val="00"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="E0002AFF" w:usb1="C0007843" w:usb2="00000009" w:usb3="00000000" w:csb0="000001FF" w:csb1="00000000"/>
+  </w:font>
+  <w:font w:name="Wingdings">
+    <w:panose1 w:val="05000000000000000000"/>
+    <w:charset w:val="02"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="00000000" w:usb1="10000000" w:usb2="00000000" w:usb3="00000000" w:csb0="80000000" w:csb1="00000000"/>
+  </w:font>
+  <w:font w:name="Cambria">
+    <w:panose1 w:val="02040503050406030204"/>
+    <w:charset w:val="00"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="E00002FF" w:usb1="400004FF" w:usb2="00000000" w:usb3="00000000" w:csb0="0000019F" w:csb1="00000000"/>
+  </w:font>
+  <w:font w:name="ＭＳ 明朝">
+    <w:charset w:val="4E"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="E00002FF" w:usb1="6AC7FDFB" w:usb2="00000012" w:usb3="00000000" w:csb0="0002009F" w:csb1="00000000"/>
+  </w:font>
+  <w:font w:name="Arial">
+    <w:panose1 w:val="020B0604020202020204"/>
+    <w:charset w:val="00"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="E0002AFF" w:usb1="C0007843" w:usb2="00000009" w:usb3="00000000" w:csb0="000001FF" w:csb1="00000000"/>
+  </w:font>
+  <w:font w:name="ＭＳ ゴシック">
+    <w:charset w:val="4E"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="E00002FF" w:usb1="6AC7FDFB" w:usb2="00000012" w:usb3="00000000" w:csb0="0002009F" w:csb1="00000000"/>
+  </w:font>
+  <w:font w:name="Calibri">
+    <w:panose1 w:val="020F0502020204030204"/>
+    <w:charset w:val="00"/>
+    <w:family w:val="auto"/>
+    <w:pitch w:val="variable"/>
+    <w:sig w:usb0="E10002FF" w:usb1="4000ACFF" w:usb2="00000009" w:usb3="00000000" w:csb0="0000019F" w:csb1="00000000"/>
+  </w:font>
+</w:fonts>