asciibook 0.0.2.beta2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e3a83946ce2d5ad304d60068e12b839012d7d22b78abfd92733825baae843e0
-  data.tar.gz: 262169c65ba8c8acae9de4de8a4dc4113b5eec8265ff1b625b5bc4a898cae55d
+  metadata.gz: e561b902bdbeba9e4d2d4031bcbd0fec7f666e68fe0a2bc58a4ea3a11664411e
+  data.tar.gz: 12c0feb2787ef840f7971f21ba7bb661de43d5aec1b5031a5550b3723728478c
 SHA512:
-  metadata.gz: f1bcc67b55ef8c5945524eac9814fd0c9dd743a35e309d99c7d68296ccc24e0caf7988de0e2a0af1304f4fe42f7977a004d65ff547c879ed32b8e3832f4036ae
-  data.tar.gz: 32ec9e68931f4d409a39e053c716989b4e66b06ca0ae1406c85683fbbee88af346141eb33bf5495cb04c53f3a8a319fc0986aaa88562d8f06da662b79e3295d6
+  metadata.gz: 343136908ff91ccf947ff08abbabb3cae77432266e74929c154dd35089997c6ea6b4427b1ff23fe471cb464aa72322d4a5ea39e62824fa60199b9472f441541a
+  data.tar.gz: ae4077c7403915eac598f120c5ec6fbcca50f70efa719f9f41c7c97d26316c2c03b15b266f01e5f08be7bb740d47ecc72efe36288dff3337bbb5a28caac880cc

data/README.adoc

@@ -5,88 +5,58 @@ Asciibook is an Ebook generator for converting AsciiDoc to HTML, PDF, EPUB and M
 
 == Installation
 
-If you are familiar with Ruby, you can use <<manual-installation>>.
+Asciibook uses docker as distribution tool. Docker helps deal with dependencies, keeps the local environment clean, and works well with CI / CD tools.
 
-If your are familiar with Docker, you can use <<docker-installation>>.
+You can download and install docker in https://www.docker.com/products/docker-desktop .
 
-[[manual-installation]]
-=== Manual installation
-
-Install by rubygems:
-
-[source, console]
-----
-$ gem install asciibook
-----
-
-For PDF generate, download and install wkhtmltopdf in https://wkhtmltopdf.org/downloads.html .
-
-For Mobi generate, download and install kindlegen in https://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211 .
-
-
-[[docker-installation]]
-=== Docker Installation
-
-Pull docker image:
+After installed docker, Pull the docker image:
 
 [source, consle]
 ----
 $ docker pull asciibook/asciibook
 ----
 
-Then use asciibook CLI in this way:
-
-[source, console]
-----
-$ docker run -v $(pwd):/asciibook asciibook/asciibook asciibook build mybook.adoc
-----
-
-Or enter the container environment to avoid repeating lengthy commands:
-
-[source, console]
-----
-$ docker run -v $(pwd):/asciibook asciibook/asciibook bash
-/asciibook $ asciibook build mybook.adoc
-----
-
 == Usage
 
-For a existing AsciiDoc file, run this command to build all format books:
+First, enter container enviroment in your AsciiDoc file diretory:
 
 [source, console]
 ----
-$ ascibook build mybook.adoc
+$ docker run -it -v $(pwd):/asciibook asciibook/asciibook bash
+/asciibook #
 ----
 
-Generated books will put in `build` directory.
+Following command is executed inside the container environment.
 
-Or generate only partial format:
+For a existing AsciiDoc file, run this command to build all formats:
 
 [source, console]
 ----
-$ asciibook build mybook.adoc --format html
-$ asciibook build mybook.adoc --format pdf,mobi
+/asciibook # ascibook build mybook.adoc
 ----
 
-If you don't want to enter the parameters repeatedly, you can create a configuration file for the document:
+Generated results will be placed in the `build` folder.
+
+Or generate partial formats:
 
 [source, console]
 ----
-$ asciibook init mybook.adoc
+/asciibook # asciibook build mybook.adoc --format html
+/asciibook # asciibook build mybook.adoc --format pdf,mobi
 ----
 
-It will create a config file `asciibook.yml` in the same directory, edit config for your need, then use this command to build next time:
+If you don't want to type the parameters repeatedly, you can create a configuration file for the document:
 
 [source, console]
 ----
