RubyGems - kitabu - Versions diffs - 1.0.0.rc1 → 1.0.0.rc2 - Mend

kitabu 1.0.0.rc1 → 1.0.0.rc2

Files changed (74) hide show

data/Gemfile.lock +14 -20
data/README.rdoc +54 -23
data/kitabu.gemspec +1 -1
data/lib/kitabu.rb +11 -4
data/lib/kitabu/cli.rb +49 -6
data/lib/kitabu/dependency.rb +19 -0
data/lib/kitabu/exporter.rb +4 -5
data/lib/kitabu/generator.rb +12 -15
data/lib/kitabu/parser.rb +27 -2
data/lib/kitabu/parser/epub.rb +96 -83
data/lib/kitabu/parser/html.rb +51 -16
data/lib/kitabu/parser/mobi.rb +1 -4
data/lib/kitabu/parser/pdf.rb +23 -20
data/lib/kitabu/parser/txt.rb +1 -5
data/lib/kitabu/syntax.rb +5 -3
data/lib/kitabu/syntax/highlight.rb +22 -0
data/lib/kitabu/toc.rb +4 -78
data/lib/kitabu/toc/epub.rb +41 -0
data/lib/kitabu/toc/html.rb +78 -0
data/lib/kitabu/version.rb +1 -1
data/spec/kitabu/cli/export_spec.rb +2 -2
data/spec/kitabu/cli/new_spec.rb +1 -1
data/spec/kitabu/cli/permalinks_spec.rb +1 -1
data/spec/kitabu/cli/version_spec.rb +1 -1
data/spec/kitabu/extensions/redcloth_spec.rb +6 -6
data/spec/kitabu/extensions/string_spec.rb +1 -1
data/spec/kitabu/parser/epub_spec.rb +5 -1
data/spec/kitabu/parser/html_spec.rb +15 -15
data/spec/kitabu/parser/pdf_spec.rb +4 -4
data/spec/kitabu/syntax_spec.rb +78 -74
data/spec/kitabu/{toc_spec.rb → toc/html_spec.rb} +5 -5
data/spec/spec_helper.rb +3 -1
data/spec/support/mybook/output/mybook.pdf.html +83 -0
data/spec/support/mybook/templates/{cover.erb → epub/cover.erb} +1 -1
data/spec/support/mybook/templates/{epub.erb → epub/page.erb} +1 -1
data/spec/support/mybook/templates/epub/style.css +0 -0
data/spec/support/mybook/templates/html/layout.css +353 -0
data/spec/support/mybook/templates/html/layout.erb +50 -0
data/spec/support/mybook/templates/html/syntax.css +58 -0
data/spec/support/mybook/templates/html/user.css +1 -0
data/spec/support/shared.rb +48 -15
data/templates/cover.erb +1 -1
data/templates/cover.png +0 -0
data/templates/epub.css +1 -0
data/templates/epub.erb +1 -1
data/templates/sample.md +6 -0
data/templates/syntax.css +58 -0
metadata +32 -44
data/spec/support/mybook/templates/epub.css +0 -1
data/spec/support/mybook/templates/layout.css +0 -137
data/spec/support/mybook/templates/layout.erb +0 -46
data/spec/support/mybook/templates/syntax.css +0 -186
data/spec/support/mybook/templates/user.css +0 -1
data/templates/styles/active4d.css +0 -114
data/templates/styles/all_hallows_eve.css +0 -72
data/templates/styles/amy.css +0 -147
data/templates/styles/blackboard.css +0 -88
data/templates/styles/brilliance_black.css +0 -605
data/templates/styles/brilliance_dull.css +0 -599
data/templates/styles/cobalt.css +0 -149
data/templates/styles/dawn.css +0 -121
data/templates/styles/eiffel.css +0 -121
data/templates/styles/espresso_libre.css +0 -109
data/templates/styles/idle.css +0 -62
data/templates/styles/iplastic.css +0 -80
data/templates/styles/lazy.css +0 -73
data/templates/styles/mac_classic.css +0 -123
data/templates/styles/magicwb_amiga.css +0 -104
data/templates/styles/pastels_on_dark.css +0 -188
data/templates/styles/slush_poppies.css +0 -85
data/templates/styles/spacecadet.css +0 -51
data/templates/styles/sunburst.css +0 -180
data/templates/styles/twilight.css +0 -137
data/templates/styles/zenburnesque.css +0 -91

