revealing 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f93791c0c42b0dbaf8e93d8828e1ef8816a52699099831e86e5add1984e24a86
-  data.tar.gz: 1275b597fa40be2c4b90b09bd7bbdaa9a1b0b8c65b547ce68fe804394c2f5697
+  metadata.gz: f0862695a5f6c85e4479c243b7c570722d2d332e6cf3441191e4bc7116f70e79
+  data.tar.gz: 2ae6561b8b5408e0eab3503b200036dc45b9976354e620848afc61ea965cdf26
 SHA512:
-  metadata.gz: f04d91887e6a4e36f0325b85a7fca0614ce05a4aa74d6d06c7f7d2d871ebbf20a38151a0cb12bf4d9dac0030af465752552a0c996795cfe80d6e661f981fe648
-  data.tar.gz: 244beb58f974520d3107a4a12c83283fb1f6aa14fd50e6d8b5d3ea5a3a871691af2219bba4fad0cba4a40b707159a620e4cce7c50edf9c6b6dde5fab4e36e913
+  metadata.gz: 252cc7d9a382f4e60a8511a0a55b31cfe9a7e6a3d7875aea385ce329b6acefb7c542b5a7ac2b43d9d6d5ab2905c0f71b54bcfc4153b4122e17d0b3100b3d89d7
+  data.tar.gz: c55292e2e6471d623bcc677e7a21780a9921ceecb0bd39a99fccf99552444c7d08313fa62cf0e1f70d2da8a5cef880f7d76363aeeffeae72cb32785bfeed4b74

data/README.markdown

@@ -2,23 +2,23 @@
 
 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))
 
+# Development
+
+* Create a test project using `revealing init`
+* Update `revealing` locally with this one-liner:
+  ```console
+  $ (cd ../revealing; git add .; bake install) && bundle update && bake -T
+  ```
+* Test changes in the test project
+
 # 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. Bail if any of the prereq tools are not there
 1. Target folders mirror source, so that we don't risk duplicates
 1. Expose customization of
    * highlight-style
@@ -30,4 +30,5 @@ Additional features:
 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. Make the initial set of files more meaningful (e.g. add the project name, `git config user.name` etc.)
 1. Web interface for live editing

data/Rakefile

@@ -1,3 +1,8 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: 'spec'

data/exe/revealing

@@ -1,10 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-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
+require 'revealing/cli'
+
+Revealing::CLI.start(ARGV)

data/lib/revealing/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+
+module Revealing
+  class CLI < Thor
+    desc 'init DIRECTORY', "initialize a new revealing project in DIRECTORY."
+    def init(directory)
+      project_directory = Pathname(directory)
+      project_directory.mkdir
+
+      templates_directory = Pathname(__dir__) / '../../templates'
+      FileUtils.cp_r(templates_directory / 'init/.', project_directory)
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+REVEAL_JS_VERSION = '3.7.0'.freeze
+
 desc 'reveal.js is present'
 directory REVEAL_JS_TARGET_DIR => TARGET_DIR do |target|
   mkdir target.name

data/lib/revealing/tasks.rb

@@ -16,15 +16,16 @@ GPP_FILES = FileList["#{GPP_DIR}/index.markdown"]
 CLEAN.include GPP_DIR, DIRTY_FILE
 CLOBBER.include TARGET_DIR
 
-REVEAL_JS = "reveal.js".freeze
+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
 
+HEADERS = FileList["headers/*"] # These are included literal; no need to copy them
+
 load "#{__dir__}/tasks/assets.rake"
 load "#{__dir__}/tasks/reveal.js.rake"
 load "#{__dir__}/tasks/gpp.rake"
@@ -32,7 +33,7 @@ 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
+file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILES, DIRTY_FILE ] + ASSETS + RESIZED_ASSETS + HEADERS do
   sh %(pandoc
       --to=revealjs
       --standalone
@@ -43,9 +44,7 @@ file TARGET_FILE => [ TARGET_DIR, REVEAL_JS_TARGET_DIR, GPP_FILES, DIRTY_FILE ]
       --variable slideNumber=true
       --variable history=true
       --variable revealjs-url=#{REVEAL_JS}
-      --include-in-header=#{TARGET_DIR}/customizations.css
+      #{HEADERS.map { |h| "--include-in-header=#{h}" }.join("\n")}
     #{GPP_FILES}
   ).split("\n").join(' ')
 end
