asciidoctor-revealjs 3.0.0 → 4.1.0.rc3

data/Rakefile

@@ -4,11 +4,13 @@ require 'asciidoctor'
 require 'asciidoctor/doctest'
 require 'colorize'
 require 'tilt'
+require 'rake/testtask'
 
 CONVERTER_FILE = 'lib/asciidoctor-revealjs/converter.rb'
 JS_FILE = 'build/asciidoctor-reveal.js'
 DIST_FILE = 'dist/main.js'
 TEMPLATES_DIR = 'templates'
+PUBLIC_DIR = 'public'
 
 file CONVERTER_FILE => FileList["#{TEMPLATES_DIR}/*"] do
   build_converter :fast
@@ -17,8 +19,7 @@ end
 namespace :build do
   desc 'Compile Slim templates and generate converter.rb'
   task :converter => 'clean' do
-    # NOTE: using mode :fast by default due to a bug in ruby-beautify under Ruby 2.5
-    #       https://github.com/erniebrodeur/ruby-beautify/issues/45
+    # NOTE: use :pretty if you want to debug the generated code
     build_converter :fast
   end
 
@@ -40,7 +41,8 @@ namespace :build do
     mkdir_p [File.dirname(JS_FILE), File.dirname(DIST_FILE)]
     File.open(JS_FILE, 'w') do |file|
       template = File.read('src/asciidoctor-revealjs.tmpl.js')
-      file << template.sub('//OPAL-GENERATED-CODE//', builder.to_s)
+      template['//OPAL-GENERATED-CODE//'] = builder.to_s
+      file << template
     end
     File.binwrite "#{JS_FILE}.map", builder.source_map
 
@@ -52,6 +54,7 @@ task :build => 'build:converter'
 
 task :clean do
   rm_rf CONVERTER_FILE
+  rm_rf PUBLIC_DIR
 end
 
 def build_converter(mode = :pretty)
@@ -76,6 +79,7 @@ def build_converter(mode = :pretty)
         basebackend: 'html',
         outfilesuffix: '.html',
         filetype: 'html',
