kitabu 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc4c26926c9593f2b8e97479bafef553a97adad2
-  data.tar.gz: 388956fdff69380c6bc9d5698ab6b37851f92fba
+  metadata.gz: 99b16e5ab09105d5dbb28f37ce455d787a62fdee
+  data.tar.gz: dd1b28e6cd2a2d910073d82464d9b1ac235c0660
 SHA512:
-  metadata.gz: 4f4bbbd287feb60d0c0a0ced3f1bf1a1d9945d51b217f137b2e65cb3c356a9a56117ed077a6e836a4b4af83f262bad8a0fcd712820d3770bd14d78ac0e8f6e1a
-  data.tar.gz: 34d1ae48a3b6071e9b63595c37724816e445ba22896d013d204fe3f7caae2f1936dfdbdf841410c0ff257d5a6d06740dd817944fb3e8676ffe8b8e54b820d078
+  metadata.gz: c06222c9fd8e790581de00cbc1020a1bb9db90df276a59936cbba614cc0eb6f54c289114eff26289aa9dce89d695861de2abab4e265fdef12f22fc49de14e1f2
+  data.tar.gz: d6e3629e8c61d471788a95455af7f54e92e231e29b74087fa63a4498a1c6846a85371e0471452f713700cf1ad261652ac8d7ab356688c0e8eda928f2f875f1d5

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## Unreleased
+## v2.0.0
 
 - Remove support for different markdown processors; now using Redcarpet.
 - Remove support for other file types like textile and html.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kitabu (2.0.0)
+    kitabu (2.0.1)
       activesupport
       eeepub-with-cover-support
       i18n

data/README.md

