asciidoctor-revealjs 1.0.4 → 1.1.0

data/Rakefile

@@ -0,0 +1,114 @@
+#!/usr/bin/env rake
+
+require 'asciidoctor'
+require 'asciidoctor/doctest'
+require 'colorize'
+require 'thread_safe'
+require 'tilt'
+
+CONVERTER_FILE = 'lib/asciidoctor-revealjs/converter.rb'
+TEMPLATES_DIR = 'templates'
+
+file CONVERTER_FILE => FileList["#{TEMPLATES_DIR}/*"] do
+  build_converter :fast
+end
+
+namespace :build do
+  desc 'Compile Slim templates and generate converter.rb'
+  task :converter => 'clean' do
+    build_converter
+  end
+
+  desc 'Compile Slim templates and generate converter.rb for Opal'
+  task 'converter:opal' => 'clean' do
+    build_converter :opal
+  end
+end
+
+task :build => 'build:converter'
+
+task :clean do
+  rm_rf CONVERTER_FILE
+end
+
+def build_converter(mode = :pretty)
+  #require 'asciidoctor-templates-compiler'
+  require_relative 'lib/asciidoctor-templates-compiler'
+  require 'slim-htag'
+
+  generator = if mode == :opal
+    Temple::Generators::ArrayBuffer.new(freeze_static: false)
+  else
+    Temple::Generators::StringBuffer
+  end
+
+  File.open(CONVERTER_FILE, 'w') do |file|
+    puts "Generating #{file.path} (mode: #{mode})."
+
+    Asciidoctor::TemplatesCompiler::RevealjsSlim.compile_converter(
+      templates_dir: TEMPLATES_DIR,
+      class_name: 'Asciidoctor::Revealjs::Converter',
+      register_for: ['revealjs'],
+      backend_info: {
+        basebackend: 'html',
+        outfilesuffix: '.html',
+        filetype: 'html',
+      },
+      delegate_backend: 'html5',
+      engine_opts: {
+        generator: generator,
+      },
+      pretty: (mode == :pretty),
+      output: file
+    )
+  end
+end
+
+DocTest::RakeTasks.new do |t|
+  t.output_examples :html, path: 'test/doctest'
+  t.input_examples :asciidoc, path: [ *DocTest.examples_path, 'examples' ]
+  t.converter = DocTest::HTML::Converter
+  t.converter_opts = { backend_name: 'revealjs' }
+end
+
+task 'prepare-converter' do
+  # Run as an external process to ensure that it will not affect tests
+  # environment with extra loaded modules (especially slim).
+  `bundle exec rake #{CONVERTER_FILE}`
+
+  require_relative 'lib/asciidoctor-revealjs'
+end
+
+namespace :examples do
+  desc 'Converts all the test slides into fully working examples that you can look in a browser'
+  # converted slides will be put in examples/ directory
+  task :convert do
+    require 'slim-htag'
+    Dir.glob('examples/*.adoc') do |_file|
+      print "Converting file #{_file}... "
+      out = Asciidoctor.convert_file _file,
+        :safe => 'safe',
+        :backend => 'revealjs',
+        :base_dir => 'examples',
+        :template_dir => 'templates'
+      if out.instance_of? Asciidoctor::Document
+        puts "✔️".green
+      else
+        puts "✖️".red
+      end
+    end
+  end
+
+  task :serve do
+    puts "View rendered examples at: http://127.0.0.1:5000/"
+    puts "Exit with Ctrl-C"
+    Dir.chdir('examples') do
+      `ruby -run -e httpd . -p 5000 -b 127.0.0.1`
+    end
+  end
+end
+
+task 'doctest:test' => 'prepare-converter'
+task 'doctest:generate' => 'prepare-converter'
+# When no task specified, run test.
+task :default => :doctest

data/asciidoctor-revealjs.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path '../lib/asciidoctor-revealjs/version', __FILE__
+require 'open3'
 
 Gem::Specification.new do |s|
   s.name = 'asciidoctor-revealjs'
@@ -17,16 +18,24 @@ Gem::Specification.new do |s|
   rescue
     Dir['**/*']
   end
