quivjek 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d65ca409aa9ca6a4c89f989eec03ccd3e66a1e9c
+  data.tar.gz: 469b356a3621fa41b28bd33cb7ed135288b12c0e
+SHA512:
+  metadata.gz: dc8ab9c141826190767d34878e239e91eb1d6fb66e3ac55f2ce85853918e100408c5096fc3939075e74794fb90c27963acc67dc0b4924f34a67c2c92fc9c03e9
+  data.tar.gz: f386bf52dd19ef84284c5d6be28733757d48b0be4238413c34156e81a79e2833f6a21c480ac5131c8794862d0c3d69db58e3e3cc15a43798a80667afcadf24a8

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+/test/resources/_posts/quiver
+/test/resources/images/q

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben Bjurstrom
+
+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,52 @@
+#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 copies a specified Quiver notebook to your Jekyll _posts folder whenever the jekyll build command runs. 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
+```
+2. In jekyll's \_config.yml file add quivjek to the gems array
+```
+gems: [quivjek]
+```
+3. Point quivjek to the Quiver notebook of choice by adding the `notebook_dir:` key in jekyll's \_config.yml file and set the value equal to the path to your chosen Quiver notebook. For example:
+```
+#jekyll _config.yml
+notebook_dir:~/Dropbox/Quiver/Quiver.qvlibrary/14F2BCE0-1B08-4ED6-993A-17C8AB0316E2.qvnotebook
+```
+
+## Usage
+Simply run ```jekyll build``` and quivjek will automatically add your Quiver notes to your jekyll site.
+
+## How to I find my quiver notebook?
+Your Quiver notebook is contained within your Quiver library. Your Quiver library is a folder that ends with the extension .qvlibrary. You can find the location of your Quiver library in Quiver's menu by going under Quiver -> Preferences -> Sync and checking the Library Location. If using the command line you can cd into it like normal. If using finder, right click on the .qvlibrary and click show package contents.
+
+Now that you're inside your Quiver libary folder you should see all of that libary's notebooks. Quiver notebooks are folders that end with the .qvnotebook extension. They will be named with a UUID as indiacted above. To determine the Quiver notebook's name check the meta.json file contained within each .qvnotebook folder.
+
+## Other info
+All quiver notes must be entirely composed of markdown or code cells.
+
+Quivjek will ignore any posts tagged as `draft`
+
+Quivjek sets the post created date based on the Quiver created date. Currently there's no easy way to modify the Quiver create date short of modifying the timestamp in the note's meta.json file. Eventually I'd like to allow overriding this value through custom fronmatter.
+
+Quivjek currently copies all notes and images to 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 changed or been removed since the last build.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/benbjurstrom/quivjek. This is my first time using ruby so pull requests to improve code style are welcome. Thanks to Bradley Curran's [quiver2jekyll](https://github.com/bradley-curran/quiver2jekyll/) package for pointing me in the right direction.
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quivjek"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/quivjek/version.rb

@@ -0,0 +1,3 @@
+class Quivjek
+  VERSION = "0.0.1"
+end

data/lib/quivjek.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/ruby
+require "date"
+require "json"
+require "fileutils"
+require "quivjek/version"
+require "jekyll"
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  q = Quivjek.new(site)
+  q.load_posts_from_quiver
+end
+
+class Quivjek
+
+  def initialize( site )
+    self.showhelp('The qivjek plugin requires notebook_dir be set in your _config.yml file') unless site.config.key?('notebook_dir')
+
+    @site         = site
+    @jekyll_dir   = site.source
+    @notebook_dir = site.config['notebook_dir']
+    @post_dir     = File.join(@jekyll_dir, "/_posts/quiver")
+    @img_dir      = File.join(@jekyll_dir, "/images/q")
+
+  end
+
+  def load_posts_from_quiver()
+
+    Dir.mkdir(@post_dir) unless File.exists?(@post_dir)
+    Dir.mkdir(@img_dir) unless File.exists?(@img_dir)
+
+    # Clear out the _posts/quiver and images/q directories in case any posts or images have been renamed
+    FileUtils.rm_rf Dir.glob(@post_dir + '/*')
+    FileUtils.rm_rf Dir.glob(@img_dir + '/*')
+
+    # Pass the path of each .qvnote to the copy_post method
+    Dir.foreach(@notebook_dir) do |item|
+      next if item == '.' or item == '..' or item == 'meta.json' or item == '.keep'
+      self.copy_note(File.join(@notebook_dir, item))
+    end
+
+  end
+
+  protected
+
+  def showhelp(message)
+    puts message.red + "\n"
+    exit
+  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))
+
+    # 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
+
+    self.copy_note_images(imagepath) if File.exist?(imagepath)
+
+    filename = self.get_filename(metajson)
+    output   = self.add_frontmatter(metajson)
+
+    contentjson = JSON.parse(File.read(contentpath))
+    output      = self.add_content(contentjson, output)
+
+    File.open(File.join(@post_dir, filename), "w") { |file| file.write(output) }
+  end
+
+  def copy_note_images(imagepath)
+
+    # copy all images from the note's resources dir to the jekyll images/q dir
+    Dir.foreach(imagepath) do |item|
+      next if item == '.' or item == '..'
+      FileUtils.cp(File.join(imagepath, item), @img_dir)
+    end
+
+  end
+
+  def get_filename(metajson)
+    title = metajson["title"].gsub(" ", "-").downcase
+
+    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
+
+    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
+
+    if !tags.empty?
+      output << "tags:\n#{tags}\n"
+    end
+
+    output << "---\n\n"
+
+    return output
+  end
+
+  def add_content(contentjson, output)
+    contentjson["cells"].each do |cell|
+      case cell["type"]
+        when "code"
+          output << "{% highlight #{cell["language"]} %}\n"
+          output << "#{cell["data"]}\n"
+          output << "{% endhighlight %}\n"
+        when "markdown"
+
+          c = cell["data"]
+
+          # Scan the markdown cell for images
+          images = c.scan(/!\[(.*)\]\(quiver-image-url\/(.*)\)/)
+          images.each do |image|
+
+            # Modify the image source to point to the alt tag in the images/q/ folder
+            c = c.gsub(image[1], image[0])
+
+            # Rename the image (since the image has already been copied from the qvnote folder)
+            File.rename(File.join(@img_dir, image[1]), File.join(@img_dir, image[0]))
+          end
+
+          output << "#{c.gsub("quiver-image-url", "/images/q")}\n"
+        else
+          showhelp(frontmatter_title + " :all cells must be code or markdown types")
+      end
+
+      output << "\n"
+
+      return output
+    end
+  end
+
+end

data/quivjek.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quivjek/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quivjek"
+  spec.version       = Quivjek::VERSION
+  spec.authors       = ["Ben Bjurstrom"]
+  spec.email         = ["ben@jelled.fake"]
+
+  spec.summary       = "A Jekyll plugin for seamless publication of Quiver notebooks"
+  spec.description   = "A Jekyll plugin that automatically copies a Quiver notebook to your Jekyll _posts folder whenever the jekyll build command runs. Quivjek also copies and properly links any images contained in a Quiver note to your Jekyll images folder."
+  spec.homepage      = "https://github.com/benbjurstrom/keyburner"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "jekyll", ">= 2.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: quivjek
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Bjurstrom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Jekyll plugin that automatically copies a Quiver notebook to your Jekyll
+  _posts folder whenever the jekyll build command runs. Quivjek also copies and properly
+  links any images contained in a Quiver note to your Jekyll images folder.
+email:
+- ben@jelled.fake
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quivjek.rb
+- lib/quivjek/version.rb
+- quivjek.gemspec
+homepage: https://github.com/benbjurstrom/keyburner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin for seamless publication of Quiver notebooks
+test_files: []