asciidoctor-epub3 2.1.3 → 2.2.0

data/lib/asciidoctor-epub3/converter.rb

@@ -105,8 +105,10 @@ module Asciidoctor
         @footnotes = []
 
         basebackend 'html'
+        filetype 'epub'
         outfilesuffix '.epub'
         htmlsyntax 'xml'
+        supports_templates true
       end
 
       def convert(node, name = nil, _opts = {})
@@ -587,8 +589,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       def convert_example(node)
         id_attr = node.id ? %( id="#{node.id}") : ''
         title_div = if node.title?
-                      %(<div class="example-title">#{node.title}</div>
-)
+                      %(<div class="example-title">#{node.captioned_title}</div>)
                     else
                       ''
                     end
@@ -735,6 +736,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
       end
 
       def convert_sidebar(node)
+        id_attribute = node.id ? %( id="#{node.id}") : ''
         classes = ['sidebar']
         if node.title?
           classes << 'titled'
@@ -747,7 +749,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
           title_attr = title_el = ''
         end
 
-        %(<aside class="#{classes * ' '}"#{title_attr} epub:type="sidebar">
+        %(<aside#{id_attribute} class="#{classes * ' '}"#{title_attr} epub:type="sidebar">
 #{title_el}<div class="content">
 #{output_content node}
 </div>
@@ -866,7 +868,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         class_attribute = %( class="#{classes.join ' '}")
 
         lines << %(<div#{id_attribute}#{class_attribute}>)
-        lines << %(<div class="title">#{node.title}</div>) if node.title?
+        lines << %(<div class="list-heading">#{node.title}</div>) if node.title?
 
         case (style = node.style)
         when 'itemized', 'ordered'
@@ -956,7 +958,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         ol_start_attr = node.attr?('start') ? %( start="#{node.attr 'start'}") : ''
         id_attribute = node.id ? %( id="#{node.id}") : ''
         lines = [%(<div#{id_attribute} class="#{div_classes * ' '}">)]
-        lines << %(<h3 class="list-heading">#{node.title}</h3>) if node.title?
+        lines << %(<div class="list-heading">#{node.title}</div>) if node.title?
         lines << %(<ol#{ol_class_attr}#{ol_start_attr}#{node.option?('reversed') ? ' reversed="reversed"' : ''}>)
         node.items.each do |item|
           li_classes = [item.role].compact
@@ -985,7 +987,7 @@ document.addEventListener('DOMContentLoaded', function(event, reader) {
         ul_class_attr = ul_classes.empty? ? '' : %( class="#{ul_classes * ' '}")
         id_attribute = node.id ? %( id="#{node.id}") : ''
         lines = [%(<div#{id_attribute} class="#{div_classes * ' '}">)]
-        lines << %(<h3 class="list-heading">#{node.title}</h3>) if node.title?
+        lines << %(<div class="list-heading">#{node.title}</div>) if node.title?
         lines << %(<ul#{ul_class_attr}>)
         node.items.each do |item|
           li_classes = [item.role].compact
@@ -1505,7 +1507,8 @@ body > svg {
 </svg></body>
 </html>)
 
-        @book.add_ordered_item %(#{name}.xhtml), content: content.to_ios, id: name
+        @book.prefixes['calibre'] = 'https://calibre-ebook.com'
+        @book.add_ordered_item(%(#{name}.xhtml), content: content.to_ios, id: name).add_property('calibre:title-page')
       end
 
       def get_frontmatter_files(doc, workdir)
@@ -1623,31 +1626,35 @@ body > svg {
 
       def nav_level(items, depth, state = {})
         lines = []
-        lines << '<ol>'
-        items.each do |item|
-          # index = (state[:index] = (state.fetch :index, 0) + 1)
-          if (chapter_filename = get_chapter_filename item).nil?
-            item_label = sanitize_xml get_numbered_title(item), :pcdata
-            item_href = %(#{state[:content_doc_href]}##{item.id})
-          else
-            # NOTE: we sanitize the chapter titles because we use formatting to control layout
-            item_label = if item.context == :document
-                           sanitize_doctitle_xml item, :cdata
-                         else
-                           sanitize_xml get_numbered_title(item), :cdata
-                         end
-            item_href = (state[:content_doc_href] = %(#{chapter_filename}.xhtml))
-          end
-          lines << %(<li><a href="#{item_href}">#{item_label}</a>)
-          if depth.zero? || (child_sections = item.sections).empty?
-            lines[-1] = %(#{lines[-1]}</li>)
-          else
-            lines << (nav_level child_sections, depth - 1, state)
-            lines << '</li>'
+
+        if depth.positive?
+          lines << '<ol>'
+          items.each do |item|
+            # index = (state[:index] = (state.fetch :index, 0) + 1)
+            if (chapter_filename = get_chapter_filename item).nil?
+              item_label = sanitize_xml get_numbered_title(item), :pcdata
+              item_href = %(#{state[:content_doc_href]}##{item.id})
+            else
+              # NOTE: we sanitize the chapter titles because we use formatting to control layout
+              item_label = if item.context == :document
+                             sanitize_doctitle_xml item, :cdata
+                           else
+                             sanitize_xml get_numbered_title(item), :cdata
+                           end
+              item_href = (state[:content_doc_href] = %(#{chapter_filename}.xhtml))
+            end
+            lines << %(<li><a href="#{item_href}">#{item_label}</a>)
+            if (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 unless chapter_filename.nil?
           end
-          state.delete :content_doc_href unless chapter_filename.nil?
+          lines << '</ol>'
         end
-        lines << '</ol>'
+
         lines * LF
       end
 

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class File
-  # NOTE: remove once minimum required Ruby version is at least 2.7
+  # TODO: remove once minimum required Ruby version is at least 2.7
   unless respond_to? :absolute_path?
     def self.absolute_path?(path)
       Pathname.new(path).absolute?

data/lib/asciidoctor-epub3/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module Epub3
-    VERSION = '2.1.3'
+    VERSION = '2.2.0'
   end
 end

metadata

@@ -1,16 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-epub3
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Dan Allen
 - Sarah White
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gepub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
@@ -54,165 +109,159 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: pygments.rb
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: epubcheck-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.2.0
+        version: 5.2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.2.0
+        version: 5.2.0.0
 - !ruby/object:Gem::Dependency
-  name: rouge
+  name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 13.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 13.2.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.50.2
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 1.70.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.20.0
+        version: 1.70.0
 - !ruby/object:Gem::Dependency
-  name: asciidoctor
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: 0.6.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: gepub
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.15
-  type: :runtime
+        version: '3.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.15
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '5.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: 'An extension for Asciidoctor that converts AsciiDoc documents to EPUB3
   e-book format.
 
@@ -293,7 +342,6 @@ homepage: https://github.com/asciidoctor/asciidoctor-epub3
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -301,15 +349,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Converts AsciiDoc documents to EPUB3 e-book format
 test_files: []