revealing 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcbd8c769d938e3504cc380edd46cbd7288a63271829da2faf8b2ef41b1c9b62
-  data.tar.gz: b602ba7250675cc5b761b5edd9b35606ce5f85cc6770f343147425f3650b4574
+  metadata.gz: d42e25725650911b0db7d824e93ea671948f801b35c919fcbc72961c1a2bb7ab
+  data.tar.gz: 76c6b2cd5acfd1e9e5e973d33c387cdde943a2e157490e14d4140196820d55f3
 SHA512:
-  metadata.gz: d6a9a2d429485905ac7f191d211485739a7ee83c3382c7bf3221ed71fb0036c2b0bb5244adfb48475c90e01afcebb9bf88feb0502ffed425b51bfb559ef7c39b
-  data.tar.gz: 42729979c92eaa079cdb2881c592c3a62d08704efaf799c5caa6791b9fcacce9a6351a6db8ecc463ad71bdbc86f65516989b73c63390c5beb6af30a12d77d71a
+  metadata.gz: 6769159967e6aa9892b7fbff20c5bf6370e5ff2ec1e6528f87ffae83ade885f95e74bcb5ba04b0419087f27bf3a66de67eb5a305ef97540e478025df717db97a
+  data.tar.gz: a7255e38b81b155dbd5c414b00a02bcdd54894a4f6400cc7c3f247ba3c9140db1d22ce5733920cf85a48aa4f4cd13dd61cdfcc8b13d7983c39711f09919b16d3

data/.overcommit.yml

@@ -0,0 +1,33 @@
+# Extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+
+PreCommit:
+  BundleCheck:
+    enabled: true
+  LocalPathsInGemfile:
+    enabled: true
+  RakeTarget:
+    enabled: true
+    targets:
+      - rubocop
+      - spec:unit
+  TrailingWhitespace:
+    enabled: true
+
+PostCheckout:
+  BundleInstall:
+    enabled: true
+
+PostMerge:
+  BundleInstall:
+    enabled: true
+
+PostRewrite:
+  BundleInstall:
+    enabled: true
+
+PrePush:
+  RakeTarget:
+    enabled: true
+    targets:
+      - default

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.2
+ruby-2.6.3

data/README.markdown

@@ -37,8 +37,10 @@ Unique features:
 
 # TODO
 
-1. `doctor` checks that all the template files are present
-1. Treat mathjax config as yet another header file
+1. Expose DITAA's `--scale` via attribute
+1. PR homebrew's [ditaa](https://github.com/Homebrew/homebrew-core/blob/master/Formula/ditaa.rb) to use `-Djava.awt.headless=true`
+1. pandoc-ditaa-inline filter should write files to cache dir and read it from there via SHA
+   - still keep the SVG inline, but do not call ditaa again if unchanged
 1. Expose customization of
    * highlight-style
    * theme

data/lib/revealing/cli.rb