-$ asciibook build
+/asciibook # asciibook init mybook.adoc
 ----
 
-Use this command to create a empty AsciiDoc and config file:
+It will create a config file named `asciibook.yml` in the same directory, edit config for your need, then use this command to build next time:
 
 [source, console]
 ----
-$ asciibook new mybook
+/asciibook # asciibook build
 ----
 
 == Development

data/book_template/asciibook.yml

@@ -1,5 +1,14 @@
 source: book.adoc
-#formats: ['html', 'pdf', 'epub', 'mobi']
-#theme_dir:
-#template_dir:
-#page_level: 1
+
+# formats:
+#   - html
+#   - pdf
+#   - epub
+#   - mobi
+#
+# theme_dir:
+# template_dir:
+# page_level: 1
+#
+# plugins:
+#   - asciidoctor-diagram

data/lib/asciibook/book.rb

@@ -46,21 +46,24 @@ module Asciibook
       doc.attributes['cover-image']
     end
 
-    def toc
-      @toc ||= outline(doc)
+    def outline
+      outline_node(doc)
     end
 
-    def outline(node)
+    # book outline only list sections that split as page
+    def outline_node(node)
       data = []
       node.sections.each do |section|
-        section_data = {
-          'title' => section.xreftext,
-          'path' => section.page ? section.page.path : "#{find_page_node(section).page.path}##{section.id}"
-        }
-        if section.sections.count > 0 and section.level < (doc.attributes['toclevels'] || 2).to_i
-          section_data['items'] = outline(section)
+        if section.page
+          section_data = {
+            'title' => section.xreftext,
+            'path' => section.page.path
+          }
+          if section.sections.count > 0 and section.level < @page_level
+            section_data['items'] = outline_node(section)
+          end
+          data << section_data
         end
-        data << section_data
       end
       data
     end
@@ -79,7 +82,7 @@ module Asciibook
       {
         'title' => doc.attributes['doctitle'],
         'attributes' => doc.attributes,
-        'toc' => toc
+        'outline' => outline
       }
     end
 
@@ -143,7 +146,7 @@ module Asciibook
     end
 
     def assets
-      Dir.glob('**/*.{jpg,png,gif,mp3,mp4,ogg,wav}', File::FNM_CASEFOLD, base: @base_dir).reject do |path|
+      Dir.glob('**/*.{jpg,png,svg,gif,mp3,mp4,ogg,wav}', File::FNM_CASEFOLD, base: @base_dir).reject do |path|
         @exclude_patterns.any? do |pattern|
           File.fnmatch?(pattern, path)
         end

data/lib/asciibook/builders/epub_builder.rb

@@ -32,11 +32,11 @@ module Asciibook
             book.add_item(@book.cover_image_path, content: File.open(File.join(@book.base_dir, @book.cover_image_path)), id: 'cover_image').cover_image
           end
 
-          Dir.glob('**/*.{jpb,png,gif,svg,css,js}', File::FNM_CASEFOLD, base: @theme_share_dir).each do |path|
+          Dir.glob('**/*.{jpb,png,gif,svg,css,js,eot,ttf,woff,woff2}', File::FNM_CASEFOLD, base: @theme_share_dir).each do |path|
             book.add_item path, content: File.open(File.join(@theme_share_dir, path)), id: id_pool.generate_key(prefix: 'theme_asset_')
           end
 
-          Dir.glob('**/*.{jpb,png,gif,svg,css,js}', File::FNM_CASEFOLD, base: @theme_dir).each do |path|
+          Dir.glob('**/*.{jpb,png,gif,svg,css,js,eot,ttf,woff,woff2}', File::FNM_CASEFOLD, base: @theme_dir).each do |path|
             book.add_item path, content: File.open(File.join(@theme_dir, path)), id: id_pool.generate_key(prefix: 'theme_asset_')
           end
 

data/lib/asciibook/builders/html_builder.rb

@@ -32,11 +32,11 @@ module Asciibook
           copy_file(path, @book.base_dir, @dest_dir)
         end
 
-        Dir.glob('**/*.{jpb,png,gif,svg,css,js}', File::FNM_CASEFOLD, base: @theme_share_dir).each do |path|
+        Dir.glob('**/*.{jpb,png,gif,svg,css,js,eot,ttf,woff,woff2}', File::FNM_CASEFOLD, base: @theme_share_dir).each do |path|
           copy_file(path, @theme_share_dir, @dest_dir)
         end
 
