asciidoctor-fb2 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c7f00f477ddb1d95bb04eb0a834308288cae185c008ee0206197c9c4403d95
-  data.tar.gz: '08772d526c95b49df5956b0ba12868aa58e4c1684b5e947aa5e233ee222c891f'
+  metadata.gz: 2c92fc77a9c3146a344b615e53430b2a1c33c04688a60a6dd175df173ec5e173
+  data.tar.gz: 991a87e1cede4126726357252f2bb19e30380912153f1a81a511ee81873124b2
 SHA512:
-  metadata.gz: 56fbb9d6633d5b3ed3b55fc1b9aa8698c4805ddacae41c44cd376952e998ad89d379fb44bca7fa5ff42454ff6bec7cd717100b7408e013850c762bde7df0bedf
-  data.tar.gz: 63a52028f548239dcc0d349f2d1ae8d371f53618c56aa47b04acb3eb1c42b9a93276dd579752d3ce143f36f61548b421e1f681d83ef47db3788cde303488aa0b
+  metadata.gz: 7da4ab8d23af356a2d321b9894d2747cfdf9913931566ace0b3945fb43e9dda32c76b1257e6555607cc3a47940c0e6e480213e395b60f5089120f5d6c2ad9db3
+  data.tar.gz: 49422fe74cb1ac22574d602a572abc5d79ae66883e20758ed721e7efc579771acf8359aa3acc67d8ad45400d344c8dd6421dab9cda46f04ab25ec358e2f26a0a

data/.github/dependabot.yml

@@ -6,3 +6,8 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -9,18 +9,16 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
-      - name: Build
-        run: bundle install --jobs 4 --retry 3
+          ruby-version: '3.0'
+          bundler-cache: true
       - name: Lint
         run: bundle exec rake lint
   test:
     strategy:
       matrix:
-        # ruby: [jruby, 2.4, 2.5, 2.6, 2.7]
-        ruby: [2.4, 2.5, 2.6, 2.7]
-        platform: [ubuntu-latest, macos-latest, windows-latest]
-    runs-on: ${{ matrix.platform }}
+        ruby: ['jruby', '2.4', '2.5', '2.6', '2.7', '3.0']
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -28,7 +26,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Build
-        run: bundle install --jobs 4 --retry 3
+          bundler-cache: true
       - name: Test
         run: bundle exec rake spec

data/.github/workflows/release.yml

@@ -11,14 +11,9 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: '3.0'
     - name: Publish to RubyGems.org
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+      uses: dawidd6/action-publish-gem@v1
+      with:
+        api_key: ${{ secrets.RUBYGEMS_API_KEY }}
+

data/CHANGELOG.adoc

@@ -1,12 +1,40 @@
 = {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.4.0 (2021-02-14) - @slonopotamus
+
+* fix table cells markup
+* bump fb2rb to 0.6.0
+
+== 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]

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,13 @@ 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.6.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.9.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.5.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.2.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
 
@@ -38,29 +44,28 @@ module Asciidoctor
         end
         node.authors.each do |author|
           title_info.authors << FB2rb::Author.new(
-            author.firstname,
-            author.middlename,
-            author.lastname,
-            nil,
-            [],
-            author.email.nil? ? [] : [author.email]
+            first_name: author.firstname,
+            middle_name: author.middlename,
+            last_name: author.lastname,
+            emails: author.email.nil? ? [] : [author.email]
           )
         end
 
         if node.attr? 'series-name'
           series_name = node.attr 'series-name'
           series_volume = node.attr 'series-volume', 1
-          title_info.sequences << FB2rb::Sequence.new(series_name, series_volume)
+          title_info.sequences << FB2rb::Sequence.new(name: series_name, number: series_volume)
         end
 
         date = node.attr('revdate') || node.attr('docdate')
-        fb2date = FB2rb::FB2Date.new(date, Date.parse(date))
+        fb2date = FB2rb::FB2Date.new(display_value: date, value: Date.parse(date))
         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)