-  s.files = files.grep %r/^(?:(?:lib|templates)\/.+|Gemfile|Rakefile|(?:CHANGELOG|LICENSE|README)\.adoc|#{s.name}\.gemspec)$/
-
+  # TODO should we still package template files now that they are built into ruby?
+  s.files = files.grep %r/^(?:(?:examples|lib|templates)\/.+|Gemfile|Rakefile|(?:CHANGELOG|LICENSE|README)\.adoc|#{s.name}\.gemspec)$/
 
   s.executables = ['asciidoctor-revealjs']
   s.extra_rdoc_files = Dir['README.adoc', 'LICENSE.adoc', 'HACKING.adoc']
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'asciidoctor', '= 1.5.4'
-  s.add_runtime_dependency 'slim', '~> 3.0.6'
+  s.add_runtime_dependency 'asciidoctor', '~> 1.5.6'
   s.add_runtime_dependency 'thread_safe', '~> 0.3.5'
 
   s.add_development_dependency 'rake', '~> 10.4.2'
+  s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.4'
+  s.add_development_dependency 'pry', '~> 0.10.4'
+  if RUBY_ENGINE != 'jruby'
+    s.add_development_dependency 'pry-byebug'
+  end
+  s.add_development_dependency 'colorize'
+  s.add_development_dependency 'asciidoctor-templates-compiler', '~> 0.3.0'
+  s.add_development_dependency 'slim', '~> 3.0.6'
+  s.add_development_dependency 'slim-htag', '~> 0.1.0'
 end

data/examples/README.adoc

@@ -0,0 +1,17 @@
+= Examples
+
+Minimal AsciiDoc slide-decks to showcase reveal.js' features or test for regressions.
+
+They are also used in automated testing.
+Because of that some metadata (AsciiDoc comments `//`) is present.
+
+== Preview examples (ruby)
+
+    $ bundle exec rake examples:convert
+
+== Preview examples (javascript)
+
+    $ bundle exec rake build:converter:opal
+    $ npm run examples
+
+Make sure you have a link between `examples/node_modules/` and `node_modules/` where reveal.js is installed.

data/examples/admonitions-icons.adoc

@@ -0,0 +1,37 @@
+// .admonitions-font
+// :include: //div[@class="slides"]
+// :header_footer:
+= Admonitions
+:backend: revealjs
+
+== Admonition
+
+IMPORTANT: This presentation is important
+
+== Admonition block
+
+[WARNING]
+====
+This is a warning block
+====
+
+== Admonition block complex
+
+[NOTE]
+.Keeping notes
+====
+These are very thorough notes.
+
+* With
+* Bullets
+====
+
+== Admonition with caption
+
+[TIP, caption='ProTip(TM)']
+.Reveal.JS
+====
+Use include blocks to split your talks into small sections.
+It's easier to reorganize afterwards.
+====
+

data/examples/admonitions.adoc

@@ -0,0 +1,38 @@
+// .admonitions-font
+// :include: //div[@class="slides"]
+// :header_footer:
+= Admonitions
+:backend: revealjs
+:icons: font
+
+== Admonition
+
+IMPORTANT: This presentation is important
+
+== Admonition block
+
+[WARNING]
+====
+This is a warning block
+====
+
+== Admonition block complex
+
+[NOTE]
+.Keeping notes
+====
+These are very thorough notes.
+
+* With
+* Bullets
+====
+
+== Admonition with caption
+
+[TIP, caption='ProTip(TM)']
+.Reveal.JS
+====
+Use include blocks to split your talks into small sections.
+It's easier to reorganize afterwards.
+====
+

data/examples/concealed-slide-titles.adoc

@@ -0,0 +1,20 @@
+// .concealed-slide-titles
+// The three different ways to hide slide titles
+// :include: //div[@class="slides"]
+// :header_footer:
+= Concealed Slide Titles
+:backend: revealjs
+
+== !
+
+This
+
+[%notitle]
+== Presentation
+
+presentation's titles
+
+[%conceal]
+== Concealed
+
+should be concealed

data/examples/customcss.adoc

@@ -0,0 +1,9 @@
+// .customcss
+// Use of the customcss attribute to load external CSS
+// :include: //body/script | //div[@class="slides"]
+// :header_footer:
+= Custom CSS
+Author
+:customcss: customcss.css
+
+== Slide 1

data/examples/customcss.css

@@ -0,0 +1,8 @@
+.reveal section h1 {
+    font-family: cursive;
+}
+
+.reveal section small {
+    margin-top: 15.3em;
+    font-family: fantasy;
+}

data/examples/data-background-newstyle.adoc

@@ -0,0 +1,63 @@
+// .images-data-background-new
+// Demonstration of the new image background syntax.
+// See https://github.com/asciidoctor/asciidoctor-reveal.js/pull/52
+// :include: //div[@class="slides"]
+// :header_footer:
+= Test slide deck
+:imagesdir: images
+:backend: revealjs
+
+[%notitle]
+== Opening
+
+image::cover.jpg[background, size=cover]
+
+== canvas
+
+image::cover.jpg[canvas, size=cover]
+
+== !
+
+image::70s.jpg[background, size=cover]
+
+image::meme-2.jpg[width=500px]
+
+== I have no background
+
+== !
+
+image::meme-7.png[]
+
+== !
+
+image::70s.jpg[background,size=contain]
+
+== hey
+
+image::bio.jpg[background,size=100px]
+
+=== here
+
+image::bio.jpg[background,size=200px]
+
+=== I
+
+image::bio.jpg[background,size=400px]
+
+=== come
+
+image::bio.jpg[background,size=800px]
+
+== URL goat
+
+image::https://upload.wikimedia.org/wikipedia/commons/b/b2/Hausziege_04.jpg[background,size=contain]
+
+[background-color=yellow]
+== No [yellow] regression
+
+
+== Empty Vertical top
+
+=== Vertical with background
+
+image::70s.jpg[canvas, size=cover]

data/examples/data-background-oldstyle.adoc

@@ -0,0 +1,44 @@
+// .images-data-background-old
+// Demonstration of the old image background syntax.
+// We should retain compatibility for a while.
+// See https://github.com/asciidoctor/asciidoctor-reveal.js/pull/52
+// :include: //div[@class="slides"]
+// :header_footer:
+= Test slide deck
+:imagesdir: images
+:backend: revealjs
+
+[background-image=cover.jpg,background-size=cover]
+== !
+
+[background-image=70s.jpg,background-size=cover]
+== !
+
+image::meme-2.jpg[width=500px]
+
+== I have no background
+
+== !
+
+image::meme-7.png[]
+
+[background-image=70s.jpg,background-size=contain]
+== !
+
+[background-image=bio.jpg,background-size=100px]
+== hey
+
+[background-image=bio.jpg,background-size=200px]
+=== here
+
+[background-image=bio.jpg,background-size=400px]
+=== I
+
+[background-image=bio.jpg,background-size=800px]
+=== come
+
+[background-image=https://upload.wikimedia.org/wikipedia/commons/b/b2/Hausziege_04.jpg,background-size=contain]
+== URL Goat
+
+[background-color=yellow]
+== No [yellow] regression

data/examples/history-regression-tests.adoc

@@ -0,0 +1,34 @@
+// .history-regression-tests
+// Demonstration of revealjs history regression.
+// See https://github.com/asciidoctor/asciidoctor-reveal.js/pull/99 and https://github.com/asciidoctor/asciidoctor-reveal.js/issues/127
+// :include: //body/script | //div[@class="slides"]
+// :header_footer:
+= First Slide
+:revealjs_history: true
+
+== Second Slide
+
+== 3rd Slide
+// slide that starts with a number
+
+== P3rhaps this won't work
+// Second char is a number
+
+== 5th Slide
+// is it skipped by reveal.js?
+
+== Illegal çhàrâctérß
+
+[[explicit]]
+== Explicit section id
+
+== 67848727
+// Everything should be stripped in the id
+
+== Repeated title
+
+== !
+// Explicit no title
+
+== Repeated title
+// Exact same title means exact same id

data/examples/history.adoc

@@ -0,0 +1,19 @@
+// .history
+// Enables Reveal.JS' browser history feature
+// :include: //body/script | //div[@class="slides"]
+// :header_footer:
+= History
+:backend: revealjs
+:revealjs_history: true
+
+== First slide
+
+Uno
+
+== Second slide
+
+Dos
+
+== Third slide
+
+Tres