persie 0.0.1.alpha1 → 0.0.1.alpha.2

data/lib/persie/builders/mobi.rb

@@ -9,20 +9,22 @@ module Persie
 
     # Builds mobi.
     def build
-      @ui.info '=== Build mobi ' << '=' * 57
+      info '=== Build mobi ' << '=' * 57
 
+      self.before_build
       self.check_dependency
       check_sample
       self.check_epub
       self.generate_mobi
+      self.after_build
 
-      @ui.info END_LINE
+      info END_LINE
     end
 
     def check_dependency
       unless Dependency.kindlegen_installed?
-        @ui.error 'kindlegen not installed, termineted!'
-        @ui.info END_LINE
+        error 'kindlegen not installed, termineted!'
+        info END_LINE
         exit 41
       end
     end
@@ -31,8 +33,8 @@ module Persie
     def check_epub
       unless File.exist? self.epub_path
         sample = sample? ? 'sample ' : nil
-        @ui.error "Please generate #{sample}ePub first"
-        @ui.info END_LINE
+        error "Please generate #{sample}ePub first"
+        info END_LINE
         exit 42
       end
     end
@@ -40,7 +42,7 @@ module Persie
     # Generates mobi file.
     def generate_mobi
       FileUtils.chdir File.dirname(self.epub_path) do
-        @ui.info 'Converting to mobi...'
+        info 'Converting to mobi...'
 
         system "kindlegen -c2 #{self.epub_path(true)}"
 
@@ -49,11 +51,11 @@ module Persie
           prepare_directory(self.mobi_path)
           FileUtils.mv(mobi_file, self.mobi_path)
 
-          @ui.confirm '    mobi file created'
-          @ui.info    "    Location: #{self.mobi_path(true)}"
+          confirm '    mobi file created'
+          info    "    Location: #{self.mobi_path(true)}"
         else
-          @ui.error '    Can not create mobi'
-          @ui.info END_LINE
+          error '    Can not create mobi'
+          info END_LINE
           exit 43
         end
       end

data/lib/persie/builders/multiple_htmls.rb

@@ -0,0 +1,87 @@
+require 'fileutils'
+
+require_relative '../builder'
+require_relative '../chunkable'
+
+module Persie
+  class MultipleHTMLs < Builder
+
+    include Chunkable
+
+    def initialize(book, options = {})
+      super
+      @spine_items = []
+      @spine_item_titles = []
+    end
+
+    # Builds multiple HTML files.
+    def build
+      info '=== Build Mutiple HTML ' << '=' * 49
+
+      self.before_build
+      self.check_sample
+      self.convert_to_single_html
+      self.generate_spine_items
+      self.chunk
+      self.copy_images
+      self.after_build
+
+      info 'Location: builds/html/multiple/'
+      info END_LINE
+
+      nil
+    end
+
+    def copy_images
+      images_dir = File.join @book.builds_dir, 'html', 'multiple', 'images'
+
+      # remove previous images first
+      # QUSTION: is this necessary?
+      FileUtils.rm_r(images_dir) if File.directory?(images_dir)
+
+      info 'Copy images...'
+      FileUtils.cp_r "#{@book.images_dir}/.", images_dir
+      confirm '    Done'
+    end
+
+    private
+
+    def adoc_custom_attributes
+      {
+        'imagesdir' => 'images',
+        'ebook-format' => 'html',
+        'multiple-pages' => true,
+        'outfilesuffix' => '.html'
+      }
+    end
+
+    # Assembles payloads for Liquid to render.
+    def assemble_payloads
+      attrs = @document.attributes
+      custom = {
+        'title' => attrs['doctitle'],
+        'generator' => "persie #{::Persie::VERSION}"
+      }
+
+      attrs.merge(custom)
+    end
+
+    # Renders ERb layouts of `single' or `multiple'.
+    def render_layout_of(format, payloads)
+      unless ['single', 'multipe'].include? format
+        error "ONLY can render layout for `single' or `multiple'"
+        info END_LINE
+        exit 53
+      end
+
+      # Site templates stored in `themes/site/' folder
+      path = File.join @book.themes_dir, 'site', "#{format}.html.liquid"
+
+      return nil unless File.exist? path
+
+      tpl = ::Liquid::Template.parse File.read(path)
+      tpl.render(payloads)
+    end
+
+  end
+end

data/lib/persie/builders/pdf.rb

@@ -11,16 +11,17 @@ module Persie
 
     # Builds PDF.
     def build