@@ -4,7 +4,9 @@
 [![Code Climate](https://codeclimate.com/github/fnando/kitabu/badges/gpa.svg)](https://codeclimate.com/github/fnando/kitabu)
 [![Test Coverage](https://codeclimate.com/github/fnando/kitabu/badges/coverage.svg)](https://codeclimate.com/github/fnando/kitabu)
 
-While Prince is too expensive (495USD for a single user license), the free version available at <http://www.princexml.com/download> generates a PDF with a small logo on the first page, which is removed when sent to a printer.
+Kitabu is a framework for creating e-books from Markdown using Ruby. Using Prince PDF generator, you'll be able to get high quality PDFs. Also supports EPUB, Mobi, Text and HTML generation.
+
+While Prince is too expensive (495USD for a single user license), the free version available at <http://www.princexml.com/download> generates a PDF with a small logo on the first page, which is removed when sent to a printer; you can use it locally for viewing the results immediately. When you're done writing your e-book, you can use [DocRaptor](http://docraptor.com), which have plans starting at $15/mo.
 
 ## Features
 
@@ -16,8 +18,8 @@ While Prince is too expensive (495USD for a single user license), the free versi
 
 ## Installation
 
-To install Kitabu, you’ll need a working Ruby 1.9+ installation.
-If you’re cool with it, just run the following command to install it.
+To install Kitabu, you'll need a working Ruby 2.0+ installation.
+If you're cool with it, just run the following command to install it.
 
     gem install kitabu
 
@@ -119,13 +121,13 @@ You'll want to see your progress eventually; it's time for you to generate the b
 
 Kitabu can generate a Table of Contents (TOC) based on your h2-h6 tags. The h1 tag is discarded because it's meant to be the book title.
 
-To print the TOC, you need to print a variable called +toc+, using the eRb tag.
+To print the TOC, you need to print a variable called `toc`, using the eRb tag.
 
     <%= toc %>
 
 #### Using ERB
 
-You can also have .erb files. You can mix Markdown and HTML, like the following:
+You can also have `.erb` files. You can mix Markdown and HTML, like the following:
 
     ## This the chapter title
 

data/lib/kitabu.rb

@@ -15,6 +15,7 @@ require "thor/group"
 require "yaml"
 require "cgi"
 require "erb"
+require "open3"
 
 require "redcarpet"
 require "rouge"
@@ -39,8 +40,18 @@ module Kitabu
   require "kitabu/toc"
   require "kitabu/cli"
   require "kitabu/markdown"
-  require "kitabu/parser"
+  require "kitabu/source_list"
   require "kitabu/exporter"
+  require "kitabu/exporter/base"
+  require "kitabu/exporter/html"
+  require "kitabu/exporter/epub"
+  require "kitabu/exporter/mobi"
+  require "kitabu/exporter/pdf"
+  require "kitabu/exporter/txt"
+  require "kitabu/exporter/css"
+  require "kitabu/footnotes/base"
+  require "kitabu/footnotes/html"
+  require "kitabu/footnotes/pdf"
   require "kitabu/stream"
   require "kitabu/dependency"
   require "kitabu/stats"

data/lib/kitabu/cli.rb

@@ -80,7 +80,7 @@ module Kitabu
     def permalinks
       inside_ebook!
 
-      html = Kitabu::Parser::HTML.new(root_dir).content
+      html = Kitabu::Exporter::HTML.new(root_dir).content
       toc = Kitabu::TOC::HTML.generate(html)
 
       toc.toc.each do |options|

data/lib/kitabu/exporter.rb

@@ -29,11 +29,11 @@ module Kitabu
       export_txt = [nil, "txt"].include?(options[:only])
 
       exported = []
-      exported << Parser::HTML.parse(root_dir)
-      exported << Parser::PDF.parse(root_dir) if export_pdf && Dependency.prince?
-      exported << Parser::Epub.parse(root_dir) if export_epub
-      exported << Parser::Mobi.parse(root_dir) if export_mobi && Dependency.kindlegen?
-      exported << Parser::Txt.parse(root_dir) if export_txt && Dependency.html2text?
+      exported << HTML.export(root_dir)
+      exported << PDF.export(root_dir) if export_pdf && Dependency.prince?
+      exported << Epub.export(root_dir) if export_epub
+      exported << Mobi.export(root_dir) if export_mobi && Dependency.kindlegen?
+      exported << Txt.export(root_dir) if export_txt && Dependency.html2text?
 
       if exported.all?
         color = :green

data/lib/kitabu/{parser.rb → exporter/base.rb}

@@ -1,13 +1,5 @@
-require 'open3'
-
 module Kitabu
-  module Parser
-    autoload :HTML  , "kitabu/parser/html"
-    autoload :PDF   , "kitabu/parser/pdf"
-    autoload :Epub  , "kitabu/parser/epub"
-    autoload :Mobi  , "kitabu/parser/mobi"
-    autoload :Txt   , "kitabu/parser/txt"
-
+  class Exporter
     class Base
       # The e-book directory.
       #
@@ -17,8 +9,8 @@ module Kitabu
       #
       attr_accessor :source
 
-      def self.parse(root_dir)
-        new(root_dir).parse
+      def self.export(root_dir)
+        new(root_dir).export
       end
 
       def initialize(root_dir)
@@ -26,6 +18,12 @@ module Kitabu
         @source = root_dir.join("text")
       end
 
+      #
+      #
+      def source_list
+        @source_list ||= SourceList.new(root_dir)
+      end
+
       # Return directory's basename.
       #
       def name

data/lib/kitabu/exporter/css.rb

@@ -0,0 +1,24 @@
+module Kitabu
+  class Exporter
+    class CSS < Base
+      attr_reader :root_dir
+
+      def export
+        files = Dir[root_dir.join("templates/styles/*.{scss,sass}").to_s]
+        options = {
+          style: :expanded,
+          line_numbers: true,
+          load_paths: [root_dir.join("templates/styles")]
+        }
+
+        files.each do |file|
+          _, file_name, syntax = *File.basename(file).match(/(.*?)\.(.*?)$/)
+          engine = Sass::Engine.new(File.read(file), options.merge(syntax: syntax.to_sym))
+          target = root_dir.join("output/styles", "#{file_name}.css")
+          FileUtils.mkdir_p(File.dirname(target))
+          File.open(target, "w") {|io| io << engine.render }
+        end
+      end
+    end
+  end
+end

data/lib/kitabu/{parser → exporter}/epub.rb

@@ -1,5 +1,5 @@
 module Kitabu
-  module Parser
+  class Exporter
     class Epub < Base
       def sections
         @sections ||= html.css("div.chapter").each_with_index.map do |chapter, index|
@@ -20,7 +20,7 @@ module Kitabu
         @html ||= Nokogiri::HTML(html_path.read)
       end
 
-      def parse
+      def export
         copy_styles!
         copy_images!
         set_metadata!

data/lib/kitabu/exporter/html.rb

@@ -0,0 +1,109 @@
+module Kitabu
+  class Exporter
+    class HTML < Base
+      class << self
+        # The footnote index control. We have to manipulate footnotes
+        # because each chapter starts from 1, so we have duplicated references.
+        #
+        attr_accessor :footnote_index
+      end
+
+      # Parse all files and save the parsed content
+      # to <tt>output/book_name.html</tt>.
+      #
+      def export
+        copy_images!
+        export_stylesheets!
+
+        File.open(root_dir.join("output/#{name}.html"), "w") do |file|
+          file << parse_layout(content)
+        end
+
+        true
+      rescue Exception => error
+        handle_error(error)
+        false
+      end
+
+      def reset_footnote_index!
+        self.class.footnote_index = 1
+      end
+
+      # Return all chapters wrapped in a <tt>div.chapter</tt> tag.
+      #
+      def content
+        String.new.tap do |content|
+          source_list.each_chapter do |files|
+            content << %[<div class="chapter">#{render_chapter(files)}</div>]
+          end
+        end
+      end
+
+      private
+      # Render +file+ considering its extension.
+      #
+      def render_file(file)
+        if format(file) == :erb
+          content = render_template(file, config)
+        else
+          content = File.read(file)
+        end
+
+        Kitabu::Markdown.render(content)
+      end
+
+      def format(file)
+        if File.extname(file) == '.erb'
+          :erb
+        else
+          :markdown
+        end
+      end
+
+      # Parse layout file, making available all configuration entries.
+      #
+      def parse_layout(html)
+        toc = TOC::HTML.generate(html)
+        content = Footnotes::HTML.process(toc.content).html.css('html').first.inner_html
+
+        locals = config.merge({
+          content: content,
+          toc: toc.to_html,
+          changelog: render_changelog
+        })
+
+        render_template(root_dir.join("templates/html/layout.erb"), locals)
+      end
+
+      # Render changelog file.
+      # This file can be used to inform any book change.
+      #
+      def render_changelog
+        changelog = Dir[root_dir.join("text/CHANGELOG.*")].first
+        render_file(changelog) if changelog
+      end
+
+      # Render all +files+ from a given chapter.
+      #
+      def render_chapter(files)
+        String.new.tap do |chapter|
+          files.each do |file|
+            chapter << render_file(file) << "\n\n"
+          end
+        end
+      end
+
+      # Copy images
+      #
+      def copy_images!
+        copy_directory("images", "output/images")
+      end
+
+      # Export all root stylesheets.
+      #
+      def export_stylesheets!
+        Exporter::CSS.new(root_dir).export
+      end
+    end
+  end
+end

data/lib/kitabu/{parser → exporter}/mobi.rb

@@ -1,7 +1,7 @@
 module Kitabu
-  module Parser
+  class Exporter
     class Mobi < Base
-      def parse
+      def export
         spawn_command ["kindlegen", epub_file.to_s]
         true
       end

data/lib/kitabu/exporter/pdf.rb

@@ -0,0 +1,43 @@
+module Kitabu
+  class Exporter
+    class PDF < Base
+      def export
+        apply_footnotes!
+        spawn_command ["prince", html_for_pdf.to_s, "-o", pdf_file.to_s]
+        spawn_command ["prince", html_for_print.to_s, "-o", print_file.to_s]
+      end
+
+      def apply_footnotes!
+        html = Footnotes::PDF.process(html_file.read).html
+        create_html_file(html_for_print, html, 'print')
+        create_html_file(html_for_pdf, html, 'pdf')
+      end
+
+      def create_html_file(target, html, class_name)
+        html.css("html").first.set_attribute "class", class_name
+        html.css("link[name=stylesheet]").first.set_attribute "href", "styles/#{class_name}.css"
+        File.open(target, "w") {|f| f << html.to_html }
+      end
+
+      def html_for_pdf
+        root_dir.join("output/#{name}.pdf.html")
+      end
+
+      def html_for_print
+        root_dir.join("output/#{name}.print.html")
+      end
+
+      def html_file
+        root_dir.join("output/#{name}.html")
+      end
+
+      def pdf_file
+        root_dir.join("output/#{name}.pdf")
+      end
+
+      def print_file
+        root_dir.join("output/#{name}.print.pdf")
+      end
+    end
+  end
+end

data/lib/kitabu/{parser → exporter}/txt.rb

@@ -1,7 +1,7 @@
 module Kitabu
-  module Parser
+  class Exporter
     class Txt < Base
-      def parse
+      def export
         spawn_command ["html2text", "-style", "pretty", "-nobs", "-o", txt_file.to_s, html_file.to_s]
       end
 

data/lib/kitabu/footnotes/base.rb

@@ -0,0 +1,33 @@
+module Kitabu
+  module Footnotes
+    class Base
+      # Set the content that will be modified.
+      attr_accessor :content
+
+      # Set the Nokogiri html object.
+      attr_accessor :html
+
+      # Set the footnote index.
+      attr_reader :footnote_index
+
+      # Process content, fixing footnotes numbering.
+      # Returns a string representing the new markup.
+      #
+      def self.process(content)
+        footnotes = new(content)
+        footnotes.process
+        footnotes
+      end
+
+      def initialize(content)
+        @content = content
+        @html = Nokogiri::HTML(content)
+        @footnote_index = 1
+      end
+
+      def increment_footnote_index!
+        @footnote_index += 1
+      end
+    end
+  end
+end

data/lib/kitabu/footnotes/html.rb

@@ -0,0 +1,52 @@
+module Kitabu
+  module Footnotes
+    class HTML < Base
+      def process
+        html.css('.chapter').each(&method(:process_chapter))
+      end
+
+      def process_chapter(chapter)
+        footnotes = chapter.css('.footnotes').first
+        return unless footnotes
+        list = footnotes.css('ol').first
+        list.set_attribute 'start', footnote_index
+
+        chapter.css('.footnotes li').each do |footnote|
+          process_footnote(chapter, footnote)
+          increment_footnote_index!
+        end
+      end
+
+      def process_footnote(chapter, footnote)
+        current_index = footnote.get_attribute('id').gsub(/[^\d]/m, '')
+        footnote.set_attribute 'id', "fn#{footnote_index}"
+
+        process_links_to_footnote(chapter, current_index)
+        process_rev_links(chapter, current_index)
+        process_ref_elements(chapter, current_index)
+      end
+
+      def process_links_to_footnote(chapter, current_index)
+        chapter.css("a[href='#fn#{current_index}']").each do |link|
+          link.set_attribute 'href', "#fn#{footnote_index}"
+        end
+      end
+
+      def process_rev_links(chapter, current_index)
+        chapter.css("a[href='#fnref#{current_index}']").each do |link|
+          link.set_attribute 'href', "#fnref#{footnote_index}"
+        end
+      end
+
+      def process_ref_elements(chapter, current_index)
+        chapter.css("sup[id=fnref#{current_index}]").each_with_index do |sup, index|
+          if index.zero?
+            sup.set_attribute 'id', "fnref#{footnote_index}"
+          else
+            sup.remove_attribute 'id'
+          end
+        end
+      end
+    end
+  end
+end