+        supports_templates: true
       },
       delegate_backend: 'html5',
       engine_opts: {
@@ -94,6 +98,11 @@ DocTest::RakeTasks.new do |t|
   t.converter_opts = { backend_name: 'revealjs' }
 end
 
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/asciidoctor-revealjs/*_test.rb']
+  t.warning = false
+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).
@@ -105,7 +114,7 @@ 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
+  task :convert => 'build:converter' do
     require 'slim-htag'
     require_relative 'lib/asciidoctor-revealjs'
     Dir.glob('examples/*.adoc') do |_file|
@@ -113,8 +122,7 @@ namespace :examples do
       out = Asciidoctor.convert_file _file,
         :safe => 'safe',
         :backend => 'revealjs',
-        :base_dir => 'examples',
-        :template_dir => 'templates'
+        :base_dir => 'examples'
       if out.instance_of? Asciidoctor::Document
         puts "✔️".green
       else
@@ -130,9 +138,24 @@ namespace :examples do
       `ruby -run -e httpd . -p 5000 -b 127.0.0.1`
     end
   end
+
+  task :publish do
+    FileUtils.rm_rf PUBLIC_DIR
+    Dir.mkdir PUBLIC_DIR
+    Dir.mkdir "#{PUBLIC_DIR}/reveal.js"
+    FileUtils.cp 'src/index.html', "#{PUBLIC_DIR}/index.html"
+    FileUtils.cp_r 'node_modules/reveal.js/', "#{PUBLIC_DIR}"
+    FileUtils.cp_r 'examples/images/', "#{PUBLIC_DIR}"
+    FileUtils.cp 'examples/release-4.0.html', "#{PUBLIC_DIR}/release-4.0.html"
+    FileUtils.cp 'examples/release-4.0.css', "#{PUBLIC_DIR}/release-4.0.css"
+    FileUtils.cp 'examples/release-4.1.html', "#{PUBLIC_DIR}/release-4.1.html"
+    FileUtils.cp 'examples/release-4.1.css', "#{PUBLIC_DIR}/release-4.1.css"
+    FileUtils.cp 'examples/a11y-dark.css', "#{PUBLIC_DIR}/a11y-dark.css"
+  end
 end
 
+task 'test' => 'doctest'
 task 'doctest:test' => 'prepare-converter'
 task 'doctest:generate' => 'prepare-converter'
 # When no task specified, run test.
-task :default => :doctest
+task :default => :test

data/asciidoctor-revealjs.gemspec

@@ -34,15 +34,17 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'thread_safe', '~> 0.3.5'
   s.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
 
-  s.add_development_dependency 'rake', '~> 10.4.2'
-  s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.5'
-  s.add_development_dependency 'pry', '~> 0.10.4'
+  s.add_development_dependency 'rake', '~> 13.0.0'
+  s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.7'
+  s.add_development_dependency 'minitest', '~> 5.14'
   if RUBY_ENGINE != 'jruby'
+    s.add_development_dependency 'pry', '~> 0.12.0'
+    s.add_development_dependency 'irb'
     s.add_development_dependency 'pry-byebug'
     s.add_development_dependency 'pygments.rb'
   end
   s.add_development_dependency 'colorize'
-  s.add_development_dependency 'asciidoctor-templates-compiler', '~> 0.4.2'
+  s.add_development_dependency 'asciidoctor-templates-compiler', '~> 0.6.0'
   s.add_development_dependency 'slim', '~> 3.0.6'
   s.add_development_dependency 'slim-htag', '~> 0.1.0'
   s.add_development_dependency 'rouge'

data/bin/asciidoctor-revealjs

@@ -9,6 +9,13 @@ require 'asciidoctor/cli'
 
 options = Asciidoctor::Cli::Options.new backend: 'revealjs'
 
+# FIXME (from asciidoctor-pdf) provide an API in Asciidoctor for sub-components to print version information
+unless ARGV != ['-v'] && (ARGV & ['-V', '--version']).empty?
+  $stdout.write %(Asciidoctor reveal.js #{Asciidoctor::Revealjs::VERSION} using )
+  options.print_version
+  exit 0
+end
+
 # FIXME (from bespoke) This is a really bizarre API. Please make me simpler.
 if Integer === (result = options.parse! ARGV)
   exit result

data/examples/a11y-dark.css

@@ -0,0 +1,99 @@
+/* a11y-dark theme */
+/* Based on the Tomorrow Night Eighties theme: https://github.com/isagalaev/highlight.js/blob/master/src/styles/tomorrow-night-eighties.css */
+/* @author: ericwbailey */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+  color: #d4d0ab;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-tag,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class,
+.hljs-regexp,
+.hljs-deletion {
+  color: #ffa07a;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params,
+.hljs-meta,
+.hljs-link {
+  color: #f5ab35;
+}
+
+/* Yellow */
+.hljs-attribute {
+  color: #ffd700;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet,
+.hljs-addition {
+  color: #abe338;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+  color: #32aaee;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+  color: #dcc6e0;
+}
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  background: #2b2b2b;
+  color: #f8f8f2;
+  padding: 0.5em;
+}
+
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-strong {
+  font-weight: bold;
+}
+
+@media screen and (-ms-high-contrast: active) {
+  .hljs-addition,
+  .hljs-attribute,
+  .hljs-built_in,
+  .hljs-builtin-name,
+  .hljs-bullet,
+  .hljs-comment,
+  .hljs-link,
+  .hljs-literal,
+  .hljs-meta,
+  .hljs-number,
+  .hljs-params,
+  .hljs-string,
+  .hljs-symbol,
+  .hljs-type,
+  .hljs-quote {
+    color: highlight;
+  }
+
+  .hljs-keyword,
+  .hljs-selector-tag {
+    font-weight: bold;
+  }
+}

data/examples/autoslide.adoc

@@ -0,0 +1,22 @@
+= Autoslide!
+// automatically proceed to the next slide after 5 seconds
+:revealjs_autoSlide: 5000
+
+== Slide 0
+
+I can do it in 5 seconds!
+
+// on this slide we need 10 seconds
+[autoslide=10000]
+== Slide 1
+
+All things considered, let's try again in 10 seconds.
+
+[autoslide=1000]
+== Slide 2
+
+Don't blink or you'll miss me :)
+
+== Slide 3
+
+(:

data/examples/custom-layout.adoc

@@ -0,0 +1,10 @@
+// .custom-layout
+// The three different ways to hide slide titles
+// :include: //body/script | //div[@class="slides"]
+// :header_footer:
+= Custom Layout
+:revealjs_disablelayout: true
+
+== Layout Disabled!
+
+Hello 👋

data/examples/customcss.adoc

@@ -1,6 +1,6 @@
 // .customcss
 // Use of the customcss attribute to load external CSS
-// :include: //body/script | //div[@class="slides"]
+// :include: //head//link[@rel="stylesheet"]
 // :header_footer:
 = Custom CSS
 Author

data/examples/data-attributes.adoc

@@ -0,0 +1,245 @@
+// :include: //div[@class="slides"]
+// :header_footer:
+= Data attributes
+:stem:
+:icons: font
+:source-highlighter: highlight.js
+:revealjs_hash: true
+:experimental:
+
+== Reference
+
+https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes
+
+// .paragraphs
+== Paragraphs
+
+[.fragment.highlight-blue,data-fragment-index=0]
+blue
+
+[.fragment,data-fragment-index=1]
+white
+
+[.fragment.highlight-red,data-fragment-index=0]
+red
+
+// .inline-images
+== Inline images
+:imagesdir: images
+
+image:cute-cat-1.jpg[cute-cat-laying,role="fragment fade-in",data-fragment-index=3]
+image:cute-cat-2.jpg[cute-cat-yawning,role="fragment fade-in",data-fragment-index=1]
+image:cute-cat-3.jpg[cute-cat-melting,role="fragment fade-in",data-fragment-index=2]
+
+== Admonitions
+
+[TIP,role="fragment fade-in",data-fragment-index=3]
+====
+Pro tip...
+====
+
+[WARNING,role="fragment fade-in",data-fragment-index=1]
+====
+Watch out for...
+====
+
+[IMPORTANT,role="fragment fade-in",data-fragment-index=2]
+====
+Don't forget...
+====
+
+== Callout numbers
+
+[source,js]
+----
+console.log('Hello'); // <1>
+
+console.log('Bonjour'); // <2>
+
+console.log('Bye'); // <3>
+----
+[role="fragment fade-in",data-state="explanation"]
+<1> Display `Hello`
+<2> Display `Bonjour`
+<3> Display `Bye`
+
+== FAQ
+
+[qanda,data-count="3"]
+What's the deal with this converter?::
+This is the official reveal.js converter for Asciidoctor.
+Is it safe to put my credit card number into this presentation?::
+Probably not.
+I need all the Powerpoint features::
+No you don’t.
+
+[[horizontal-list]]
+== Horizontal list
+
+[horizontal,data-style="horizontal"]
+Hard drive:: Permanent storage for operating system and/or user files.
+RAM:: Temporarily stores information the CPU uses during operation.
+
+== Description list
+
+[.operating-systems,data-id="1234"]
+Operating Systems::
+* Linux
+* macOS
+* Windows
+
+== Example
+
+[#lorem.ipsum,data-style="lorem ipsum"]
+====
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua.
+====
+
+[[images]]
+== Images
+
+:imagesdir: images
+
+image::cute-cat-1.jpg[cute-cat-laying,height="100px",role="fragment fade-in",data-fragment-index=3]
+
+image::cute-cat-2.jpg[cute-cat-yawning,height="100px",role="fragment fade-in",data-fragment-index=1]
+
+image::cute-cat-3.jpg[cute-cat-melting,height="100px",role="fragment fade-in",data-fragment-index=2]
+
+== Inline links
+
+Learn how to use xref:images[images,role=fragment,data-fragment-index=1],
+xref:horizontal-list[horizontal lists,role=fragment,data-fragment-index=2]
+and link:https://duckduckgo.com/[duckduckgo.com,role=fragment,data-fragment-index=3].
+
+== Source blocks
+
+[source,javascript,role=fragment,data-fragment-index=2,data-lang-family=interpreted]
+----
+console.log('Hello world')
+----
+
+[source,kotlin,role=fragment,data-fragment-index=1,data-lang-family=compiled]
+----
+println("Hello world")
+----
+
+== Literal
+
+Open a terminal and type:
+
+[data-program-type=bash,data-program-version=1.2.3]
+ ./forgotten-realms.sh
+
+[data-output-type=error,data-prompt=y/n]
+....
+error: The requested operation returned error: 1954 Forbidden search for defensive operations manual
+absolutely fatal: operation initiation lost in the dodecahedron of doom
+would you like to die again? y/n
+....
+
+== Atom podium
+
+[role=fragment,data-fragment-index=2,data-medal=gold]
+. Protons
+
+[start=2,role=fragment,data-fragment-index=1,data-medal=silver]
+. Electrons
+
+[start=3,role=fragment,data-fragment-index=0,data-medal=bronze]
+. Neutrons
+
+[.columns.wrap]
+== Colors
+
+[.column.fragment,data-fragment-index=1]
+--
+image::data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'%3E%3Ccircle fill='blue' cx='50' cy='50' r='50'/%3E%3C/svg%3E[width=40%]
+
+image::data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'%3E%3Ccircle fill='yellow' cx='50' cy='50' r='50'/%3E%3C/svg%3E[width=40%]
+--
+
+[.column.fragment.fade-in-out,data-fragment-index=0]
+--
+image::data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100'%3E%3Ccircle fill='green' cx='50' cy='50' r='50'/%3E%3C/svg%3E[width=40%]
+--
+
+== Abstract
+
+[abstract,data-block-type=abstract]
+.Abstract
+Documentation is a distillation of many long, squiggly adventures.
+
+== Quote
+
+[data-context=civil-rights,data-event=speech,data-date=28/08/1963]
+> I have a dream that my four little children will one day live in a nation where they will not be judged by the color of their skin, but by the content of their character. I have a dream today!
+> -- Martin Luther King Jr. delivering the speech at the 1963 Washington D.C. Civil Rights March.
+
+== Math!
+
+[stem,data-algebra-concept=square-root]
+++++
+\sqrt{37} = \sqrt{\frac{73^2-1}{12^2}} \approx \frac{73}{12} (1 - \frac{1}{2\cdot73^2})
+++++
+
+== Tables
+
+[cols="1,1",options=header,role=fragment,data-fragment-index=1]
+.App
+|===
+|Name
+|Category
+
+|Firefox
+|Browser
+|===
+
+[%header,format=csv,role=fragment,data-fragment-index=0]
+.Music
+|===
+Artist,Track,Genre
+The Lumineers,Ho Hey,Folk Rock
+|===
+
+== TODO
+
+[%interactive,data-state=in-progress]
+- [ ] Dig
+- [x] Plant
+- [ ] Hose
+
+== Seagulls
+
+// Title: Flock Seagulls
+// License: Attribution CC 3.0
+// Recorded by Daniel Simion
+audio::flock-of-seagulls_daniel-simion.mp3[options="autoplay,loop",data-license="cc-3.0"]
+
+== Verse
+
+[verse, Carl Sandburg, two lines from the poem Fog, data-verse-type=poem]
+The fog comes
+on little cat feet.
+
+== Video
+
+video::kZH9JtPBq7k[youtube,start=34,data-video-id=kZH9JtPBq7k]
+
+== Inline quoted
+
+I can't believe it, we *won*!
+
+Type the word [.userinput]#asciidoc# into the search bar.
+
+Word with an [#bookmark-a]#explicit# id.
+
+Let's put some [#bookmark-b.concept.word]_emphasis_.
+
+== Sidebar
+
+[data-visiblity=visible,data-position=left]
+****
+Sidebars are used to visually separate auxiliary bits of content that supplement the main text.
+****