-        Dir.glob('**/*.{jpb,png,gif,svg,css,js}', File::FNM_CASEFOLD, base: @theme_dir).each do |path|
+        Dir.glob('**/*.{jpb,png,gif,svg,css,js,eot,ttf,woff,woff2}', File::FNM_CASEFOLD, base: @theme_dir).each do |path|
           copy_file(path, @theme_dir, @dest_dir)
         end
       end

data/lib/asciibook/builders/pdf_builder.rb

@@ -15,7 +15,7 @@ module Asciibook
         copy_assets
         generate_header_footer
         generate_pdf
-        #clean_workdir
+        clean_workdir
       end
 
       def prepare_workdir
@@ -44,11 +44,11 @@ module Asciibook
           copy_file(path, @book.base_dir, @tmp_dir)
         end
 
-        Dir.glob('**/*.{jpb,png,gif,svg,css,js}', File::FNM_CASEFOLD, base: @theme_share_dir).each do |path|
+        Dir.glob('**/*.{jpb,png,gif,svg,css,js,eot,ttf,woff,woff2}', File::FNM_CASEFOLD, base: @theme_share_dir).each do |path|
           copy_file(path, @theme_share_dir, @tmp_dir)
         end
 
-        Dir.glob('**/*.{jpb,png,gif,svg,css,js}', File::FNM_CASEFOLD, base: @theme_dir).each do |path|
+        Dir.glob('**/*.{jpb,png,gif,svg,css,js,eot,ttf,woff,woff2}', File::FNM_CASEFOLD, base: @theme_dir).each do |path|
           copy_file(path, @theme_dir, @tmp_dir)
         end
       end
@@ -123,6 +123,7 @@ module Asciibook
             command << 'toc' << '--xsl-style-sheet' << 'toc.xsl'
           else
             command << page.path
+            command << '--allow' << File.expand_path(@tmp_dir)
           end
         end
         filename = "#{@book.basename}.pdf"

data/lib/asciibook/command.rb

@@ -38,10 +38,19 @@ module Asciibook
             File.open(File.join(dir, 'asciibook.yml'), 'w') do |file|
               file.write <<~EOF
                 source: #{filename}
-                #formats: ['html', 'pdf', 'epub', 'mobi']
-                #theme_dir:
-                #template_dir:
-                #page_level: 1
+
+                # formats:
+                #   - html
+                #   - pdf
+                #   - epub
+                #   - mobi
+                #
+                # theme_dir:
+                # template_dir:
+                # page_level: 1
+                #
+                # plugins:
+                #   - asciidoctor-diagram
               EOF
             end
           else
@@ -58,6 +67,7 @@ module Asciibook
         c.option :template_dir, '--template-dir DIR', 'Template dir.'
         c.option :dest_dir, '--dest-dir DIR', 'Destination dir.'
         c.option :page_level, '--page-level NUM', Integer, 'Page split base on section level, default is 1.'
+        c.option :plugins, '--plugin PLUGIN1[,PLUGIN2[,PLUGIN3...]]', Array, 'Require ruby gem or ruby script plugin.'
         c.action do |args, options|
           source = args[0] || '.'
           if File.directory?(source)
@@ -66,8 +76,10 @@ module Asciibook
               hash
             end
             options = config_options.merge(options)
+            load_plugins(options[:plugins])
             Asciibook::Book.load_file(options.delete(:source), options).build
           elsif File.file?(source)
+            load_plugins(options[:plugins])
             Asciibook::Book.load_file(source, options).build
           else
             abort "Build target '#{source}' neither a folder nor a file"
@@ -81,5 +93,13 @@ module Asciibook
 
       p.go(argv)
     end
+
+    def self.load_plugins(plugins)
+      if plugins
+        plugins.each do |plugin|
+          require plugin
+        end
+      end
+    end
   end
 end

data/lib/asciibook/converter.rb

@@ -127,9 +127,15 @@ module Asciibook
     end
 
     def block_to_hash(node)