@@ -1,50 +1,23 @@
 module Kitabu
   module Parser
-    class Epub < Html
-      module Toc
-        HEAD = <<-HEAD
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
-  <head>
-    <meta content='application/xhtml+xml; charset=utf-8' http-equiv='Content-Type' />
-    <title>Table of Contents</title>
-  </head>
-  <body>
-    <div id='toc'>
-      <ul>
-HEAD
-TAIL = <<-TAIL
-      </ul>
-    </div>
-  </body>
-</html>
-TAIL
-        def generate_html(nav)
-          HEAD +
-          nav.map { |element|
-            "<li><a href='#{element[:content]}'>#{element[:label]}</a></li>"
-          }.join +
-          TAIL
+    class Epub < Base
+      def sections
+        @sections ||= html.css("div.chapter").each_with_index.map do |chapter, index|
+          OpenStruct.new({
+            :index    => index,
+            :filename => "section_#{index}.html",
+            :filepath => tmp_dir.join("section_#{index}.html").to_s,
+            :html     => Nokogiri::HTML(chapter.inner_html)
+          })
         end
-        def generate_file(*args)
-          filename = "tmp/toc.html"
-          File.open(filename, 'w') { |file| file.write generate_html(*args) }
-          filename
-        end
-        module_function :generate_file, :generate_html
       end
-      attr_accessor :epub
+      def epub
+        @epub ||= EeePub::Maker.new
+      end
-      def initialize(*args)
-        super
-        FileUtils.mkdir_p('tmp')
-        @epub = EeePub::Maker.new
+      def html
+        @html ||= Nokogiri::HTML(html_path.read)
       end
       def parse
@@ -57,75 +30,115 @@ TAIL
         epub.identifier   config[:identifier][:id], :scheme => config[:identifier][:type]
         epub.cover_page   cover_image
-        assets            = collect_assets
-        sections          = collect_sections
-        filenames         = collect_filenames(sections)
+        write_sections!
+        write_toc!
-        epub.files        filenames + assets
-        epub.nav          collect_nav(sections, filenames)
-        epub.toc_page     Toc.generate_file collect_nav(sections, filenames)
+        epub.files    sections.map(&:filepath) + assets
+        epub.nav      navigation
+        epub.toc_page toc_path
         epub.save(epub_path)
         true
       rescue Exception
         p $!, $@
         false
       end
-      def collect_assets
-        [cover_image, File.join(root_dir, "templates", "epub", "style.css")].compact
+      def write_toc!
+        toc = TOC::Epub.new(navigation)
+        File.open(toc_path, "w") do |file|
+          file << toc.to_html
+        end
       end
-      def cover_image
-        path = root_dir.join('images/cover-epub.jpg')
-        return path if File.exist?(path)
+      def write_sections!
+        # First we need to get all ids, which are used as
+        # the anchor target.
+        #
+        links = sections.inject({}) do |buffer, section|
+          section.html.css("[id]").each do |element|
+            anchor = "##{element["id"]}"
+            buffer[anchor] = "#{section.filename}#{anchor}"
+          end
+          buffer
+        end
+        # Then we can normalize all links and
+        # manipulate other paths.
+        #
+        sections.each do |section|
+          section.html.css("a[href^='#']").each do |link|
+            href = link["href"]
+            link.set_attribute("href", links.fetch(href, href))
+          end
+          # Replace all srcs.
+          #
+          section.html.css("[src]").each do |element|
+            src = File.basename(element["src"]).gsub(/\.svg$/, ".png")
+            element.set_attribute("src", src)
+          end
+          FileUtils.mkdir_p(tmp_dir)
+          # Save file to disk.
+          #
+          File.open(section.filepath, "w") do |file|
+            file << render_chapter(section.html.css("body").inner_html)
+          end
+        end
       end
-      def chapter(entry)
-        files = chapter_files(entry)
-        content = replace_paths(render_chapter(files, true))
-        html = Nokogiri(content)
-        title = html.css("h2").first.text
-        [
-          title,
-          render_template(
-            root_dir.join("templates/epub/page.erb"),
-            {:chapter_title => title, :content => content, :language => config[:language]}
-          )
-        ]
+      def render_chapter(content)
+        locals = config.merge(:content => content)
+        render_template(template_path, locals)
       end