-      @ui.info '=== Build PDF ' << '=' * 58
+      info '=== Build PDF ' << '=' * 58
 
+      self.before_build
       self.check_dependency
       self.check_sample
-
       self.convert_to_html
       self.restart_page_number
       self.convert_to_pdf
+      self.after_build
 
-      @ui.info END_LINE
+      info END_LINE
 
       nil
     end
@@ -28,8 +29,8 @@ module Persie
     # Checks dependency.
     def check_dependency
       unless Dependency.prince_installed?
-        @ui.error 'Error: PrinceXML not installed'
-        @ui.info END_LINE
+        error 'Error: PrinceXML not installed'
+        info END_LINE
         exit 22
       end
     end
@@ -54,13 +55,13 @@ module Persie
 
     # Converts AsciiDoc document to HTML, and writes to a file.
     def convert_to_html
-      @ui.info 'Converting to HTML...'
+      info 'Converting to HTML...'
       html = @document.convert
       prepare_directory(self.html_path)
       File.write(self.html_path, html)
-      @ui.confirm '    HTMl file created'
-      @ui.info    "    Location: #{self.html_path(true)}"
-      @ui.info '' # new line
+      confirm '    HTMl file created'
+      info    "    Location: #{self.html_path(true)}"
+      info '' # new line
     end
 
     # Restart PDF page number.
@@ -81,15 +82,15 @@ module Persie
 
     # Converts HTML to PDF with PrinceXML.
     def convert_to_pdf
-      @ui.info 'Converting to PDF...'
+      info 'Converting to PDF...'
       prepare_directory(self.pdf_path)
       system "prince #{self.html_path} -o #{self.pdf_path}"
       if $?.to_i == 0
-        @ui.confirm '    PDF file created'
-        @ui.info    "    Location: #{self.pdf_path(true)}"
+        confirm '    PDF file created'
+        info    "    Location: #{self.pdf_path(true)}"
       else
-        @ui.error '    Error: Cannot create PDF with PrinceXML'
-        @ui.info END_LINE
+        error '    Error: Cannot create PDF with PrinceXML'
+        info END_LINE
         exit 23
       end
     end

data/lib/persie/builders/{site.rb → single_html.rb}

@@ -3,43 +3,33 @@ require 'liquid'
 require_relative '../builder'
 
 module Persie
-  class Site < Builder
+  class SingleHTML < Builder
 
     def initialize(book, options = {})
       super
     end
 
-    # Builds a website.
+    # Builds single HTML file.
     def build
-      @ui.info '=== Build site ' << '=' * 57
+      info '=== Build Single HTML ' << '=' * 50
 
-      if @options.multiple?
-        self.build_multiple
-        return nil
-      end
-
-      self.build_single
+      self.before_build
+      self.check_sample
+      self.generate_html
+      self.after_build
 
-      @ui.info END_LINE
+      info END_LINE
 
       nil
     end
 
-    def build_multiple
-      @ui.warning "Multiple pages\n"
-
-      @ui.warning 'Not Implemented!'
-    end
-
-    # Builds single file website.
-    def build_single
-      @ui.warning "Single page\n"
-
-      html_path = File.join(@book.builds_dir, 'site', 'single' ,'index.html')
+    # Generates single HTML file.
+    def generate_html
+      html_path = File.join(@book.builds_dir, 'html', 'single' ,'index.html')
       prepare_directory(html_path)
 
       html = @document.convert
-      content = render_layout_of('single', assemble_payloads(html))
+      content = render_layout assemble_payloads(html)
 
       if content.nil?
         File.write(html_path, html)
@@ -48,11 +38,11 @@ module Persie
       end
 
       if File.exist? html_path
-        @ui.confirm 'Site created'
-        @ui.info    "Location: site/single/index.html"
+        confirm 'HTML created'
+        info    "Location: builds/html/single/index.html"
       else
-        @ui.error 'Cannot create site'
-        @ui.info END_LINE
+        error 'Cannot create HTML'
+        info END_LINE
         exit 52
       end
     end
@@ -61,8 +51,8 @@ module Persie
 
     def adoc_custom_attributes
       {
-        'ebook-format' => 'site',
-        'single-page' => @options.multiple? ? false : true,
+        'ebook-format' => 'html',
+        'single-page' => true,
         'outfilesuffix' => '.html'
       }
     end
@@ -89,16 +79,9 @@ module Persie
       attrs.merge(custom)
     end
 
