asciidoctor-fb2 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 210abe6551fe7da1d9b89221086ccf555b0415e14ffec68915c859ba3b05bf5a
-  data.tar.gz: 92d848355114858d43682c963606466c0f5e07bfcbcaf65e1436aa6cb34cecca
+  metadata.gz: fefb6e896cf8679642198ac1ffe5222916781f71cbb775130bf32eeb00b375b4
+  data.tar.gz: 5100ec044994316213786b065115f6214ca4dd29c4f8655fc3a9ffc42726d258
 SHA512:
-  metadata.gz: 4ca271531be2ecfe832f45bfe25ba0ddfb69c938fd19acb4b9edde6f31c4d1f7b6efee4bc87c00429a9cfd8d3841acd1ecfe78c39fdea3cf5d2a14490a3b3306
-  data.tar.gz: 68d20bc6f6fae5ba45c036fff85377294801c37bbf0abbc0c47fbf965aee74cfe8517e67c324ace6a96d26e801b1626564043ee6ef8d87d61d11f7742df6f5f1
+  metadata.gz: '099b2149b1dacc1a1239725ce386afdc48ff7429a6aa7e0108af80db0c84630c176ec6adf96090f671c7a51bd1140590d920133ba4de76788e239fe490951317'
+  data.tar.gz: 7418059f5dd43b7f77087acac3af70764e80af4dc676be995c9d421edd01dd89008b11926c36151b6832b1c137684236cad3b00a12b6798a5747d23690089c7c

data/.github/workflows/ci.yml

@@ -17,8 +17,7 @@ jobs:
   test:
     strategy:
       matrix:
-        # ruby: [jruby, 2.4, 2.5, 2.6, 2.7]
-        ruby: [2.4, 2.5, 2.6, 2.7]
+        ruby: [jruby, 2.4, 2.5, 2.6, 2.7]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:

data/CHANGELOG.adoc

@@ -1,12 +1,41 @@
 = {project-name} Changelog
 :project-name: Asciidoctor FB2
 :project-handle: asciidoctor-fb2
-:slug: slonopotamus/{project-handle}
+:slug: asciidoctor/{project-handle}
 :uri-project: https://github.com/{slug}
 
 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-project}/commits/master[commit history] on GitHub.
 
+== 0.3.1 (2020-11-29) - @slonopotamus
+
+* fix crash on `+toc::[]+` macro
+* avoid adding `notes` body to FB2 if document doesn't have any footnotes
+* fix invalid XML syntax for table cells
+
+== 0.3.0 (2020-11-25) - @slonopotamus
+
+* output MIME type for FB2 embedded binary files. https://github.com/slonopotamus/asciidoctor-fb2/issues/19[#19]
+* handle `+image:file[]+` syntax for `+:front-cover-image:+` document attribute. https://github.com/slonopotamus/asciidoctor-fb2/issues/19[#19]
+
+== 0.2.4 (2020-11-24) - @slonopotamus
+
+* add support for table captions
+* fix images from subfolders not loaded in Calibre
+* add initial CSS support
+
+== 0.2.3 (2020-11-24) - @slonopotamus
+
+* add support for literal blocks
+* fix crash for `menu` inline macro without submenu. https://github.com/slonopotamus/asciidoctor-fb2/issues/15[#15]
+* add initial support for sidebar
+
+== 0.2.2 (2020-11-24) - @slonopotamus
+
+* do not crash on inline line break macro. https://github.com/slonopotamus/asciidoctor-fb2/issues/14[#14]
+* add support for verses
+* add support for quotes
+
 == 0.2.1 (2020-11-24) - @slonopotamus
 
 * add support for `kbd` inline macro. https://github.com/slonopotamus/asciidoctor-fb2/issues/13[#13]

data/README.adoc

@@ -2,7 +2,7 @@
 Marat Radchenko <marat@slonopotamus.org>
 :project-name: Asciidoctor FB2
 :project-handle: asciidoctor-fb2