@@ -5,6 +5,7 @@ require_relative 'prerequisite'
 module Revealing
   PREREQUISITES = [
     Prerequisite.new('curl'),
+    Prerequisite.new('ditaa'),
     Prerequisite.new('gm', 'graphicsmagick'),
     Prerequisite.new('gpp'),
     Prerequisite.new('pandoc'),
@@ -17,13 +18,29 @@ module Revealing
 
     desc 'doctor', 'Checks whether your system is fit for revealing.'
     def doctor
-      PREREQUISITES.each do |tool|
-        if tool.available?
-          puts "OK: #{tool} is available."
-        else
-          warn "Error: #{tool.command} is not available. Install it using `#{tool.install_hint}`."
+      anything_missing = false
+      missing_tools = PREREQUISITES.reject(&:available?)
+
+      if missing_tools.any?
+        anything_missing = true
+        warn 'Error: The following required tools are not available:'
+        missing_tools.each do |tool|
+          warn "  * #{tool} - install it with `#{tool.install_hint}`"
         end
       end
+
+      missing_files = target_files_in(Pathname.getwd).reject(&:exist?)
+
+      if missing_files.any?
+        anything_missing = true
+        warn 'Error: The following files do not exist:'
+        missing_files.each do |missing|
+          warn "  * #{missing.relative_path_from(Pathname.getwd)}"
+        end
+        warn 'Consider running `revealing init` to create them.'
+      end
+
+      exit 1 if anything_missing
     end
 
     desc 'init [DIRECTORY]', 'initialize a new revealing project in DIRECTORY. Defaults to the current working directory.'
@@ -31,11 +48,9 @@ module Revealing
       project_directory = Pathname(directory)
       project_directory.mkdir unless project_directory.exist?
 
-      templates_directory = Pathname(__dir__) / '../../templates/init'
-
       # FileUtils.cp_r overwrites the target if it exists, but we want to preserve it
       # and print information about what happened
-      source_target_pairs(templates_directory, project_directory).each do |src, target|
+      template_files.zip(target_files_in(project_directory)).each do |src, target|
         if target.exist?
           warn "#{target} exists; skipping"
         else
@@ -46,13 +61,22 @@ module Revealing
       end
     end
 
+    desc 'version', 'Prints version information'
+    def version
+      puts "revealing #{Revealing::VERSION}"
+    end
+    map %w(-V --version) => :version
+
     private
 
-    def source_target_pairs(src_dir, target_dir)
-      src_dir
-        .glob('**/*')
-        .select(&:file?)
-        .map{|e| [e, target_dir / e.relative_path_from(src_dir)]}
+    TEMPLATES_DIR = Pathname(__dir__) / '../../templates'
+
+    def template_files
+      TEMPLATES_DIR.glob('**/*').select(&:file?)
+    end
+
+    def target_files_in(dir)
+      template_files.map{|f| dir / f.relative_path_from(TEMPLATES_DIR)}
     end
   end
 end

data/lib/revealing/tasks.rb

@@ -51,9 +51,9 @@ file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILE, DIRTY_FILE, ME
       --variable history=true
       --variable revealjs-url=#{REVEAL_JS}
       --mathjax=https://cdnjs.cloudflare.com/ajax/libs/mathjax/#{MATH_JAX_VERSION}/MathJax.js?config=TeX-AMS_CHTML-full
-      --include-in-header=#{__dir__ + '/../../templates/mathjax/config.js'}
       "--metadata-file=#{METADATA_FILE.to_path}"
       #{HEADERS.map { |h| "--include-in-header=#{h}" }.join("\n")}
+      --lua-filter #{__dir__}/../../tools/pandoc-ditaa-inline/ditaa-inline.lua
     #{GPP_FILE}
   ).split("\n").join(' ')
 end

data/lib/revealing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Revealing
-  VERSION = '1.2.0'
+  VERSION = '1.4.0'
 end

data/revealing.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-bundler'
   spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'overcommit'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rspec'

data/tools/pandoc-ditaa-inline/README.markdown

@@ -0,0 +1,30 @@
+# Pandoc Filter for DITAA
+
+Turns inline DITAA diagrams into SVG. Needs a local installation of ditaa, e.g. `brew install ditaa`.
+
+# Example
+
+Given this markdown document (note the DITAA block) saved as `example.markdown`
+
+```markdown
+The following graph shows two boxes, connected:
+
+```ditaa
++-----+   +-----+
+|  A  |-->|  B  |
++-----+   +-----+
+ ```
+
+As you can see, ditaa renders that quite pretty. It's turned into an embedded SVG.
+
+```
+
+The following command turns the DITAA block into SVG, embedded in the HTML:
+
+```command
+$ pandoc --lua-filter ditaa-inline.lua --out example.html example.markdown
+```
+
+The result looks like this:
+
+![](example.png)

data/tools/pandoc-ditaa-inline/ditaa-inline.lua

@@ -0,0 +1,6 @@
+function CodeBlock(block)
+  if block.classes[1] == "ditaa" then
+    local img = pandoc.pipe("ditaa", {"-", "-", "--svg", "--scale", "1.0"}, block.text)
+    return pandoc.Para({pandoc.RawInline("html", img)})
+  end
+end

data/tools/pandoc-ditaa-inline/examples/README.markdown

@@ -0,0 +1,25 @@
+# Example
+
+Given this markdown document (note the DITAA block) saved as `example.markdown`:
+
+```markdown
+The following graph shows two boxes, connected:
+
+```ditaa
++-----+   +-----+
+|  A  |-->|  B  |
++-----+   +-----+
+ ```
+
+As you can see, ditaa renders that quite pretty. It's turned into an embedded SVG.
+```
+
+The following command turns the DITAA block into SVG, embedded in the HTML:
+
+```command
+$ pandoc --lua-filter ditaa-inline.lua --out example.html example.markdown
+```
+
+The result looks like this:
+
+![](example.png)

