asciidoctor-epub3 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41b54ee8dc9d1be6beb0b1e120bbec6f1092844b857565c486bf4e7544a9d1f2
-  data.tar.gz: c19f9ca716e1bbfd51d1cb7c76956eebccfddbb5a44fd0741176e53664f9015e
+  metadata.gz: 5ee3533e733000fb2993b451bc747991ccab2634a91208266e61d6530055c8cf
+  data.tar.gz: 6e42f2fc2c09382374920e1263c436c866ced640a7cc8dbf3bf1b55aa866033e
 SHA512:
-  metadata.gz: 73bd3c80e9e1e25649abf4e6caa79e4c0a891e951d9667d5a0140bbcdcd0bd0399560d37086f35dafc06d3be8eae9d443d119606c55404cc82cdc144356ac446
-  data.tar.gz: fe37d04a7bacc742328dc817cb084c01b8b067a97bba864b343987876e9a7cb90c919b470337e69cddd5942b84d3030e52aea61c780e54a57473893fb4eccacd
+  metadata.gz: 2fe027ccae88e3ad3ace13d369f89ef8d0a837e627b4204e47bc2ae1e7b148dc8d8ec4699b48b18e0e64c65d2a2d2afd0f29f07fdfd46a03f01fde64ed29d662
+  data.tar.gz: c1a0601815f2b1add43036b397705fbf648bebc0ede9921893f20c7fc8e5dd16a35799eb39dd0d8b8871636861e56bf3721644fd38d3fd5cb0f290642b553105

data/CHANGELOG.adoc

@@ -5,7 +5,25 @@
 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 (2021-04-29) - @slonopotamus
