asciidoctor-epub3 1.5.0.alpha.12

data/lib/asciidoctor-epub3/ext.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'ext/asciidoctor'
+require_relative 'ext/core'

data/lib/asciidoctor-epub3/ext/asciidoctor.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'asciidoctor/logging_shim' unless defined? Asciidoctor::Logging

data/lib/asciidoctor-epub3/ext/asciidoctor/logging_shim.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Logging
+    class StubLogger
+      class << self
+        def debug message = nil
+          puts %(asciidoctor: DEBUG: #{message || (block_given? ? yield : '???')}) if $VERBOSE
+        end
+
+        def info message = nil
+          puts %(asciidoctor: INFO: #{message || (block_given? ? yield : '???')}) if $VERBOSE
+        end
+
+        def warn message = nil
+          ::Kernel.warn %(asciidoctor: WARNING: #{message || (block_given? ? yield : '???')})
+        end
+
+        def error message = nil
+          ::Kernel.warn %(asciidoctor: ERROR: #{message || (block_given? ? yield : '???')})
+        end
+
+        def fatal message = nil
+          ::Kernel.warn %(asciidoctor: FATAL: #{message || (block_given? ? yield : '???')})
+        end
+      end
+    end
+
+    def logger
+      StubLogger
+    end
+  end
+end

data/lib/asciidoctor-epub3/ext/core.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'core/string'

data/lib/asciidoctor-epub3/ext/core/string.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'stringio' unless defined? StringIO
+
+class String
+  def to_ios
+    StringIO.new self
+  end unless method_defined? :to_ios
+end

data/lib/asciidoctor-epub3/font_icon_map.rb

@@ -0,0 +1,378 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Epub3
+    # Map of Font Awesome icon names to unicode characters
+    FontIconMap = {
+      glass: '\f000',
+      music: '\f001',
+      search: '\f002',
+      envelope_o: '\f003',
+      heart: '\f004',
+      star: '\f005',
+      star_o: '\f006',
+      user: '\f007',
+      film: '\f008',
+      th_large: '\f009',
+      th: '\f00a',
+      th_list: '\f00b',
+      check: '\f00c',
+      times: '\f00d',
+      search_plus: '\f00e',
+      search_minus: '\f010',
+      power_off: '\f011',
+      signal: '\f012',
+      cog: '\f013',
+      trash_o: '\f014',
+      home: '\f015',
+      file_o: '\f016',
+      clock_o: '\f017',
+      road: '\f018',
+      download: '\f019',
+      arrow_circle_o_down: '\f01a',
+      arrow_circle_o_up: '\f01b',
+      inbox: '\f01c',
+      play_circle_o: '\f01d',
+      repeat: '\f01e',
+      refresh: '\f021',
+      list_alt: '\f022',
+      lock: '\f023',
+      flag: '\f024',
+      headphones: '\f025',
+      volume_off: '\f026',
+      volume_down: '\f027',
+      volume_up: '\f028',
+      qrcode: '\f029',
+      barcode: '\f02a',
+      tag: '\f02b',
+      tags: '\f02c',
+      book: '\f02d',
+      bookmark: '\f02e',
+      print: '\f02f',
+      camera: '\f030',
+      font: '\f031',
+      bold: '\f032',
+      italic: '\f033',
+      text_height: '\f034',
+      text_width: '\f035',
+      align_left: '\f036',
+      align_center: '\f037',
+      align_right: '\f038',
+      align_justify: '\f039',
+      list: '\f03a',
+      outdent: '\f03b',
+      indent: '\f03c',
+      video_camera: '\f03d',
+      picture_o: '\f03e',
+      pencil: '\f040',
+      map_marker: '\f041',
+      adjust: '\f042',
+      tint: '\f043',
+      pencil_square_o: '\f044',
+      share_square_o: '\f045',
+      check_square_o: '\f046',
+      arrows: '\f047',
+      step_backward: '\f048',
+      fast_backward: '\f049',
+      backward: '\f04a',
+      play: '\f04b',
+      pause: '\f04c',
+      stop: '\f04d',
+      forward: '\f04e',
+      fast_forward: '\f050',
+      step_forward: '\f051',
+      eject: '\f052',
+      chevron_left: '\f053',
+      chevron_right: '\f054',
+      plus_circle: '\f055',
+      minus_circle: '\f056',
+      times_circle: '\f057',
+      check_circle: '\f058',
+      question_circle: '\f059',
+      info_circle: '\f05a',
+      crosshairs: '\f05b',
+      times_circle_o: '\f05c',
+      check_circle_o: '\f05d',
+      ban: '\f05e',
+      arrow_left: '\f060',
+      arrow_right: '\f061',
+      arrow_up: '\f062',
+      arrow_down: '\f063',
+      share: '\f064',
+      expand: '\f065',
+      compress: '\f066',
+      plus: '\f067',
+      minus: '\f068',
+      asterisk: '\f069',
+      exclamation_circle: '\f06a',
+      gift: '\f06b',
+      leaf: '\f06c',
+      fire: '\f06d',
+      eye: '\f06e',
+      eye_slash: '\f070',
+      exclamation_triangle: '\f071',
+      plane: '\f072',
+      calendar: '\f073',
+      random: '\f074',
+      comment: '\f075',
+      magnet: '\f076',
+      chevron_up: '\f077',
+      chevron_down: '\f078',
+      retweet: '\f079',
+      shopping_cart: '\f07a',
+      folder: '\f07b',
+      folder_open: '\f07c',
+      arrows_v: '\f07d',
+      arrows_h: '\f07e',
+      bar_chart_o: '\f080',
+      twitter_square: '\f081',
+      facebook_square: '\f082',
+      camera_retro: '\f083',
+      key: '\f084',
+      cogs: '\f085',
+      comments: '\f086',
+      thumbs_o_up: '\f087',
+      thumbs_o_down: '\f088',
+      star_half: '\f089',
+      heart_o: '\f08a',
+      sign_out: '\f08b',
+      linkedin_square: '\f08c',
+      thumb_tack: '\f08d',
+      external_link: '\f08e',
+      sign_in: '\f090',
+      trophy: '\f091',
+      github_square: '\f092',
+      upload: '\f093',
+      lemon_o: '\f094',
+      phone: '\f095',
+      square_o: '\f096',
+      bookmark_o: '\f097',
+      phone_square: '\f098',
+      twitter: '\f099',
+      facebook: '\f09a',
+      github: '\f09b',
+      unlock: '\f09c',
+      credit_card: '\f09d',
+      rss: '\f09e',
+      hdd_o: '\f0a0',
+      bullhorn: '\f0a1',
+      bell: '\f0f3',
+      certificate: '\f0a3',
+      hand_o_right: '\f0a4',
+      hand_o_left: '\f0a5',
+      hand_o_up: '\f0a6',
+      hand_o_down: '\f0a7',
+      arrow_circle_left: '\f0a8',
+      arrow_circle_right: '\f0a9',
+      arrow_circle_up: '\f0aa',
+      arrow_circle_down: '\f0ab',
+      globe: '\f0ac',
+      wrench: '\f0ad',
+      tasks: '\f0ae',
+      filter: '\f0b0',
+      briefcase: '\f0b1',
+      arrows_alt: '\f0b2',
+      users: '\f0c0',
+      link: '\f0c1',
+      cloud: '\f0c2',
+      flask: '\f0c3',
+      scissors: '\f0c4',
+      files_o: '\f0c5',
+      paperclip: '\f0c6',
+      floppy_o: '\f0c7',
+      square: '\f0c8',
+      bars: '\f0c9',
+      list_ul: '\f0ca',
+      list_ol: '\f0cb',
+      strikethrough: '\f0cc',
+      underline: '\f0cd',
+      table: '\f0ce',
+      magic: '\f0d0',
+      truck: '\f0d1',
+      pinterest: '\f0d2',
+      pinterest_square: '\f0d3',
+      google_plus_square: '\f0d4',
+      google_plus: '\f0d5',
+      money: '\f0d6',
+      caret_down: '\f0d7',
+      caret_up: '\f0d8',
+      caret_left: '\f0d9',
+      caret_right: '\f0da',
+      columns: '\f0db',
+      sort: '\f0dc',
+      sort_asc: '\f0dd',
+      sort_desc: '\f0de',
+      envelope: '\f0e0',
+      linkedin: '\f0e1',
+      undo: '\f0e2',
+      gavel: '\f0e3',
+      tachometer: '\f0e4',
+      comment_o: '\f0e5',
+      comments_o: '\f0e6',
+      bolt: '\f0e7',
+      sitemap: '\f0e8',
+      umbrella: '\f0e9',
+      clipboard: '\f0ea',
+      lightbulb_o: '\f0eb',
+      exchange: '\f0ec',
+      cloud_download: '\f0ed',
+      cloud_upload: '\f0ee',
+      user_md: '\f0f0',
+      stethoscope: '\f0f1',
+      suitcase: '\f0f2',
+      bell_o: '\f0a2',
+      coffee: '\f0f4',
+      cutlery: '\f0f5',
+      file_text_o: '\f0f6',
+      building_o: '\f0f7',
+      hospital_o: '\f0f8',
+      ambulance: '\f0f9',
+      medkit: '\f0fa',
+      fighter_jet: '\f0fb',
+      beer: '\f0fc',
+      h_square: '\f0fd',
+      plus_square: '\f0fe',
+      angle_double_left: '\f100',
+      angle_double_right: '\f101',
+      angle_double_up: '\f102',
+      angle_double_down: '\f103',
+      angle_left: '\f104',
+      angle_right: '\f105',
+      angle_up: '\f106',
+      angle_down: '\f107',
+      desktop: '\f108',
+      laptop: '\f109',
+      tablet: '\f10a',
+      mobile: '\f10b',
+      circle_o: '\f10c',
+      quote_left: '\f10d',
+      quote_right: '\f10e',
+      spinner: '\f110',
+      circle: '\f111',
+      reply: '\f112',
+      github_alt: '\f113',
+      folder_o: '\f114',
+      folder_open_o: '\f115',
+      smile_o: '\f118',
+      frown_o: '\f119',
+      meh_o: '\f11a',
+      gamepad: '\f11b',
+      keyboard_o: '\f11c',
+      flag_o: '\f11d',
+      flag_checkered: '\f11e',
+      terminal: '\f120',
+      code: '\f121',
+      reply_all: '\f122',
+      mail_reply_all: '\f122',
+      star_half_o: '\f123',
+      location_arrow: '\f124',
+      crop: '\f125',
+      code_fork: '\f126',
+      chain_broken: '\f127',
+      question: '\f128',
+      info: '\f129',
+      exclamation: '\f12a',
+      superscript: '\f12b',
+      subscript: '\f12c',
+      eraser: '\f12d',
+      puzzle_piece: '\f12e',
+      microphone: '\f130',
+      microphone_slash: '\f131',
+      shield: '\f132',
+      calendar_o: '\f133',
+      fire_extinguisher: '\f134',
+      rocket: '\f135',
+      maxcdn: '\f136',
+      chevron_circle_left: '\f137',
+      chevron_circle_right: '\f138',
+      chevron_circle_up: '\f139',
+      chevron_circle_down: '\f13a',
+      html5: '\f13b',
+      css3: '\f13c',
+      anchor: '\f13d',
+      unlock_alt: '\f13e',
+      bullseye: '\f140',
+      ellipsis_h: '\f141',
+      ellipsis_v: '\f142',
+      rss_square: '\f143',
+      play_circle: '\f144',
+      ticket: '\f145',
+      minus_square: '\f146',
+      minus_square_o: '\f147',
+      level_up: '\f148',
+      level_down: '\f149',
+      check_square: '\f14a',
+      pencil_square: '\f14b',
+      external_link_square: '\f14c',
+      share_square: '\f14d',
+      compass: '\f14e',
+      caret_square_o_down: '\f150',
+      caret_square_o_up: '\f151',
+      caret_square_o_right: '\f152',
+      eur: '\f153',
+      gbp: '\f154',
+      usd: '\f155',
+      inr: '\f156',
+      jpy: '\f157',
+      rub: '\f158',
+      krw: '\f159',
+      btc: '\f15a',
+      file: '\f15b',
+      file_text: '\f15c',
+      sort_alpha_asc: '\f15d',
+      sort_alpha_desc: '\f15e',
+      sort_amount_asc: '\f160',
+      sort_amount_desc: '\f161',
+      sort_numeric_asc: '\f162',
+      sort_numeric_desc: '\f163',
+      thumbs_up: '\f164',
+      thumbs_down: '\f165',
+      youtube_square: '\f166',
+      youtube: '\f167',
+      xing: '\f168',
+      xing_square: '\f169',
+      youtube_play: '\f16a',
+      dropbox: '\f16b',
+      stack_overflow: '\f16c',
+      instagram: '\f16d',
+      flickr: '\f16e',
+      adn: '\f170',
+      bitbucket: '\f171',
+      bitbucket_square: '\f172',
+      tumblr: '\f173',
+      tumblr_square: '\f174',
+      long_arrow_down: '\f175',
+      long_arrow_up: '\f176',
+      long_arrow_left: '\f177',
+      long_arrow_right: '\f178',
+      apple: '\f179',
+      windows: '\f17a',
+      android: '\f17b',
+      linux: '\f17c',
+      dribbble: '\f17d',
+      skype: '\f17e',
+      foursquare: '\f180',
+      trello: '\f181',
+      female: '\f182',
+      male: '\f183',
+      gittip: '\f184',
+      sun_o: '\f185',
+      moon_o: '\f186',
+      archive: '\f187',
+      bug: '\f188',
+      vk: '\f189',
+      weibo: '\f18a',
+      renren: '\f18b',
+      pagelines: '\f18c',
+      stack_exchange: '\f18d',
+      arrow_circle_o_right: '\f18e',
+      arrow_circle_o_left: '\f190',
+      caret_square_o_left: '\f191',
+      dot_circle_o: '\f192',
+      wheelchair: '\f193',
+      vimeo_square: '\f194',
+      try: '\f195',
+      plus_square_o: '\f196',
+    }
+  end
+end

data/lib/asciidoctor-epub3/packager.rb

@@ -0,0 +1,722 @@
+# frozen_string_literal: true
+
+autoload :FileUtils, 'fileutils'
+autoload :Open3, 'open3'
+
+module Asciidoctor
+  module Epub3
+    module GepubBuilderMixin
+      include ::Asciidoctor::Logging
+      DATA_DIR = ::File.expand_path ::File.join(__dir__, '..', '..', 'data')
+      SAMPLES_DIR = ::File.join DATA_DIR, 'samples'
+      LF = ?\n
+      CharEntityRx = ContentConverter::CharEntityRx
+      XmlElementRx = ContentConverter::XmlElementRx
+      FromHtmlSpecialCharsMap = ContentConverter::FromHtmlSpecialCharsMap
+      FromHtmlSpecialCharsRx = ContentConverter::FromHtmlSpecialCharsRx
+      CsvDelimiterRx = /\s*,\s*/
+      ImageMacroRx = /^image::?(.*?)\[(.*?)\]$/
+      ImgSrcScanRx = /<img src="(.+?)"/
+      SvgImgSniffRx = /<img src=".+?\.svg"/
+
+      attr_reader :book, :format, :spine
+
+      # FIXME: move to Asciidoctor::Helpers
+      def sanitize_doctitle_xml doc, content_spec
+        doctitle = doc.header? ? doc.doctitle : (doc.attr 'untitled-label')
+        sanitize_xml doctitle, content_spec
+      end
+
+      # FIXME: move to Asciidoctor::Helpers
+      def sanitize_xml content, content_spec
+        if content_spec != :pcdata && (content.include? '<')
+          if (content = (content.gsub XmlElementRx, '').strip).include? ' '
+            content = content.tr_s ' ', ' '
+          end
+        end
+
+        case content_spec
+        when :attribute_cdata
+          content = content.gsub '"', '&quot;' if content.include? '"'
+        when :cdata, :pcdata
+          # noop
+        when :plain_text
+          if content.include? ';'
+            content = content.gsub(CharEntityRx) { [$1.to_i].pack 'U*' } if content.include? '&#'
+            content = content.gsub FromHtmlSpecialCharsRx, FromHtmlSpecialCharsMap
+          end
+        else
+          raise ::ArgumentError, %(Unknown content spec: #{content_spec})
+        end
+        content
+      end
+
+      def add_theme_assets doc
+        builder = self
+        format = @format
+        workdir = if doc.attr? 'epub3-stylesdir'
+                    stylesdir = doc.attr 'epub3-stylesdir'
+                    # FIXME: make this work for Windows paths!!
+                    if stylesdir.start_with? '/'
+                      stylesdir
+                    else
+                      docdir = doc.attr 'docdir', '.'
+                      docdir = '.' if docdir.empty?
+                      ::File.join docdir, stylesdir
+                    end
+                  else
+                    ::File.join DATA_DIR, 'styles'
+                  end
+
+        # TODO: improve design/UX of custom theme functionality, including custom fonts
+        resources do
+          if format == :kf8
+            # NOTE add layer of indirection so Kindle Direct Publishing (KDP) doesn't strip font-related CSS rules
+            file 'styles/epub3.css' => '@import url("epub3-proxied.css");'.to_ios
+            file 'styles/epub3-css3-only.css' => '@import url("epub3-css3-only-proxied.css");'.to_ios
+            file 'styles/epub3-proxied.css' => (builder.postprocess_css_file ::File.join(workdir, 'epub3.css'), format)
+            file 'styles/epub3-css3-only-proxied.css' => (builder.postprocess_css_file ::File.join(workdir, 'epub3-css3-only.css'), format)
+          else
+            file 'styles/epub3.css' => (builder.postprocess_css_file ::File.join(workdir, 'epub3.css'), format)
+            file 'styles/epub3-css3-only.css' => (builder.postprocess_css_file ::File.join(workdir, 'epub3-css3-only.css'), format)
+          end
+        end
+
+        resources do
+          font_files, font_css = builder.select_fonts ::File.join(DATA_DIR, 'styles/epub3-fonts.css'), (doc.attr 'scripts', 'latin')
+          file 'styles/epub3-fonts.css' => font_css
+          unless font_files.empty?
+            # NOTE metadata property in oepbs package manifest doesn't work; must use proprietary iBooks file instead
+            #(@book.metadata.add_metadata 'meta', 'true')['property'] = 'ibooks:specified-fonts' unless format == :kf8
+            builder.optional_file 'META-INF/com.apple.ibooks.display-options.xml' => '<?xml version="1.0" encoding="UTF-8"?>
+<display_options>
+<platform name="*">
+<option name="specified-fonts">true</option>
+</platform>
+</display_options>'.to_ios unless format == :kf8
+
+            # https://github.com/asciidoctor/asciidoctor-epub3/issues/120
+            #
+            # 'application/x-font-ttf' causes warnings in epubcheck 4.0.2,
+            # "non-standard font type". Discussion:
+            # https://www.mobileread.com/forums/showthread.php?t=231272
+            #
+            # 3.1 spec recommends 'application/font-sfnt', but epubcheck doesn't
+            # implement that yet (warnings). https://idpf.github.io/epub-cmt/v3/
+            #
+            # 3.0 spec recommends 'application/vnd.ms-opentype', this works without
+            # warnings.
+            # http://www.idpf.org/epub/30/spec/epub30-publications.html#sec-core-media-types
+            with_media_type 'application/vnd.ms-opentype' do
+              font_files.each do |font_file|
+                file font_file => ::File.join(DATA_DIR, font_file)
+              end
+            end
+          end
+        end
+        nil
+      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}/))
+
+        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
+        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)
+          @last_defined_item.tap do |last_item|
+            last_item['width'] = width
+            last_item['height'] = height
+          end
+        end
+        nil
+      end
+
+      # NOTE must be called within the ordered block
+      def add_cover_page doc, spine_builder, manifest
+        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'
+        height = cover_item_attrs.delete 'height'
+
+        # NOTE SVG wrapper maintains aspect ratio and confines image to view box
+        content = %(<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+<head>
+<meta charset="UTF-8"/>
+<title>#{sanitize_doctitle_xml doc, :cdata}</title>
+<style type="text/css">
+@page {
+  margin: 0;
+}
+html {
+  margin: 0 !important;
+  padding: 0 !important;
+}
+body {
+  margin: 0;
+  padding: 0 !important;
+  text-align: center;
+}
+body > svg {
+  /* prevent bleed onto second page (removes descender space) */
+  display: block;
+}
+</style>
+</head>
+<body epub:type="cover"><svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
+  width="100%" height="100%" viewBox="0 0 #{width} #{height}" preserveAspectRatio="xMidYMid meet">
+<image width="#{width}" height="#{height}" xlink:href="#{href}"/>
+</svg></body>
+</html>).to_ios
+        # Gitden expects a cover.xhtml, so add it to the spine
+        spine_builder.file 'cover.xhtml' => content
+        assigned_id = (spine_builder.instance_variable_get :@last_defined_item).item.id
+        spine_builder.id 'cover'
+        # clearly a deficiency of gepub that it does not match the id correctly
+        # FIXME can we move this hack elsewhere?
+        @book.spine.itemref_by_id[assigned_id].idref = 'cover'
+        nil
+      end
+
+      def add_images_from_front_matter
+        (::File.read 'front-matter.html').scan ImgSrcScanRx do
+          resources do
+            file $1
+          end
+        end if ::File.file? 'front-matter.html'
+        nil
+      end
+
+      def add_front_matter_page _doc, spine_builder
+        if ::File.file? 'front-matter.html'
+          front_matter_content = ::File.read 'front-matter.html'
+          spine_builder.file 'front-matter.xhtml' => (postprocess_xhtml front_matter_content, @format)
+          spine_builder.add_property 'svg' unless (spine_builder.property? 'svg') || SvgImgSniffRx !~ front_matter_content
+        end
+        nil
+      end
+
+      def add_content_images doc, images
+        docimagesdir = (doc.attr 'imagesdir', '.').chomp '/'
+        docimagesdir = (docimagesdir == '.' ? nil : %(#{docimagesdir}/))
+
+        self_logger = logger
+        workdir = (workdir = doc.attr 'docdir').nil_or_empty? ? '.' : workdir
+        resources workdir: workdir do
+          images.each do |image|
+            if (image_path = image[:path]).start_with? %(#{docimagesdir}jacket/cover.)
+              self_logger.warn %(image path is reserved for cover artwork: #{image_path}; skipping image found in content)
+            elsif ::File.readable? image_path
+              file image_path
+            else
+              self_logger.error %(#{::File.basename image[:docfile]}: image not found or not readable: #{::File.expand_path image_path, workdir})
+            end
+          end
+        end
+        nil
+      end
+
+      def add_profile_images doc, usernames
+        imagesdir = (doc.attr 'imagesdir', '.').chomp '/'
+        imagesdir = (imagesdir == '.' ? nil : %(#{imagesdir}/))
+
+        resources do
+          file %(#{imagesdir}avatars/default.jpg) => ::File.join(DATA_DIR, 'images/default-avatar.jpg')
+          file %(#{imagesdir}headshots/default.jpg) => ::File.join(DATA_DIR, 'images/default-headshot.jpg')
+        end
+
+        self_logger = logger
+        workdir = (workdir = doc.attr 'docdir').nil_or_empty? ? '.' : workdir
+        resources do
+          usernames.each do |username|
+            avatar = %(#{imagesdir}avatars/#{username}.jpg)
+            if ::File.readable? (resolved_avatar = (::File.join workdir, avatar))
+              file avatar => resolved_avatar
+            else
+              self_logger.error %(avatar for #{username} not found or readable: #{avatar}; falling back to default avatar)
+              file avatar => ::File.join(DATA_DIR, 'images/default-avatar.jpg')
+            end
+
+            headshot = %(#{imagesdir}headshots/#{username}.jpg)
+            if ::File.readable? (resolved_headshot = (::File.join workdir, headshot))
+              file headshot => resolved_headshot
+            elsif doc.attr? 'builder', 'editions'
+              self_logger.error %(headshot for #{username} not found or readable: #{headshot}; falling back to default headshot)
+              file headshot => ::File.join(DATA_DIR, 'images/default-headshot.jpg')
+            end
+          end
+        end
+        nil
+      end
+
+      def add_content doc
+        builder, spine, format, images = self, @spine, @format, {}
+        workdir = (doc.attr 'docdir').nil_or_empty? ? '.' : workdir
+        resources workdir: workdir do
+          extend GepubResourceBuilderMixin
+          builder.add_images_from_front_matter
+          builder.add_nav_doc doc, self, spine, format
+          builder.add_ncx_doc doc, self, spine
+          ordered do
+            builder.add_cover_page doc, self, @book.manifest unless format == :kf8
+            builder.add_front_matter_page doc, self
+            spine.each_with_index do |item, _i|
+              docfile = item.attr 'docfile'
+              imagesdir = (item.attr 'imagesdir', '.').chomp '/'
+              imagesdir = (imagesdir == '.' ? '' : %(#{imagesdir}/))
+              file %(#{item.id || (item.attr 'docname')}.xhtml) => (builder.postprocess_xhtml item.convert, format)
+              add_property 'svg' if ((item.attr 'epub-properties') || []).include? 'svg'
+              # QUESTION should we pass the document itself?
+              item.references[:images].each do |target|
+                images[image_path = %(#{imagesdir}#{target})] ||= { docfile: docfile, path: image_path }
+              end
+              # QUESTION reenable?
+              #linear 'yes' if i == 0
+            end
+          end
+        end
+        add_content_images doc, images.values
+        nil
+      end
+
+      def add_nav_doc doc, spine_builder, spine, format
+        spine_builder.nav 'nav.xhtml' => (postprocess_xhtml nav_doc(doc, spine), format)
+        spine_builder.id 'nav'
+        nil
+      end
+
+      # TODO: aggregate authors of spine document into authors attribute(s) on main document
+      def nav_doc doc, spine
+        lines = [%(<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="#{lang = doc.attr 'lang', 'en'}" lang="#{lang}">
+<head>
+<meta charset="UTF-8"/>
+<title>#{sanitize_doctitle_xml doc, :cdata}</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)"/>
+</head>
+<body>
+<h1>#{sanitize_doctitle_xml doc, :pcdata}</h1>
+<nav epub:type="toc" id="toc">
+<h2>#{doc.attr 'toc-title'}</h2>)]
+        lines << (nav_level spine, [(doc.attr 'toclevels', 1).to_i, 0].max)
+        lines << %(</nav>
+</body>
+</html>)
+        lines * LF
+      end
+
+      def nav_level items, depth, state = {}
+        lines = []
+        lines << '<ol>'
+        items.each do |item|
+          #index = (state[:index] = (state.fetch :index, 0) + 1)
+          if item.context == :document
+            # NOTE we sanitize the chapter titles because we use formatting to control layout
+            item_label = sanitize_doctitle_xml item, :cdata
+            item_href = (state[:content_doc_href] = %(#{item.id || (item.attr 'docname')}.xhtml))
+          else
+            item_label = sanitize_xml item.title, :pcdata
+            item_href = %(#{state[:content_doc_href]}##{item.id})
+          end
+          lines << %(<li><a href="#{item_href}">#{item_label}</a>)
+          if depth == 0 || (child_sections = item.sections).empty?
+            lines[-1] = %(#{lines[-1]}</li>)
+          else
+            lines << (nav_level child_sections, depth - 1, state)
+            lines << '</li>'
+          end
+          state.delete :content_doc_href if item.context == :document
+        end
+        lines << '</ol>'
+        lines * LF
+      end
+
+      # NOTE gepub doesn't support building a ncx TOC with depth > 1, so do it ourselves
+      def add_ncx_doc doc, spine_builder, spine
+        spine_builder.file 'toc.ncx' => (ncx_doc doc, spine).to_ios
+        spine_builder.id 'ncx'
+        nil
+      end
+
+      def ncx_doc doc, spine
+        # TODO: populate docAuthor element based on unique authors in work
+        lines = [%(<?xml version="1.0" encoding="utf-8"?>
+<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1" xml:lang="#{doc.attr 'lang', 'en'}">
+<head>
+<meta name="dtb:uid" content="#{@book.identifier}"/>
+%{depth}
+<meta name="dtb:totalPageCount" content="0"/>
+<meta name="dtb:maxPageNumber" content="0"/>
+</head>
+<docTitle><text>#{sanitize_doctitle_xml doc, :cdata}</text></docTitle>
+<navMap>)]
+        lines << (ncx_level spine, [(doc.attr 'toclevels', 1).to_i, 0].max, state = {})
+        lines[0] = lines[0].sub '%{depth}', %(<meta name="dtb:depth" content="#{state[:max_depth]}"/>)
+        lines << %(</navMap>
+</ncx>)
+        lines * LF
+      end
+
+      def ncx_level items, depth, state = {}
+        lines = []
+        state[:max_depth] = (state.fetch :max_depth, 0) + 1
+        items.each do |item|
+          index = (state[:index] = (state.fetch :index, 0) + 1)
+          item_id = %(nav_#{index})
+          if item.context == :document
+            item_label = sanitize_doctitle_xml item, :cdata
+            item_href = (state[:content_doc_href] = %(#{item.id || (item.attr 'docname')}.xhtml))
+          else
+            item_label = sanitize_xml item.title, :cdata
+            item_href = %(#{state[:content_doc_href]}##{item.id})
+          end
+          lines << %(<navPoint id="#{item_id}" playOrder="#{index}">)
+          lines << %(<navLabel><text>#{item_label}</text></navLabel>)
+          lines << %(<content src="#{item_href}"/>)
+          unless depth == 0 || (child_sections = item.sections).empty?
+            lines << (ncx_level child_sections, depth - 1, state)
+          end
+          lines << %(</navPoint>)
+          state.delete :content_doc_href if item.context == :document
+        end
+        lines * LF
+      end
+
+      def collect_keywords doc, spine
+        ([doc] + spine).map {|item|
+          if item.attr? 'keywords'
+            (item.attr 'keywords').split CsvDelimiterRx
+          else
+            []
+          end
+        }.flatten.uniq
+      end
+
+      # Swap fonts in CSS based on the value of the document attribute 'scripts',
+      # then return the list of fonts as well as the font CSS.
+      def select_fonts filename, scripts = 'latin'
+        font_css = ::File.read filename
+        font_css = font_css.gsub(/(?<=-)latin(?=\.ttf\))/, scripts) unless scripts == 'latin'
+
+        # match CSS font urls in the forms of:
+        # src: url(../fonts/notoserif-regular-latin.ttf);
+        # src: url(../fonts/notoserif-regular-latin.ttf) format("truetype");
+        font_list = font_css.scan(/url\(\.\.\/([^)]+\.ttf)\)/).flatten
+
+        [font_list, font_css.to_ios]
+      end
+
+      def postprocess_css_file filename, format
+        return filename unless format == :kf8
+        postprocess_css ::File.read(filename), format
+      end
+
+      def postprocess_css content, format
+        return content.to_ios unless format == :kf8
+        # TODO: convert regular expressions to constants
+        content
+          .gsub(/^  -webkit-column-break-.*\n/, '')
+          .gsub(/^  max-width: .*\n/, '')
+          .to_ios
+      end
+
+      def postprocess_xhtml_file filename, format
+        return filename unless format == :kf8
+        postprocess_xhtml ::File.read(filename), format
+      end
+
+      # NOTE Kindle requires that
+      #      <meta charset="utf-8"/>
+      #      be converted to
+      #      <meta http-equiv="Content-Type" content="application/xml+xhtml; charset=UTF-8"/>
+      def postprocess_xhtml content, format
+        return content.to_ios unless format == :kf8
+        # TODO: convert regular expressions to constants
+        content
+          .gsub(/<meta charset="(.+?)"\/>/, '<meta http-equiv="Content-Type" content="application/xml+xhtml; charset=\1"/>')
+          .gsub(/<img([^>]+) style="width: (\d\d)%;"/, '<img\1 style="width: \2%; height: \2%;"')
+          .gsub(/<script type="text\/javascript">.*?<\/script>\n?/m, '')
+          .to_ios
+      end
+    end
+
+    module GepubResourceBuilderMixin
+      # Add missing method to builder to add a property to last defined item
+      def add_property property
+        @last_defined_item.add_property property
+      end
+
+      # Add helper method to builder to check if property is set on last defined item
+      def property? property
+        (@last_defined_item['properties'] || []).include? property
+      end
+    end
+
+    class Packager
+      include ::Asciidoctor::Logging
+
+      EpubExtensionRx = /\.epub$/i
+      KindlegenCompression = ::Hash['0', '-c0', '1', '-c1', '2', '-c2', 'none', '-c0', 'standard', '-c1', 'huffdic', '-c2']
+
+      def initialize spine_doc, spine, format = :epub3, _options = {}
+        @document = spine_doc
+        @spine = spine || []
+        @format = format
+      end
+
+      def package options = {}
+        doc = @document
+        spine = @spine
+        fmt = @format
+        target = options[:target]
+        dest = File.dirname target
+
+        # FIXME: authors should be aggregated already on parent document
+        if doc.attr? 'authors'
+          authors = (doc.attr 'authors').split(GepubBuilderMixin::CsvDelimiterRx).concat(spine.map {|item| item.attr 'author' }.compact).uniq
+        else
+          authors = []
+        end
+
+        builder = ::GEPUB::Builder.new do
+          extend GepubBuilderMixin
+          @document = doc
+          @spine = spine
+          @format = fmt
+          @book.epub_backward_compat = fmt != :kf8
+
+          language doc.attr('lang', 'en')
+          id 'pub-language'
+
+          if doc.attr? 'uuid'
+            unique_identifier doc.attr('uuid'), 'pub-identifier', 'uuid'
+          else
+            unique_identifier doc.id, 'pub-identifier', 'uuid'
+          end
+          # replace with next line once the attributes argument is supported
+          #unique_identifier doc.id, 'pub-id', 'uuid', 'scheme' => 'xsd:string'
+
+          # NOTE we must use :plain_text here since gepub reencodes
+          title sanitize_doctitle_xml(doc, :plain_text)
+          id 'pub-title'
+
+          # FIXME: this logic needs some work
+          if doc.attr? 'publisher'
+            publisher (publisher_name = (doc.attr 'publisher'))
+            # marc role: Book producer (see http://www.loc.gov/marc/relators/relaterm.html)
+            creator (doc.attr 'producer', publisher_name), 'bkp'
+          elsif doc.attr? 'producer'
+            # NOTE Use producer as both publisher and producer if publisher isn't specified
+            producer_name = doc.attr 'producer'
+            publisher producer_name
+            # marc role: Book producer (see http://www.loc.gov/marc/relators/relaterm.html)
+            creator producer_name, 'bkp'
+          elsif doc.attr? 'author'
+            # NOTE Use author as creator if both publisher or producer are absent
+            # marc role: Author (see http://www.loc.gov/marc/relators/relaterm.html)
+            creator doc.attr('author'), 'aut'
+          end
+
+          if doc.attr? 'creator'
+            # marc role: Creator (see http://www.loc.gov/marc/relators/relaterm.html)
+            creator doc.attr('creator'), 'cre'
+          else
+            # marc role: Manufacturer (see http://www.loc.gov/marc/relators/relaterm.html)
+            # QUESTION should this be bkp?
+            creator 'Asciidoctor', 'mfr'
+          end
+
+          # TODO: getting author list should be a method on Asciidoctor API
+          contributors(*authors)
+
+          if doc.attr? 'revdate'
+            begin
+              date doc.attr('revdate')
+            rescue ArgumentError => e
+              logger.error %(#{::File.basename doc.attr('docfile')}: failed to parse revdate: #{e}, using current time as a fallback)
+              date ::Time.now
+            end
+          else
+            date ::Time.now
+          end
+
+          description doc.attr('description') if doc.attr? 'description'
+
+          (collect_keywords doc, spine).each do |s|
+            subject s
+          end
+
+          source doc.attr('source') if doc.attr? 'source'
+
+          rights doc.attr('copyright') if doc.attr? 'copyright'
+
+          #add_metadata 'ibooks:specified-fonts', true
+
+          add_theme_assets doc
+          add_cover_image doc
+          if (doc.attr 'publication-type', 'book') != 'book'
+            usernames = spine.map {|item| item.attr 'username' }.compact.uniq
+            add_profile_images doc, usernames
+          end
+          add_content doc
+        end
+
+        ::FileUtils.mkdir_p dest unless ::File.directory? dest
+
+        epub_file = fmt == :kf8 ? %(#{::Asciidoctor::Helpers.rootname target}-kf8.epub) : target
+        builder.generate_epub epub_file
+        logger.debug %(Wrote #{fmt.upcase} to #{epub_file})
+        if options[:extract]
+          extract_dir = epub_file.sub EpubExtensionRx, ''
+          ::FileUtils.remove_dir extract_dir if ::File.directory? extract_dir
+          ::Dir.mkdir extract_dir
+          ::Dir.chdir extract_dir do
+            ::Zip::File.open epub_file do |entries|
+              entries.each do |entry|
+                next unless entry.file?
+                unless (entry_dir = ::File.dirname entry.name) == '.' || (::File.directory? entry_dir)
+                  ::FileUtils.mkdir_p entry_dir
+                end
+                entry.extract
+              end
+            end
+          end
+          logger.debug %(Extracted #{fmt.upcase} to #{extract_dir})
+        end
+
+        if fmt == :kf8
+          # QUESTION shouldn't we validate this epub file too?
+          distill_epub_to_mobi epub_file, target, options[:compress], options[:kindlegen_path]
+        elsif options[:validate]
+          validate_epub epub_file, options[:epubcheck_path]
+        end
+      end
+
+      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
+          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 = 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|
+          logger.info line
+        end
+        err.each_line do |line|
+          log_line line
+        end
+
+        output_file = ::File.join ::File.dirname(epub_file), mobi_file
+        if res.success?
+          logger.debug %(Wrote MOBI to #{output_file})
+        else
+          logger.error %(kindlegen failed to write MOBI to #{output_file})
+        end
+      end
+
+      def get_epubcheck_command epubcheck_path
+        unless epubcheck_path.nil?
+          logger.debug %(Using ebook-epubcheck-path attribute: #{epubcheck_path})
+          return [epubcheck_path]
+        end
+
+        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
+        end
+        err.each_line do |line|
+          log_line line
+        end
+
+        logger.error %(EPUB validation failed: #{epub_file}) unless res.success?
+      end
+
+      def log_line line
+        line = line.strip
+
+        if line =~ /^fatal/i
+          logger.fatal line
+        elsif line =~ /^error/i
+          logger.error line
+        elsif line =~ /^warning/i
+          logger.warn line
+        else
+          logger.info line
+        end
+      end
+    end
+  end
+end