data/tools/pandoc-ditaa-inline/examples/example.html

@@ -0,0 +1,31 @@
+<p>The following graph shows two boxes, connected:</p>
+<p><?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<svg
+    xmlns='http://www.w3.org/2000/svg'
+    width='210'
+    height='98'
+    shape-rendering='geometricPrecision'
+    version='1.0'>
+  <defs>
+    <filter id='f2' x='0' y='0' width='200%' height='200%'>
+      <feOffset result='offOut' in='SourceGraphic' dx='5' dy='5' />
+      <feGaussianBlur result='blurOut' in='offOut' stdDeviation='3' />
+      <feBlend in='SourceGraphic' in2='blurOut' mode='normal' />
+    </filter>
+  </defs>
+  <g stroke-width='1' stroke-linecap='square' stroke-linejoin='round'>
+    <rect x='0' y='0' width='210' height='98' style='fill: #ffffff'/>
+    <path stroke='gray' fill='gray' filter='url(#f2)' d='M25.0 35.0 L25.0 63.0 L85.0 63.0 L85.0 35.0 z' />
+    <path stroke='gray' fill='gray' filter='url(#f2)' d='M125.0 63.0 L185.0 63.0 L185.0 35.0 L125.0 35.0 z' />
+    <path stroke='#000000' stroke-width='1,000000' stroke-linecap='round' stroke-linejoin='round' fill='white' d='M25.0 35.0 L25.0 63.0 L85.0 63.0 L85.0 35.0 z' />
+    <path stroke='#000000' stroke-width='1,000000' stroke-linecap='round' stroke-linejoin='round' fill='white' d='M125.0 63.0 L185.0 63.0 L185.0 35.0 L125.0 35.0 z' />
+    <path stroke='none' stroke-width='1,000000' stroke-linecap='round' stroke-linejoin='round' fill='#000000' d='M110.0 42.0 L120.0 49.0 L110.0 56.0 z' />
+    <path stroke='#000000' stroke-width='1,000000' stroke-linecap='round' stroke-linejoin='round' fill='none' d='M115.0 49.0 L95.0 49.0 ' />
+    <text x='52' y='54' font-family='Courier' font-size='15' stroke='none' fill='#000000' ><![CDATA[A ]]></text>
+    <text x='153' y='54' font-family='Courier' font-size='15' stroke='none' fill='#000000' ><![CDATA[B ]]></text>
+  </g>
+</svg></p>
+<p>As you can see, ditaa renders that quite pretty. It’s turned into an embedded SVG.</p>
+<p>Other blocks are left untouched:</p>
+<div class="sourceCode" id="cb1"><pre class="sourceCode ruby"><code class="sourceCode ruby"><a class="sourceLine" id="cb1-1" title="1">puts <span class="st">&quot;olleH&quot;</span>.reverse</a></code></pre></div>
+<p>That’s it!</p>

data/tools/pandoc-ditaa-inline/examples/example.markdown

@@ -0,0 +1,17 @@
+The following graph shows two boxes, connected:
+
+```ditaa
++-----+   +-----+
+|  A  |-->|  B  |
++-----+   +-----+
+```
+
+As you can see, ditaa renders that quite pretty. It's turned into an embedded SVG.
+
+Other blocks are left untouched:
+
+```ruby
+puts "olleH".reverse
+```
+
+That's it!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revealing
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Steffen Uhlig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-19 00:00:00.000000000 Z
+date: 2019-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +204,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -207,12 +222,18 @@ files:
 - lib/revealing/tasks/reveal.js.rake
 - lib/revealing/version.rb
 - revealing.gemspec
-- templates/init/Gemfile
-- templates/init/README.markdown
-- templates/init/Rakefile
-- templates/init/metadata.yml
-- templates/init/src/index.markdown
-- templates/mathjax/config.js
+- templates/Gemfile
+- templates/README.markdown
+- templates/Rakefile
+- templates/headers/mathjax.js
+- templates/metadata.yml
+- templates/src/index.markdown
+- tools/pandoc-ditaa-inline/README.markdown
+- tools/pandoc-ditaa-inline/ditaa-inline.lua
+- tools/pandoc-ditaa-inline/examples/README.markdown
+- tools/pandoc-ditaa-inline/examples/example.html
+- tools/pandoc-ditaa-inline/examples/example.markdown
+- tools/pandoc-ditaa-inline/examples/example.png
 homepage: 
 licenses:
 - MIT