asciidoctor-epub3 1.5.0.alpha.11 → 1.5.0.alpha.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6cfcebc3d7d9ef77b095587955fd682f7cfb5b245d03a10f7e7c8737f8c7092
-  data.tar.gz: db9e5bc0d12af5937f1628bc8313036fca1e50c04e324384e42d11f22922a021
+  metadata.gz: 761bc4b79a56daa0101477d7e58da7e5bcfa33f1a23e0f58ded5639ea1f91241
+  data.tar.gz: dc6068f91e7c7284f7e3891ea74d42014255eb7e318911e85be3fbfbbba8fbb1
 SHA512:
-  metadata.gz: 5ec6e59577eab71f02cefa75d97a48e00516ec7d3aba4ff31122ba31d699de3b779995d2efa44a8016cf1a2f7003e66bad137dd424781fde1a1af1dc6a06621a
-  data.tar.gz: 9e409822739509a541afa965466d8574c1de853b3e057db4d810a134093129ac0e261e998f56540c1b8cdfcb1333a0c369fd1a7d3f70a7728552f94cd1f6f0cf
+  metadata.gz: 9691e8c859d1a4b8c27f5e1cf2999450ba6dc5dc53b5841084a734196de6ffc6eb6158bec6bd9dda70cfa869837d466e02bd7db9ca524fd27f72b417ad77bc37
+  data.tar.gz: 1d7f3bc67a899f05596ca5be57aedee0e737a0ec2243767faf2ea1f3ad2fcef40b6111d5a6798a9156ca73872df90e3e7338acf5c395d5b0f41d5523cab639e9

data/CHANGELOG.adoc

@@ -5,6 +5,16 @@
 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.12 (2020-02-02) - @slonopotamus
