quivjek 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89f2083f8fa0d38194df93c7d644cfedbe29cb6e
-  data.tar.gz: 3d986b97b490e32f475c79843ca871b065b202be
+  metadata.gz: cddb138a8ddddbc65215afc6014cd62855558b8a
+  data.tar.gz: e0e2064128abfdcfd12316f257b44c2cbe7957ee
 SHA512:
-  metadata.gz: e2ee61b8194aa8f511eed12d8df343287efa1cd9f93ba67838923c4e55b3c1ce227b7d16b9206d3e909687ed9208371e6c859b0bee49bf091f3e74c9c8388351
-  data.tar.gz: 596e4f64b2b3ef9a121732fa76af0b68e183ddaeae1993ea24d4a47d985228c5bc6509ad9770dd92857e9d8c060b6d723ffc71f44aec34f4c6c21188ccdd1929
+  metadata.gz: 12f0fe9e24a397a5d7e47e36b03a787780099b5c1de9e1c9c5b765e6b7eb643cf96459eee85b0eee2cd5cc6e1b81d58438e127f58ebfba12ad374970115010e7
+  data.tar.gz: e1c94c28e1eda6225d15aefad543a777291758ee0c1042acd98479a1f4ada284c38b4c0924200929eb6d8617cf4b5d7ffd028cb2fb8f4a1256873430476991a5

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -9,4 +10,5 @@
 /tmp/
 /.idea
 /test/resources/_posts/quiver
-/test/resources/images/q
+/test/resources/images/q
+/vendor/

data/README.md

