revealing 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ce7e4c5d36c9c49bd0706ab1e5144e3caf5f6eea1f78dcfd755380529e469da
-  data.tar.gz: a3eb4ee20c3114bfea423f0bfb0ca9d2bc1f8b19c6a0d8bfac49966143fa83a9
+  metadata.gz: d47824e706f740bb4bd389506532615d0f27c64d3c222ac24ba9a5edfc9b7ec2
+  data.tar.gz: 37502d62f798b59acbd06b9e9a37bf62eb82bac0753bf1fa2e84594a29b7e40f
 SHA512:
-  metadata.gz: 077c15b028cb74513e68703500c2a5842df05b32927b7ebe230e0ba3a9d438f1e9704c8d7d3811eafaa3a935e8e95616610ae87a1886bd2b431aa696a5398c1e
-  data.tar.gz: c3044633f92ae7679ab6f72f6a8af1524b802d8ae42d77896b74966985c5063847b4df9d25cf01239534a7095330ab85ec3fb814701cf198c5f7fa93b594c2b8
+  metadata.gz: 91b2f7a00c4b60d06f0d81a59ffc43383272857cbaeb7f768091e101f17ff859c47cbcc6091843b111dff1ab899df7be1756c2a4fd49cf51f9d6d7c514dcfc1b
+  data.tar.gz: b10369ffc6c16f1e64635ac80998358a280eab4675c6e4a1279b89c2a21d44745d780394a8e0fe237af7327659d3849b20f205929936542f2a1a7b8409c81e73

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format documentation
+--tty
+--order random
+--require 'spec_helper'

data/Gemfile

@@ -1,2 +1,2 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/README.markdown

@@ -1,5 +1,7 @@
 # `revealing` - A Workflow for reveal.js Presentations
 
