RubyGems - asciibook - Versions diffs - 0.0.0 → 0.0.1 - Mend

asciibook 0.0.0 → 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (72) hide show

checksums.yaml +5 -5
data/README.adoc +122 -0
data/book_template/asciibook.yml +5 -0
data/book_template/book.adoc +3 -0
data/exe/asciibook +7 -0
data/lib/asciibook.rb +19 -1
data/lib/asciibook/asciidoctor_ext/abstract_node.rb +5 -0
data/lib/asciibook/book.rb +153 -0
data/lib/asciibook/builders/base_builder.rb +24 -0
data/lib/asciibook/builders/epub_builder.rb +84 -0
data/lib/asciibook/builders/html_builder.rb +45 -0
data/lib/asciibook/builders/mobi_builder.rb +21 -0
data/lib/asciibook/builders/pdf_builder.rb +154 -0
data/lib/asciibook/command.rb +85 -0
data/lib/asciibook/converter.rb +303 -0
data/lib/asciibook/page.rb +30 -0
data/lib/asciibook/version.rb +1 -1
data/templates/admonition.html +4 -0
data/templates/audio.html +7 -0
data/templates/colist.html +7 -0
data/templates/dlist.html +12 -0
data/templates/document.html +29 -0
data/templates/embedded.html +20 -0
data/templates/example.html +4 -0
data/templates/footnotes.html +7 -0
data/templates/image.html +11 -0
data/templates/index.html +40 -0
data/templates/inline_anchor.html +12 -0
data/templates/inline_callout.html +1 -0
data/templates/inline_footnote.html +1 -0
data/templates/inline_image.html +3 -0
data/templates/inline_indexterm.html +5 -0
data/templates/inline_quoted.html +24 -0
data/templates/listing.html +4 -0
data/templates/literal.html +1 -0
data/templates/olist.html +8 -0
data/templates/page_break.html +1 -0
data/templates/paragraph.html +1 -0
data/templates/pass.html +1 -0
data/templates/preamble.html +3 -0
data/templates/quote.html +9 -0
data/templates/section.html +4 -0
data/templates/sidebar.html +6 -0
data/templates/stem.html +9 -0
data/templates/table.html +41 -0
data/templates/thematic_break.html +1 -0
data/templates/ulist.html +8 -0
data/templates/verse.html +9 -0
data/templates/video.html +10 -0
data/theme/epub/epub.css +6 -0
data/theme/epub/layout.html +14 -0
data/theme/html/html.css +190 -0
data/theme/html/html.js +29 -0
data/theme/html/layout.html +91 -0
data/theme/mobi/layout.html +13 -0
data/theme/mobi/mobi.css +2 -0
data/theme/pdf/config.yml +6 -0
data/theme/pdf/footer.html +11 -0
data/theme/pdf/header.html +3 -0
data/theme/pdf/layout.html +14 -0
data/theme/pdf/pdf.css +3 -0
data/theme/pdf/toc.xsl +81 -0
data/theme/share/default.css +174 -0
data/theme/share/highlight.css +216 -0
data/theme/share/normalize.css +349 -0
metadata +119 -21
data/.gitignore +0 -9
data/.travis.yml +0 -4
data/Gemfile +0 -4
data/README.md +0 -41
data/Rakefile +0 -10
data/asciibook.gemspec +0 -25

data/lib/asciibook/builders/html_builder.rb ADDED

@@ -0,0 +1,45 @@
+module Asciibook
+  module Builders
+    class HtmlBuilder < BaseBuilder
+      def initialize(book)
+        super
+        @dest_dir = File.join(@book.dest_dir, 'html')
+        @theme_dir = File.join(@book.theme_dir, 'html')
+      end
+      def build
+        FileUtils.mkdir_p @dest_dir
+        FileUtils.rm_r Dir.glob("#{@dest_dir}/*")
+        generate_pages
+        copy_assets
+      end
+      def generate_pages
+        layout = Liquid::Template.parse(File.read(File.join(@theme_dir, 'layout.html')))
+        @book.pages.each do |page|
+          File.open(File.join(@dest_dir, page.path), 'w') do |file|
+            file.write layout.render({
+              'book' => @book.to_hash,
+              'page' => page.to_hash
+            })
+          end
+        end
+      end
+      def copy_assets
+        @book.assets.each do |path|
+          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|
+          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|
+          copy_file(path, @theme_dir, @dest_dir)
+        end
+      end
+    end
+  end
+end

