asciidoctor-fb2 0.1.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d4c3a2aa4774098306334ce565317f632d1a18915560dd25df96ce059fa24d
-  data.tar.gz: fe4bc5213b9009120a250db9ef89db70c5c312a09f57ee3b74bf11f68a4ed180
+  metadata.gz: 10a3aff0401e84e1ad7ef6e5beb2cd823dacb368ccd5171326597eb72fadb355
+  data.tar.gz: 0120b9bf29fbde68b6bdea2245bc903a27404da357f419116b07ba41c35e7742
 SHA512:
-  metadata.gz: 2d9cc6fa6b74be5c852752a2836d0a1607a0d3baeefbeb4047565e2a2b4b68cc7098250a6ad359c58456d55fbf025bcad4c6e0da5f1ad7eb8ba28fccaceebb92
-  data.tar.gz: d1ba09be9557da949cccef970a09efdd4a78003b8e3f1d726293da17d69d08435f31f9eeab9e96650cb0c37f962f11d4eea20b05e7f0fb787b2a8b10feac460e
+  metadata.gz: 8e1d26f435621c97a0b0a62d2de350ad39fa6d4acac36bf6b5d15d330e881bd7dfd5bcf55cbeea8c4e76ac0cf996583ecf27931012427ee4e34b30f7a8f49d2b
+  data.tar.gz: fbd79588f67f4295829c4b0012d5178dd292167c14be8d5294fe9fe514fa20073b2afd2fea6d2db8db99a58964fc59c1e9b7a505ebe7871b153dbb97d4ec10c0

data/CHANGELOG.adoc

@@ -7,6 +7,37 @@
 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.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]
+* update fb2rb to 0.3.0
+* add support for nested lists. https://github.com/slonopotamus/asciidoctor-fb2/issues/2[#2]
+* output uncompressed book if filename doesn't end with `.zip`
+* add support for `menu` inline macro. https://github.com/slonopotamus/asciidoctor-fb2/issues/12[#12]
+
 == 0.1.0 (2020-07-24) - @slonopotamus
 
-* Initial release
+* initial release

data/README.adoc