-      abstract_block_to_hash(node).merge!({
+      data = abstract_block_to_hash(node).merge!({
         'blockname' => node.blockname
       })
+
+      if node.node_name == 'image'
+        data['target'] = node.image_uri(node.attributes['target'])
+      end
+
+      data
     end
 
     def list_to_hash(node)
@@ -235,6 +241,8 @@ module Asciibook
         end
 
         data['id'] = id
+      when 'inline_image'
+        data['target'] = node.image_uri(node.target)
       end
 
       data

data/lib/asciibook/page.rb

@@ -14,7 +14,41 @@ module Asciibook
     end
 
     def content
-      node.convert
+      @content ||= node.convert
+    end
+
+    def doc
+      @doc ||= Nokogiri::HTML.fragment(content)
+    end
+
+    def image_url
+      doc.css('img').first&.attr('src')
+    end
+
+    def description
+      doc.css('p').first&.text
+    end
+
+    def outline
+      outline_node(@node)
+    end
+
+    # page outline only list sections that not split as page
+    def outline_node(node)
+      data = []
+      node.sections.each do |section|
+        if !section.page
+          section_data = {
+            'title' => section.xreftext,
+            'path' => "##{section.id}"
+          }
+          if section.sections.count > 0
+            section_data['items'] = outline_node(section)
+          end
+          data << section_data
+        end
+      end
+      data
     end
 
     def to_hash
@@ -22,6 +56,9 @@ module Asciibook
         'path' => path,
         'title' => title,
         'content' => content,
+        'image_url' => image_url,
+        'description' => description,
+        'outline' => outline,
         'prev_page' => prev_page && { 'path' => prev_page.path, 'title' => prev_page.title },
         'next_page' => next_page && { 'path' => next_page.path, 'title' => next_page.title }
       }

data/lib/asciibook/version.rb

@@ -1,3 +1,3 @@
 module Asciibook
-  VERSION = "0.0.2.beta2"
+  VERSION = "0.0.5"
 end

data/lib/asciibook.rb

@@ -1,4 +1,5 @@
 require "asciidoctor"
+require "asciidoctor-mathematical"
 require "rexml/document"
 require "nokogiri"
 require "fileutils"

data/templates/admonition.html

@@ -1,4 +1,9 @@
 <div class="admonition admonition-{{ node.attributes.name }}" {% if node.id %}id="{{ node.id }}"{% endif %}>
-  {% if node.title %}<h5>{{ node.title }}</h5>{% endif %}
-  {{ node.content }}
+  <div class="admonition-icon">
+    <b>{{ node.attributes.name | upcase }}</b>
+  </div>
+  <div class="admonition-content">
+    {% if node.title %}<h5>{{ node.title }}</h5>{% endif %}
+    {{ node.content }}
+  </div>
 </div>

data/templates/image.html

@@ -1,6 +1,6 @@
 <figure class="image" {% if node.id %}id="{{ node.id }}"{% endif %}>
   {% if node.attributes.link %}<a href="{{ node.attributes.link }}">{% endif %}
-    <img src="{{ node.attributes.target }}"
+    <img src="{{ node.target }}"
          {% if node.attributes.alt %}alt="{{ node.attributes.alt }}"{% endif %}
          {% if node.attributes.width %}width="{{ node.attributes.width }}"{% endif %}
          {% if node.attributes.height %}height="{{ node.attributes.height }}"{% endif %} />

data/templates/inline_break.html

@@ -0,0 +1 @@
+{{ node.text }}<br/>

data/templates/inline_callout.html

@@ -1 +1 @@
-<a class="callout" id="callout-{{ node.id }}" href="#colist-{{ node.id }}">{{ node.text }}</a>
+<a class="callout" id="callout-{{ node.id }}" href="#colist-{{ node.id }}">{{ node.text }}</a>

data/templates/inline_image.html

@@ -1,3 +1,5 @@
 <img src="{{ node.target }}"
      {% if node.attributes.alt %}alt="{{ node.attributes.alt }}"{% endif %}
-     {% if node.attributes.title %}title="{{ node.attributes.title }}"{% endif %} />
+     {% if node.attributes.title %}title="{{ node.attributes.title }}"{% endif %}
+     {% if node.attributes.width %}width="{{ node.attributes.width }}"{% endif %}
+     {% if node.attributes.height %}height="{{ node.attributes.height }}"{% endif %} />