data/lib/asciibook/builders/mobi_builder.rb ADDED

@@ -0,0 +1,21 @@
+module Asciibook
+  module Builders
+    class MobiBuilder < EpubBuilder
+      def initialize(book)
+        super
+        @dest_dir = File.join(@book.dest_dir, 'mobi')
+        @theme_dir = File.join(@book.theme_dir, 'mobi')
+      end
+      def build
+        super
+        epub_file = File.join(@dest_dir, "#{@book.basename}.epub")
+        system 'kindlegen', epub_file
+        FileUtils.rm epub_file
+      end
+    end
+  end
+end

data/lib/asciibook/builders/pdf_builder.rb ADDED

@@ -0,0 +1,154 @@
+module Asciibook
+  module Builders
+    class PdfBuilder < BaseBuilder
+      def initialize(book)
+        super
+        @dest_dir = File.join(@book.dest_dir, 'pdf')
+        @tmp_dir = File.join(@dest_dir, 'tmp')
+        @theme_dir = File.join(@book.theme_dir, 'pdf')
+        @theme_config = YAML.safe_load(File.read(File.join(@theme_dir, 'config.yml')))
+      end
+      def build
+        prepare_workdir
+        generate_pages
+        copy_assets
+        generate_header_footer
+        generate_pdf
+        #clean_workdir
+      end
+      def prepare_workdir
+        FileUtils.mkdir_p @tmp_dir
+        FileUtils.rm_r Dir.glob("#{@tmp_dir}/*")
+      end
+      def clean_workdir
+        FileUtils.rm_r @tmp_dir
+      end
+      def generate_pages
+        layout = Liquid::Template.parse(File.read(File.join(@theme_dir, 'layout.html')))
+        @book.pages.each do |page|
+          File.open(File.join(@tmp_dir, page.path), 'w') do |file|
+            file.write layout.render({
+              'book' => @book.to_hash,
+              'page' => page.to_hash
+            })
+          end
+        end
+      end
+      def copy_assets
+        @book.assets.each do |path|
+          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|
+          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|
+          copy_file(path, @theme_dir, @tmp_dir)
+        end
+      end
+      def generate_header_footer
+        layout = Liquid::Template.parse <<~EOF
+          <!DOCTYPE html>
+          <html>
+            <head>
+              <script>
+                function subst() {
+                    var vars = {};
+                    var query_strings_from_url = document.location.search.substring(1).split('&');
+                    for (var query_string in query_strings_from_url) {
+                        if (query_strings_from_url.hasOwnProperty(query_string)) {
+                            var temp_var = query_strings_from_url[query_string].split('=', 2);
+                            vars[temp_var[0]] = decodeURI(temp_var[1]);
+                        }
+                    }
+                    var css_selector_classes = ['page', 'frompage', 'topage', 'webpage', 'section', 'subsection', 'date', 'isodate', 'time', 'title', 'doctitle', 'sitepage', 'sitepages'];
+                    for (var css_class in css_selector_classes) {
+                        if (css_selector_classes.hasOwnProperty(css_class)) {
+                            var element = document.getElementsByClassName(css_selector_classes[css_class]);
+                            for (var j = 0; j < element.length; ++j) {
+                                element[j].textContent = vars[css_selector_classes[css_class]];
+                            }
+                        }
+                    }
+                }
+              </script>
+              <style>
+                html, body {
+                  margin: 0;
+                  padding: 0;
+                }
+              </style>
+            </head>
+            <body onload="subst()">
+              {{ content }}
+            </body>
+          </html>
+        EOF
+        File.open(File.join(@tmp_dir, 'header.html'), 'w') do |file|
+          file.write layout.render('content' => File.read(File.join(@theme_dir, 'header.html')))
+        end
+        File.open(File.join(@tmp_dir, 'footer.html'), 'w') do |file|
+          file.write layout.render('content' => File.read(File.join(@theme_dir, 'footer.html')))
+        end
+      end
+      def generate_pdf
+        command = ['wkhtmltopdf']
+        command << '--header-html' << File.expand_path('header.html', @tmp_dir)
+        command << '--footer-html' << File.expand_path('footer.html', @tmp_dir)
+        command << '--margin-top' << @theme_config.fetch('margin_top', 10).to_s
+        command << '--margin-left' << @theme_config.fetch('margin_left', 10).to_s
+        command << '--margin-right' << @theme_config.fetch('margin_right', 10).to_s
+        command << '--margin-bottom' << @theme_config.fetch('margin_bottom', 10).to_s
+        command << '--header-spacing' << @theme_config.fetch('header_spacing', 0).to_s
+        command << '--footer-spacing' << @theme_config.fetch('footer_spacing', 0).to_s
+        if @book.cover_image_path
+          prepare_cover
+          command << 'cover' << 'cover.html'
+        end
+        @book.pages.each do |page|
+          if page.node.is_a?(Asciidoctor::Section) && page.node.sectname == 'toc'
+            prepare_toc_xsl(page)
+            command << 'toc' << '--xsl-style-sheet' << 'toc.xsl'
+          else
+            command << page.path
+          end
+        end
+        filename = "#{@book.basename}.pdf"
+        command << filename
+        command << { chdir: @tmp_dir }
+        system(*command)
+        FileUtils.cp File.join(@tmp_dir, filename), @dest_dir
+      end
+      def prepare_cover
+        File.open(File.join(@tmp_dir, 'cover.html'), 'w') do |file|
+          file.write <<~EOF
+            <img src="#{@book.cover_image_path}" />
+          EOF
+        end
+      end
+      def prepare_toc_xsl(page)
+        File.open(File.join(@tmp_dir, 'toc.xsl'), 'w') do |file|
+          file.write Liquid::Template.parse(File.read(File.join(@theme_dir, 'toc.xsl'))).render({
+            'book' => @book.to_hash,
+            'page' => page.to_hash
+          })
+        end
+      end
+    end
+  end
+end

