asciibook 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f64973fae33051b769fb21e19142a7ef45498256
-  data.tar.gz: d6be9d277506c26178ccfe10a49cfc906c0da131
+SHA256:
+  metadata.gz: f5860141a3903d0f2939ec985c5b81bbdd5b3cf14771e65daa16136c1c02bb9f
+  data.tar.gz: a89d6248fd14e1088037e5a15e7174f5a43ba8508b6168e4a3b2addf63e4b3e9
 SHA512:
-  metadata.gz: ed2d02fa7b9f315fc24dd928dcd41b0e81a0dde9f719601504af83c141490beaec7701438b857c74b50e46f24cab9edb24555f509dc3bed10b1f238e269ec5b6
-  data.tar.gz: 3a08b54b7815227719252f7d4b5eead8fdfd4c3024f53892dd2eff0f4b32d4f04a205e38050ea63fbaa1ad2ebbccb08cfcf8c55ee07a2344ac7d196336b80fab
+  metadata.gz: 2ff6a611b748a2cf9e1ee49ea99ed385fd75d10a3db42615a9ee0804d92b642b996ffdc808c497c596723f56bd1965181fabb6d71e8597714c4c093f08c56fe0
+  data.tar.gz: b7f63c4c369a50afbc01c0b6981f13a82f87b15003353f459cc38c79bc1c5d4a47b5216a1cf68f4b9362767a5780eea9b4c25c923fa6b3aadbf6e0f2d859b668

data/README.adoc

