asciidoctor-epub3 1.5.0.alpha.18 → 1.5.0.alpha.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 352b650ba19d840c6f0eb7cdcc1f6abe941d05316b4d92d220faf2e21b63ba87
-  data.tar.gz: fd2a164d0c20c9ee6415e47d9d77db71f6ba09500219778508794e6210b93130
+  metadata.gz: 30d660ed4a7fc21dc01c61ae77515dbba77dd8bbbd7618e45709f7048745040c
+  data.tar.gz: f3b2d04be71c163e9ed29ae907f2a2c2ab00ecd3e6ecb329775952b5853ebf9d
 SHA512:
-  metadata.gz: be30f10eaa7309066230c86e3f124cda27a9668a0b1eac7ac2d68f70eddacb2ab9886dadcd96ac292845d4da28c52ffefa63ded60282cbf0d55c39fa8efbf0df
-  data.tar.gz: 3e1ec0eef64136a609d402a5cae8b4bb03007ea462a362f2e33df55ed0b84bdc624c61b9813cafca1a35d81401c31859fef28f487505aaaaa036944134f7ad77
+  metadata.gz: 06fb18e09b9ec33401e46168f85436c871accb1f3774b51a8f29373185ba1a538bb2f7a00663e37a43c778238b8bd55ac01883b58f8a173041b0fcb20acdea91
+  data.tar.gz: 248b718e05d9e8750dbb44117de81a04cdde271da64f96b720f145e54de61a19cf79d29e7f2dd4b2664f84b9c534c38d94ca84e6e87982839a31144c0cf0a3f2

data/CHANGELOG.adoc

@@ -5,6 +5,20 @@
 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.19 (2020-10-21) - @slonopotamus
