asciidoctor-epub3 1.5.0.alpha.15 → 1.5.0.alpha.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4404201f6335840b7c6bb344eed4870654ae7132a3a63309d3a3f64536da62f2
-  data.tar.gz: 252e5083cc9a5e1d589181ee0b141414f7182867ba763a1927271d72779ab4e2
+  metadata.gz: bbc1a47f9a011cc194ab8cd731ec3d6121079f0a49e32540329d8b30fb390ecc
+  data.tar.gz: c02ceac6c1c9259ff70a3b799ceb9ed70f5af5e5b233914882332b560f95259d
 SHA512:
-  metadata.gz: e85119f2680e17c119d1997e9272e14630c64caae39c27a2055ec60cf617399d95154e1cf3de41f2eedebc9b73a373f2028c3c854cb1d779da3adfde3c79c0f8
-  data.tar.gz: ef099d1233ad69d99e0985ba6f9580d99f80ccdc824d036505f5507adf18fad79a8643684f111665d086147558a41eec4513db95be5d93d6e4d1bf46d35a3dba
+  metadata.gz: 409a0b3d28aa559a14f33fd042b739595b1be0625b18044c308b088f3396479fc3859eece4d81bf9439d9c10e815061143eaed29506266154b9c22e6b2fd8100
+  data.tar.gz: d1e8a6c56803400dc9181bbaacec99df81a522a24301e96adb40f19456066e16d27202da6ce8e48081ee177e51c166916ef951eefc3119aba3ea02235b1b3628

data/CHANGELOG.adoc

@@ -5,6 +5,14 @@
 This document provides a high-level view of the changes to the {project-name} by release.
 For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub.
 