@@ -0,0 +1,122 @@
+= Asciibook
+:toc:
+
+Asciibook is an Ebook generator for converting AsciiDoc to HTML, PDF, EPUB and MOBI.
+
+== Installation
+
+If you are familiar with Ruby, you can use <<manual-installation>>.
+
+If your are familiar with Docker, you can use <<docker-installation>>.
+
+[[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:
+
+[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:
+
+[source, console]
+----
+$ ascibook build mybook.adoc
+----
+
+Generated books will put in `build` directory.
+
+Or generate only partial format:
+
+[source, console]
+----
+$ asciibook build mybook.adoc --format html
+$ asciibook build mybook.adoc --format pdf,mobi
+----
+
+If you don't want to enter the parameters repeatedly, you can create a configuration file for the document:
+
+[source, console]
+----
+$ asciibook init mybook.adoc
+----
+
+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:
+
+[source, console]
+----
+$ asciibook build
+----
+
+Use this command to create a empty AsciiDoc and config file:
+
+[source, console]
+----
+$ asciibook new mybook
+----
+
+== Development
+
+Clone this repo:
+
+[source, console]
+----
+$ git clone https://github.com/asciibook/asciibook.git
+$ cd asciibook
+----
+
+Star dev environment with docker:
+
+[source, console]
+----
+$ docker-compose run console
+----
+
+Run test:
+
+[source, console]
+----
+/asciibook # rake test
+----
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/asciibook/asciibook.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/book_template/asciibook.yml

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

data/book_template/book.adoc

@@ -0,0 +1,3 @@
+= My Book
+
+Write from here...

data/exe/asciibook

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path '../../lib', __FILE__
+
+require "asciibook/command"
+
+Asciibook::Command.execute(ARGV)

data/lib/asciibook.rb

@@ -1,5 +1,23 @@
+require "asciidoctor"
+require "rexml/document"
+require "nokogiri"
+require "fileutils"
+require "liquid"
+require "logger"
+require 'yaml'
+require "gepub"
+require "rouge"
+
 require "asciibook/version"
+require "asciibook/asciidoctor_ext/abstract_node"
+require "asciibook/converter"
+require "asciibook/book"
+require "asciibook/page"
+require "asciibook/builders/base_builder"
+require "asciibook/builders/html_builder"
+require "asciibook/builders/pdf_builder"
+require "asciibook/builders/epub_builder"
+require "asciibook/builders/mobi_builder"
 
 module Asciibook
-  # Your code goes here...
 end

data/lib/asciibook/asciidoctor_ext/abstract_node.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+  class AbstractNode
+    attr_accessor :page
+  end
+end

data/lib/asciibook/book.rb

@@ -0,0 +1,153 @@
+module Asciibook
+  class Book
+    attr_reader :data, :options, :doc, :pages, :basename, :base_dir, :dest_dir, :theme_dir, :template_dir
+
+    def initialize(data, options = {})
+      @data = data
+      @options = options
+      @basename = options[:basename] || 'output'
+      @base_dir = options[:base_dir] || '.'
+      @dest_dir = options[:dest_dir] || File.join(@base_dir, 'build')
+      @theme_dir = options[:theme_dir] || File.expand_path('../../../theme', __FILE__)
+      @formats = options[:formats] || %w(html pdf epub mobi)
+      @template_dir = options[:template_dir]
+
+      @page_level = @options[:page_level] || 1
+
+      @logger = @options[:logger] || Logger.new(STDERR, level: :warn)
+
+      @exclude_patterns = ["build/**/*"]
+    end
+
+    def self.load_file(path, options = {})
+      options.merge!(
+        basename: File.basename(path, '.*'),
+        base_dir: File.dirname(path)
+      )
+
+      if File.exist?(path)
+        new(File.open(path, 'r:utf-8').read, options)
+      else
+        raise "File not exists #{path}"
+      end
+    end
+
+    def process
+      @doc = Asciidoctor.load(@data, base_dir: @base_dir, backend: 'asciibook', logger: @logger, safe: :unsafe, template_dirs: [@template_dir].compact)
+      @toc = nil
+      process_pages
+    end
+
+    def title
+      doc.attributes['doctitle']
+    end
+
+    def cover_image_path
+      doc.attributes['cover-image']
+    end
+
+    def toc
+      @toc ||= outline(doc)
+    end
+
+    def outline(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)
+        end
+        data << section_data
+      end
+      data
+    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 to_hash
+      {
+        'title' => doc.attributes['doctitle'],
+        'attributes' => doc.attributes,
+        'toc' => toc
+      }
+    end
+
+    def build
+      if @formats.include?('html')
+        Builders::HtmlBuilder.new(self).build
+      end
+
+      if @formats.include?('pdf')
+        Builders::PdfBuilder.new(self).build
+      end
+
+      if @formats.include?('epub')
+        Builders::EpubBuilder.new(self).build
+      end
+
+      if @formats.include?('mobi')
+        Builders::MobiBuilder.new(self).build
+      end
+    end
+
+    def process_pages
+      @pages = []
+
+      append_page('index.html', doc)
+
+      if @page_level > 0
+        doc.sections.each do |section|
+          process_page(section)
+        end
+      end
+    end
+
+    def process_page(node)
+      append_page("#{node.id}.html", node)
+
+      if node.level < @page_level
+        node.sections.each do |section|
+          process_page(section)
+        end
+      end
+    end
+
+    def append_page(path, node)
+      if @pages.map(&:path).include?(path)
+        @logger.warn("Page path already in use: #{path}")
+      end
+
+      page = Page.new(
+        path: path,
+        node: node
+      )
+
+      if last_page = @pages.last
+        page.prev_page = last_page
+        last_page.next_page = page
+      end
+
+      node.page = page
+      @pages << page
+    end
+
+    def assets
+      Dir.glob('**/*.{jpg,png,gif,mp3,mp4,ogg,wav}', File::FNM_CASEFOLD, base: @base_dir).reject do |path|
+        @exclude_patterns.any? do |pattern|
+          File.fnmatch?(pattern, path)
+        end
+      end
+    end
+  end
+end

data/lib/asciibook/builders/base_builder.rb

@@ -0,0 +1,24 @@
+module Asciibook
+  module Builders
+    class BaseBuilder
+      def initialize(book)
+        @book = book
+        @theme_share_dir = File.join(@book.theme_dir, 'share')
+
+        # reset book doc
+        @book.process
+      end
+
+      def build
+        raise NotImplementedError
+      end
+
+      def copy_file(path, src_dir, dest_dir)
+        src_path = File.join(src_dir, path)
+        dest_path = File.join(dest_dir, path)
+        FileUtils.mkdir_p File.dirname(dest_path)
+        FileUtils.cp src_path, dest_path
+      end
+    end
+  end
+end

data/lib/asciibook/builders/epub_builder.rb

@@ -0,0 +1,84 @@
+module Asciibook
+  module Builders
+    class EpubBuilder < BaseBuilder
+      def initialize(book)
+        super
+        @dest_dir = File.join(@book.dest_dir, 'epub')
+        @theme_dir = File.join(@book.theme_dir, 'epub')
+      end
+
+      def build
+        FileUtils.mkdir_p @dest_dir
+
+        layout = Liquid::Template.parse(File.read(File.join(@theme_dir, 'layout.html')))
+
+        # Satisfy epub specifications
+        @book.pages.each do |page|
+          page.path = page.path.gsub(/.html$/, '.xhtml')
+        end
+
+        epub = GEPUB::Book.new do |book|
+          book.title = @book.title
+          book.identifier = @book.doc.attributes['identifier'] || 'undefined'
+          book.language = @book.doc.attributes['language'] || 'en'
+
+          id_pool = GEPUB::Package::IDPool.new
+
+          @book.assets.each do |path|
+            book.add_item path, content: File.open(File.join(@book.base_dir, path)), id: id_pool.generate_key(prefix: 'asset_')
+          end
+
+          if @book.cover_image_path
+            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|
+            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|
+            book.add_item path, content: File.open(File.join(@theme_dir, path)), id: id_pool.generate_key(prefix: 'theme_asset_')
+          end
+
+          book.ordered do
+            @book.pages.each do |page|
+              html = layout.render(
+                'book' => @book.to_hash,
+                'page' => page.to_hash
+              )
+              book.add_item page.path, content: StringIO.new(html), id: id_pool.generate_key(prefix: 'page_')
+            end
+          end
+
+          book.add_tocdata tocdata
+        end
+
+        epub.generate_epub(File.join(@dest_dir, "#{@book.basename}.epub"))
+
+        # restore page path
+        @book.pages.each do |page|
+          page.path = page.path.gsub(/.xhtml$/, '.html')
+        end
+      end
+
+      def tocdata
+        outline(@book.doc, 1)
+      end
+
+      def outline(node, level)
+        data = []
+        node.sections.each do |section|
+          data << {
+            text: section.xreftext,
+            link: section.page ? section.page.path : "#{@book.find_page_node(section).page.path}##{section.id}",
+            level: level
+          }
+          if section.sections.count > 0 and section.level < (@book.doc.attributes['toclevels'] || 2).to_i
+            data.concat outline(section, level + 1)
+          end
+        end
+        data
+      end
+    end
+  end
+end