data/lib/asciibook/command.rb ADDED

@@ -0,0 +1,85 @@
+require "asciibook"
+require "mercenary"
+module Asciibook
+  class Command
+    def self.execute(argv)
+      p = Mercenary::Program.new(:asciibook)
+      p.version Asciibook::VERSION
+      p.description 'Asciibook is a ebook generator from Asciidoc to html/pdf/epub/mobi'
+      p.syntax 'asciibook <command> [options]'
+      p.command(:new) do |c|
+        c.description 'Create a new book scaffold in PATH'
+        c.syntax 'new PATH'
+        c.action do |args, options|
+          path = args[0]
+          if path
+            FileUtils.mkdir_p path
+            template_dir = File.expand_path('../../../book_template', __FILE__)
+            files = Dir.glob('*', base: template_dir).map { |file| File.join(template_dir, file) }
+            # TODO: confirm if file exists
+            FileUtils.cp_r files, path
+          else
+            abort "Please specify PATH to create book"
+          end
+        end
+      end
+      p.command(:init) do |c|
+        c.description 'Init a asciibook config for a Asciidoc file'
+        c.syntax 'init FILE'
+        c.action do |args, options|
+          source = args[0]
+          if File.file?(source)
+            dir = File.dirname source
+            filename = File.basename source
+            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
+              EOF
+            end
+          else
+            abort "Please specify the Asciidoc document to build"
+          end
+        end
+      end
+      p.command(:build) do |c|
+        c.description 'Build book'
+        c.syntax 'build [FILE|DIR]'
+        c.option :formats, '--format FORMAT1[,FORMAT2[,FORMAT3...]]', Array, 'Formats you want to build, allow: html,pdf,epub,mobi, default is all.'
+        c.option :theme_dir, '--theme-dir DIR', 'Theme dir.'
+        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.action do |args, options|
+          source = args[0] || '.'
+          if File.directory?(source)
+            config_options = YAML.safe_load(File.read(File.join(source, 'asciibook.yml'))).reduce({}) do |hash, (key, value)|
+              hash[key.to_sym] = %w(source theme_dir template_dir dest_dir).include?(key) ? File.join(source, value) : value
+              hash
+            end
+            options = config_options.merge(options)
+            Asciibook::Book.load_file(options.delete(:source), options).build
+          elsif File.file?(source)
+            Asciibook::Book.load_file(source, options).build
+          else
+            abort "Build target '#{source}' neither a folder nor a file"
+          end
+        end
+      end
+      p.action do |args, _|
+        puts p
+      end
+      p.go(argv)
+    end
+  end
+end

data/lib/asciibook/converter.rb ADDED