@@ -14,24 +14,39 @@ image:{uri-project}/workflows/CI/badge.svg?branch=master[Build Status,link={uri-
 
 == Installation
 
+{project-name} is published on RubyGems.org.
+You can install the published gem using the following command:
+
 [source,shell script]
 ----
-$ gem install asciidoctor-fb2 --pre
+$ gem install asciidoctor-fb2
 ----
 
-== Usage
+Assuming all the required gems install properly, verify you can run the `{project-handle}` script:
 
 [source,shell script]
 ----
-asciidoctor-fb2 /path/to/book.adoc
+$ asciidoctor-fb2 -v
 ----
 
-== Development
+If you see the version of {project-name} printed, you're ready to use {project-name}.
 
-After checking out the repo, run `bundle install` to install dependencies.
-Then, run `bundle exec rake spec` to run the tests.
+== Usage
+
+Converting an AsciiDoc document to FB2 is as simple as passing your document to the `{project-handle}` command.
+This command should be available on your PATH if you installed the `{project-handle}` gem.
+Otherwise, you can find the command in the [path]_bin_ folder of the project.
+We also recommend specifying an output directory using the `-D` option flag.
+
+[source,shell script]
+----
+$ asciidoctor-fb2 -D output path/to/book.adoc
+----
+
+When the script completes, you'll see the file [file]_book.fb2.zip_ appear in the [path]_output_ directory.
+Open that file with an FB2 reader to view the result.
 
-=== FB2-related AsciiDoc Attributes
+== FB2-related AsciiDoc Attributes
 
 The metadata in the generated FB2 file is populated from attributes in the AsciiDoc document.
 The names of the attributes and the metadata elements to which they map are documented in this section.
@@ -48,10 +63,18 @@ The names of the attributes and the metadata elements to which they map are docu
 |Populates the content language in FB2 metadata.
 
 |keywords
-|Populates keywords list in FB2 metadata
+|Populates keywords list in FB2 metadata.
 The keywords should be represented as comma-separated values (CSV).
 
 |genres
-|Populates genres list in FB2 metadata
+|Populates genres list in FB2 metadata.
 The genres should be represented as comma-separated values (CSV).
+
+|front-cover-image
+|Specifies path to front cover image.
 |===
+
+== Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests.

data/asciidoctor-fb2.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'asciidoctor', '~> 2.0'
-  s.add_runtime_dependency 'fb2rb', '~> 0.2.0'
+  s.add_runtime_dependency 'fb2rb', '~> 0.4.0'
 
   s.add_development_dependency 'asciidoctor-diagram', '~> 2.0'
   s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rspec', '~> 3.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.88.0'
-  s.add_development_dependency 'rubocop-rspec', '~> 1.42.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'
 end

data/data/fb2.css

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

data/lib/asciidoctor_fb2.rb

@@ -6,6 +6,8 @@ require 'fb2rb'
 
 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
@@ -23,8 +25,10 @@ module Asciidoctor
       end
 
       # @param node [Asciidoctor::Document]
-      def convert_document(node) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      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
 
@@ -57,6 +61,12 @@ module Asciidoctor
         fb2date = FB2rb::FB2Date.new(date, Date.parse(date))
         title_info.date = document_info.date = fb2date
 
+        unless (cover_image = node.attr('front-cover-image')).nil?
+          cover_image_path = node.image_uri(cover_image)
+          register_binary(node, cover_image_path)
+          title_info.coverpage = FB2rb::Coverpage.new([%(##{cover_image_path})])
+        end
+
         document_info.id = node.attr('uuid', '')
         document_info.version = node.attr('revnumber')
         document_info.program_used = %(Asciidoctor FB2 #{VERSION} using Asciidoctor #{node.attr('asciidoctor-version')})
@@ -113,8 +123,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>)
@@ -141,6 +190,35 @@ module Asciidoctor
         %(#{open}#{node.text}#{close})
       end
 
+      # @param node [Asciidoctor::Inline]
+      def convert_inline_menu(node)
+        caret = '&#160;<strong>&#8250;</strong> '
+        menu = node.attr('menu')
+        menuitem = node.attr('menuitem')
+        submenus = node.attr('submenus') * %(</b>#{caret}<b>)
+
+        result = %(<strong>#{menu}</strong>)
+        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
@@ -169,13 +247,13 @@ module Asciidoctor
 
       # @param node [Asciidoctor::Inline]
       def convert_inline_image(node)
-        image_attrs = resolve_image_attrs(node, node.target)
+        image_attrs = register_binary(node, node.image_uri(node.target))
         %(<image #{image_attrs * ' '}/>)
       end
 
       # @param node [Asciidoctor::Block]
       def convert_image(node)
-        image_attrs = resolve_image_attrs(node, node.attr('target'))
+        image_attrs = register_binary(node, node.image_uri(node.attr('target')))
         image_attrs << %(title="#{node.captioned_title}") if node.title?
         image_attrs << %(id="#{node.id}") if node.id
         %(<p><image #{image_attrs * ' '}/></p>)
@@ -190,8 +268,7 @@ module Asciidoctor
 
       # @param node [Asciidoctor::AbstractNode]
       # @param target [String]
-      def resolve_image_attrs(node, target) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        target = node.image_uri(target)
+      def register_binary(node, target) # 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)
@@ -201,6 +278,10 @@ module Asciidoctor
           end
 
           if File.readable?(fs_path)
+            # Calibre fails to load images if they contain path separators
+            target.sub!('/', '_')
+            target.sub!('\\', '_')
+
             @book.add_binary(target, fs_path)
             target = %(##{target})
           end
@@ -212,30 +293,47 @@ module Asciidoctor
 
       # @param node [Asciidoctor::Block]
       def convert_admonition(node)
-        %(<p><strong>#{node.title || node.caption}:</strong>
+        lines = [%(<p><strong>#{node.title || node.caption}:</strong>
 #{node.content}
-</p>)
+</p>)]
+        lines << '<empty-line/>' unless node.has_role?('last')
+        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 = []
+        @stack ||= []
+
         node.items.each do |item|
-          lines << %(<p>• #{item.text}</p>)
+          @stack << '•'
+          lines << %(<p>#{@stack * ' '} #{item.text}</p>)
           lines << %(<p>#{item.content}</p>) if item.blocks?
+          @stack.pop
         end
-        lines << '<empty-line/>' unless node.has_role?('last')
+
+        lines << '<empty-line/>' unless node.has_role?('last') || !@stack.empty?
         lines * "\n"
       end
 
       # @param node [Asciidoctor::List]
-      def convert_olist(node)
+      def convert_olist(node) # rubocop:disable Metrics/AbcSize
         lines = []
+        @stack ||= []
         node.items.each_with_index do |item, index|
-          lines << %(<p>#{index + 1}. #{item.text}</p>)
+          @stack << %(#{index + 1}.)
+          lines << %(<p>#{@stack * ' '} #{item.text}</p>)
           lines << %(<p>#{item.content}</p>) if item.blocks?
+          @stack.pop
         end
-        lines << '<empty-line/>' unless node.has_role?('last')
+        lines << '<empty-line/>' unless node.has_role?('last') || !@stack.empty?
         lines * "\n"
       end
 
@@ -271,7 +369,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?
 
@@ -287,7 +387,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
 
@@ -319,7 +419,11 @@ module Asciidoctor
 
       # @param output [FB2rb::Book]
       def write(output, target)
-        output.write(target)
+        if target.respond_to?(:end_with?) && target.end_with?('.zip')
+          output.write_compressed(target)
+        else
+          output.write_uncompressed(target)
+        end
       end
     end
   end

data/lib/asciidoctor_fb2/version.rb

@@ -2,6 +2,6 @@
 
 module Asciidoctor
   module FB2
-    VERSION = '0.1.0'
+    VERSION = '0.2.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-fb2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Marat Radchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: asciidoctor-diagram
   requirement: !ruby/object:Gem::Requirement
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 0.93.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: 0.93.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.42.0
+        version: 1.44.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.42.0
+        version: 1.44.0
 description: 
 email:
 - marat@slonopotamus.org
@@ -129,6 +129,7 @@ files:
 - Rakefile
 - asciidoctor-fb2.gemspec
 - bin/asciidoctor-fb2
+- data/fb2.css
 - lib/asciidoctor_fb2.rb
 - lib/asciidoctor_fb2/version.rb
 - tasks/bundler.rake
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Converts AsciiDoc documents to FB2 e-book formats