-    # Renders ERb layouts of `single' or `multiple'.
-    def render_layout_of(format, payloads)
-      unless ['single', 'multipe'].include? format
-        @ui.error "ONLY can render layout for `single' or `multiple'"
-        @ui.info END_LINE
-        exit 53
-      end
-
-      # Site templates stored in `themes/site/' folder
-      path = File.join @book.themes_dir, 'site', "#{format}.html.liquid"
+    # Renders ERb layouts.
+    def render_layout(payloads)
+      path = File.join @book.themes_dir, 'html', 'single.html.liquid'
 
       return nil unless File.exist? path
 

data/lib/persie/chunkable.rb

@@ -0,0 +1,255 @@
+require 'nokogiri'
+
+module Persie
+  module Chunkable
+
+    # these are not using `include' directive
+    SPECIAL_SPINE_ITEMS = ['cover', 'titlepage', 'nav']
+
+    # Gets/Sets spine items.
+    attr_accessor :spine_items
+
+    # Gets/Sets spine items's titles.
+    attr_accessor :spine_item_titles
+
+    # Converts to single HTML file.
+    def convert_to_single_html
+      info 'Converting to HTML...'
+      format = @document.attr('ebook-format')
+      html = @document.convert
+      prepare_directory self.html_path(format)
+      File.write self.html_path(format), html
+      confirm '    HTMl file created'
+      info    "    Location: #{self.html_path(format, true)}\n"
+    end
+
+    # Generates spine items.
+    def generate_spine_items
+      register_spine_item_processor
+
+      # Re-load the master file
+      doc = ::Asciidoctor.load_file(@book.master_file, adoc_options)
+      @spine_items.concat SPECIAL_SPINE_ITEMS
+      @spine_items.concat doc.references['spine_items']
+
+      # no need cover page and titlepage in HTML format
+      @spine_items.shift(2) if @document.attr('ebook-format') == 'html'
+
+      @spine_items
+    end
+
+    # Chucks single HTML file to multiple HTML files.
+    def chunk
+      info 'Chunking files...'
+
+      format = @document.attr('ebook-format')
+      content = File.read self.html_path(format)
+      root = ::Nokogiri::HTML(content)
+
+      # Adjust spint items
+      @has_cover    = root.css('div[data-type="cover"]').size > 0
+      @has_toc      = root.css('nav[data-type="toc"]').size > 0
+      self.spine_items.delete('cover') unless @has_cover
+      self.spine_items.delete('toc')   unless @has_toc
+
+      correct_nav_href(root)
+
+      top_level_sections = resolve_top_level_sections(root)
+
+      # stupid check, incase of something went wrong
+      unless top_level_sections.count == self.spine_items.count
+        error '    Count of sections DO NOT equal to spine items count.'
+        error '    Terminated!'
+        if @options.debug?
+          info 'sections count: ' + top_level_sections.count
+          info 'spine_items: ' + self.spine_items.inspect
+        end
+        info  '=' * 72
+        exit 31
+      end
+
+      sep = '<body data-type="book">'
+      before = content.split(sep).first
+      after  = %(</body>\n</html>)
+
+      # Collect the first h1 heading first
+      top_level_sections.each_with_index do |node, i|
+        title = if (i == 0 && @has_cover) # cover page don't have title
+          @document.attr('cover-page-title', 'Cover')
+        else
+          node.css('h1:first-of-type').first.inner_text
+        end
+        @spine_item_titles << title
+      end
+
+      top_level_sections.each_with_index do |node, i|
+        # Footnotes
+        footnotes_div = generate_footnotes(node)
+
+        # Write to chunked file
+        ext = @document.attr('outfilesuffix', '.html')
+        to_dir = if format == 'epub'
+          @tmp_dir
+        else
+          File.join @book.builds_dir, 'html', 'multiple'
+        end
+        path = File.join(to_dir, "#{self.spine_items[i]}#{ext}")
+        prepare_directory(path)
+        combined = [before, sep, node.to_xhtml, footnotes_div, after] * "\n"
+
+        # use only when building multiple html files
+        layout = File.join @book.themes_dir, 'html', 'multiple.html.liquid'
+
+        chunked_content = if format == 'epub'
+          combined
+        elsif (format == 'html' && !File.exist?(layout))
+          combined
+        else
+          require 'liquid'
+          tpl = ::Liquid::Template.parse File.read(layout)
+
+          if i == 0
+            prev_url   = nil
+            prev_title = nil
+          else
+            prev_url   = "#{@spine_items[i - 1]}#{ext}"
+            prev_title = @spine_item_titles[i - 1]
+          end
+
+          if (j = i + 1) == @spine_items.count
+            next_url   = nil
+            next_title = nil
+          else
+            next_url   = "#{@spine_items[j]}#{ext}"
+            next_title = @spine_item_titles[j]
+          end
+
+          payloads = assemble_payloads.merge 'page_title' => @spine_item_titles[i],
+                                             'content' => node.to_xhtml,
+                                             'footnotes' => footnotes_div,
+                                             'prev_url' => prev_url,
+                                             'next_url' => next_url,
+                                             'prev_title' => prev_title,
+                                             'next_title' => next_title
+
+          tpl.render(payloads)
+        end
+
+        File.write path, chunked_content
+      end
+
+      confirm "    Done"
+    end
+
+    # Gets XHTML file path.
+    def html_path(format, relative = false)
+      name = sample? ? "#{@book.slug}-sample" : @book.slug
+      path = File.join('tmp', format, "#{name}.html")
+      return path if relative
+
+      File.join(@book.base_dir, path)
+    end
+
+    private
+
+    # Corrects navigation items' href.
+    #
+    # Example:
+    #   href="#id" => href="path.xhtml#id"
+    def correct_nav_href(node)
+      # return early if no table of contents
+      return nil unless (ols = node.css('nav[data-type="toc"]> ol')).size > 0
+
+      spine_items_dup = self.spine_items.dup
+      SPECIAL_SPINE_ITEMS.each { |i| spine_items_dup.delete(i) }
+
+      ext = @document.attr('outfilesuffix', '.html')
+      top_level_lis = ols.first.css('> li')
+      j = 0
+      top_level_lis.each do |li|
+        if li['data-type'] == 'part'
+          first_a = li.css('> a').first
+          first_a_href = first_a['href']
+          first_a['href'] = "#{spine_items_dup[j]}#{ext}#{first_a_href}"
+          if (li_ols = li.css('> ol')).size > 0
+            li_ol = li_ols.first
+            li_ol.css('> li').each do |lli|
+              j += 1
+              lli.css('a').each do |a|
+                old_href = a['href']
+                a['href'] = "#{spine_items_dup[j]}#{ext}#{old_href}"
+              end
+            end
+            j += 1
+          end
+        else
+          li.css('a').each do |a|
+            old_href = a['href']
+            a['href'] = "#{spine_items_dup[j]}#{ext}#{old_href}"
+          end
+          j += 1
+        end
+      end
+    end
+
+    # Resolves top level sections.
+    #
+    # When there are parts, takes sections within each part out.
+    def resolve_top_level_sections(node)
+      if (parts = node.css('body > div[data-type="part"]')).size > 0
+        parts.each do |part|
+          sections = part.css('> section')
+          sections.each do |sect|
+            part.delete sect
+          end
+          part.add_next_sibling(sections)
+        end
+      end
+
+      # return a nodeset, contains all top level sections
+      node.css('body > *')
+    end
+
+    # Generates footnotes for one node.
+    def generate_footnotes(node)
+      footnotes_div = nil
+      footnotes = node.css('span[data-type="footnote"]')
+      if footnotes.length > 0
+        footnotes_div = generate_footnotes_div(footnotes)
+        replace_footnote_with_sup(footnotes)
+      end
+
+      footnotes_div
+    end
+
+    # Generate a footnotes div element.
+    def generate_footnotes_div(footnotes)
+      epub_type = if @document.attr('ebook-format') == 'epub'
+        %( epub:type="footnote")
+      else
+        nil
+      end
+      result = ['<div class="footnotes">']
+      result << '<ol>'
+      footnotes.each_with_index do |fn, i|
+        index = i + 1
+        ref = %( <a href="#fn-ref-#{index}">&#8617;</a>)
+        result << %(<li id="fn-#{index}"#{epub_type}>#{fn.inner_html}#{ref}</li>)
+      end
+      result << '</ol>'
+      result << '</div>'
+
+      result * "\n"
+    end
+
+    def replace_footnote_with_sup(footnotes)
+      footnotes.each_with_index do |fn, i|
+        index = i + 1
+        fn.replace(%(<sup><a id="fn-ref-#{index}" href="#fn-#{index}">#{index}</a></sup>))
+      end
+
+      nil
+    end
+
+  end
+end