@@ -1,39 +1,55 @@
 # Quivjek: A Jekyll plugin for seamless publication of Quiver notebooks
 [![Build Status](https://travis-ci.org/benbjurstrom/quivjek.svg?branch=master)](https://travis-ci.org/benbjurstrom/quivjek)
 
-Quivjek is a Jekyll plugin that automatically exports all notes from a specified Quiver notebook to your _posts folder when the jekyll build command is run. Quivjek also copies and properly links any images contained in a Quiver note to your Jekyll images folder.
+Quivjek is a [Jekyll](https://jekyllrb.com/) plugin that automatically exports all notes from a specified [Quiver](http://happenapps.com/#quiver) notebook to your _posts folder when the jekyll build command is run. Quivjek also copies and properly links any images contained in a Quiver note to your Jekyll images folder.
 
 ## Installation
 1. Install the quivjek gem
-```
-gem install quivjek
-```
+  ```bash
+  gem install quivjek
+  ```
 2. Add quivjek to the gems array found in the _config.yml file.
-```
-#jekyll_dir/_config.yml
-gems: [quivjek]
-```
+  ```yaml
+  #jekyll_dir/_config.yml
+  gems: [quivjek]
+  ```
 3. Point quivjek to the Quiver notebook of choice by adding the `notebook_dir:` key to the \_config.yml file with a value equal to your notebooks file path. For example:
-```
-#jekyll_dir/_config.yml
-notebook_dir:~/Dropbox/Quiver/Quiver.qvlibrary/14F2BCE0-1B08-4ED6-993A-17C8AB0316E2.qvnotebook
-```
+  ```yaml
+  #jekyll_dir/_config.yml
+  notebook_dir:~/Dropbox/Quiver/Quiver.qvlibrary/14F2BCE0-1B08-4ED6-993A-17C8AB0316E2.qvnotebook
+  ```
 
-To determine a notebook's filepath right click on the note in the Quiver sidebar and choose open in finder. Be aware that Quiver notebooks are folders ending in the .qvnotebook extension and named with a random UUID as in the example above.
+To determine a Quiver notebook's filepath right click on the note in the Quiver sidebar and choose open in finder. Be aware that Quiver notebooks are folders ending in the .qvnotebook extension and named with a random UUID as in the example above.
 
 ## Usage
-Simply run `jekyll build` and quivjek will automatically add your Quiver notes to your jekyll site
+Run `jekyll build` and quivjek will automatically copy your Quiver notes to your jekyll _posts folder prior to build.
 
 ## Things you should know
-All quiver notes must be entirely composed of markdown or code cells.
+1. All quiver notes must be entirely composed of markdown or code cells.
 
-Quivjek will ignore any posts tagged as `draft`
+1. Quivjek will ignore any posts tagged as `draft`
 
-Quivjek sets the post created date based on the note's created date. Currently there's no easy way to modify the note's create date in Quiver short of modifying the timestamp in the note's meta.json file. Eventually I'd like to allow overriding this value through custom frontmatter.
+1. Optionally you can include a YAML front matter envelope to your Quiver note.
 
-Quivjek currently copies all notes and images to the jekyll directory within the subfolders `/_posts/quiver` and `/images/q` respectivly. On build quivjek deletes all files from these subfolders and re-copies the notes and images from the Quiver notebook. This is done to clean up any deleted or renamed items. Eventually I'd like to save a manafest and only update the notes and images that have been modified or deleted since the last build.
+  ```yaml
+  
+  ---
+  title: This is an example post
+  date: '2016-09-14'
+  ---
+  
+  Some content...
+  ```
 
-When an image is added to a markdown cell, Quiver renames the file and sets the original file name as the image tag's alt attribute. For example the image `big-claw-puppy-on-wood-floor.jpg` becomes `![big-claw-puppy-on-wood-floor.jpg](quiver-image-url/642370E09A291BC1601CFD68B44A5C16.jpg)`. For SEO purposes quivjek reverses this process by renaming the image to whatever is found in your alt tag. Therefore it is recormended your alt tags are lowercase, slug-ified, unique, and end in the image file extension.
+  * By default Quivjek sets the front matter date (and markdown file name) based on the Quiver note's created date metadata. This can be overridden by adding the date front matter to your Quiver note.
+
+  * By default Quivjek sets the front matter title (and markdown file name) equal to the Quiver note's title. This can be overridden by adding the title front matter to your quiver note.
+
+  * By default Quivjek adds the Quiver note's tags as front matter tags.
+
+1. Quivjek currently copies all notes and images to the jekyll directory within the subfolders `/_posts/quiver` and `/images/q` respectively. On build quivjek deletes all files from these subfolders and re-copies the notes and images from the Quiver notebook. This is done to clean up any deleted or renamed items. Eventually I'd like to save a manifest and only update the notes and images that have been modified or deleted since the last build.
+
+1. When an image is added to a markdown cell, Quiver renames the file and sets the original file name as the image tag's alt attribute. For example the image `big-claw-puppy-on-wood-floor.jpg` becomes `![big-claw-puppy-on-wood-floor.jpg](quiver-image-url/642370E09A291BC1601CFD68B44A5C16.jpg)`. For SEO purposes quivjek reverses this process by renaming the image to whatever is found in your alt tag. Therefore it is recommended your alt tags are lowercase, slug-ified, unique, and end in the image file extension.
 
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/quivjek.rb

@@ -4,6 +4,8 @@ require "json"
 require "fileutils"
 require "quivjek/version"
 require "jekyll"
+require "front_matter_parser"
+require "yaml"
 
 Jekyll::Hooks.register :site, :after_init do |site|
   q = Quivjek.new(site)
@@ -48,29 +50,51 @@ class Quivjek
   end
 
   def copy_note(note_dir)
-    metapath    = File.join(note_dir, "meta.json")
-    contentpath = File.join(note_dir, "content.json")
-    imagepath   = File.join(note_dir, "resources")
-
-    showhelp("meta.json doesn't exist") unless File.exist? metapath
-    metajson = JSON.parse(File.read(metapath))
+    # Load the quiver note meta.json file.
+    metajson = load_meta_json(note_dir)
 
     # Skip this note if tagged with draft
     metajson["tags"].each do |tag|
       return if tag == 'draft'
     end
 
-    showhelp(contentpath + "content.json doesn't exist") unless File.exist? contentpath
-
+    # Copy the notes images to the jekyll directory
+    imagepath    = File.join(note_dir, "resources")
     self.copy_note_images(imagepath) if File.exist?(imagepath)
 
-    filename = self.get_filename(metajson)
-    output   = self.add_frontmatter(metajson)
+    # Load the quiver note content.json file and merge its cells.
+    contentjson = load_content_json(note_dir)
+    content     = self.merge_cells(contentjson, '')
 
-    contentjson = JSON.parse(File.read(contentpath))
-    output      = self.add_content(contentjson, output)
+    # Parse out optional frontmatter from the content
+    parsed      = FrontMatterParser.parse(content)
+    fm          = parsed.front_matter
+    content     = parsed.content
 
+    # Set some default frontmatter and combine with content
+    fm = set_default_frontmatter(fm, metajson)
+    output = fm.to_yaml + "---\n" + content
+
+    # Write the markdown file to the jekyll dir
+    filename    = self.get_filename(fm)
     File.open(File.join(@post_dir, filename), "w") { |file| file.write(output) }
+
+  end
+
+  def load_meta_json(dir)
+    metapath    = File.join(dir, "meta.json")
+    showhelp("meta.json doesn't exist") unless File.exist? metapath
+    metajson = JSON.parse(File.read(metapath))
+
+    return metajson
+  end
+
+  def load_content_json(dir)
+    contentpath = File.join(dir, "content.json")
+    showhelp(contentpath + "content.json doesn't exist") unless File.exist? contentpath
+    contentjson = JSON.parse(File.read(contentpath))
+
+    return contentjson
   end
 
   def copy_note_images(imagepath)
@@ -83,35 +107,37 @@ class Quivjek
 
   end
 
-  def get_filename(metajson)
-    title = metajson["title"].gsub(" ", "-").downcase
+  def get_filename(fm)
+    title = fm["title"].gsub(" ", "-").downcase
+    date = DateTime.parse(fm["date"])
 
-    created_at_date = DateTime.strptime(metajson["created_at"].to_s, "%s")
-    day = "%02d" % created_at_date.day
-    month = "%02d" % created_at_date.month
-    year = created_at_date.year
+    day = "%02d" % date.day
+    month = "%02d" % date.month
+    year = date.year
 
     return "#{year}-#{month}-#{day}-#{title}.md"
   end
 
-  def add_frontmatter(metajson)
-    tags   = metajson["tags"].map { |tag| "    - #{tag}" }.join("\n")
-    output = <<eos
----
-layout: post
-title: "#{metajson["title"]}"
-eos
+  def set_default_frontmatter(fm, metajson)
+
+    # If certain frontmatter is missing default to quiver metadata
+    fm['title'] = metajson['title']      unless fm['title']
 
+    if !fm.key?("date")
+      date = DateTime.strptime(metajson["created_at"].to_s, "%s")
+      fm['date'] = date.strftime('%Y-%m-%d')
+    end
+
+    tags   = metajson["tags"].map { |tag| "    - #{tag}" }.join("\n")
     if !tags.empty?
-      output << "tags:\n#{tags}\n"
+      fm['tags']  = tags
     end
 
-    output << "---\n\n"
+    return fm
 
-    return output
   end
 
-  def add_content(contentjson, output)
+  def merge_cells(contentjson, output)
     contentjson["cells"].each do |cell|
       case cell["type"]
         when "code"

data/lib/quivjek/version.rb

@@ -1,3 +1,3 @@
 class Quivjek
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/quivjek.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "front_matter_parser", "0.0.4"
+
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: quivjek
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Bjurstrom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2017-02-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: front_matter_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin for seamless publication of Quiver notebooks