+
+* make kindlegen a runtime dependency so it installs automatically during `gem install asciidoctor-epub3` (#270)
+* make `KINDLEGEN` env var work again (#269)
+* stop adding default front cover image (#180)
+* enable Pygments on non-Windows JRuby platforms (#264)
+* provide a human-readable error message when we fail to find KindleGen (#268)
+* try to use KindleGen/EPUBCheck binary from `$PATH` (#276)
+* add `ebook-kindlegen-path`/`ebook-epubcheck-path` attributes to override KindleGen/EPUBCheck executable location (#276)
+
 == 1.5.0.alpha.11 (2020-01-26) - @slonopotamus
 
 * drop unused dependencies: thread_safe, concurrent-ruby (#234)

data/Gemfile

@@ -8,8 +8,6 @@ gemspec
 gem 'asciidoctor', ENV['ASCIIDOCTOR_VERSION'], require: false if ENV.key? 'ASCIIDOCTOR_VERSION'
 
 group :optional do
-  gem 'epubcheck-ruby', '4.2.2.0'
-  gem 'kindlegen', (Gem::Version.new RUBY_VERSION) < (Gem::Version.new '2.4.0') ? '3.0.3' : '3.0.5'
   gem 'pygments.rb', '1.2.1'
 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.11, 2020-01-26
+v1.5.0.alpha.12, 2020-02-02
 // Settings:
 :experimental:
 :idprefix:
@@ -541,14 +541,22 @@ For more information about this attribute and other related attributes, see {uri
 *-D, --destination-dir* ::
   Writes files to specified directory (defaults to the current directory)
 
+*-a ebook-epubcheck-path=<path>*::
+  Specifies path to EPUBCheck executable to use with `-a ebook-validate`.
+  This attribute takes precedence over `EPUBCHECK` environment variable.
+
 *-a ebook-extract* ::
   Extracts the EPUB3 to a folder in the destination directory after the file is generated
 
 *-a ebook-format=<format>* ::
   Specifies the ebook format to generate (epub3 or kf8, default: epub3)
 
+*-a ebook-kindlegen-path=<path>*::
+  Specifies path to KindleGen executable to use when producing KF8/Mobi.
+  This attribute takes precedence over `KINDLEGEN` environment variable.
+
 *-a ebook-validate* ::
-  Runs {uri-epubcheck}[EpubCheck] to validate output file against the EPUB3 specification
+  Runs {uri-epubcheck}[EPUBCheck] to validate output file against the EPUB3 specification
 
 *-a ebook-compress=<0|1|2|none|standard|huffdic>* ::
   Controls the compression type used by kindlegen (0=none [default if unset], 1=standard [default if empty], 2=huffdic)
@@ -556,6 +564,16 @@ For more information about this attribute and other related attributes, see {uri
 *-v, --version* ::
   Display the program version
 
+=== Environment variables
+
+*EPUBCHECK*::
+  Specifies path to EPUBCheck executable to use with `-a ebook-validate`.
+  Effect of this variable can be overriden with `-a ebook-epubcheck-path` attribute.
+
+*KINDLEGEN*::
+  Specifies path to KindleGen executable to use when producing KF8/Mobi.
+  Effect of this variable can be overriden with `-a ebook-kindlegen-path` attribute.
+
 === EPUB3 Archive Structure
 
 Here's a sample manifest of files found in an EPUB3 document produced by {project-name}.
@@ -614,16 +632,16 @@ The sample book contains placeholder images for an author avatar and a book cove
 
 // TODO explain the avatar and book cover images
 
-=== Changing the Cover Image
+=== Adding the Cover Image
 
 Ereaders have different image resolution and file size limits regarding a book's cover.
-Kindle covers tend to be 1050x1600 (16:9 resolution), which is the size of the sample cover provided with {project-name}.
+Kindle covers tend to be 1050x1600 (16:9 resolution).
 To ensure your cover displays correctly, you'll want to review the documentation or publisher guidelines for the e-reading platform you're targeting.
 
 WARNING: We've found that if the book cover is more than 1600px on any side, Aldiko will not render it and may even crash.
 
 Feel free to use the SVG of the sample cover in the [path]_data/images_ folder as a template for creating your own cover.
-Once your image is ready, you can replace the placeholder cover image by defining the `front-cover-image` attribute in the header of the master document.
+Once your image is ready, you can set the cover image by defining the `front-cover-image` attribute in the header of the master document.
 
 [source,asciidoc]
 ----

data/asciidoctor-epub3.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('lib/asciidoctor-epub3/version', File.dirname(__FILE__))
+require_relative 'lib/asciidoctor-epub3/version'
 require 'open3' unless defined? Open3
 
 Gem::Specification.new do |s|
@@ -17,8 +17,7 @@ An extension for Asciidoctor that converts AsciiDoc documents to EPUB3 and KF8/M
   s.homepage = 'https://github.com/asciidoctor/asciidoctor-epub3'
   s.license = 'MIT'
 
-  # NOTE required ruby version is informational only; it's not enforced since it can't be overridden and can cause builds to break
-  #s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.3.0'
 
   files = begin
     (result = Open3.popen3('git ls-files -z') {|_, out| out.read }.split %(\0)).empty? ? Dir['**/*'] : result
@@ -31,11 +30,13 @@ An extension for Asciidoctor that converts AsciiDoc documents to EPUB3 and KF8/M
 
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'rake', '~> 12.3.0'
+  s.add_development_dependency 'rake', '~> 13.0.0'
   s.add_development_dependency 'rspec', '~> 3.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.78.0'
+  s.add_development_dependency 'rubocop', '~> 0.79.0'
   s.add_development_dependency 'rubocop-rspec', '~> 1.37.0'
 
   s.add_runtime_dependency 'asciidoctor', '>= 1.5.3', '< 3.0.0'
+  s.add_runtime_dependency 'epubcheck-ruby', '~> 4.2.2.0'
   s.add_runtime_dependency 'gepub', '~> 1.0.0'
+  s.add_runtime_dependency 'kindlegen', '>= 3.0.3', '<= 3.0.5'
 end

data/lib/asciidoctor-epub3/converter.rb

@@ -21,6 +21,8 @@ module Asciidoctor
         htmlsyntax 'xml'
         @validate = false
         @extract = false
+        @kindlegen_path = nil
+        @epubcheck_path = nil
       end
 
       def convert node, name = nil
@@ -28,6 +30,8 @@ module Asciidoctor
           @validate = node.attr? 'ebook-validate'
           @extract = node.attr? 'ebook-extract'
           @compress = node.attr 'ebook-compress'
+          @kindlegen_path = node.attr 'ebook-kindlegen-path'
+          @epubcheck_path = node.attr 'ebook-epubcheck-path'
           spine_items = node.references[:spine_items]
           if spine_items.nil?
             logger.error %(#{::File.basename node.document.attr('docfile')}: failed to find spine items, produced file will be invalid)
@@ -44,7 +48,7 @@ module Asciidoctor
 
       # FIXME: we have to package in write because we don't have access to target before this point
       def write packager, target
-        packager.package validate: @validate, extract: @extract, compress: @compress, target: target
+        packager.package validate: @validate, extract: @extract, compress: @compress, kindlegen_path: @kindlegen_path, epubcheck_path: @epubcheck_path, target: target
         nil
       end
     end
@@ -92,15 +96,16 @@ module Asciidoctor
         @icon_names = []
       end
 
-      def convert node, name = nil
-        if respond_to? name ||= node.node_name
-          send name, node
+      def convert node, name = nil, _opts = {}
+        method_name = %(convert_#{name ||= node.node_name})
+        if respond_to? method_name
+          send method_name, node
         else
-          logger.warn %(conversion missing in epub3 backend for #{name})
+          logger.warn %(conversion missing in backend #{@backend} for #{name})
         end
       end
 
-      def document node
+      def convert_document node
         docid = node.id
         pubtype = node.attr 'publication-type', 'book'
 
@@ -193,11 +198,11 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       end
 
       # NOTE embedded is used for AsciiDoc table cell content
-      def embedded node
+      def convert_embedded node
         node.content
       end
 
-      def section node
+      def convert_section node
         hlevel = node.level + 1
         epub_type_attr = node.special ? %( epub:type="#{node.sectname}") : ''
         div_classes = [%(sect#{node.level}), node.role].compact
@@ -215,36 +220,36 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       end
 
       # TODO: support use of quote block as abstract
-      def preamble node
+      def convert_preamble node
         if (first_block = node.blocks[0]) && first_block.style == 'abstract'
-          abstract first_block
+          convert_abstract first_block
           # REVIEW: should we treat the preamble as an abstract in general?
         elsif first_block && node.blocks.size == 1
-          abstract first_block
+          convert_abstract first_block
         else
           node.content
         end
       end
 
-      def open node
+      def convert_open node
         id_attr = node.id ? %( id="#{node.id}") : nil
         class_attr = node.role ? %( class="#{node.role}") : nil
         if id_attr || class_attr
           %(<div#{id_attr}#{class_attr}>
-#{convert_content node}
+#{output_content node}
 </div>)
         else
-          convert_content node
+          output_content node
         end
       end
 
-      def abstract node
+      def convert_abstract node
         %(<div class="abstract" epub:type="preamble">
-#{convert_content node}
+#{output_content node}
 </div>)
       end
 
-      def paragraph node
+      def convert_paragraph node
         role = node.role
         # stack-head is the alternative to the default, inline-head (where inline means "run-in")
         head_stop = node.attr 'head-stop', (role && (node.has_role? 'stack-head') ? nil : '.')
@@ -257,7 +262,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
       end
 
-      def pass node
+      def convert_pass node
         content = node.content
         if content == '<?hard-pagebreak?>'
           '<hr epub:type="pagebreak" class="pagebreak"/>'
@@ -266,7 +271,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
       end
 
-      def admonition node
+      def convert_admonition node
         id_attr = node.id ? %( id="#{node.id}") : ''
         if node.title?
           title = node.title
@@ -290,29 +295,29 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
                     end
         %(<aside#{id_attr} class="admonition #{type}"#{title_attr} epub:type="#{epub_type}">
 #{title_el}<div class="content">
-#{convert_content node}
+#{output_content node}
 </div>
 </aside>)
       end
 
-      def example node
+      def convert_example node
         id_attr = node.id ? %( id="#{node.id}") : ''
         title_div = node.title? ? %(<div class="example-title">#{node.title}</div>
 ) : ''
         %(<div#{id_attr} class="example">
 #{title_div}<div class="example-content">
-#{convert_content node}
+#{output_content node}
 </div>
 </div>)
       end
 
-      def floating_title node
+      def convert_floating_title node
         tag_name = %(h#{node.level + 1})
         id_attribute = node.id ? %( id="#{node.id}") : ''
         %(<#{tag_name}#{id_attribute} class="#{['discrete', node.role].compact * ' '}">#{node.title}</#{tag_name}>)
       end
 
-      def listing node
+      def convert_listing node
         figure_classes = ['listing']
         figure_classes << 'coalesce' if node.option? 'unbreakable'
         pre_classes = node.style == 'source' ? ['source', %(language-#{node.attr 'language'})] : ['screen']
@@ -326,19 +331,19 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       end
 
       # QUESTION should we wrap the <pre> in either <div> or <figure>?
-      def literal node
+      def convert_literal node
         %(<pre class="screen">#{node.content}</pre>)
       end
 
-      def page_break _node
+      def convert_page_break _node
         '<hr epub:type="pagebreak" class="pagebreak"/>'
       end
 
-      def thematic_break _node
+      def convert_thematic_break _node
         '<hr class="thematicbreak"/>'
       end
 
-      def quote node
+      def convert_quote node
         id_attr = %( id="#{node.id}") if node.id
         class_attr = (role = node.role) ? %( class="blockquote #{role}") : ' class="blockquote"'
 
@@ -356,7 +361,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
 
         footer_tag = footer_content.empty? ? '' : %(
 <footer>~ #{footer_content * ' '}</footer>)
-        content = (convert_content node).strip
+        content = (output_content node).strip
         %(<div#{id_attr}#{class_attr}>
 <blockquote>
 #{content}#{footer_tag}
@@ -364,7 +369,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
 </div>)
       end
 
-      def verse node
+      def convert_verse node
         id_attr = %( id="#{node.id}") if node.id
         class_attr = (role = node.role) ? %( class="verse #{role}") : ' class="verse"'
 
@@ -385,7 +390,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
 </div>)
       end
 
-      def sidebar node
+      def convert_sidebar node
         classes = ['sidebar']
         if node.title?
           classes << 'titled'
@@ -400,12 +405,12 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
 
         %(<aside class="#{classes * ' '}"#{title_attr} epub:type="sidebar">
 #{title_el}<div class="content">
-#{convert_content node}
+#{output_content node}
 </div>
 </aside>)
       end
 
-      def table node
+      def convert_table node
         lines = [%(<div class="table">)]
         lines << %(<div class="content">)
         table_id_attr = node.id ? %( id="#{node.id}") : ''
@@ -493,7 +498,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         lines * LF
       end
 
-      def colist node
+      def convert_colist node
         lines = ['<div class="callout-list">
 <ol>']
         num = CalloutStartNum
@@ -506,7 +511,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       end
 
       # TODO: add complex class if list has nested blocks
-      def dlist node
+      def convert_dlist node
         lines = []
         case (style = node.style)
         when 'itemized', 'ordered'
@@ -560,7 +565,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         lines * LF
       end
 
-      def olist node
+      def convert_olist node
         complex = false
         div_classes = ['ordered-list', node.style, node.role].compact
         ol_classes = [node.style, ((node.option? 'brief') ? 'brief' : nil)].compact
@@ -588,7 +593,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         lines * LF
       end
 
-      def ulist node
+      def convert_ulist node
         complex = false
         div_classes = ['itemized-list', node.style, node.role].compact
         ul_classes = [node.style, ((node.option? 'brief') ? 'brief' : nil)].compact
@@ -615,7 +620,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         lines * LF
       end
 
-      def image node
+      def convert_image node
         target = node.attr 'target'
         type = (::File.extname target)[1..-1]
         id_attr = node.id ? %( id="#{node.id}") : ''
@@ -654,7 +659,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
 </figure>)
       end
 
-      def inline_anchor node
+      def convert_inline_anchor node
         target = node.target
         case node.type
         when :xref # TODO: would be helpful to know what type the target is (e.g., bibref)
@@ -722,22 +727,22 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
       end
 
-      def inline_break node
+      def convert_inline_break node
         %(#{node.text}<br/>)
       end
 
-      def inline_button node
+      def convert_inline_button node
         %(<b class="button">[<span class="label">#{node.text}</span>]</b>)
       end
 
-      def inline_callout node
+      def convert_inline_callout node
         num = CalloutStartNum
         int_num = node.text.to_i
         (int_num - 1).times { num = num.next }
         %(<i class="conum" data-value="#{int_num}">#{num}</i>)
       end
 
-      def inline_footnote node
+      def convert_inline_footnote node
         if (index = node.attr 'index')
           %(<sup class="noteref">[<a id="noteref-#{index}" href="#note-#{index}" epub:type="noteref">#{index}</a>]</sup>)
         elsif node.type == :xref
@@ -745,7 +750,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
       end
 
-      def inline_image node
+      def convert_inline_image node
         if node.type == 'icon'
           @icon_names << (icon_name = node.target)
           i_classes = ['icon', %(i-#{icon_name})]
@@ -769,11 +774,11 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
       end
 
-      def inline_indexterm node
+      def convert_inline_indexterm node
         node.type == :visible ? node.text : ''
       end
 
-      def inline_kbd node
+      def convert_inline_kbd node
         if (keys = node.attr 'keys').size == 1
           %(<kbd>#{keys[0]}</kbd>)
         else
@@ -782,7 +787,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
       end
 
-      def inline_menu node
+      def convert_inline_menu node
         menu = node.attr 'menu'
         # NOTE we swap right angle quote with chevron right from FontAwesome using CSS
         caret = %(#{NoBreakSpace}<span class="caret">#{RightAngleQuote}</span> )
@@ -796,7 +801,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
       end
 
-      def inline_quoted node
+      def convert_inline_quoted node
         case node.type
         when :strong
           %(<strong>#{node.text}</strong>)
@@ -819,7 +824,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         end
       end
 
-      def convert_content node
+      def output_content node
         node.content_model == :simple ? %(<p>#{node.content}</p>) : node.content
       end
 
@@ -915,7 +920,8 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       if (document = @document).backend == 'epub3'
         document.attributes['spine'] = ''
         document.set_attribute 'listing-caption', 'Listing'
-        if !(defined? ::JRuby) && (::Gem.try_activate 'pygments.rb')
+        # pygments.rb hangs on JRuby for Windows, see https://github.com/asciidoctor/asciidoctor-epub3/issues/253
+        if !(::RUBY_ENGINE == 'jruby' && Gem.win_platform?) && (Gem.try_activate 'pygments.rb')
           if document.set_attribute 'source-highlighter', 'pygments'
             document.set_attribute 'pygments-css', 'style'
             document.set_attribute 'pygments-style', 'bw'

data/lib/asciidoctor-epub3/packager.rb

@@ -7,7 +7,7 @@ module Asciidoctor
   module Epub3
     module GepubBuilderMixin
       include ::Asciidoctor::Logging
-      DATA_DIR = ::File.expand_path ::File.join(::File.dirname(__FILE__), '..', '..', 'data')
+      DATA_DIR = ::File.expand_path ::File.join(__dir__, '..', '..', 'data')
       SAMPLES_DIR = ::File.join DATA_DIR, 'samples'
       LF = ?\n
       CharEntityRx = ContentConverter::CharEntityRx
@@ -15,7 +15,6 @@ module Asciidoctor
       FromHtmlSpecialCharsMap = ContentConverter::FromHtmlSpecialCharsMap
       FromHtmlSpecialCharsRx = ContentConverter::FromHtmlSpecialCharsRx
       CsvDelimiterRx = /\s*,\s*/
-      DefaultCoverImage = 'images/default-cover.png'
       ImageMacroRx = /^image::?(.*?)\[(.*?)\]$/
       ImgSrcScanRx = /<img src="(.+?)"/
       SvgImgSniffRx = /<img src=".+?\.svg"/
@@ -119,28 +118,27 @@ module Asciidoctor
       end
 
       def add_cover_image doc
+        return if (image_path = doc.attr 'front-cover-image').nil?
+
         imagesdir = (doc.attr 'imagesdir', '.').chomp '/'
         imagesdir = (imagesdir == '.' ? nil : %(#{imagesdir}/))
 
-        if (image_path = doc.attr 'front-cover-image')
-          image_attrs = {}
-          if (image_path.include? ':') && image_path =~ ImageMacroRx
-            logger.warn %(deprecated block macro syntax detected in front-cover-image attribute) if image_path.start_with? 'image::'
-            image_path = %(#{imagesdir}#{$1})
-            (::Asciidoctor::AttributeList.new $2).parse_into image_attrs, %w(alt width height) unless $2.empty?
-          end
-          workdir = (workdir = doc.attr 'docdir').nil_or_empty? ? '.' : workdir
-          if ::File.readable? ::File.join(workdir, image_path)
-            unless !image_attrs.empty? && (width = image_attrs['width']) && (height = image_attrs['height'])
-              width, height = 1050, 1600
-            end
-          else
-            logger.error %(#{::File.basename doc.attr('docfile')}: front cover image not found or readable: #{::File.expand_path image_path, workdir})
-            image_path = nil
-          end
+        image_attrs = {}
+        if (image_path.include? ':') && image_path =~ ImageMacroRx
+          logger.warn %(deprecated block macro syntax detected in front-cover-image attribute) if image_path.start_with? 'image::'
+          image_path = %(#{imagesdir}#{$1})
+          (::Asciidoctor::AttributeList.new $2).parse_into image_attrs, %w(alt width height) unless $2.empty?
         end
 
-        image_path, workdir, width, height = DefaultCoverImage, DATA_DIR, 1050, 1600 unless image_path
+        workdir = (workdir = doc.attr 'docdir').nil_or_empty? ? '.' : workdir
+        unless ::File.readable? ::File.join(workdir, image_path)
+          logger.error %(#{::File.basename doc.attr('docfile')}: front cover image not found or readable: #{::File.expand_path image_path, workdir})
+          return
+        end
+
+        unless !image_attrs.empty? && (width = image_attrs['width']) && (height = image_attrs['height'])
+          width, height = 1050, 1600
+        end
 
         resources do
           cover_image %(#{imagesdir}jacket/cover#{::File.extname image_path}) => (::File.join workdir, image_path)
@@ -154,7 +152,8 @@ module Asciidoctor
 
       # NOTE must be called within the ordered block
       def add_cover_page doc, spine_builder, manifest
-        cover_item_attrs = manifest.items['item_cover'].instance_variable_get :@attributes
+        return if (cover_item_attrs = manifest.items['item_cover'].instance_variable_get :@attributes).nil?
+
         href = cover_item_attrs['href']
         # NOTE we only store width and height temporarily to pass through the values
         width = cover_item_attrs.delete 'width'
@@ -609,26 +608,46 @@ body > svg {
 
         if fmt == :kf8
           # QUESTION shouldn't we validate this epub file too?
-          distill_epub_to_mobi epub_file, target, options[:compress]
+          distill_epub_to_mobi epub_file, target, options[:compress], options[:kindlegen_path]
         elsif options[:validate]
-          validate_epub epub_file
+          validate_epub epub_file, options[:epubcheck_path]
         end
       end
 
-      def distill_epub_to_mobi epub_file, target, compress
-        if !(kindlegen_cmd = ENV['kindlegen']).nil?
-          argv = [kindlegen_cmd]
-        else
+      def get_kindlegen_command kindlegen_path
+        unless kindlegen_path.nil?
+          logger.debug %(Using ebook-kindlegen-path attribute: #{kindlegen_path})
+          return [kindlegen_path]
+        end
+
+        unless (result = ENV['KINDLEGEN']).nil?
+          logger.debug %(Using KINDLEGEN env variable: #{result})
+          return [result]
+        end
+
+        begin
           require 'kindlegen' unless defined? ::Kindlegen
-          argv = [::Kindlegen.command.to_s]
+          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
+      end
+
+      def distill_epub_to_mobi epub_file, target, compress, kindlegen_path
         mobi_file = ::File.basename target.sub(EpubExtensionRx, '.mobi')
         compress_flag = KindlegenCompression[compress ? (compress.empty? ? '1' : compress.to_s) : '0']
-        argv += ['-dont_append_source', compress_flag, '-o', mobi_file, epub_file].compact
 
-        # This duplicates Kindlegen.run, but we want to override executable
-        out, err, res = Open3.capture3(*argv) do |r|
-          r.force_encoding 'UTF-8' if windows? && r.respond_to?(:force_encoding)
+        argv = get_kindlegen_command(kindlegen_path) + ['-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|
+            r.force_encoding 'UTF-8' if ::Gem.win_platform? && r.respond_to?(:force_encoding)
+          end
+        rescue Errno::ENOENT => e
+          raise 'Unable to run KindleGen. Either install the kindlegen gem or set KINDLEGEN environment variable with path to KindleGen executable', cause: e
         end
 
         out.each_line do |line|
@@ -646,15 +665,34 @@ body > svg {
         end
       end
 
-      def validate_epub epub_file
-        if !(epubcheck = ENV['EPUBCHECK']).nil?
-          argv = [epubcheck]
-        else
-          argv = [::Gem.ruby, ::Gem.bin_path('epubcheck-ruby', 'epubcheck')]
+      def get_epubcheck_command epubcheck_path
+        unless epubcheck_path.nil?
+          logger.debug %(Using ebook-epubcheck-path attribute: #{epubcheck_path})
+          return [epubcheck_path]
         end
 
-        argv += ['-w', epub_file]
-        out, err, res = Open3.capture3(*argv)
+        unless (result = ENV['EPUBCHECK']).nil?
+          logger.debug %(Using EPUBCHECK env variable: #{result})
+          return [result]
+        end
+
+        begin
+          result = ::Gem.bin_path 'epubcheck-ruby', 'epubcheck'
+          logger.debug %(Using EPUBCheck from gem: #{result})
+          [::Gem.ruby, result]
+        rescue ::Gem::Exception => e
+          logger.debug %(#{e}; Using EPUBCheck from PATH)
+          ['epubcheck']
+        end
+      end
+
+      def validate_epub epub_file, epubcheck_path
+        argv = get_epubcheck_command(epubcheck_path) + ['-w', epub_file]
+        begin
+          out, err, res = Open3.capture3(*argv)
+        rescue Errno::ENOENT => e
+          raise 'Unable to run EPUBCheck. Either install epubcheck-ruby gem or set EPUBCHECK environment variable with path to EPUBCheck executable', cause: e
+        end
 
         out.each_line do |line|
           logger.info line

data/lib/asciidoctor-epub3/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-epub3
 version: !ruby/object:Gem::Version
-  version: 1.5.0.alpha.11
+  version: 1.5.0.alpha.12
 platform: ruby
 authors:
 - Dan Allen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2020-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 13.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +87,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: epubcheck-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.2.0
 - !ruby/object:Gem::Dependency
   name: gepub
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +115,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: kindlegen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.0.5
 description: 'An extension for Asciidoctor that converts AsciiDoc documents to EPUB3
   and KF8/MOBI (Kindle) e-book archives.
 
@@ -159,8 +193,6 @@ files:
 - data/images/default-avatar.jpg
 - data/images/default-avatar.png
 - data/images/default-avatar.svg
-- data/images/default-cover-large.png
-- data/images/default-cover.png
 - data/images/default-cover.svg
 - data/images/default-headshot.jpg
 - data/images/default-headshot.png
@@ -191,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"