-:slug: slonopotamus/{project-handle}
+:slug: asciidoctor/{project-handle}
 :uri-project: https://github.com/{slug}
 :uri-ci: {uri-project}/actions?query=branch%3Amaster
 :uri-gem: https://rubygems.org/gems/{project-handle}

data/asciidoctor-fb2.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors = ['Marat Radchenko']
   s.email = ['marat@slonopotamus.org']
   s.summary = 'Converts AsciiDoc documents to FB2 e-book formats'
-  s.homepage = 'https://github.com/slonopotamus/asciidoctor-fb2'
+  s.homepage = 'https://github.com/asciidoctor/asciidoctor-fb2'
   s.license = 'MIT'
   s.required_ruby_version = '>= 2.4.0'
 
@@ -19,11 +19,12 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'asciidoctor', '~> 2.0'
-  s.add_runtime_dependency 'fb2rb', '~> 0.3.0'
+  s.add_runtime_dependency 'fb2rb', '~> 0.4.0'
+  s.add_runtime_dependency 'mime-types', '~> 3.0'
 
   s.add_development_dependency 'asciidoctor-diagram', '~> 2.0'
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.10.0'
-  s.add_development_dependency 'rubocop', '~> 0.93.0'
-  s.add_development_dependency 'rubocop-rspec', '~> 1.44.0'
+  s.add_development_dependency 'rubocop', '~> 1.4.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.0.0'
 end

data/data/fb2.css

@@ -0,0 +1,3 @@
+body {
+  text-align: justify
+}

data/lib/asciidoctor_fb2.rb

@@ -3,14 +3,18 @@
 require 'asciidoctor'
 require 'asciidoctor/converter'
 require 'fb2rb'
+require 'mime/types'
 
 module Asciidoctor
   module FB2
+    DATA_DIR = File.expand_path(File.join(__dir__, '..', 'data'))
+
     # Converts AsciiDoc documents to FB2 e-book formats
     class Converter < Asciidoctor::Converter::Base # rubocop:disable Metrics/ClassLength
       include ::Asciidoctor::Writer
 
       CSV_DELIMITER_REGEX = /\s*,\s*/.freeze
+      IMAGE_ATTRIBUTE_VALUE_RX = /^image:{1,2}(.*?)\[(.*?)\]$/.freeze
 
       register_for 'fb2'
 
@@ -25,6 +29,8 @@ module Asciidoctor
       # @param node [Asciidoctor::Document]
       def convert_document(node) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         @book = FB2rb::Book.new
+        @book.add_stylesheet('text/css', File.join(DATA_DIR, 'fb2.css'))
+
         document_info = @book.description.document_info
         title_info = @book.description.title_info
 
@@ -58,8 +64,9 @@ module Asciidoctor
         title_info.date = document_info.date = fb2date
 
         unless (cover_image = node.attr('front-cover-image')).nil?
+          cover_image = Regexp.last_match(1) if cover_image =~ IMAGE_ATTRIBUTE_VALUE_RX
           cover_image_path = node.image_uri(cover_image)
