asciidoctor-bespoke 1.0.0.alpha.1

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/gem_tasks'
+rescue LoadError => e
+  warn e.message
+end
+
+task default: ['build']

data/bin/asciidoctor-bespoke

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+if File.file?(asciidoctor_bespoke = (File.expand_path '../../lib/asciidoctor-bespoke.rb', __FILE__))
+  require asciidoctor_bespoke
+else
+  require 'asciidoctor-bespoke'
+end
+require 'asciidoctor/cli'
+
+options = Asciidoctor::Cli::Options.new backend: 'bespoke'
+
+# FIXME This is a really bizarre API. Please make me simpler.
+if Integer === (result = options.parse! ARGV)
+  exit result
+else
+  invoker = Asciidoctor::Cli::Invoker.new options
+  GC.start
+  invoker.invoke!
+  exit invoker.code
+end

data/lib/asciidoctor-bespoke.rb

@@ -0,0 +1,2 @@
+require 'asciidoctor' unless defined? Asciidoctor::Converter
+require_relative 'asciidoctor-bespoke/converter'

data/lib/asciidoctor-bespoke/converter.rb

@@ -0,0 +1,48 @@
+require 'asciidoctor/converter/html5'
+require 'asciidoctor/converter/composite'
+require 'asciidoctor/converter/template'
+
+# Asciidoctor < 1.5.5 doesn't recognize svg tag name if followed immediately by newline
+Asciidoctor::Converter::Html5Converter.tap do |klass|
+  klass.send :remove_const, :SvgPreambleRx
+  klass.const_set :SvgPreambleRx, /\A.*?(?=<svg\b)/m
+end if Asciidoctor::VERSION == '1.5.3' || Asciidoctor::VERSION == '1.5.4'
+
+module Asciidoctor
+module Bespoke
+  class Converter < ::Asciidoctor::Converter::CompositeConverter
+    ProvidedTemplatesDir = ::File.expand_path '../../../templates', __FILE__
+    SlimPrettyOpts = { pretty: true, indent: false }.freeze
+    register_for 'bespoke'
+
+    def initialize backend, opts = {}
+      template_dirs = [ProvidedTemplatesDir] # last dir wins
+      if (custom_template_dirs = opts[:template_dirs])
+        template_dirs += custom_template_dirs.map {|d| ::File.expand_path d }
+      end
+      include_dirs = template_dirs.reverse.tap {|c| c << (::File.join c.pop, 'slim') } # first dir wins
+      engine_opts = (opts[:template_engine_options] || {}).dup
+      extra_slim_opts = { include_dirs: include_dirs }
+      extra_slim_opts.update SlimPrettyOpts if Set.new(%w(1 true)).include?(ENV['SLIM_PRETTY'].to_s)
+      engine_opts[:slim] = (engine_opts.key? :slim) ? (extra_slim_opts.merge engine_opts[:slim]) : extra_slim_opts
+      template_opts = opts.merge htmlsyntax: 'html', template_engine: 'slim', template_engine_options: engine_opts
+      template_converter = ::Asciidoctor::Converter::TemplateConverter.new backend, template_dirs, template_opts
+      html5_converter = ::Asciidoctor::Converter::Html5Converter.new backend, opts
+      super backend, template_converter, html5_converter
+      basebackend 'html'
+      htmlsyntax 'html'
+    end
+
+    def convert node, transform = nil, opts = {}
+      if (node.attributes.delete 'skip-option') || node.context == :preamble
+        ''
+      # FIXME mixin slide? method to AbstractBlock (or AbstractNode)
+      elsif node.context == :section && node.level == 1 && (node.attr? 'transform')
+        super node, %(slide_#{node.attr 'transform'}), opts
+      else
+        super
+      end
+    end
+  end
+end
+end

data/lib/asciidoctor-bespoke/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+module Bespoke
+  VERSION = '1.0.0.alpha.1'
+end
+end

data/templates/slim/admonition.html.slim

@@ -0,0 +1,4 @@
+- if has_role? 'cue'
+  include notes.html.slim
+- else
+  =delegate

data/templates/slim/audio.html.slim

@@ -0,0 +1,3 @@
+audio(id=id src=(media_uri local_attr :target) loop=('true' if option? :loop) preload='auto'
+    data-rewind=('true' if option? :rewind) data-volume=((option? :muted) ? 0 : (attr :volume)))
+  span.alt=local_attr :alt, 'Your browser does not support the audio element.'

data/templates/slim/document.html.slim

@@ -0,0 +1,69 @@
+doctype 5
+html lang=(attr :lang, 'en' unless attr? :nolang)
+  head
+    meta charset=(attr :encoding, 'utf-8')
+    / QUESTION should we add maximum-scale=1 to viewport setting?
+    meta name='viewport' content='width=device-width, initial-scale=1'
+    title=(doctitle sanitize: true, use_fallback: true).tr_s(' ', ' ')
+    - [:description, :keywords, :author, :copyright].each do |_key|
+      - if attr? _key
+        meta name=_key content=(attr _key)
+    meta name='generator' content="Asciidoctor #{attr 'asciidoctor-version'} (Bespoke.js converter)"
+    - if attr? :favicon
+      - if (_favicon_href = attr :favicon).empty?
+        - _favicon_href = 'favicon.ico'
+      - if (_favicon_image_type = File.extname(_favicon_href)[1..-1]) == 'ico'
+        - _favicon_image_type = 'x-icon'
+      link rel='shortcut icon' href=_favicon_href type="image/#{_favicon_image_type}"
+    meta name='mobile-web-app-capable' content='yes'
+    - if attr? :appname
+      meta name='application-name' content=(attr :appname)
+    link rel='stylesheet' href='build/build.css'
+    - if attr? :icons, 'font'
+      - if attr? 'iconfont-remote'
+        link rel='stylesheet' href=(attr 'iconfont-cdn', (cdn_uri 'font-awesome', '4.5.0', 'css/font-awesome.min.css'))
+      - else
+        link rel='stylesheet' href=(normalize_web_path 'font-awesome.css', (attr :stylesdir, ''))
+    - case (_source_highlighter = attr 'source-highlighter')
+    - when 'highlight.js'
+      link rel='stylesheet' href="#{_highlightjs_path = attr 'highlightjsdir', (cdn_uri 'highlight.js', '9.1.0')}/styles/#{attr 'highlightjs-theme', 'github'}.min.css"
+    - when 'prettify'
+      link rel='stylesheet' href="#{_prettify_path = attr 'prettifydir', (cdn_uri 'prettify', 'r298')}/#{attr 'prettify-theme', 'prettify'}.min.css"
+    - unless (_docinfo = docinfo :head, '-bespoke.html').empty?
+      =_docinfo
+  body id=id
+    article.deck
+      - unless noheader
+        / TODO enable :header docinfo once Asciidoctor 1.5.5 is available
+        /- unless (_docinfo = docinfo :header, '-bespoke.html').empty?
+        /  =_docinfo
+        - if header?
+          include slide_title.html.slim
+      =content
+      - unless (_docinfo = docinfo :footer, '-bespoke.html').empty?
+        =_docinfo
+    script src='build/build.js'
+    - case _source_highlighter
+    - when 'highlight.js'
+      script src="#{_highlightjs_path}/highlight.min.js"
+      |<script>Array.prototype.forEach.call(document.querySelectorAll('i.conum+b'),function(n){n.parentNode.removeChild(n)});</script>
+      |<script>hljs.initHighlighting()</script>
+    - when 'prettify'
+      script src="#{_prettify_path}/prettify.js"
+      |<script>Array.prototype.forEach.call(document.querySelectorAll('i.conum+b'),function(n){n.parentNode.removeChild(n)})</script>
+      |<script>prettyPrint()</script>
+    - if attr? :stem
+      script type='text/x-mathjax-config'
+        |MathJax.Hub.Config({
+           messageStyle: "none",
+           tex2jax: {
+             inlineMath: [#{Asciidoctor::INLINE_MATH_DELIMITERS[:latexmath].inspect}],
+             displayMath: [#{Asciidoctor::BLOCK_MATH_DELIMITERS[:latexmath].inspect}],
+             ignoreClass: "nostem|nolatexmath"
+           },
+           asciimath2jax: {
+             delimiters: [#{Asciidoctor::BLOCK_MATH_DELIMITERS[:asciimath].inspect}],
+             ignoreClass: "nostem|noasciimath"
+           }
+         })
+      script src="#{cdn_uri 'mathjax', '2.6.0', 'MathJax.js?config=TeX-MML-AM_HTMLorMML'}"

data/templates/slim/helpers.rb

@@ -0,0 +1,222 @@
+# This module gets mixed in to every node (the context of the template) at the
+# time the node is being converted. The properties and methods in this module
+# effectively become direct members of the template.
+module Slim::Helpers
+  CDN_BASE = '//cdnjs.cloudflare.com/ajax/libs'
+  EOL = %(\n)
+  BUILD_ROLE_BY_TYPE = {
+    'self' => 'build',
+    'items' => 'build-items'
+  }
+
+  SvgStartTagRx = /\A<svg[^>]*>/
+  ViewBoxAttributeRx = /\sview[bB]ox="[^"]+"/
+  WidthAttributeRx = /\swidth="([^"]+)"/
+  HeightAttributeRx = /\sheight="([^"]+)"/
+  SliceHintRx = /  +/
+
+  # Capture nested template content and register it with the specified key, to
+  # be executed at a later time.
+  #
+  # This method must be invoked using the control code directive (i.e., -). By
+  # using a control code directive, the block is set up to append the result
+  # directly to the output buffer. (Integrations often hide the distinction
+  # between a control code directive and an output directive in this context).
+  #
+  # key   - The Symbol under which to save the template block.
+  # opts  - A Hash of options to control processing (default: {}):
+  #         * :append  - A Boolean that indicates whether to append this block
+  #                      to others registered with this key (default: false).
+  #         * :content - String content to be used if template content is not
+  #                      provided (optional).
+  # block - The template content (in Slim template syntax).
+  #
+  # Examples
+  #
+  #   - content_for :body
+  #     p content
+  #   - content_for :body, append: true
+  #     p more content
+  #
+  # Returns nothing.
+  def content_for key, opts = {}, &block
+    @content = {} unless defined? @content
+    (opts[:append] ? (@content[key] ||= []) : (@content[key] = [])) << (block_given? ? block : lambda { opts[:content] })
+    nil
+  end
+
+  # Checks whether deferred template content has been registered for the specified key.
+  #
+  # key - The Symbol under which to look for saved template blocks.
+  #
+  # Returns a Boolean indicating whether content has been registered for this key.
+  def content_for? key
+    (defined? @content) && (@content.key? key)
+  end
+
+  # Evaluates the deferred template content registered with the specified key.
+  #
+  # When the corresponding content_for method is invoked using a control code
+  # directive, the block is set up to append the result to the output buffer
+  # directly.
+  #
+  # key  - The Symbol under which to look for template blocks to yield.
+  # opts - A Hash of options to control processing (default: {}):
+  #        * :drain - A Boolean indicating whether to drain the key of blocks
+  #                   after calling them (default: true).
+  #
+  # Examples
+  #
+  #   - yield_content :body
+  #
+  # Returns nothing (assuming the content has been captured in the context of control code).
+  def yield_content key, opts = {}
+    if (defined? @content) && (blks = (opts.fetch :drain, true) ? (@content.delete key) : @content[key])
+      blks.map {|b| b.call }.join
+    end
+    nil
+  end
+
+  def asset_uri_scheme
+    if instance_variable_defined? :@asset_uri_scheme
+      @asset_uri_scheme
+    else
+      @asset_uri_scheme = (scheme = @document.attr 'asset-uri-scheme', 'https').nil_or_empty? ? nil : %(#{scheme}:)
+    end
+  end
+
+  def cdn_uri name, version, path = nil
+    [%(#{asset_uri_scheme}#{CDN_BASE}), name, version, path].compact * '/'
+  end
+
+  #--
+  #TODO mix directly into AbstractNode
+  def local_attr name, default_val = nil
+    attr name, default_val, false
+  end
+
+  #--
+  #TODO mix directly into AbstractNode
+  def local_attr? name, default_val = nil
+    attr? name, default_val, false
+  end
+
+  # Retrieve the converted content, wrap it in a `<p>` element if
+  # the content_model equals :simple and return the result.
+  #
+  # Returns the block content as a String, wrapped inside a `<p>` element if
+  # the content_model equals `:simple`.
+  def resolve_content
+    @content_model == :simple ? %(<p>#{content}</p>) : content
+  end
+
+  #--
+  #TODO mix into AbstractBlock directly?
+  def pluck selector = {}, &block
+    quantity = (selector.delete :quantity).to_i
+    if blocks?
+      unless (result = find_by selector, &block).empty?
+        result = result[0..(quantity - 1)] if quantity > 0
+        result.each {|b| b.set_attr 'skip-option', '' }
+      end
+    else
+      result = []
+    end
+    quantity == 1 ? result[0] : result
+  end
+
+  def pluck_first selector = {}, &block
+    pluck selector.merge(quantity: 1), &block
+  end
+
+  def partition_title str
+    ::Asciidoctor::Document::Title.new str, separator: (@document.attr 'title-separator')
+  end
+
+  # Retrieves the level-1 section node for the current slide.
+  #
+  # Returns the Asciidoctor::Section for the current slide.
+  def slide
+    node = self
+    until node.context == :section && node.level == 1
+      node = node.parent
+    end
+    node
+  end
+
+  # Resolves the list of build-related roles for this block.
+  #
+  # Consults the build attribute first, then the build option if the build
+  # attribute is not set.
+  #
+  # Also sets the build-initiated attribute on the slide if not previously set.
+  #
+  # Returns an Array of build-related roles or an empty Array if builds are not
+  # enabled on this node.
+  def build_roles
+    if local_attr? :build
+      slide.set_attr 'build-initiated', ''
+      (local_attr :build).split('+').map {|type| BUILD_ROLE_BY_TYPE[type] }
+    elsif option? :build
+      if (_slide = slide).local_attr? 'build-initiated'
+        ['build-items']
+      else
+        _slide.set_attr 'build-initiated', ''
+        ['build', 'build-items']
+      end
+    else
+      []
+    end
+  end
+
+  # QUESTION should we wrap in span.line if active but delimiter is not present?
+  # TODO alternate terms for "slice" - part(ition), chunk, segment, split, break
+  def slice_text str, active = nil
+    if (active || (active.nil? && (option? :slice))) && (str.include? '  ')
+      (str.split SliceHintRx).map {|line| %(<span class="line">#{line}</span>) }.join EOL
+    else
+      str
+    end
+  end
+
+  # Retrieves the built-in html5 converter.
+  # 
+  # Returns the instance of the Asciidoctor::Converter::Html5Converter
+  # associated with this node.
+  def html5_converter
+    converter.converters[-1]
+  end
+
+  def delegate
+    html5_converter.convert self
+  end
+
+  def include_svg target
+    if (svg = html5_converter.read_svg_contents self, target)
+      # add viewBox attribute if missing
+      unless ViewBoxAttributeRx =~ (start_tag = SvgStartTagRx.match(svg)[0])
+        if (width = start_tag.match WidthAttributeRx) && (width = width[1].to_f) >= 0 &&
+            (height = start_tag.match HeightAttributeRx) && (height = height[1].to_f) >= 0
+          width = width.to_i if width == width.to_i
+          height = height.to_i if height == height.to_i
+          svg = %(<svg viewBox="0 0 #{width} #{height}"#{start_tag[4..-1]}#{svg[start_tag.length..-1]})
+        end
+      end
+      svg
+    else
+      %(<span class="alt">#{local_attr 'alt'}</span>)
+    end
+  end
+
+  def spacer
+    ' '
+  end
+
+  def newline
+    if defined? @pretty
+      @pretty ? EOL : nil
+    elsif (@pretty = ::Thread.current[:tilt_current_template].options[:pretty])
+      EOL
+    end
+  end
+end

data/templates/slim/image.html.slim

@@ -0,0 +1,24 @@
+- _target, _alt, _width, _height, _format, _reload = (local_attr :target), (local_attr :alt), (local_attr :width), (local_attr :height), (local_attr :format), ('true' if option? :reload)
+/ QUESTION support default image role?
+figure.image id=id class=[role, ('flux' if option? :flux)]
+  / TODO support link on image
+  / TODO append an index/counter to the alt attribute (since it is otherwise shared)
+  - _target.split(/[#,]/).each do |_target|
+    =newline
+    - if _format == 'svg' || (_target.include? '.svg') && ((_svg = option? :inline) || (_obj = option? :interactive))
+      - case
+      - when _svg
+        =include_svg _target
+      - when _obj
+        object type='image/svg+xml' data=(image_uri _target) width=_width height=_height data-reload=_reload
+          / TODO support fallback option
+          span.alt=_alt
+    - else
+      img src=(image_uri _target) alt=_alt width=_width height=_height data-reload=_reload
+  - if title?
+    =newline
+    figcaption=title
+  - if local_attr? :credit
+    =newline
+    / QUESTION sould we use data-credit on <figure> element instead?
+    small.credit=local_attr :credit

data/templates/slim/listing.html.slim

@@ -0,0 +1,15 @@
+- _has_title = title?
+- content_for :pre
+  - if style == 'source' && (_lang = local_attr :language)
+    / NOTE class attribute required for highlight.js and prettify
+    / QUESTION should we add a "highlight" class to pre?
+    pre.source id=(id unless _has_title) : code data-lang=_lang class="language-#{_lang} prettyprint" =content
+  - else
+    / QUESTION should we add a class to pre?
+    pre id=(id unless _has_title) : code =content
+- if _has_title
+  figure.listing id=id
+    figcaption=title
+    - yield_content :pre
+- else
+  - yield_content :pre

data/templates/slim/literal.html.slim

@@ -0,0 +1,10 @@
+// NOTE if style is not set, then it's a literal paragraph (not a literal block)
+- _has_title = title?
+- content_for :pre
+  pre.screen id=(id unless _has_title) class=role : samp =content
+- if _has_title
+  figure.listing id=id
+    figcaption=title
+    - yield_content :pre
+- else
+  - yield_content :pre