-
-task default: TARGET_FILE

data/lib/revealing/version.rb

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

data/revealing.gemspec

@@ -27,5 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rake'
   spec.add_dependency 'bundler'
   spec.add_dependency 'git-dirty'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rspec'
 end
 # rubocop:enable Metrics/BlockLength

data/templates/init/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'revealing'

data/templates/init/README.markdown

@@ -0,0 +1,23 @@
+# New Presentation
+
+This is the source of New Presentation. It was generated with [`revealing`](https://github.com/suhlig/revealing).
+
+# 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
+
+# Setup
+
+Do this once:
+
+1. Get Ruby if not already present
+1. `gem install bundler`
+1. `bundle install`
+
+# Generate the Presentation
+
+1. Run `rake` in the project directory
+1. Open `public_html/index.html` in a browser

data/templates/init/Rakefile

@@ -0,0 +1,3 @@
+require 'revealing/tasks'
+
+task default: TARGET_FILE

data/templates/init/src/index.markdown

@@ -0,0 +1,17 @@
+% New Presentation
+% The Author
+
+# First Slide
+
+* Written in Markdown
+* Created with [`revealing`](https://github.com/suhlig/revealing)
+* Based on [reveal.js](https://revealjs.com)
+
+# What's next?
+
+```console
+10 rake
+20 open public_html/index.html
+30 vim src/index.markdown
+40 goto 10
+```

data/tmp/aruba/shiny-new-presentation/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'revealing'

data/tmp/aruba/shiny-new-presentation/README.markdown

@@ -0,0 +1,10 @@
+# New Presentation
+
+This is the source of New Presentation. It was generated with [`revealing`](https://github.com/suhlig/revealing).
+
+# Setup (once)
+
+1. Get Ruby
+1. `gem install bundler`
+1. Run `rake` in the project directory
+1. Open `public_html/index.html` in a browser

data/tmp/aruba/shiny-new-presentation/Rakefile

@@ -0,0 +1,3 @@
+require 'revealing/tasks'
+
+task default: TARGET_FILE

data/tmp/aruba/shiny-new-presentation/src/index.markdown

@@ -0,0 +1,18 @@
+% New Presentation
+% The Author
+
+# First Slide
+
+* Written in Markdown
+* Created with [`revealing`](https://github.com/suhlig/revealing)
+* Based on [reveal.js](https://revealjs.com)
+
+# What's next?
+
+```console
+10. bundle install
+20. rake
+30. open `public_html/index.html`
+40. vim src/index.markdown
+50. goto 20
+```

data/tmp/rspec_guard_result

@@ -0,0 +1 @@
+1 examples, 0 failures in 0.4326 seconds

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: revealing
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Steffen Uhlig
@@ -52,6 +52,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: aruba
+  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
+    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-byebug
+  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: rspec
+  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'
 description: |-
   Provides a workflow for creating reveal.js
                            presentations. It uses pandoc to create the
@@ -60,7 +130,6 @@ email:
 - steffen@familie-uhlig.net
 executables:
 - revealing
-- revealing-task
 extensions: []
 extra_rdoc_files: []
 files:
@@ -69,13 +138,22 @@ files:
 - README.markdown
 - Rakefile
 - exe/revealing
-- exe/revealing-task
+- lib/revealing/cli.rb
 - 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
+- templates/init/Gemfile
+- templates/init/README.markdown
+- templates/init/Rakefile
+- templates/init/src/index.markdown
+- tmp/aruba/shiny-new-presentation/Gemfile
+- tmp/aruba/shiny-new-presentation/README.markdown
+- tmp/aruba/shiny-new-presentation/Rakefile
+- tmp/aruba/shiny-new-presentation/src/index.markdown
+- tmp/rspec_guard_result
 homepage: 
 licenses:
 - MIT

data/exe/revealing-task

@@ -1,29 +0,0 @@
-#!/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)