-      def collect_sections
-        entries.map { |entry| chapter(entry) }
+      def assets
+        @assets ||= begin
+          assets = Dir[root_dir.join("templates/epub/*.css")]
+          assets += Dir[root_dir.join("images/**/*.{jpg,png,gif}")]
+          assets << cover_image if cover_image
+          assets
+        end
       end
-      def collect_filenames(sections)
-        index = 0
+      def cover_image
+        path = Dir[root_dir.join("templates/epub/cover.{jpg,png,gif}").to_s].first
+        return path if path && File.exist?(path)
+      end
+      def navigation
         sections.map do |section|
-          index += 1
-          filename = "tmp/section_#{index}.html"
-          File.open(filename, 'w') { |file| file.write section[1] }
-          filename
+          {
+            :label => section.html.css("h2:first-of-type").text,
+            :content => section.filename
+          }
         end
       end
-      def collect_nav(sections, filenames)
-        [sections, filenames].transpose.map do |section, filename|
-          {:label => section[0], :content => File.basename(filename)}
-        end
+      def template_path
+        root_dir.join("templates/epub/page.erb")
       end
-      def replace_paths(text)
-        text.gsub(%r[src="(.*?)"]) {|m| %[src="#{File.basename($1)}"]}
+      def html_path
+        root_dir.join("output/#{name}.html")
       end
       def epub_path
         root_dir.join("output/#{name}.epub")
       end
+      def tmp_dir
+        root_dir.join("output/tmp")
+      end
+      def toc_path
+        tmp_dir.join("toc.html")
+      end
     end
   end
 end

data/lib/kitabu/parser/html.rb CHANGED

@@ -1,6 +1,6 @@
 module Kitabu
   module Parser
-    class Html < Base
+    class HTML < Base
       # Supported Markdown libraries
       #
       MARKDOWN_LIBRARIES = %w[Maruku BlueCloth PEGMarkdown Redcarpet RDiscount]
@@ -17,11 +17,20 @@ module Kitabu
       #
       EXTENSIONS = %w[md mkdn markdown textile html]
+      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 parse
-        File.open(root_dir.join("output/#{name}.html"), "w+") do |file|
+        reset_footnote_index!
+        File.open(root_dir.join("output/#{name}.html"), "w") do |file|
           file << parse_layout(content)
         end
         true
@@ -29,6 +38,10 @@ module Kitabu
         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
@@ -44,12 +57,6 @@ module Kitabu
         end
       end
-      # Return the configuration file.
-      #
-      def config
-        Kitabu.config(root_dir)
-      end
       # Return a list of all recognized files.
       #
       def entries
@@ -96,7 +103,7 @@ module Kitabu
         content = Kitabu::Syntax.render(root_dir, file_format, File.read(file), plain_syntax)
-        case file_format
+        content = case file_format
         when :markdown
           markdown.new(content).to_html
         when :textile
@@ -104,6 +111,40 @@ module Kitabu
         else
           content
         end
+        render_footnotes(content, plain_syntax)
+      end
+      def render_footnotes(content, plain_syntax = false)
+        html = Nokogiri::HTML(content)
+        footnotes = html.css("p[id^='fn']")
+        return content if footnotes.empty?
+        reset_footnote_index! unless self.class.footnote_index
+        footnotes.each do |fn|
+          index = self.class.footnote_index
+          actual_index = fn["id"].gsub(/[^\d]/, "")
+          fn.set_attribute("id", "fn#{index}")
+          html.css("a[href='#fn#{actual_index}']").each do |link|
+            link.set_attribute("href", "#fn#{index}")
+          end
+          html.css("a[href='#fnr#{actual_index}']").each do |link|
+            link.set_attribute("href", "#fnr#{index}")
+          end
+          html.css("[id=fnr#{actual_index}]").each do |tag|
+            tag.set_attribute("id", "fnr#{index}")
+          end
+          self.class.footnote_index += 1
+        end
+        html.css("body").inner_html
       end
       def format(file)
@@ -120,7 +161,7 @@ module Kitabu
       # Parse layout file, making available all configuration entries.
       #
       def parse_layout(html)