+== 1.5.0.alpha.16 (2020-04-26) - @slonopotamus
+
+* add basic audio and video support (#9)
+* add support for `[horizontal]` definition list (#165)
+* add proper handling of `:data-uri:` document attribute (#324)
+* add support for customizable document splitting into chapters via `epub-chapter-level` attribute (#327)
+* avoid outputting 'true' for unsupported blocks (#332)
+
 == 1.5.0.alpha.15 (2020-03-11) - @slonopotamus
 
 * support section numbering and captions (#20)

data/README.adoc

@@ -1,6 +1,6 @@
 = {project-name}: A _native_ EPUB3 converter for AsciiDoc
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v1.5.0.alpha.15, 2020-03-11
+v1.5.0.alpha.16, 2020-04-26
 // Settings:
 :experimental:
 :idprefix:
@@ -140,6 +140,7 @@ Like other converters, Asciidoctor EPUB3 handles this chunking task by automatic
 
 When `doctype` attribute is set to `book`, each top-level section will become a separate ebook "chapter" file.
 This includes preface, bibliography, appendix, etc.
+This behavior can be configured via `epub-chapter-level` document attribute.
 
 Otherwise, whole document is converted to a single ebook chapter.
 
@@ -298,6 +299,13 @@ The recommended practice is to identify the referenced resource by means of a st
 |An optional override of the properties attribute for this document's item in the manifest.
 _Only applies to a chapter document._
 
+|epub-chapter-level
+|Specify the section level at which to split the EPUB into separate "chapter" files.
+This attribute only affects documents with `:doctype: book`.
+The default is to split into chapters at level-1 sections.
+This attribute only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users.
+Some readers may be slow if the chapter files are too large, so for large documents with few level-1 headings, one might want to use a chapter level of 2 or 3.
+
 |series-name, series-volume, series-id
 |Populates the series statements (`belongs-to-collection`) in the package metadata.
 Volume is a number, ID probably a UUID that is constant for all volumes in the series.

data/asciidoctor-epub3.gemspec

@@ -36,9 +36,10 @@ An extension for Asciidoctor that converts AsciiDoc documents to EPUB3 and KF8/M
   s.add_development_dependency 'rake', '~> 13.0.0'
   s.add_development_dependency 'rouge', '~> 3.0'
   s.add_development_dependency 'rspec', '~> 3.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.80.0'
+  s.add_development_dependency 'rubocop', '~> 0.81.0'
   s.add_development_dependency 'rubocop-rspec', '~> 1.38.0'
 
   s.add_runtime_dependency 'asciidoctor', '>= 1.5.6', '< 3.0.0'
   s.add_runtime_dependency 'gepub', '~> 1.0.0'
+  s.add_runtime_dependency 'mime-types', '~> 3.0'
 end

data/data/styles/epub3.css

@@ -357,6 +357,11 @@ dl dd {
   margin-top: 0.25em;
 }
 
+td.hdlist1 {
+  font-weight: bold;
+  padding-right: 0.625em;
+}
+
 div.callout-list {
   margin-top: 0.5em;
 }

data/lib/asciidoctor-epub3/converter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'mime/types'
 require 'open3'
 require_relative 'font_icon_map'
 
@@ -29,7 +30,7 @@ module Asciidoctor
                 unless (entry_dir = ::File.dirname entry.name) == '.' || (::File.directory? entry_dir)
                   ::FileUtils.mkdir_p entry_dir
                 end
-                entry.extract
+                entry.extract entry.name
               end
             end
           end
@@ -104,7 +105,8 @@ module Asciidoctor
         if respond_to? method_name
           send method_name, node
         else
-          logger.warn %(conversion missing in backend #{@backend} for #{name})
+          logger.warn %(#{::File.basename node.attr('docfile')}: conversion missing in backend #{@backend} for #{name})
+          nil
         end
       end
 
@@ -114,7 +116,8 @@ module Asciidoctor
           return Asciidoctor::Document === node ? node.attr('docname') || node.id : nil
         end
         return (node.id || 'preamble') if node.context == :preamble && node.level == 0
-        Asciidoctor::Section === node && node.level <= 1 ? node.id : nil
+        chapter_level = [node.document.attr('epub-chapter-level', 1).to_i, 1].max
+        Asciidoctor::Section === node && node.level <= chapter_level ? node.id : nil
       end
 
       def get_numbered_title node
@@ -150,7 +153,7 @@ module Asciidoctor
         @epubcheck_path = node.attr 'ebook-epubcheck-path'
         @xrefs_seen = ::Set.new
         @icon_names = []
-        @images = []
+        @media_files = []
         @footnotes = []
 
         @book = GEPUB::Book.new 'EPUB/package.opf'
@@ -221,14 +224,7 @@ module Asciidoctor
         add_front_matter_page node
 
         if node.doctype == 'book'
-          toc_items = []
-          node.sections.each do |section|
-            toc_items << section
-            section.sections.each do |subsection|
-              next if get_chapter_name(node).nil?
-              toc_items << subsection
-            end
-          end
+          toc_items = node.sections
           node.content
         else
           toc_items = [node]
@@ -245,13 +241,16 @@ module Asciidoctor
         docimagesdir = (node.attr 'imagesdir', '.').chomp '/'
         docimagesdir = (docimagesdir == '.' ? nil : %(#{docimagesdir}/))
 
-        @images.each do |image|
-          if image[:name].start_with? %(#{docimagesdir}jacket/cover.)
-            logger.warn %(image path is reserved for cover artwork: #{image[:name]}; skipping image found in content)
-          elsif ::File.readable? image[:path]
-            @book.add_item image[:name], content: image[:path]
+        @media_files.each do |file|
+          if file[:name].start_with? %(#{docimagesdir}jacket/cover.)
+            logger.warn %(path is reserved for cover artwork: #{file[:name]}; skipping file found in content)
+          elsif ::File.readable? file[:path]
+            mime_types = MIME::Types.type_for file[:name]
+            mime_types.delete_if {|x| x.media_type != file[:media_type] }
+            preferred_mime_type = mime_types.empty? ? nil : mime_types[0].content_type
+            @book.add_item file[:name], content: file[:path], media_type: preferred_mime_type
           else
-            logger.error %(#{File.basename node.attr('docfile')}: image not found or not readable: #{image[:path]})
+            logger.error %(#{File.basename node.attr('docfile')}: media file not found or not readable: #{file[:path]})
           end
         end
 
@@ -565,7 +564,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
         figure_classes = ['listing']
         figure_classes << 'coalesce' if node.option? 'unbreakable'
-        title_div = node.title? ? %(<figcaption>#{get_numbered_title node}</figcaption>) : ''
+        title_div = node.title? ? %(<figcaption>#{node.captioned_title}</figcaption>) : ''
         %(<figure class="#{figure_classes * ' '}">#{title_div}
         #{syntax_hl ? (syntax_hl.format node, lang, opts) : pre_open + (node.content || '') + pre_close}
 </figure>)
@@ -757,16 +756,30 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       # TODO: add complex class if list has nested blocks
       def convert_dlist node
         lines = []
+        id_attribute = node.id ? %( id="#{node.id}") : ''
+
+        classes = case node.style
+                  when 'horizontal'
+                    ['hdlist', node.role]
+                  when 'itemized', 'ordered'
+                    # QUESTION should we just use itemized-list and ordered-list as the class here? or just list?
+                    ['dlist', %(#{node.style}-list), node.role]
+                  else
+                    ['description-list']
+                  end.compact
+
+        class_attribute = %( class="#{classes.join ' '}")
+
+        lines << %(<div#{id_attribute}#{class_attribute}>)
+        lines << %(<div class="title">#{node.title}</div>) if node.title?
+
         case (style = node.style)
         when 'itemized', 'ordered'
           list_tag_name = style == 'itemized' ? 'ul' : 'ol'
           role = node.role
           subject_stop = node.attr 'subject-stop', (role && (node.has_role? 'stack') ? nil : ':')
-          # QUESTION should we just use itemized-list and ordered-list as the class here? or just list?
-          div_classes = [%(#{style}-list), role].compact
           list_class_attr = (node.option? 'brief') ? ' class="brief"' : ''
-          lines << %(<div class="#{div_classes * ' '}">
-<#{list_tag_name}#{list_class_attr}#{list_tag_name == 'ol' && (node.option? 'reversed') ? ' reversed="reversed"' : ''}>)
+          lines << %(<#{list_tag_name}#{list_class_attr}#{list_tag_name == 'ol' && (node.option? 'reversed') ? ' reversed="reversed"' : ''}>)
           node.items.each do |subjects, dd|
             # consists of one term (a subject) and supporting content
             subject = [*subjects].first.text
@@ -782,11 +795,40 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
             end
             lines << '</li>'
           end
-          lines << %(</#{list_tag_name}>
-</div>)
+          lines << %(</#{list_tag_name}>)
+        when 'horizontal'
+          lines << '<table>'
+          if (node.attr? 'labelwidth') || (node.attr? 'itemwidth')
+            lines << '<colgroup>'
+            col_style_attribute = (node.attr? 'labelwidth') ? %( style="width: #{(node.attr 'labelwidth').chomp '%'}%;") : ''
+            lines << %(<col#{col_style_attribute} />)
+            col_style_attribute = (node.attr? 'itemwidth') ? %( style="width: #{(node.attr 'itemwidth').chomp '%'}%;") : ''
+            lines << %(<col#{col_style_attribute} />)
+            lines << '</colgroup>'
+          end
+          node.items.each do |terms, dd|
+            lines << '<tr>'
+            lines << %(<td class="hdlist1#{(node.option? 'strong') ? ' strong' : ''}">)
+            first_term = true
+            terms.each do |dt|
+              lines << %(<br />) unless first_term
+              lines << '<p>'
+              lines << dt.text
+              lines << '</p>'
+              first_term = nil
+            end
+            lines << '</td>'
+            lines << '<td class="hdlist2">'
+            if dd
+              lines << %(<p>#{dd.text}</p>) if dd.text?
+              lines << dd.content if dd.blocks?
+            end
+            lines << '</td>'
+            lines << '</tr>'
+          end
+          lines << '</table>'
         else
-          lines << '<div class="description-list">
-<dl>'
+          lines << '<dl>'
           node.items.each do |terms, dd|
             [*terms].each do |dt|
               lines << %(<dt>
@@ -803,9 +845,10 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
             end
             lines << '</dd>'
           end
-          lines << '</dl>
-</div>'
+          lines << '</dl>'
         end
+
+        lines << '</div>'
         lines * LF
       end
 
@@ -879,14 +922,16 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         document
       end
 
-      def register_image node, target
-        if target.end_with? '.svg'
+      def register_media_file node, target, media_type
+        if target.end_with?('.svg') || target.start_with?('data:image/svg+xml')
           chapter = get_enclosing_chapter node
           chapter.set_attr 'epub-properties', [] unless chapter.attr? 'epub-properties'
           epub_properties = chapter.attr 'epub-properties'
           epub_properties << 'svg' unless epub_properties.include? 'svg'
         end
 
+        return if target.start_with? 'data:'
+
         out_dir = node.attr('outdir', nil, true) || doc_option(node.document, :to_dir)
         fs_path = (::File.join out_dir, target)
         unless ::File.exist? fs_path
@@ -894,7 +939,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
           fs_path = ::File.join base_dir, target
         end
         # We need *both* virtual and physical image paths. Unfortunately, references[:images] only has one of them.
-        @images << { name: target, path: fs_path }
+        @media_files << { name: target, path: fs_path, media_type: media_type }
       end
 
       def resolve_image_attrs node
@@ -911,16 +956,81 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         img_attrs
       end
 
+      def convert_audio node
+        id_attr = node.id ? %( id="#{node.id}") : ''
+        target = node.media_uri node.attr 'target'
+        register_media_file node, target, 'audio'
+        title_element = node.title? ? %(\n<figcaption>#{node.captioned_title}</figcaption>) : ''
+
+        autoplay_attr = (node.option? 'autoplay') ? ' autoplay="autoplay"' : ''
+        controls_attr = (node.option? 'nocontrols') ? '' : ' controls="controls"'
+        loop_attr = (node.option? 'loop') ? ' loop="loop"' : ''
+
+        start_t = node.attr 'start'
+        end_t = node.attr 'end'
+        if start_t || end_t
+          time_anchor = %(#t=#{start_t || ''}#{end_t ? ",#{end_t}" : ''})
+        else
+          time_anchor = ''
+        end
+
+        %(<figure#{id_attr} class="audioblock#{prepend_space node.role}">#{title_element}
+<div class="content">
+<audio src="#{target}#{time_anchor}"#{autoplay_attr}#{controls_attr}#{loop_attr}>
+<div>Your Reading System does not support (this) audio.</div>
+</audio>
+</div>
+</figure>)
+      end
+
+      # TODO: Support multiple video files in different formats for a single video
+      def convert_video node
+        id_attr = node.id ? %( id="#{node.id}") : ''
+        target = node.media_uri node.attr 'target'
+        register_media_file node, target, 'video'
+        title_element = node.title? ? %(\n<figcaption>#{node.captioned_title}</figcaption>) : ''
+
+        width_attr = (node.attr? 'width') ? %( width="#{node.attr 'width'}") : ''
+        height_attr = (node.attr? 'height') ? %( height="#{node.attr 'height'}") : ''
+        autoplay_attr = (node.option? 'autoplay') ? ' autoplay="autoplay"' : ''
+        controls_attr = (node.option? 'nocontrols') ? '' : ' controls="controls"'
+        loop_attr = (node.option? 'loop') ? ' loop="loop"' : ''
+
+        start_t = node.attr 'start'
+        end_t = node.attr 'end'
+        if start_t || end_t
+          time_anchor = %(#t=#{start_t || ''}#{end_t ? ",#{end_t}" : ''})
+        else
+          time_anchor = ''
+        end
+
+        if (poster = node.attr 'poster').nil_or_empty?
+          poster_attr = ''
+        else
+          poster = node.media_uri poster
+          register_media_file node, poster, 'image'
+          poster_attr = %( poster="#{poster}")
+        end
+
+        %(<figure#{id_attr} class="video#{prepend_space node.role}">#{title_element}
+<div class="content">
+<video src="#{target}#{time_anchor}"#{width_attr}#{height_attr}#{autoplay_attr}#{poster_attr}#{controls_attr}#{loop_attr}>
+<div>Your Reading System does not support (this) video.</div>
+</video>
+</div>
+</figure>)
+      end
+
       def convert_image node
         target = node.image_uri node.attr 'target'
-        register_image node, target
+        register_media_file node, target, 'image'
         id_attr = node.id ? %( id="#{node.id}") : ''
+        title_element = node.title? ? %(\n<figcaption>#{node.captioned_title}</figcaption>) : ''
         img_attrs = resolve_image_attrs node
         %(<figure#{id_attr} class="image#{prepend_space node.role}">
 <div class="content">
 <img src="#{target}"#{prepend_space img_attrs * ' '} />
-</div>#{node.title? ? %(
-<figcaption>#{node.captioned_title}</figcaption>) : ''}
+</div>#{title_element}
 </figure>)
       end
 
@@ -1025,7 +1135,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
           %(<i class="#{i_classes * ' '}"></i>)
         else
           target = node.image_uri node.target
-          register_image node, target
+          register_media_file node, target, 'image'
 
           img_attrs = resolve_image_attrs node
           img_attrs << %(class="inline#{prepend_space node.role}")

data/lib/asciidoctor-epub3/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Epub3
-    VERSION = '1.5.0.alpha.15'
+    VERSION = '1.5.0.alpha.16'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-epub3
 version: !ruby/object:Gem::Version
-  version: 1.5.0.alpha.15
+  version: 1.5.0.alpha.16
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
@@ -107,14 +107,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 'An extension for Asciidoctor that converts AsciiDoc documents to EPUB3
   and KF8/MOBI (Kindle) e-book archives.