-          title_info.coverpage = FB2rb::Coverpage.new([%(##{cover_image_path})])
+          register_binary(node, cover_image_path, 'image')
+          title_info.coverpage = FB2rb::Coverpage.new(images: [%(##{cover_image_path})])
         end
 
         document_info.id = node.attr('uuid', '')
@@ -74,8 +79,8 @@ module Asciidoctor
 <title><p>#{node.doctitle}</p></title>
 #{node.content}
 </section>)
-        @book.bodies << FB2rb::Body.new(nil, body)
-        if node.document.footnotes
+        @book.bodies << FB2rb::Body.new(content: body)
+        unless node.document.footnotes.empty?
           notes = []
           node.document.footnotes.each do |footnote|
             notes << %(<section id="note-#{footnote.index}">
@@ -83,7 +88,7 @@ module Asciidoctor
 <p>#{footnote.text}</p>
 </section>)
           end
-          @book.bodies << FB2rb::Body.new('notes', notes * "\n")
+          @book.bodies << FB2rb::Body.new(name: 'notes', content: notes * "\n")
         end
         @book
       end
@@ -108,6 +113,11 @@ module Asciidoctor
         end
       end
 
+      # @param _node [Asciidoctor::Block]
+      def convert_toc(_node)
+        ''
+      end
+
       # @param node [Asciidoctor::Block]
       def convert_paragraph(node)
         lines = [
@@ -137,7 +147,7 @@ module Asciidoctor
       # @param node [Asciidoctor::Block]
       def convert_verse(node)
         body = node.content&.split("\n\n")&.map do |stanza|
-          %(<stanza>\n<v>#{stanza.split("\n").join("</v>\n<v>")}</v>\n</stanza>)
+          %(<stanza>\n<v>#{stanza.split("\n") * "</v>\n<v>"}</v>\n</stanza>)
         end&.join("\n")
 
         citetitle = node.attr('citetitle')
@@ -155,6 +165,11 @@ module Asciidoctor
 
       # @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>)
@@ -186,11 +201,11 @@ 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
@@ -207,7 +222,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]
@@ -238,13 +253,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>)
@@ -257,9 +272,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)
@@ -269,7 +290,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
@@ -287,6 +313,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 = []
@@ -347,28 +380,36 @@ module Asciidoctor
         lines * "\n"
       end
 
+      # @param cell [Asciidoctor::Table::Cell]
+      def get_cell_content(cell) # rubocop:disable Metrics/MethodLength
+        case cell.style
+        when :asciidoc
+          cell.content
+        when :emphasis
+          %(<emphasis>#{cell.text}</emphasis>)
+        when :literal
+          %(<code>#{cell.text}</code>)
+        when :monospaced
+          %(<code>#{cell.text}</code>)
+        when :strong
+          %(<strong>#{cell.text}</strong>)
+        else
+          cell.text
+        end
+      end
+
       # @param node [Asciidoctor::Table]
       def convert_table(node) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-        lines = ['<table>']
-        node.rows.to_h.each do |tsec, rows| # rubocop:disable Metrics/BlockLength
+        lines = []
+        lines << %(<subtitle>#{node.captioned_title}</subtitle>) if node.title?
+        lines << '<table>'
+        node.rows.to_h.each do |tsec, rows|
           next if rows.empty?
 
           rows.each do |row|
             lines << '<tr>'
             row.each do |cell|
-              cell_content = if tsec == :head
-                               cell.text
-                             else
-                               case cell.style
-                               when :asciidoc
-                                 cell.content
-                               when :literal
-                                 %(<p><pre>#{cell.text}</pre></p>)
-                               else
-                                 (cell_content = cell.content).empty? ? '' : %(<p>#{cell_content.join "</p>\n<p>"}</p>)
-                               end
-                             end
-
+              cell_content = get_cell_content(cell)
               cell_tag_name = (tsec == :head || cell.style == :header ? 'th' : 'td')
               cell_attrs = [
                 %(halign="#{cell.attr 'halign'}"),
@@ -376,7 +417,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.2'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-fb2
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Marat Radchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2021-02-14 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.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.6.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,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.93.0
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.93.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.44.0
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.44.0
+        version: 2.2.0
 description: 
 email:
 - marat@slonopotamus.org
@@ -129,6 +157,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 +165,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: {}
@@ -155,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Converts AsciiDoc documents to FB2 e-book formats