+== 2.0.0 (2024-01-12) - @slonopotamus
+
+* fix handling of chapters with Unicode titles for Mobi (#417)
+* add XML declarations to XHTML files (#424 by @abbrev)
+* bump the oldest supported Ruby to 2.6
+* bump the oldest supported Asciidoctor to 2.0
+* escape double quotes in alt text (#443)
+* refactor `btn` styling to be more customizable (#450)
+* fix duplicate HTML IDs in case the same footnote is used multiple times (#447)
+* add initial support for `:pygments-linenums-mode: inline` (#451)
+* line numbers are no longer selected when copying text from code snippets (#422)
+* compress CSS to reduce its size
+* preserve roles of admonition blocks (#420)
+* use prose font for verse blocks (#394)
+* add support for absolute cover image path (#419)
+* add support for floating blocks (#405)
+* fix `<hN>` tags for chapters (#388)
+
+== 1.5.1 (2021-04-29) - @slonopotamus
 
 * update Font Awesome Solid to 5.15.1
 * use CSS for image size scaling instead of `width` attribute (#382)
@@ -71,7 +89,7 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[
 * fix image and listing numbers being reset in each chapter (#178)
 * fix xref resolving between sub-includes of chapter files (#166)
 * add support for contentless include files (#151)
-* drop nonstandard `<<chapter#>>` xref syntax and instead support vanilla `<<anchor>>` or `<<file#anchor>>` syntax (#136)
+* drop nonstandard `\<<chapter#>>` xref syntax and instead support vanilla `\<<anchor>>` or `\<<file#anchor>>` syntax (#136)
 * properly include bibliography generated by asciidoctor-bibtex (#206)
 * require Asciidoctor 1.5.6+
 * add support for book preamble (#303)

data/Gemfile

@@ -5,15 +5,12 @@ source 'https://rubygems.org'
 # Look in asciidoctor-epub3.gemspec for runtime and development dependencies.
 gemspec
 
-if ENV.key? 'ASCIIDOCTOR_VERSION'
-  gem 'asciidoctor', ENV['ASCIIDOCTOR_VERSION'], require: false
-  # Newer asciidoctor-diagram 1.5.x require asciidoctor >=1.5.7
-  gem 'asciidoctor-diagram', '1.5.16', require: false if Gem::Version.new(ENV['ASCIIDOCTOR_VERSION']) < Gem::Version.new('2.0.0')
-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.5.0'
-  # Kindlegen is unavailable neither for 64-bit MacOS nor for ARM
-  gem 'kindlegen', '~> 3.1.0' unless RbConfig::CONFIG['host_os'] =~ /darwin/
+  # epubcheck-ruby might be safe to be converted into runtime dependency,
+  # but could have issues when packaged into asciidoctorj-epub3
+  gem 'epubcheck-ruby', '~> 5.1.0.0'
+
+  # Kindlegen is unavailable neither for 64-bit x86 macOS nor for ARM
+  # Also, skip JRuby on Windows for now. See https://github.com/jruby/jruby/issues/7171
+  gem 'kindlegen', '~> 3.1.0' unless RUBY_PLATFORM =~ /darwin/ || (Gem.win_platform? && RUBY_ENGINE == 'jruby')
 end

data/README.adoc

@@ -1,29 +1,28 @@
 = {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, 2021-04-29
-v1.5.0, 2021-04-29
+v2.0.0, 2024-01-12
 :project-name: Asciidoctor EPUB3
 :project-handle: asciidoctor-epub3
 :uri-project: https://github.com/asciidoctor/{project-handle}
 :uri-gem: https://rubygems.org/gems/asciidoctor-epub3
-:uri-ci: {uri-project}/actions?query=branch%3Amaster
+:uri-ci: {uri-project}/actions?query=branch%3Amain
 :uri-issues: {uri-project}/issues
 :uri-rvm: https://rvm.io
 
 image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg[project chat,link=https://asciidoctor.zulipchat.com/]
 image:https://img.shields.io/gem/v/asciidoctor-epub3.svg[Latest Release,link={uri-gem}]
-image:{uri-project}/workflows/CI/badge.svg?branch=master[GitHub Actions,link={uri-ci}]
+image:{uri-project}/workflows/CI/badge.svg?branch=main[GitHub Actions,link={uri-ci}]
 
 {project-name} is a set of Asciidoctor extensions for converting AsciiDoc documents directly to the EPUB3 and KF8/MOBI e-book formats.
 
 == Documentation
 
-Detailed installation and usage instructions can be found on the https://docs.asciidoctor.org/asciidoctor-epub3/latest/[Asciidoctor Docs site].
+Detailed installation and usage instructions can be found on the https://docs.asciidoctor.org/epub3-converter/latest/[Asciidoctor Docs site].
 
 == Installation
 
 {project-name} is published on RubyGems.org.
-{project-name} requires Ruby 2.3 or newer.
+{project-name} requires Ruby 2.6 or newer.
 You can install the published gem using the following command:
 
 [source,shell script]

data/Rakefile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 $default_tasks = [] # rubocop:disable Style/GlobalVars
-Dir.glob('tasks/*.rake').each {|file| load file }
+Dir.glob('tasks/*.rake').each { |file| load file }
 task default: $default_tasks unless $default_tasks.empty? # rubocop:disable Style/GlobalVars

data/asciidoctor-epub3.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.version = Asciidoctor::Epub3::VERSION
 
   s.summary = 'Converts AsciiDoc documents to EPUB3 and KF8/MOBI (Kindle) e-book formats'
-  s.description = <<-EOS
-An extension for Asciidoctor that converts AsciiDoc documents to EPUB3 and KF8/MOBI (Kindle) e-book archives.
+  s.description = <<~EOS
+    An extension for Asciidoctor that converts AsciiDoc documents to EPUB3 and KF8/MOBI (Kindle) e-book archives.
   EOS
 
   s.authors = ['Dan Allen', 'Sarah White']
@@ -17,30 +17,33 @@ An extension for Asciidoctor that converts AsciiDoc documents to EPUB3 and KF8/M
   s.homepage = 'https://github.com/asciidoctor/asciidoctor-epub3'
   s.license = 'MIT'
 
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.6.0'
 
   files = begin
-    (result = Open3.popen3('git ls-files -z') {|_, out| out.read }.split %(\0)).empty? ? Dir['**/*'] : result
-  rescue
+    (result = Open3.popen3('git ls-files -z') { |_, out| out.read }.split %(\0)).empty? ? Dir['**/*'] : result
+  rescue StandardError
     Dir['**/*']
   end
-  s.files = files.grep %r/^(?:(?:data\/(?:fonts|images|styles)|lib)\/.+|Gemfile|Rakefile|LICENSE|(?:CHANGELOG|NOTICE|README)\.adoc|\.yardopts|#{s.name}\.gemspec)$/
-  s.executables = %w(asciidoctor-epub3 adb-push-ebook)
-  s.test_files = s.files.grep(/^(?:test|spec|feature)\/.*$/)
+  s.files = files.grep %r{^(?:(?:data/(?:fonts|images|styles)|lib)/.+|Gemfile|Rakefile|LICENSE|(?:CHANGELOG|NOTICE|README)\.adoc|\.yardopts|#{s.name}\.gemspec)$}
+  s.executables = %w[asciidoctor-epub3 adb-push-ebook]
 
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'asciidoctor-diagram', '>= 1.5.0', '< 3.0.0'
+  s.add_development_dependency 'asciidoctor-diagram', '~> 2.0'
   s.add_development_dependency 'asciimath', '~> 2.0'
   s.add_development_dependency 'coderay', '~> 1.1.0'
-  s.add_development_dependency 'pygments.rb', '~> 2.2.0'
-  s.add_development_dependency 'rake', '~> 13.0.0'
+  s.add_development_dependency 'pygments.rb', '~> 2.4.0'
+  s.add_development_dependency 'rake', '~> 13.1.0'
   s.add_development_dependency 'rouge', '~> 3.0'
-  s.add_development_dependency 'rspec', '~> 3.10.0'
-  s.add_development_dependency 'rubocop', '~> 0.81.0'
-  s.add_development_dependency 'rubocop-rspec', '~> 1.41.0'
+  s.add_development_dependency 'rspec', '~> 3.12.0'
+  s.add_development_dependency 'rubocop', '~> 1.50.2'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.20.0'
 
-  s.add_runtime_dependency 'asciidoctor', '>= 1.5.6', '< 3.0.0'
+  s.add_runtime_dependency 'asciidoctor', '~> 2.0'
   s.add_runtime_dependency 'gepub', '~> 1.0.0'
   s.add_runtime_dependency 'mime-types', '~> 3.0'
+
+  # TODO: switch to 'sass-embedded' when we drop Ruby 2.5 support
+  s.add_runtime_dependency 'sass'
 end

data/bin/adb-push-ebook

@@ -4,10 +4,10 @@
 ADB = ENV['ADB'] || 'adb'
 TARGETS = {
   '.epub' => '/sdcard/',
-  '.mobi' => '/sdcard/Android/data/com.amazon.kindle/files/',
-}
+  '.mobi' => '/sdcard/Android/data/com.amazon.kindle/files/'
+}.freeze
 
-unless ::File.executable? ADB
+unless File.executable? ADB
   warn %(adb-push-ebook: `adb` not found.\nPlease set the ADB environment variable or add `adb` to your PATH.)
   exit 1
 end
@@ -17,19 +17,21 @@ require 'shellwords'
 
 payload_file = ARGV[0] || '_output/sample-book'
 
-if (payload_file_ext = File.extname payload_file).empty?
-  transfers = TARGETS.map do |(ext, target_dir)|
-    {
-      src: %(#{payload_file}#{ext}),
-      dest: target_dir,
-    }
-  end
-else
-  transfers = [{ src: payload_file, dest: TARGETS[payload_file_ext] }]
-end
+transfers = if (payload_file_ext = File.extname payload_file).empty?
+              TARGETS.map do |(ext, target_dir)|
+                {
+                  src: %(#{payload_file}#{ext}),
+                  dest: target_dir
+                }
+              end
+            else
+              [{ src: payload_file, dest: TARGETS[payload_file_ext] }]
+            end
 
 transfers.each do |transfer|
+  next unless File.file? transfer[:src]
+
   Open3.popen2e Shellwords.join([ADB, 'push', transfer[:src], transfer[:dest]]) do |_input, output, _wait_thr|
-    output.each {|line| puts line }
-  end if File.file? transfer[:src]
+    output.each { |line| puts line }
+  end
 end

data/data/styles/_colors.scss

@@ -0,0 +1,90 @@
+$black: #000000;
+$off-black: #101010;
+$deep-gray: #202020;
+$dark-gray: #333332;
+$tuatara-gray: #40403E;
+$medium-gray: #707070;
+$gray: #C8C8C8;
+$off-white: #E0E0E0;
+$papaya-white: #FFF0D4;
+$white: #FFFFFF;
+
+$mahogany-red: #C83737;
+$flamingo-orange: #F2642A;
+$light-yellow: #FFC14F;
+$beauty-pink: #F1CECE;
+$cinderella-pink: #FCD9CA;
+
+$green: #57AD68;
+$medium-green: #468C54;
+
+// =========================
+// === assign the colors ===
+// =========================
+
+$body-background: $white;
+
+$header-text: $off-black;
+$h4-header-text: $deep-gray;
+$h5-header-text: $dark-gray;
+
+$chapter-header-title-text: $dark-gray;
+$chapter-header-title-border: $dark-gray;
+$chapter-header-em: $green;
+
+$link-border: $dark-gray;
+
+$blockquote-text: $black;
+$para-first-text: $dark-gray;
+
+$list-lvl1: $dark-gray;
+$list-lvl2: $green;
+$list-lvl3: $dark-gray;
+$list-lvl4: $green;
+
+$footer-context: $dark-gray;
+
+$abstract-text: $dark-gray;
+$abstract-link: $dark-gray;
+
+$caption-text: $dark-gray;
+
+$aside-background: $off-white;
+$aside-border: $gray;
+
+$button-text: $black;
+$button-shadow: $gray;
+
+$pre-text: $off-black;
+$pre-background: $off-white;
+$pre-border: $gray;
+
+$kbd-background: $off-white;
+$kbd-border: $gray;
+
+$mark-text: $black;
+$mark-background: $light-yellow;
+
+$last-mark-text: $green;
+
+$i-conum-text: $medium-green;
+
+$table-border: $medium-gray;
+
+$note-border: $light-yellow;
+$note-background: $papaya-white;
+
+$tip-border: $tuatara-gray;
+$tip-background: $off-white;
+
+$caution-border: $medium-gray;
+$caution-background: $off-white;
+
+$warning-border: $mahogany-red;
+$warning-background: $beauty-pink;
+
+$important-border: $flamingo-orange;
+$important-background: $cinderella-pink;
+
+$about-author-border: $gray;
+$headshot-border: $medium-gray;

data/data/styles/_reset.scss

@@ -0,0 +1,54 @@
+/* educate older readers about tags introduced in HTML5 */
+article, aside, details, figcaption, figure, footer, header, hgroup, menu, nav, section, summary {
+  display: block;
+}
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  border: 0;
+  font: inherit;
+  font-size: 100%;
+  margin: 0;
+  padding: 0;
+  vertical-align: baseline;
+}
+
+@page {
+  margin: 0;
+}
+
+*, *:before, *:after {
+  box-sizing: border-box;
+}
+
+body {
+  line-height: 1;
+}
+
+blockquote, q {
+  quotes: none;
+}
+
+img {
+  max-width: 100%;
+}
+
+ol, ul {
+  list-style: none;
+}
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}

data/data/styles/{epub3-css3-only.css → epub3-css3-only.scss}

@@ -1,45 +1,15 @@
-/* @page is for EPUB2 only */
-@page {
-  margin: 0;
-}
-
-body.calibre-desktop {
-  padding: 20pt 0 !important;
-}
-
-body.calibre-desktop > section {
-  margin: 0 25pt;
-}
-
 /* Gitden & Namo default to 16px font-size; bump it to 19px (118.75%) */
 body.gitden-reader,
 body.namo-epub-library {
   font-size: 118.75%;
 }
 
-/* Gitden doesn't give us much margin, so let's roughly match Aldiko and Kindle (narrow setting) */
-body.gitden-reader {
-  margin: 0 5pt !important;
-}
-
-/* Namo has the same margin problem, except setting side margins doesn't work */
-/*body.namo-epub-library > section.chapter {
-  margin: 0 5pt;
-}*/
-
 /* Use tighter margins and smaller font (18px) on phones (Nexus 4 and smaller) */
 @media only screen and (max-device-width: 768px) and (max-device-height: 1280px), only screen and (max-device-width: 1280px) and (max-device-height: 768px) {
   body.gitden-reader,
   body.namo-epub-library {
     font-size: 112.5%;
   }
-
-  /*body.gitden-reader {
-    margin: 0 5pt !important;
-  }*/
-  /*body.namo-epub-library > section.chapter {
-    margin: 0 5pt;
-  }*/
 }
 
 body.gitden-reader pre {
@@ -55,7 +25,7 @@ h1 :not(code), h2 :not(code), h3:not(.list-heading) :not(code), h4 :not(code), h
 }
 
 /* QUESTION what about nested elements inside code? */
-body code, body kbd, body pre, pre :not(code) {
+body code, body kbd, body :not(.verse) > pre, :not(.verse) > pre :not(code) {
   /* !important required to override custom font setting in Kindle / Gitden / Namo */
   /* Gitden requires the extra weight of a parent selector */
   /* Kindle and Gitden require the override on pre child elements */