-        toc = Toc.generate(html)
+        toc = TOC::HTML.generate(html)
         locals = config.merge({
           :content   => toc.content,
           :toc       => toc.to_html,
@@ -138,12 +179,6 @@ module Kitabu
         nil
       end
-      # Render a eRb template using +locals+ as data seed.
-      #
-      def render_template(file, locals = {})
-        ERB.new(File.read(file)).result OpenStruct.new(locals).instance_eval{ binding }
-      end
       # Render all +files+ from a given chapter.
       #
       def render_chapter(files, plain_syntax = false)

data/lib/kitabu/parser/mobi.rb CHANGED

@@ -2,10 +2,7 @@ module Kitabu
   module Parser
     class Mobi < Base
       def parse
-        command = ["kindlegen", epub_file.to_s,]
-        puts command
-        Process.wait Process.spawn(*command)
+        spawn_command ["kindlegen", epub_file.to_s,]
         true
       end

data/lib/kitabu/parser/pdf.rb CHANGED

@@ -1,32 +1,35 @@
 module Kitabu
   module Parser
-    class Pdf < Base
+    class PDF < Base
       def parse
-        content = File.read(html_file)
-        prince_friendly_footnotes = transform_footnotes(content)
-        transformed_html_file = File.new('output/prince_friendly_footnote_file.html', 'w')
-        transformed_html_file.write prince_friendly_footnotes
+        apply_footnotes!
+        spawn_command ["prince", with_footnotes_file.to_s, "-o", pdf_file.to_s]
+      end
-        command = ["prince", transformed_html_file.path, "-o", pdf_file.to_s]
-        Process.wait Process.spawn(*command)
+      def apply_footnotes!
+        html = Nokogiri::HTML(html_file.read)
-        transformed_html_file.close
-        File.unlink(transformed_html_file)
-        true
-      end
+        # https://github.com/tenderlove/nokogiri/issues/339
+        html.css("html").first.tap do |element|
+          next unless element
+          element.delete("xmlns")
+          element.delete("xml:lang")
+        end
-      def transform_footnotes(content)
-        doc = Nokogiri::HTML(content)
-        doc.css('a').each do |node|
-          prince_friendly_footnote = <<-FN
-            #{node.text}<span class='fn'><a href='#{node['href']}'>#{node['href']}</a></span>
-          FN
+        html.css("p.footnote[id^='fn']").each do |fn|
+          fn.node_name = "span"
+          fn.set_attribute("class", "fn")
-          node.replace(prince_friendly_footnote)
+          html.css("[href='##{fn["id"]}']").each do |link|
+            link.add_next_sibling(fn)
+          end
         end
-        doc.to_xhtml
+        File.open(with_footnotes_file, "w") {|f| f << html.to_xhtml}
+      end
+      def with_footnotes_file
+        root_dir.join("output/#{name}.pdf.html")
       end
       def html_file

data/lib/kitabu/parser/txt.rb CHANGED

@@ -2,11 +2,7 @@ module Kitabu
   module Parser
     class Txt < Base
       def parse
-        command = ["html2text", "-style", "pretty", "-o", txt_file.to_s, html_file.to_s]
-        puts command.join(' ')
-        Process.wait Process.spawn(*command)
-        true
+        spawn_command ["html2text", "-style", "pretty", "-o", txt_file.to_s, html_file.to_s]
       end
       def html_file

data/lib/kitabu/syntax.rb CHANGED

@@ -1,5 +1,7 @@
 module Kitabu
   class Syntax
+    autoload :Highlight, "kitabu/syntax/highlight"
     attr_reader :io
     attr_reader :lines
     attr_reader :root_dir
@@ -65,7 +67,7 @@ module Kitabu
       code = raw.to_s.strip_heredoc
       code = process_file.gsub(/\n^.*?@(begin|end):.*?$/, "") if meta[:file]
-      code = Pygments.highlight(code, :lexer => language)
+      code = Highlight.apply(code, language)
       # escape for textile
       code = %[<notextile>#{code}</notextile>] if format == :textile
@@ -117,8 +119,8 @@ module Kitabu
     #
     def config
       Kitabu.config(root_dir)
-    end
+    end
     # Return the language used for this syntax block. Overrideable
     # for epub generation.
     def language