@@ -0,0 +1,303 @@
+module Asciibook
+  class Converter < Asciidoctor::Converter::Base
+    register_for "asciibook"
+    DEFAULT_TEMPLATE_PATH = File.expand_path('../../../templates', __FILE__)
+    def initialize(backend, options = {})
+      super
+      init_backend_traits outfilesuffix: '.html', basebackend: 'html'
+      @template_dirs = (options[:template_dirs] || []).unshift(DEFAULT_TEMPLATE_PATH)
+      @templates = {}
+    end
+    def convert(node, transform = node.node_name, options = {})
+      get_template(transform).render 'node' => node_to_hash(node)
+    end
+    private
+    def get_template(name)
+      return @templates[name] if @templates[name]
+      @template_dirs.reverse.each do |template_dir|
+        path = File.join template_dir, "#{name}.html"
+        if File.exist?(path)
+          @templates[name] = Liquid::Template.parse(File.read(path))
+          break
+        end
+      end
+      unless @templates[name]
+        raise "Template not found #{name}"
+      end
+      @templates[name]
+    end
+    def node_to_hash(node)
+      case node
+      when Asciidoctor::Document
+        document_to_hash(node)
+      when Asciidoctor::Section
+        section_to_hash(node)
+      when Asciidoctor::Block
+        block_to_hash(node)
+      when Asciidoctor::List
+        list_to_hash(node)
+      when Asciidoctor::Table
+        table_to_hash(node)
+      when Asciidoctor::Inline
+        inline_to_hash(node)
+      else
+        raise "Uncatched type #{node} #{node.attributes}"
+      end
+    end
+    def abstract_node_to_hash(node)
+      {
+        'context' => node.context.to_s,
+        'node_name' => node.node_name,
+        'id' => node.id,
+        'attributes' => node.attributes
+      }
+    end
+    def abstract_block_to_hash(node)
+      abstract_node_to_hash(node).merge!({
+        'level' => node.level,
+        'title' => node.title,
+        'caption' => node.caption,
+        'captioned_title' => node.captioned_title,
+        'style' => node.style,
+        'content' => node_content(node),
+        'xreftext' => node.xreftext
+      })
+    end
+    def node_content(node)
+      case node
+      when Asciidoctor::Document, Asciidoctor::Section
+        if node.node_name == 'section' && node.sectname == 'toc'
+          outline(node.document)
+        elsif node.node_name == 'section' && node.sectname == 'index'
+          get_template('index').render('indexterms' => node.document.references[:indexterms])
+        else
+          content = node.blocks.select { |b| b.page.nil? }.map {|b| b.convert }.join("\n")
+          if node.page && node.page.footnotes.any?
+            content += get_template('footnotes').render('footnotes' => node.page.footnotes)
+          end
+          content
+        end
+      else
+        case node.node_name
+        when 'listing'
+          if node.style == 'source' && node.document.syntax_highlighter
+            node.document.syntax_highlighter.format node, node.attributes['language'], { css_mode: :class }
+          else
+            "<pre>#{node.content}</pre>"
+          end
+        else
+          node.content
+        end
+      end
+    end
+    def document_to_hash(node)
+      title = node.attributes['doctitle'] && node.doctitle(partition: true)
+      abstract_block_to_hash(node).merge!({
+        'title' => title&.main,
+        'subtitle' => title&.subtitle,
+        'outline' => outline(node),
+        'authors' => node.authors.map { |author| author.to_h.map { |key, value| [key.to_s, value] }.to_h }
+      })
+    end
+    def section_to_hash(node)
+      abstract_block_to_hash(node).merge!({
+        'index' => node.index,
+        'number' => node.number,
+        'sectname' => node.sectname,
+        'special' => node.special,
+        'numbered' => node.numbered,
+        'sectnum' => node.sectnum
+      })
+    end
+    def block_to_hash(node)
+      abstract_block_to_hash(node).merge!({
+        'blockname' => node.blockname
+      })
+    end
+    def list_to_hash(node)
+      case node.context
+      when :dlist
+        abstract_block_to_hash(node).merge!({
+          'items' => node.items.map { |terms, item|
+            {
+              'terms' => terms.map {|term| listitem_to_hash(term) },
+              'description' => listitem_to_hash(item)
+            }
+          }
+        })
+      else
+        abstract_block_to_hash(node).merge!({
+          'items' => node.blocks.map { |item| listitem_to_hash(item) }
+        })
+      end
+    end
+    def listitem_to_hash(node)
+      abstract_block_to_hash(node).merge!({
+        'text' => (node.text? ? node.text : nil)
+      })
+    end
+    def table_to_hash(node)
+      abstract_block_to_hash(node).merge!({
+        'columns' => node.columns,
+        'rows' => {
+          'head' => node.rows.head.map { |row| row.map {|cell| cell_to_hash(cell) } },
+          'body' => node.rows.body.map { |row| row.map {|cell| cell_to_hash(cell) } },
+          'foot' => node.rows.foot.map { |row| row.map {|cell| cell_to_hash(cell) } }
+        }
+      })
+    end
+    def cell_to_hash(node)
+      abstract_node_to_hash(node).merge!({
+        'text' => node.text,
+        'content' => node.content,
+        'style' => node.style,
+        'colspan' => node.colspan,
+        'rowspan' => node.rowspan
+      })
+    end
+    def inline_to_hash(node)
+      data = abstract_node_to_hash(node).merge!({
+        'text' => node.text,
+        'type' => node.type.to_s,
+        'target' => node.target,
+        'xreftext' => node.xreftext
+      })
+      case node.node_name
+      when 'inline_anchor'
+        data['text'] ||= node.document.references[:refs][node.attributes['refid']]&.xreftext || "[#{node.attributes['refid']}]"
+        if (node.type == :xref) && (target_node = node.document.references[:refs][node.attributes['refid']])
+          data['target'] = if target_node.page
+            target_node.page.path
+          else
+            "#{find_page_node(target_node).page&.path}#{node.target}"
+          end
+        end
+      when 'inline_footnote'
+        if page = find_page_node(node).page
+          if index = page.footnotes.find_index { |footnote| footnote['text'] == node.text }
+            footnote = page.footnotes[index]
+            data['id'] = nil
+            data['index'] = footnote['index']
+            data['target'] = "#_footnotedef_#{footnote['index']}"
+          else
+            index = page.footnotes.count + 1
+            page.footnotes.push({
+              'index' => index,
+              'text' => node.text,
+              'refid' => "_footnoteref_#{index}",
+              'id' => "_footnotedef_#{index}"
+            })
+            data['id'] = "_footnoteref_#{index}"
+            data['index'] = index
+            data['target'] = "#_footnotedef_#{index}"
+          end
+        else
+          index = node.attr 'index'
+          data['id'] = (node.type == :xref ? nil : "_footnoteref_#{index}")
+          data['index'] = index
+          data['target'] = "#_footnotedef_#{index}"
+        end
+      when 'inline_indexterm'
+        node.document.references[:indexterms] ||= []
+        node.document.references[:indexcount] ||= 0
+        indexterms = node.document.references[:indexterms]
+        indexcount = node.document.references[:indexcount] += 1
+        id = "_indexterm_#{indexcount}"
+        target = "#{find_page_node(node).page&.path}#_indexterm_#{indexcount}"
+        if node.type == :visible
+          register_term(indexterms, [node.text], target)
+        else
+          register_term(indexterms, node.attributes['terms'], target)
+        end
+        data['id'] = id
+      end
+      data
+    end
+    def register_term(indexterms, terms, target)
+      items = indexterms
+      item = nil
+      terms.each_with_index do |term, index|
+        term_index = items.find_index { |item| item['term'] == term }
+        if term_index
+          item = items[term_index]
+        else
+          item = {
+            'term' => term,
+            'targets' => [],
+            'items' => []
+          }
+          items.push item
+          items.sort_by! { |item| item['term'] }
+        end
+        if index == terms.size - 1
+          # save targe now
+          item['targets'].push target
+        else
+          # go deeper
+          items = item['items']
+        end
+      end
+    end
+    def find_page_node(node)
+      page_node = node
+      until page_node.page or page_node.parent.nil?
+        page_node = page_node.parent
+      end
+      page_node
+    end
+    def outline(node)
+      result = ''
+      if node.sections.any? && node.level < (node.document.attributes['toclevels'] || 2).to_i
+        result << "<ol>"
+        node.sections.each do |section|
+          result << "<li>"
+          target = if section.page
+            "#{section.page.path}"
+          else
+            "#{find_page_node(section).page&.path}##{section.id}"
+          end
+          result << %Q(<a href="#{target}">)
+          result << "#{section.sectnum} " if section.numbered && section.level < (node.document.attributes['sectnumlevels'] || 3).to_i
+          result << section.title
+          result << "</a>"
+          result << outline(section)
+          result << "</li>"
+        end
+        result << "</ol>"
+      end
+      result
+    end
+  end
+end