-          register_binary(node, cover_image_path)
+          register_binary(node, cover_image_path, 'image')
           title_info.coverpage = FB2rb::Coverpage.new([%(##{cover_image_path})])
         end
 
@@ -75,7 +82,7 @@ module Asciidoctor
 #{node.content}
 </section>)
         @book.bodies << FB2rb::Body.new(nil, body)
-        if node.document.footnotes
+        unless node.document.footnotes.empty?
           notes = []
           node.document.footnotes.each do |footnote|
             notes << %(<section id="note-#{footnote.index}">
@@ -108,6 +115,11 @@ module Asciidoctor
         end
       end
 
+      # @param _node [Asciidoctor::Block]
+      def convert_toc(_node)
+        ''
+      end
+
       # @param node [Asciidoctor::Block]
       def convert_paragraph(node)
         lines = [
@@ -119,8 +131,47 @@ module Asciidoctor
         lines * "\n"
       end
 
+      # @param node [Asciidoctor::Block]
+      def convert_quote(node)
+        citetitle = node.attr('citetitle')
+        citetitle_tag = citetitle.nil_or_empty? ? '' : %(<subtitle>#{citetitle}</subtitle>)
+
+        author = node.attr('attribution')
+        author_tag = author.nil_or_empty? ? '' : %(<text-author>#{node.attr('attribution')}</text-author>)
+
+        %(<cite>
+#{citetitle_tag}
+<p>#{node.content}</p>
+#{author_tag}
+</cite>)
+      end
+
+      # @param node [Asciidoctor::Block]
+      def convert_verse(node)
+        body = node.content&.split("\n\n")&.map do |stanza|
+          %(<stanza>\n<v>#{stanza.split("\n") * "</v>\n<v>"}</v>\n</stanza>)
+        end&.join("\n")
+
+        citetitle = node.attr('citetitle')
+        citetitle_tag = citetitle.nil_or_empty? ? '' : %(<title>#{citetitle}</title>)
+
+        author = node.attr('attribution')
+        author_tag = author.nil_or_empty? ? '' : %(<text-author>#{node.attr('attribution')}</text-author>)
+
+        %(<poem>
+#{citetitle_tag}
+#{body}
+#{author_tag}
+</poem>)
+      end
+
       # @param node [Asciidoctor::Block]
       def convert_listing(node)
+        convert_literal(node)
+      end
+
+      # @param node [Asciidoctor::Block]
+      def convert_literal(node)
         lines = []
         node.content.split("\n").each do |line|
           lines << %(<p><code>#{line}</code></p>)
@@ -152,15 +203,20 @@ module Asciidoctor
         caret = '&#160;<strong>&#8250;</strong> '
         menu = node.attr('menu')
         menuitem = node.attr('menuitem')
-        submenus = node.attr('submenus').join(%(</b>#{caret}<b>))
+        submenus = node.attr('submenus') * %(</b>#{caret}<b>)
 
         result = %(<strong>#{menu}</strong>)
-        result += %(#{caret}<strong>#{submenus}</strong>) unless submenus.empty?
-        result += %(#{caret}<strong>#{menuitem}</strong>) unless menuitem.empty?
+        result += %(#{caret}<strong>#{submenus}</strong>) unless submenus.nil_or_empty?
+        result += %(#{caret}<strong>#{menuitem}</strong>) unless menuitem.nil_or_empty?
 
         result
       end
 
+      # @param node [Asciidoctor::Inline]
+      def convert_inline_break(node)
+        node.text
+      end
+
       # @param node [Asciidoctor::Inline]
       def convert_inline_button(node)
         %([<strong>#{node.text}</strong>])
@@ -168,7 +224,7 @@ module Asciidoctor
 
       # @param node [Asciidoctor::Inline]
       def convert_inline_kbd(node)
-        %(<strong>#{node.attr('keys').join('</strong>+<strong>')}</strong>)
+        %(<strong>#{node.attr('keys') * '</strong>+<strong>'}</strong>)
       end
 
       # @param node [Asciidoctor::Inline]
@@ -199,13 +255,13 @@ module Asciidoctor
 
       # @param node [Asciidoctor::Inline]
       def convert_inline_image(node)
-        image_attrs = register_binary(node, node.image_uri(node.target))
+        image_attrs = register_binary(node, node.image_uri(node.target), 'image')
         %(<image #{image_attrs * ' '}/>)
       end
 
       # @param node [Asciidoctor::Block]
       def convert_image(node)
-        image_attrs = register_binary(node, node.image_uri(node.attr('target')))
+        image_attrs = register_binary(node, node.image_uri(node.attr('target')), 'image')
         image_attrs << %(title="#{node.captioned_title}") if node.title?
         image_attrs << %(id="#{node.id}") if node.id
         %(<p><image #{image_attrs * ' '}/></p>)
@@ -218,9 +274,15 @@ module Asciidoctor
         doc
       end
 
+      def determine_mime_type(filename, media_type)
+        mime_types = MIME::Types.type_for(filename)
+        mime_types.delete_if { |x| x.media_type != media_type }
+        mime_types.empty? ? nil : mime_types[0].content_type
+      end
+
       # @param node [Asciidoctor::AbstractNode]
       # @param target [String]
-      def register_binary(node, target) # rubocop:disable Metrics/MethodLength
+      def register_binary(node, target, media_type) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         unless Asciidoctor::Helpers.uriish?(target)
           out_dir = node.attr('outdir', nil, true) || doc_option(node.document, :to_dir)
           fs_path = File.join(out_dir, target)
@@ -230,7 +292,12 @@ module Asciidoctor
           end
 
           if File.readable?(fs_path)
-            @book.add_binary(target, fs_path)
+            # Calibre fails to load images if they contain path separators
+            target.sub!('/', '_')
+            target.sub!('\\', '_')
+
+            mime_type = determine_mime_type(target, media_type)
+            @book.add_binary(target, fs_path, mime_type)
             target = %(##{target})
           end
         end
@@ -248,6 +315,13 @@ module Asciidoctor
         lines * "\n"
       end
 
+      # @param node [Asciidoctor::Block]
+      def convert_sidebar(node)
+        title_tag = node.title.nil_or_empty? ? '' : %(<p><strong>#{node.title}</strong></p>)
+        %(#{title_tag}
+#{node.content})
+      end
+
       # @param node [Asciidoctor::List]
       def convert_ulist(node)
         lines = []
@@ -310,7 +384,9 @@ module Asciidoctor
 
       # @param node [Asciidoctor::Table]
       def convert_table(node) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-        lines = ['<table>']
+        lines = []
+        lines << %(<subtitle>#{node.captioned_title}</subtitle>) if node.title?
+        lines << '<table>'
         node.rows.to_h.each do |tsec, rows| # rubocop:disable Metrics/BlockLength
           next if rows.empty?
 
@@ -326,7 +402,7 @@ module Asciidoctor
                                when :literal
                                  %(<p><pre>#{cell.text}</pre></p>)
                                else
-                                 (cell_content = cell.content).empty? ? '' : %(<p>#{cell_content.join "</p>\n<p>"}</p>)
+                                 (cell_content = cell.content).empty? ? '' : %(<p>#{cell_content * "</p>\n<p>"}</p>)
                                end
                              end
 
@@ -337,7 +413,7 @@ module Asciidoctor
               ]
               cell_attrs << %(colspan="#{cell.colspan}") if cell.colspan
               cell_attrs << %(rowspan="#{cell.rowspan}") if cell.rowspan
-              lines << %(<#{cell_tag_name} #{cell_attrs * ' '}">#{cell_content}</#{cell_tag_name}>)
+              lines << %(<#{cell_tag_name} #{cell_attrs * ' '}>#{cell_content}</#{cell_tag_name}>)
             end
             lines << '</tr>'
           end

data/lib/asciidoctor_fb2/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module FB2
-    VERSION = '0.2.1'
+    VERSION = '0.3.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-fb2
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Marat Radchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2020-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.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: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.93.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.93.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.44.0
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.44.0
+        version: 2.0.0
 description: 
 email:
 - marat@slonopotamus.org
@@ -129,6 +143,7 @@ files:
 - Rakefile
 - asciidoctor-fb2.gemspec
 - bin/asciidoctor-fb2
+- data/fb2.css
 - lib/asciidoctor_fb2.rb
 - lib/asciidoctor_fb2/version.rb
 - tasks/bundler.rake
@@ -136,7 +151,7 @@ files:
 - tasks/console.rake
 - tasks/rspec.rake
 - tasks/rubocop.rake
-homepage: https://github.com/slonopotamus/asciidoctor-fb2
+homepage: https://github.com/asciidoctor/asciidoctor-fb2
 licenses:
 - MIT
 metadata: {}