+
+* add title and id support for literal blocks (#357)
+* fix quotes not being properly escaped in section titles (#358)
+* fix crash when encountering unsupported Asciidoctor node (#360)
+* add support for 100%-wide table (#356)
+* do not add multiple entries for same media files in book manifest (#370)
+* do not add bogus entries to manifest when `:data-uri:` attribute is set (#371)
+* add id support for listing blocks (#372)
+* stop using deprecated `epub:type` for admonitions (#373)
+* fix `epub:type` attributes for special sections (#374)
+* fix font resize not working in iBooks (#368)
+* fix visited link color in iBooks night mode (#366)
+
 == 1.5.0.alpha.18 (2020-07-27) - @slonopotamus
 
 * remove <b> from chapter subtitle (#123)
@@ -112,6 +126,7 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * upgrade pygments.rb to 1.2.1 (#216)
 * gepub dependency is no longer locked to 1.0.2 and will use latest 1.0.x version
 * fix `-a ebook-validate` not working on Windows (#232)
+* fix crash when inline pass macro `m` contains an icon (#375)
 
 == 1.5.0.alpha.9 (2019-04-04) - @mojavelinux
 

data/Gemfile

@@ -14,7 +14,4 @@ end
 group :optional do
   # epubcheck-ruby might be safe to be converted into runtime dependency, but could have issues when packaged into asciidoctorj-epub3
   gem 'epubcheck-ruby', '~> 4.2.4.0'
-  # We would like to make kindlegen a runtime dependency, but can't because of the way asciidoctorj-epub3 packaging works
-  # See https://github.com/asciidoctor/asciidoctor-epub3/issues/288
-  gem 'kindlegen', '~> 3.0.3'
 end

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.18, 2020-07-27
+v1.5.0.alpha.19, 2020-10-21
 // Settings:
 :experimental:
 :idprefix:

data/data/styles/epub3.css

@@ -17,7 +17,6 @@ html {
   /* set the em base (and relative em anchor) by setting the font-size on html */
   /* TODO set font-size > 100% except for Kindle */
   font-size: 100%;
-  -webkit-text-size-adjust: 100%;
 }
 
 /* don't set margin on body as that's how many readers frame reading area */
@@ -243,12 +242,6 @@ body:first-of-type a:link {
   background-position: 0 1.2em;
 }
 
-body a:visited {
-  color: #333332;
-  /* hack for font color in iBooks */
-  -webkit-text-fill-color: #333332;
-}
-
 code.literal {
   /* don't let it affect line spacing */
   /* disable since M+ 1mn won't interrupt line height */
@@ -685,12 +678,6 @@ div.abstract > p {
   line-height: 1.75;
 }
 
-div.abstract > p a:link {
-  color: #333332;
-  /* hack for font color in iBooks */
-  -webkit-text-fill-color: #333332;
-}
-
 div.abstract > p:first-child::first-line {
   font-weight: bold;
   -webkit-font-feature-settings: "kern" off;

data/lib/asciidoctor-epub3/converter.rb

@@ -39,9 +39,9 @@ module Asciidoctor
 
         if @format == :kf8
           # QUESTION shouldn't we validate this epub file too?
-          distill_epub_to_mobi epub_file, target, @compress, @kindlegen_path
+          distill_epub_to_mobi epub_file, target, @compress
         elsif @validate
-          validate_epub epub_file, @epubcheck_path
+          validate_epub epub_file
         end
       end
 
@@ -105,7 +105,7 @@ module Asciidoctor
         if respond_to? method_name
           send method_name, node
         else
-          logger.warn %(#{::File.basename node.attr('docfile')}: conversion missing in backend #{@backend} for #{name})
+          logger.warn %(conversion missing in backend #{@backend} for #{name})
           nil
         end
       end
@@ -143,6 +143,10 @@ module Asciidoctor
         title
       end
 
+      def icon_names
+        @icon_names ||= []
+      end
+
       def convert_document node
         @format = node.attr('ebook-format').to_sym
 
@@ -152,8 +156,7 @@ module Asciidoctor
         @kindlegen_path = node.attr 'ebook-kindlegen-path'
         @epubcheck_path = node.attr 'ebook-epubcheck-path'
         @xrefs_seen = ::Set.new
-        @icon_names = []
-        @media_files = []
+        @media_files = {}
         @footnotes = []
 
         @book = GEPUB::Book.new 'EPUB/package.opf'
@@ -267,14 +270,14 @@ module Asciidoctor
         docimagesdir = (node.attr 'imagesdir', '.').chomp '/'
         docimagesdir = (docimagesdir == '.' ? nil : %(#{docimagesdir}/))
 
-        @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)
+        @media_files.each do |name, file|
+          if name.start_with? %(#{docimagesdir}jacket/cover.)
+            logger.warn %(path is reserved for cover artwork: #{name}; skipping file found in content)
           elsif file[:path].nil? || File.readable?(file[:path])
-            mime_types = MIME::Types.type_for file[:name]
+            mime_types = MIME::Types.type_for 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
+            @book.add_item name, content: file[:path], media_type: preferred_mime_type
           else
             logger.error %(#{File.basename node.attr('docfile')}: media file not found or not readable: #{file[:path]})
           end
@@ -328,7 +331,7 @@ module Asciidoctor
         chapter_item = @book.add_ordered_item %(#{docid}.xhtml)
 
         doctitle = node.document.doctitle partition: true, use_fallback: true
-        doctitle_sanitized = sanitize_xml doctitle.combined, :cdata
+        chapter_title = doctitle.combined
 
         if node.context == :document && doctitle.subtitle?
           title = %(#{doctitle.main} )
@@ -337,7 +340,7 @@ module Asciidoctor
           # HACK: until we get proper handling of title-only in CSS
           title = ''
           subtitle = get_numbered_title node
-          doctitle_sanitized = sanitize_xml subtitle, :cdata
+          chapter_title = subtitle
         else
           title = nil
           subtitle = nil
@@ -360,10 +363,10 @@ module Asciidoctor
 
         # NOTE must run after content is resolved
         # TODO perhaps create dynamic CSS file?
-        if @icon_names.empty?
+        if icon_names.empty?
           icon_css_head = ''
         else
-          icon_defs = @icon_names.map {|name|
+          icon_defs = icon_names.map {|name|
             %(.i-#{name}::before { content: "#{FontIconMap.unicode name}"; })
           } * LF
           icon_css_head = %(<style>
@@ -387,7 +390,7 @@ module Asciidoctor
 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xmlns:mml="http://www.w3.org/1998/Math/MathML" xml:lang="#{lang = node.document.attr 'lang', 'en'}" lang="#{lang}">
 <head>
 <meta charset="UTF-8"/>
-<title>#{doctitle_sanitized}</title>
+<title>#{chapter_title}</title>
 <link rel="stylesheet" type="text/css" href="styles/epub3.css"/>
 <link rel="stylesheet" type="text/css" href="styles/epub3-css3-only.css" media="(min-device-width: 0px)"/>
 #{icon_css_head}<script type="text/javascript"><![CDATA[
@@ -401,11 +404,13 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
 ]]></script>)]
 
         syntax_hl = node.document.syntax_highlighter
+        epub_type_attr = node.respond_to?(:section) && node.sectname != 'section' ? %( epub:type="#{node.sectname}") : ''
+
         lines << (syntax_hl.docinfo :head, node, linkcss: linkcss, self_closing_tag_slash: '/') if syntax_hl&.docinfo? :head
 
         lines << %(</head>
 <body>
-<section class="chapter" title="#{doctitle_sanitized}" epub:type="chapter" id="#{docid}">
+<section class="chapter" title=#{chapter_title.encode xml: :attr}#{epub_type_attr} id="#{docid}">
 #{header}
         #{content})
 
@@ -446,11 +451,10 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       def convert_section node
         if add_chapter(node).nil?
           hlevel = node.level
-          epub_type_attr = node.special ? %( epub:type="#{node.sectname}") : ''
+          epub_type_attr = node.sectname != 'section' ? %( epub:type="#{node.sectname}") : ''
           div_classes = [%(sect#{node.level}), node.role].compact
           title = get_numbered_title node
-          title_sanitized = xml_sanitize title
-          %(<section class="#{div_classes * ' '}" title="#{title_sanitized}"#{epub_type_attr}>
+          %(<section class="#{div_classes * ' '}" title=#{title.encode xml: :attr}#{epub_type_attr}>
 <h#{hlevel} id="#{node.id}">#{title}</h#{hlevel}>#{(content = node.content).empty? ? '' : %(
           #{content})}
 </section>)
@@ -533,14 +537,12 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         type = node.attr 'name'
         epub_type = case type
                     when 'tip'
-                      'help'
-                    when 'note'
-                      'note'
-                    when 'important', 'warning', 'caution'
-                      'warning'
+                      'tip'
+                    when 'important', 'warning', 'caution', 'note'
+                      'notice'
                     else
                       logger.warn %(unknown admonition type: #{type})
-                      'note'
+                      'notice'
                     end
         %(<aside#{id_attr} class="admonition #{type}"#{title_attr} epub:type="#{epub_type}">
 #{title_el}<div class="content">
@@ -567,6 +569,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       end
 
       def convert_listing node
+        id_attribute = node.id ? %( id="#{node.id}") : ''
         nowrap = (node.option? 'nowrap') || !(node.document.attr? 'prewrap')
         if node.style == 'source'
           lang = node.attr 'language'
@@ -589,7 +592,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         figure_classes = ['listing']
         figure_classes << 'coalesce' if node.option? 'unbreakable'
         title_div = node.title? ? %(<figcaption>#{node.captioned_title}</figcaption>) : ''
-        %(<figure class="#{figure_classes * ' '}">#{title_div}
+        %(<figure#{id_attribute} class="#{figure_classes * ' '}">#{title_div}
         #{syntax_hl ? (syntax_hl.format node, lang, opts) : pre_open + (node.content || '') + pre_close}
 </figure>)
       end
@@ -617,9 +620,13 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         Helpers.require_library('asciimath', true, :warn).nil? ? :unavailable : :loaded
       end
 
-      # QUESTION should we wrap the <pre> in either <div> or <figure>?
       def convert_literal node
-        %(<pre class="screen">#{node.content}</pre>)
+        id_attribute = node.id ? %( id="#{node.id}") : ''
+        title_element = node.title? ? %(<figcaption>#{node.captioned_title}</figcaption>) : ''
+        %(<figure#{id_attribute} class="literalblock#{prepend_space node.role}">
+#{title_element}
+<div class="content"><pre class="screen">#{node.content}</pre></div>
+</figure>)
       end
 
       def convert_page_break _node
@@ -712,10 +719,8 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         table_styles = []
         if (autowidth = node.option? 'autowidth') && !(node.attr? 'width')
           table_classes << 'fit-content'
-        elsif (tablewidth = node.attr 'tablepcwidth') == 100
-          table_classes << 'stretch'
         else
-          table_styles << %(width: #{tablewidth}%;)
+          table_styles << %(width: #{node.attr 'tablepcwidth'}%;)
         end
         table_class_attr = %( class="#{table_classes * ' '}")
         table_style_attr = !table_styles.empty? ? %( style="#{table_styles * '; '}") : ''
@@ -966,6 +971,8 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
           epub_properties << 'svg' unless epub_properties.include? 'svg'
         end
 
+        return if target.start_with? 'data:'
+
         if Asciidoctor::Helpers.uriish? target
           # We need to add both local and remote media files to manifest
           fs_path = nil
@@ -978,7 +985,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
           end
         end
         # We need *both* virtual and physical image paths. Unfortunately, references[:images] only has one of them.
-        @media_files << { name: target, path: fs_path, media_type: media_type }
+        @media_files[target] ||= { path: fs_path, media_type: media_type }
       end
 
       def resolve_image_attrs node
@@ -1165,7 +1172,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
 
       def convert_inline_image node
         if node.type == 'icon'
-          @icon_names << (icon_name = node.target)
+          icon_names << (icon_name = node.target)
           i_classes = ['icon', %(i-#{icon_name})]
           i_classes << %(icon-#{node.attr 'size'}) if node.attr? 'size'
           i_classes << %(icon-flip-#{(node.attr 'flip')[0]}) if node.attr? 'flip'
@@ -1626,10 +1633,10 @@ body > svg {
           .to_ios
       end
 
-      def get_kindlegen_command kindlegen_path
-        unless kindlegen_path.nil?
-          logger.debug %(Using ebook-kindlegen-path attribute: #{kindlegen_path})
-          return [kindlegen_path]
+      def get_kindlegen_command
+        unless @kindlegen_path.nil?
+          logger.debug %(Using ebook-kindlegen-path attribute: #{@kindlegen_path})
+          return [@kindlegen_path]
         end
 
         unless (result = ENV['KINDLEGEN']).nil?
@@ -1637,22 +1644,15 @@ body > svg {
           return [result]
         end
 
-        begin
-          require 'kindlegen' unless defined? ::Kindlegen
-          result = ::Kindlegen.command.to_s
-          logger.debug %(Using KindleGen from gem: #{result})
-          [result]
-        rescue LoadError => e
-          logger.debug %(#{e}; Using KindleGen from PATH)
-          [%(kindlegen#{::Gem.win_platform? ? '.exe' : ''})]
-        end
+        logger.debug 'Using KindleGen from PATH'
+        [%(kindlegen#{::Gem.win_platform? ? '.exe' : ''})]
       end
 
-      def distill_epub_to_mobi epub_file, target, compress, kindlegen_path
+      def distill_epub_to_mobi epub_file, target, compress
         mobi_file = ::File.basename target.sub(EpubExtensionRx, '.mobi')
         compress_flag = KindlegenCompression[compress ? (compress.empty? ? '1' : compress.to_s) : '0']
 
-        argv = get_kindlegen_command(kindlegen_path) + ['-dont_append_source', compress_flag, '-o', mobi_file, epub_file].compact
+        argv = get_kindlegen_command + ['-dont_append_source', compress_flag, '-o', mobi_file, epub_file].compact
         begin
           # This duplicates Kindlegen.run, but we want to override executable
           out, err, res = Open3.capture3(*argv) do |r|
@@ -1677,10 +1677,10 @@ body > svg {
         end
       end
 
-      def get_epubcheck_command epubcheck_path
-        unless epubcheck_path.nil?
-          logger.debug %(Using ebook-epubcheck-path attribute: #{epubcheck_path})
-          return [epubcheck_path]
+      def get_epubcheck_command
+        unless @epubcheck_path.nil?
+          logger.debug %(Using ebook-epubcheck-path attribute: #{@epubcheck_path})
+          return [@epubcheck_path]
         end
 
         unless (result = ENV['EPUBCHECK']).nil?
@@ -1698,8 +1698,8 @@ body > svg {
         end
       end
 
-      def validate_epub epub_file, epubcheck_path
-        argv = get_epubcheck_command(epubcheck_path) + ['-w', epub_file]
+      def validate_epub epub_file
+        argv = get_epubcheck_command + ['-w', epub_file]
         begin
           out, err, res = Open3.capture3(*argv)
         rescue Errno::ENOENT => e

data/lib/asciidoctor-epub3/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-epub3
 version: !ruby/object:Gem::Version
-  version: 1.5.0.alpha.18
+  version: 1.5.0.alpha.19
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
@@ -287,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Converts AsciiDoc documents to EPUB3 and KF8/MOBI (Kindle) e-book formats