+[![Build Status](https://travis-ci.org/suhlig/revealing.svg?branch=master)](https://travis-ci.org/suhlig/revealing)
+
 This gem provides a set of [`Rake`](https://github.com/ruby/rake) tasks to create [`reveal.js`](https://revealjs.com) presentations from markdown files. It uses [`pandoc`](https://pandoc.org/) to create the final presentation. The output is a self-contained set of static HTML files that can be viewed locally uploaded to a web server.
 
 # Examples
@@ -9,18 +11,31 @@ This gem provides a set of [`Rake`](https://github.com/ruby/rake) tasks to creat
 # Development
 
 * Create a test project using `revealing init`
-* Update `revealing` locally with this one-liner:
+* Test by referring to the changed tasks:
+  ```console
+  rake -f ~/workspace/revealing/lib/revealing/tasks.rb -T
+  ```
+
+# Releasing
+
+* Make the changes
+* Run tests
+* From a test project, install the updated gem locally and invoke it:
   ```console
-  $ (cd ../revealing; git add .; bake install) && bundle update && bake -T
+  $ (cd ../revealing; git add .; bake install) && bundle update && bake clobber default
   ```
-* Test changes in the test project
+  Verify that everything works.
+* Bump the version in `lib/revealing/version.rb`
+* git commit
+* `gem signin` to rubygems.org
+* `bundle exec rake release`
 
 # TODO
 
-1. Bail if any of the prereq tools are not there
 1. `revealing doctor` to analyze tools
 1. Target folders mirror source, so that we don't risk duplicates
 1. Read desired versions of dependencies from a YAML file (with sensible defaults coming from this project)
+1. Re-add ditaa processing
 1. Add mathjax (copy to target if present, otherwise use CDN)
 1. Expose customization of
    * highlight-style

data/lib/revealing/cli.rb

@@ -1,14 +1,39 @@
 require 'thor'
+require 'pathname'
 
 module Revealing
   class CLI < Thor
-    desc 'init DIRECTORY', "initialize a new revealing project in DIRECTORY."
-    def init(directory)
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'init [DIRECTORY]', 'initialize a new revealing project in DIRECTORY. Defaults to the current working directory.'
+    def init(directory = '.')
       project_directory = Pathname(directory)
-      project_directory.mkdir
+      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|
+        if target.exist?
+          warn "#{target} exists; skipping"
+        else
+          target.dirname.mkpath
+          FileUtils.cp(src, target)
+          puts "#{target} created"
+        end
+      end
+    end
+
+    private
 
-      templates_directory = Pathname(__dir__) / '../../templates'
-      FileUtils.cp_r(templates_directory / 'init/.', project_directory)
+    def source_target_pairs(src_dir, target_dir)
+      src_dir
+        .glob('**/*')
+        .select(&:file?)
+        .map{|e| [e, target_dir / e.relative_path_from(src_dir)]}
     end
   end
 end

data/lib/revealing/tasks/assets.rake

@@ -1,13 +1,15 @@
+prereq 'gm'
+
 RESIZED_ASSETS.zip(RESIZABLE_ASSETS).each do |target, source|
   desc "Resize #{source} to #{target}"
-  file target => source do
+  file target => ['gm', source] do
     sh "gm convert #{source} -geometry '1920x1080>' #{target}"
   end
 end
 
 ASSETS.zip(ASSET_SOURCES).each do |target, source|
   desc "Copy #{source} to #{target}"
-  file target => source do
+  file target => ['gm', source] do
     cp source, target
   end
 end

data/lib/revealing/tasks/gpp.rake

@@ -1,4 +1,6 @@
+prereq 'gpp'
+
 desc "Sources are pre-processed into the single #{GPP_FILE}"
-file GPP_FILE => [GPP_DIR, DIRTY_FILE] + SOURCE_FILES do |target|
+file GPP_FILE => ['gpp', GPP_DIR, DIRTY_FILE] + SOURCE_FILES do |target|
   sh %(gpp -I src -x -o #{target} #{SOURCE_DIR}/index.markdown)
 end

data/lib/revealing/tasks/prereq.rake

@@ -0,0 +1,11 @@
+#
+# Synthesize a task that ensures that the given prerequisite tool is available
+#
+def prereq(name)
+  desc "Assert that #{name} is available"
+  task name do |task|
+    unless system("type #{name} > /dev/null 2>&1")
+      raise "#{task} is not available. Use `revealing doctor` to assist fixing."
+    end
+  end
+end

data/lib/revealing/tasks/reveal.js.rake

@@ -1,7 +1,8 @@
 REVEAL_JS_VERSION = '3.7.0'.freeze
+prereq 'curl'
 
 desc 'reveal.js is present'
-directory REVEAL_JS_TARGET_DIR => TARGET_DIR do |target|
+directory REVEAL_JS_TARGET_DIR => ['curl', TARGET_DIR] do |target|
   mkdir target.name
 
   if ENV['REVEAL_JS_DIR'].to_s.empty?

data/lib/revealing/tasks.rb

@@ -3,7 +3,7 @@ require 'pathname'
 require 'git-dirty'
 
 SOURCE_DIR = Pathname('src')
-SOURCE_FILES = FileList["#{SOURCE_DIR}/**/*.markdown"]
+SOURCE_FILES = FileList[SOURCE_DIR / '**/*.markdown']
 
 TARGET_DIR = Pathname('public_html')
 directory TARGET_DIR
@@ -12,7 +12,7 @@ TARGET_FILE = TARGET_DIR / 'index.html'
 GPP_DIR = Pathname('gpp')
 directory GPP_DIR
 DIRTY_FILE = GPP_DIR / '.dirty'
-GPP_FILE = FileList["#{GPP_DIR}/index.markdown"]
+GPP_FILE = FileList[GPP_DIR / 'index.markdown']
 
 CLEAN.include GPP_DIR, DIRTY_FILE
 CLOBBER.include TARGET_DIR
@@ -20,20 +20,22 @@ CLOBBER.include TARGET_DIR
 REVEAL_JS = 'reveal.js'.freeze
 REVEAL_JS_TARGET_DIR = TARGET_DIR / REVEAL_JS
 
-RESIZABLE_ASSETS = (FileList[SOURCE_DIR / "**/*.png"] + FileList[SOURCE_DIR / "**/*.jpg"])
+RESIZABLE_ASSETS = (FileList[SOURCE_DIR / '**/*.png'] + FileList[SOURCE_DIR / '**/*.jpg'])
 RESIZED_ASSETS = RESIZABLE_ASSETS.pathmap("#{TARGET_DIR}/%f")
-ASSET_SOURCES = FileList[SOURCE_DIR / "*"] - RESIZABLE_ASSETS - SOURCE_FILES
+ASSET_SOURCES = FileList[SOURCE_DIR / '*'] - RESIZABLE_ASSETS - SOURCE_FILES
 ASSETS = ASSET_SOURCES.pathmap("#{TARGET_DIR}/%f") - RESIZED_ASSETS
-HEADERS = FileList["headers/*"] # These are included literal; no need to copy them
+HEADERS = FileList['headers/*'] # These are included literal; no need to copy them
 
+load "#{__dir__}/tasks/prereq.rake"
 load "#{__dir__}/tasks/gpp.rake"
 load "#{__dir__}/tasks/assets.rake"
 load "#{__dir__}/tasks/reveal.js.rake"
 
 git_dirty_file DIRTY_FILE
+prereq 'pandoc'
 
 desc "Build #{TARGET_FILE}"
-file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILE, DIRTY_FILE ] + ASSETS + RESIZED_ASSETS + HEADERS do
+file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILE, DIRTY_FILE, 'pandoc'] + ASSETS + RESIZED_ASSETS + HEADERS do
   sh %(pandoc
       --to=revealjs
       --standalone

data/lib/revealing/version.rb

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

data/templates/init/README.markdown

@@ -5,7 +5,6 @@ This is the source of New Presentation. It was generated with [`revealing`](http
 # Features
 
 * Images are resized for the web using [`graphicsmagick`](http://www.graphicsmagick.org/)
-* Embedded [`ditaa`](http://ditaa.sourceforge.net/) snippets are rendered to images
 * `#include` and other [`gpp`](https://logological.org/gpp) features allow organizing the sources of complex presentations
 * Files in the `headers` folder are included verbatim in the HTML `<head>` section
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revealing
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Steffen Uhlig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-14 00:00:00.000000000 Z
+date: 2019-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -134,6 +134,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - Gemfile
 - README.markdown
@@ -143,6 +144,7 @@ files:
 - lib/revealing/tasks.rb
 - lib/revealing/tasks/assets.rake
 - lib/revealing/tasks/gpp.rake
+- lib/revealing/tasks/prereq.rake
 - lib/revealing/tasks/reveal.js.rake
 - lib/revealing/version.rb
 - revealing.gemspec