dove 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6f8473843077e47f14b0dd3b99a461c11bbf4d3
+  data.tar.gz: 288e3a6f703f956eded4111f08f546b40a575762
+SHA512:
+  metadata.gz: b7f0f2d445dbd7c8691ee2f9b3f57af764dd770fe302ed7877d474aa0c27c45d342174045cd019109685cb41d2287370f608ae159dfc90f06a4f06a3a615f3a8
+  data.tar.gz: 019eab34d953bc0a7f279eb486216283f57bfcb23a5b4942c6dfe1258ab7983438c62f2feaafaa4170666832625543f8f8ed803f9959085fe01234ac039857dc

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/README.md

@@ -0,0 +1,51 @@
+# Dove
+
+Write single page HTML documents with ease.
+
+I sometimes want to quickly draft documents in something other than LaTeX. I've realized
+that in the 21^st century HTML pages can easily serve that same purpose DOC, ODT and PDF
+files serve. Dove enables you to write your text in Markdown, then generate beautiful web
+documents.
+
+Example output can be seen [here](http://archseer.github.io/dove/).
+
+## Note
+
+I was really lazy and didn't want to bother converting Markdown into HTML, then inserting
+it into a HTML layout and bothering with syntax highlighting, so I've searched for alternatives.
+I've used Jekyll before, but for writing one-page documents I don't really need a full-blown
+static website solution. I then I had found [rocco](https://github.com/rtomayko/rocco)
+which is a code documentation generator, and I've used a bit of the code from it
+to write Dove, a (web) document generator.
+
+## About
+
+Dove takes a Markdown file, converts it using [Redcarpet](https://github.com/vmg/redcarpet), syntax highlights
+any code snippets inside using [Rouge](https://github.com/jayferd/rouge), then
+it takes a layout file (I use [Slim](http://slim-lang.com/)) and uses [Tilt](https://github.com/rtomayko/tilt)
+to render it, and insert the document into the template. It also detects and
+extracts any YAML frontmatter and inserts it into the layout as variables!
+
+## Usage
+
+Dove is meant to be used using it's binary file:
+
+```
+dove document.md
+```
+
+Glob patterns can also be used just as easily:
+
+```
+dove *.md README *.txt
+```
+
+But one can also require Dove inside a script, and make a new instance of it,
+passing in the filename and options, then use the `render` method.
+
+```ruby
+dove = Dove.new('document.md', template_file: 'doc_layout.slim')
+dove.render
+```
+
+Note: The default layout requires `author` and `title` YAML frontmatter.

data/bin/dove

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+#/ Usage: dove [-o <dir>] <file>...
+#/ Generate web documents from Markdown <file>s. Glob patterns can be used.
+#/
+#/ Options:
+#/   -t, --template=<path>  Specify the file to use as template
+#/   -w, --watch            Watch for file changes and rebuild
+#/       --help             Show this help message
+
+require 'optparse'
+require 'fileutils'
+require 'dove'
+
+# Write usage message to stdout and exit.
+def usage(stream=$stderr, status=1)
+  stream.puts File.readlines(__FILE__).
+    grep(/^#\//).
+    map { |line| line.sub(/^#. ?/, '') }.
+    join
+  exit status
+end
+
+# Like `Kernel#abort` but writes a note encouraging the user to consult
+# `dove --help` for more information.
+def abort_with_note(message=nil)
+  $stderr.puts message if message
+  abort "See `dove --help' for usage information."
+end
+
+# Generate the file and write it to output dir.
+def build(filename, options)
+  dove = Dove.new(filename, options)
+  dest = "#{File.basename(filename, '.*')}.html"
+  dest = File.join(options[:output_dir], dest) if options[:output_dir] != '.'
+  puts "dove: #{Time.now.strftime("%Y-%m-%d %H:%M:%S")} #{filename} -> #{dest}"
+  FileUtils.mkdir_p File.dirname(dest)
+  File.open(dest, 'wb') { |fd| fd.write(dove.render) }
+end
+
+# Parse command line options, aborting if anything goes wrong.
+sources = []
+options = {:output_dir => '.'}
+ARGV.options { |o|
+  o.program_name = File.basename($0)
+  o.on("-o", "--output=DIR")            { |dir| options[:output_dir] = dir }
+  o.on("-t", "--template=TEMPLATE")     { |template| options[:template_file] = template }
+  o.on("-s", "--stylesheet=STYLESHEET") { |stylesheet| options[:stylesheet] = stylesheet }
+  o.on("-w", "--watch")                 { options[:watch] = true }
+  o.on_tail("-h", "--help")             { usage($stdout, 0) }
+  o.parse!
+} or abort_with_note
+
+# Eat sources from ARGV.
+sources.push(*Dir[ARGV.shift]) while ARGV.any?
+
+# Make sure we have some files to work with.
+if sources.empty?
+  abort_with_note "#{File.basename($0)}: no input <file>s given"
+end
+
+# Run each file through Dove and write output.
+sources.each do |filename|
+  build(filename, options)
+end
+
+def watch(files, options)
+  require 'directory_watcher'
+
+  dw = DirectoryWatcher.new('.', glob: files, pre_load: true, interval: 1)
+
+  dw.add_observer do |*args|
+    args.each { |event| build(event.path, options) }
+  end
+
+  dw.start
+
+  trap("INT") do
+    puts "dove: flew away"
+    exit 0
+  end
+  loop { sleep 1000 }
+end
+
+# Start the watcher if the watch option was enabled.
+watch(sources, options) if options[:watch]

data/dove.gemspec

@@ -0,0 +1,23 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "dove/version"
+
+Gem::Specification.new do |s|
+  s.platform      = Gem::Platform::RUBY
+  s.name          = 'dove'
+  s.version       = Dove::VERSION
+  s.homepage      = 'https://github.com/archSeer/dove'
+  s.authors       = ["Blaž Hrastnik"]
+  s.email         = ['speed.the.bboy@gmail.com']
+  s.summary       = "Write single page HTML documents with ease"
+  s.description   = "Write single page HTML documents with ease"
+
+  s.files         = `git ls-files`.split("\n")
+  #s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = ["dove"]
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'redcarpet', '~> 2.3.0'
+  s.add_dependency 'tilt', '~> 1.4.1'
+  s.add_dependency 'slim', '~> 2.0'
+  s.add_dependency 'rouge', '~> 0.3.7'
+end

data/lib/dove.rb

@@ -0,0 +1,47 @@
+require 'redcarpet'
+require 'tilt'
+require 'slim'
+require 'yaml'
+require 'rouge'
+require 'dove/rougify'
+
+class Dove
+  def initialize(filename, options ={})
+    @file = filename
+
+    # When `block` is given, it must read the contents of the file using
+    # whatever means necessary and return it as a string. With no `block`,
+    # the file is read to retrieve data.
+    @data, @yaml_data = extract_yaml(if block_given? then yield else File.read(filename) end)
+
+    @options =  {
+      :output_dir    => '.',
+      :template_file => "#{File.dirname(__FILE__)}/dove/layout.slim",
+      #:stylesheet    => 'styles.css'
+    }.merge(options)
+  end
+
+  # Extracts the YAML frontmatter.
+  def extract_yaml text
+    if md = text.match(/\A(---\s*\n.*?\n?)^(---\s*$\n?)/m)
+      [md.post_match, YAML.load(md[1])]
+    else
+      [text, {}]
+    end
+  end
+
+  # Renders the Markdown file and inserts it into the layout.
+  def render
+    extensions = {
+      autolink:            true,
+      space_after_headers: true,
+      fenced_code_blocks:  true,
+      lax_spacing:         true,
+      strikethrough:       true,
+      superscript:         true,
+      no_intra_emphasis:   true 
+    }
+    markdown = Redcarpet::Markdown.new(Rougify, extensions)
+    Tilt.new(@options[:template_file], {pretty: true}).render(Object.new, @yaml_data) { markdown.render(@data) }
+  end
+end

data/lib/dove/layout.slim

@@ -0,0 +1,12 @@
+doctype html
+html
+  head
+    meta charset="utf-8"
+    title = title
+    link rel='stylesheet' type='text/css' href='styles.css'
+    link rel='stylesheet' type='text/css' href='http://fonts.googleapis.com/css?family=Source+Sans+Pro'
+
+  body
+    header = title
+    article == yield
+    footer Copyright © #{Time.now.year} #{author}

data/lib/dove/rougify.rb

@@ -0,0 +1,4 @@
+require 'rouge/plugins/redcarpet'
+class Rougify < Redcarpet::Render::HTML
+  include Rouge::Plugins::Redcarpet # use Rouge with Redcarpet
+end

data/lib/dove/version.rb

@@ -0,0 +1,3 @@
+class Dove
+  VERSION = '0.1.1'
+end

data/styles.css

@@ -0,0 +1,241 @@
+/* http://meyerweb.com/eric/tools/css/reset/
+   v2.0 | 20110126
+   License: none (public domain)
+*/
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  font: inherit;
+  vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+  display: block;
+}
+body {
+  line-height: 1;
+}
+ol, ul {
+  list-style: none;
+}
+blockquote, q {
+  quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: '';
+  content: none;
+}
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+
+/* END reset.css */
+
+a {
+  color: hsl(235, 65%, 64%);
+  border-bottom: 1px solid;
+  text-decoration: none;
+}
+a:hover {
+  color: hsl(235, 65%, 84%);
+}
+
+h1, h2, h3, h4, h5, h6 {
+  margin: 1em 0 15px;
+  font-family: inherit;
+  font-weight: bold;
+  line-height: 20px;
+  color: #222;
+  text-rendering: optimizeLegibility;
+}
+
+h1, h2, h3 {line-height: 40px}
+h1 {font-size: 38.5px}
+h2 {font-size: 31.5px}
+h3 {font-size: 24.5px}
+h4 {font-size: 17.5px}
+h5 {font-size: 14px}
+h6 {font-size: 11.9px}
+
+h1 {border-bottom: 1px solid #ddd}
+h2 {border-bottom: 1px solid #eee}
+
+p, ul, ol {
+  margin: 0 0 1em;
+  line-height: 1.6;
+}
+
+em {font-style: italic}
+
+strong {font-weight: bold; color: #444;}
+
+code, pre {
+  /* colors match the Tomorrow Night rouge theme */
+  background-color: #1d1f21;
+  color: #c5c8c6;
+  padding: 2px 5px;
+  margin: 0 0 20px;
+  font-size: 14px;
+  font-family: Monaco, courier, monospace;
+  -webkit-font-smoothing: antialiased;
+  overflow: auto;
+  border-radius: 3px;
+  line-height: 1.35;
+}
+
+pre {
+  display: block;
+  padding: 10px 15px;
+}
+
+blockquote {
+  font-size: 14px;
+  line-height: 22px;
+  color: #777;
+  margin: 10px;
+  padding-left: 15px;
+  border-left: 1px solid #ccc;
+}
+
+ul, ol {margin-left: 20px;}
+ul li {list-style-type: square;}
+ol li {list-style-type: decimal;}
+
+
+/* superscript and subscript https://gist.github.com/unruthless/413930 */
+sub, sup {
+  /* Specified in % so that the sup/sup is the
+     right size relative to the surrounding text */
+  font-size: 75%;
+ 
+  /* Zero out the line-height so that it doesn't
+     interfere with the positioning that follows */
+  line-height: 0;
+ 
+  /* Where the magic happens: makes all browsers position
+     the sup/sup properly, relative to the surrounding text */
+  position: relative;
+ 
+  /* Note that if you're using Eric Meyer's reset.css, this
+     is already set and you can remove this rule */
+  vertical-align: baseline;
+}
+ 
+sup {
+  /* Move the superscripted text up */
+  top: -0.5em;
+}
+ 
+sub {
+  /* Move the subscripted text down, but only
+     half as far down as the superscript moved up */
+  bottom: -0.25em;
+}
+
+/* styles */
+
+body {
+  font-family: Source Sans Pro;
+  color: #666;
+  max-width: 720px;
+  margin: 15px auto;
+}
+
+header {
+  color: hsl(235, 65%, 64%);
+  font-weight: 900;
+  font-size: 80px;
+  text-align: center;
+  margin: 10px 0 50px;
+}
+
+footer {
+  margin: 50px 0 20px;
+  font-size: 12px;
+  text-align: center;
+}
+
+/* Modified Tomorrow Again color scheme -- https://github.com/MozMorris/tomorrow-pygments*/
+.highlight .hll { background-color: #373b41 }
+.highlight  { background: #1d1f21; color: #c5c8c6 }
+.highlight .c { color: #969896 } /* Comment */
+.highlight .err { color: #cc6666 } /* Error */
+.highlight .k { color: #b294bb } /* Keyword */
+.highlight .l { color: #de935f } /* Literal */
+.highlight .n { color: #c5c8c6 } /* Name */
+.highlight .o { color: #c5c8c6 } /* Operator */
+.highlight .p { color: #c5c8c6 } /* Punctuation */
+.highlight .cm { color: #969896 } /* Comment.Multiline */
+.highlight .cp { color: #969896 } /* Comment.Preproc */
+.highlight .c1 { color: #969896 } /* Comment.Single */
+.highlight .cs { color: #969896 } /* Comment.Special */
+.highlight .gd { color: #cc6666 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gh { color: #c5c8c6; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #b5bd68 } /* Generic.Inserted */
+.highlight .gp { color: #969896; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #8abeb7; font-weight: bold } /* Generic.Subheading */
+.highlight .kc { color: #b294bb } /* Keyword.Constant */
+.highlight .kd { color: #b294bb } /* Keyword.Declaration */
+.highlight .kn { color: #8abeb7 } /* Keyword.Namespace */
+.highlight .kp { color: #b294bb } /* Keyword.Pseudo */
+.highlight .kr { color: #b294bb } /* Keyword.Reserved */
+.highlight .kt { color: #f0c674 } /* Keyword.Type */
+.highlight .ld { color: #b5bd68 } /* Literal.Date */
+.highlight .m { color: #de935f } /* Literal.Number */
+.highlight .s { color: #b5bd68 } /* Literal.String */
+.highlight .na { color: #81a2be } /* Name.Attribute */
+.highlight .nb { color: #c5c8c6 } /* Name.Builtin */
+.highlight .nc { color: #f0c674 } /* Name.Class */
+.highlight .no { color: #cc6666 } /* Name.Constant */
+.highlight .nd { color: #8abeb7 } /* Name.Decorator */
+.highlight .ni { color: #c5c8c6 } /* Name.Entity */
+.highlight .ne { color: #cc6666 } /* Name.Exception */
+.highlight .nf { color: #81a2be } /* Name.Function */
+.highlight .nl { color: #c5c8c6 } /* Name.Label */
+.highlight .nn { color: #f0c674 } /* Name.Namespace */
+.highlight .nx { color: #81a2be } /* Name.Other */
+.highlight .py { color: #c5c8c6 } /* Name.Property */
+.highlight .nt { color: #b294bb } /* Name.Tag */
+.highlight .nv { color: #cc6666 } /* Name.Variable */
+.highlight .ow { color: #8abeb7 } /* Operator.Word */
+.highlight .w { color: #c5c8c6 } /* Text.Whitespace */
+.highlight .mf { color: #de935f } /* Literal.Number.Float */
+.highlight .mh { color: #de935f } /* Literal.Number.Hex */
+.highlight .mi { color: #de935f } /* Literal.Number.Integer */
+.highlight .mo { color: #de935f } /* Literal.Number.Oct */
+.highlight .sb { color: #b5bd68 } /* Literal.String.Backtick */
+.highlight .sc { color: #c5c8c6 } /* Literal.String.Char */
+.highlight .sd { color: #969896 } /* Literal.String.Doc */
+.highlight .s2 { color: #b5bd68 } /* Literal.String.Double */
+.highlight .se { color: #de935f } /* Literal.String.Escape */
+.highlight .sh { color: #b5bd68 } /* Literal.String.Heredoc */
+.highlight .si { color: #de935f } /* Literal.String.Interpol */
+.highlight .sx { color: #b5bd68 } /* Literal.String.Other */
+.highlight .sr { color: #b5bd68 } /* Literal.String.Regex */
+.highlight .s1 { color: #b5bd68 } /* Literal.String.Single */
+.highlight .ss { color: #b5bd68 } /* Literal.String.Symbol */
+.highlight .bp { color: #c5c8c6 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #cc6666 } /* Name.Variable.Class */
+.highlight .vg { color: #cc6666 } /* Name.Variable.Global */
+.highlight .vi { color: #cc6666 } /* Name.Variable.Instance */
+.highlight .il { color: #de935f } /* Literal.Number.Integer.Long */

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: dove
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Blaž Hrastnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+description: Write single page HTML documents with ease
+email:
+- speed.the.bboy@gmail.com
+executables:
+- dove
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- bin/dove
+- dove.gemspec
+- lib/dove.rb
+- lib/dove/layout.slim
+- lib/dove/rougify.rb
+- lib/dove/version.rb
+- styles.css
+homepage: https://github.com/archSeer/dove
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Write single page HTML documents with ease
+test_files: []
+has_rdoc: