revealing 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f93791c0c42b0dbaf8e93d8828e1ef8816a52699099831e86e5add1984e24a86
+  data.tar.gz: 1275b597fa40be2c4b90b09bd7bbdaa9a1b0b8c65b547ce68fe804394c2f5697
+SHA512:
+  metadata.gz: f04d91887e6a4e36f0325b85a7fca0614ce05a4aa74d6d06c7f7d2d871ebbf20a38151a0cb12bf4d9dac0030af465752552a0c996795cfe80d6e661f981fe648
+  data.tar.gz: 244beb58f974520d3107a4a12c83283fb1f6aa14fd50e6d8b5d3ea5a3a871691af2219bba4fad0cba4a40b707159a620e4cce7c50edf9c6b6dde5fab4e36e913

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,33 @@
+# `revealing` - A Workflow for reveal.js Presentations
+
+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.
+
+Additional 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
+
+# Examples
+
+* [Zero to CF in Kube-Cluster in 30 Seconds with Concourse, Helm, Fissile and Eirini](http://zero2cfin30s.eirini.cf/) (source: [suhlig/zero-to-cf-in-30-seconds](https://github.com/suhlig/zero-to-cf-in-30-seconds))
+
+# TODO
+
+1. Can the default task still be overridden in projects?
+1. Bail if any of the prereq tools are not there
+1. Keep assets in their source folders
+1. What happens if `customizations.css` is not there?
+1. `revealing init` creates a new project with the right structure, already `git init`-ed
+1. Target folders mirror source, so that we don't risk duplicates
+1. Expose customization of
+   * highlight-style
+   * slide-level
+   * theme
+   * slideNumber
+   * history
+1. Read desired versions of dependencies from a YAML file (with sensible defaults coming from this project)
+1. Add mathjax (copy to target if present, otherwise use CDN)
+1. Provide a docker image so that we can run without installing everything
+1. PDF output
+1. Web interface for live editing

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/exe/revealing

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+warn <<EOM
+TBD:
+* git init (at . or at given dir)
+* create src/index.markdown
+* create Gemfile
+* create Rakefile
+* say that 'rake --tasks' is the next thing to do
+EOM

data/exe/revealing-task

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+# probably obsolete
+
+require 'rake'
+require 'bundler'
+raise "Bundler is required.  Please install bundler with 'gem install bundler'" unless defined?(Bundler)
+
+Bundler.setup
+app = Rake.application
+
+app.init
+# Pathname(__dir__).parent.glob('{lib/**/*.rake}').each { |t| load t }
+require 'revealing/tasks'
+
+tasks = app.tasks
+if ARGV.empty?
+  warn "Missing task. Expect one of #{tasks.join(", ")}"
+  exit 1
+end
+
+task = ARGV[0]
+
+if ! tasks.include?(task)
+  warn "No such task: #{task}"
+  exit 1
+end
+
+app.invoke_task(task)

data/lib/revealing/tasks/assets.rake

@@ -0,0 +1,13 @@
+RESIZED_ASSETS.zip(RESIZABLE_ASSETS).each do |target, source|
+  desc "Resize #{source} to #{target}"
+  file target => 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
+    cp source, target
+  end
+end

data/lib/revealing/tasks/gpp.rake

@@ -0,0 +1,4 @@
+desc "Sources are pre-processed into #{TARGET_DIR}"
+file "#{GPP_DIR}/index.markdown" => [GPP_DIR, DIRTY_FILE] + FileList["#{SOURCE_DIR}/**/*.markdown"] do |target|
+  sh %(gpp -I src -x -o #{target} #{SOURCE_DIR}/index.markdown)
+end

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

@@ -0,0 +1,12 @@
+desc 'reveal.js is present'
+directory REVEAL_JS_TARGET_DIR => TARGET_DIR do |target|
+  mkdir target.name
+
+  if ENV['REVEAL_JS_DIR'].to_s.empty?
+    warn "Downloading reveal.js #{REVEAL_JS_VERSION}. Set REVEAL_JS_DIR in order to use a cached version."
+    sh "curl --location https://github.com/hakimel/reveal.js/archive/#{REVEAL_JS_VERSION}.tar.gz | tar xz -C #{target.name} --strip-components 1"
+  else
+    warn "Using cached version of reveal.js from #{ENV['REVEAL_JS_DIR']}"
+    cp_r FileList["#{ENV['REVEAL_JS_DIR']}/."], target.name, remove_destination: true
+  end
+end

data/lib/revealing/tasks.rb

@@ -0,0 +1,51 @@
+require 'rake/clean'
+require 'pathname'
+require 'git-dirty'
+
+SOURCE_DIR = 'src'.freeze
+
+TARGET_DIR = Pathname('public_html')
+directory TARGET_DIR
+TARGET_FILE = TARGET_DIR / 'index.html'
+
+GPP_DIR = Pathname('gpp')
+directory GPP_DIR
+DIRTY_FILE = GPP_DIR / '.dirty'
+GPP_FILES = FileList["#{GPP_DIR}/index.markdown"]
+
+CLEAN.include GPP_DIR, DIRTY_FILE
+CLOBBER.include TARGET_DIR
+
+REVEAL_JS = "reveal.js".freeze
+REVEAL_JS_TARGET_DIR = TARGET_DIR / REVEAL_JS
+REVEAL_JS_VERSION = '3.7.0'.freeze
+
+RESIZABLE_ASSETS = (FileList["assets/*.png"] + FileList["assets/*.jpg"])
+RESIZED_ASSETS = RESIZABLE_ASSETS.pathmap("#{TARGET_DIR}/%f")
+ASSET_SOURCES = FileList['assets/*'] - RESIZABLE_ASSETS
+ASSETS = ASSET_SOURCES.pathmap("#{TARGET_DIR}/%f") - RESIZED_ASSETS
+
+load "#{__dir__}/tasks/assets.rake"
+load "#{__dir__}/tasks/reveal.js.rake"
+load "#{__dir__}/tasks/gpp.rake"
+
+git_dirty_file DIRTY_FILE
+
+desc "Build #{TARGET_FILE}"
+file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILES, DIRTY_FILE ] + ASSETS + RESIZED_ASSETS do
+  sh %(pandoc
+      --to=revealjs
+      --standalone
+      --highlight-style zenburn
+      --slide-level=1
+      --output #{TARGET_FILE}
+      --variable theme=white
+      --variable slideNumber=true
+      --variable history=true
+      --variable revealjs-url=#{REVEAL_JS}
+      --include-in-header=#{TARGET_DIR}/customizations.css
+    #{GPP_FILES}
+  ).split("\n").join(' ')
+end
+
+task default: TARGET_FILE

data/lib/revealing/version.rb

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

data/revealing.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'revealing/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = 'revealing'
+  spec.version       = Revealing::VERSION
+  spec.authors       = ['Steffen Uhlig']
+  spec.email         = ['steffen@familie-uhlig.net']
+
+  spec.summary       = 'Rake tasks to for reveal.js presentations'
+  spec.description   = %(Provides a workflow for creating reveal.js
+                         presentations. It uses pandoc to create the
+                         presentation from markdown files.)
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rake'
+  spec.add_dependency 'bundler'
+  spec.add_dependency 'git-dirty'
+end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: revealing
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steffen Uhlig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git-dirty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Provides a workflow for creating reveal.js
+                           presentations. It uses pandoc to create the
+                           presentation from markdown files.
+email:
+- steffen@familie-uhlig.net
+executables:
+- revealing
+- revealing-task
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.markdown
+- Rakefile
+- exe/revealing
+- exe/revealing-task
+- lib/revealing/tasks.rb
+- lib/revealing/tasks/assets.rake
+- lib/revealing/tasks/gpp.rake
+- lib/revealing/tasks/reveal.js.rake
+- lib/revealing/version.rb
+- revealing.gemspec
+homepage: 
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Rake tasks to for reveal.js presentations
+test_files: []