asciidoctor-fb2 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b60e7a379175a8473e96c61ed95598104689ac84def256f01ec626d850025af
-  data.tar.gz: 96c60b98e0245a9aa4d61037d538f31b623dfd53e0c24407428c784a2753f9c9
+  metadata.gz: 2fe8aeff6fa259f44c96b2adcc9f2f2074e68b918f1dc4ec0d509691b34b67e4
+  data.tar.gz: 6ca94abe536faeeb639bea944ac21a90b6cabe6de42ad733fe7879148665441d
 SHA512:
-  metadata.gz: 13bc939cf1450190c85b87e51333c6d58f3e2d3b2181be4c9a5af8705dd645900cd00a1290f74f68adfed42ad1570cfc4c6ed8974940b7317e5c524b96824b74
-  data.tar.gz: 314760eafb08dfda7c44087dab1d7d6a5309ac45f134612a455b84e894d1b8b328beb06d65be37e7e7a7d20de4bc589841a461c3b50c2e666264c8b8ae505ee6
+  metadata.gz: b18f5a752a529d7a13e7beb1cc30c097914d2696a39f1bfdb736a748b16ee2fcf32544a6fa6b5166b8611a524411a812acc4530550e366a19210dab66ac3cdd2
+  data.tar.gz: 8d6eee70a2a3bbaa328f8f2d9056cf4a25150b0bb6d398323d6ab509cb8a43489171c564492720b21acfda4b52bb0060867d11ad608a76371ba8cbf3565ced2a

data/CHANGELOG.adoc

@@ -7,6 +7,34 @@
 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.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]
+* add support for `btn` inline macro
+
 == 0.2.0 (2020-11-23) - @slonopotamus
 
 * add support for cover image via `+:front-cover-image:+` attribute. https://github.com/slonopotamus/asciidoctor-fb2/issues/3[#3]

data/asciidoctor-fb2.gemspec

@@ -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
 
@@ -119,8 +126,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 +198,30 @@ 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>])
+      end
+
+      # @param node [Asciidoctor::Inline]
+      def convert_inline_kbd(node)
+        %(<strong>#{node.attr('keys') * '</strong>+<strong>'}</strong>)
+      end
+
       # @param node [Asciidoctor::Inline]
       def convert_inline_anchor(node) # rubocop:disable Metrics/MethodLength
         case node.type
@@ -189,13 +250,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>)
@@ -208,9 +269,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)
@@ -220,7 +287,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
@@ -238,6 +310,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 = []
@@ -300,7 +379,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?
 
@@ -316,7 +397,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
 

data/lib/asciidoctor_fb2/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module FB2
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-fb2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Marat Radchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2020-11-25 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