kitabu 1.0.6 → 2.0.0

data/lib/kitabu/parser/mobi.rb

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

data/lib/kitabu/parser/pdf.rb

@@ -3,11 +3,13 @@ module Kitabu
     class PDF < Base
       def parse
         apply_footnotes!
-        spawn_command ["prince", with_footnotes_file.to_s, "-o", pdf_file.to_s]
+        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 = Nokogiri::HTML(html_file.read)
+        footnote_count = 1
 
         # https://github.com/sparklemotion/nokogiri/issues/339
         html.css("html").first.tap do |element|
@@ -16,22 +18,60 @@ module Kitabu
           element.delete("xml:lang")
         end
 
-        html.css("p.footnote[id^='_fn']").each do |fn|
-          fn.node_name = "span"
-          fn.set_attribute("class", "fn")
+        chapters = html.css(".chapter")
 
-          html.css("[href='##{fn["id"]}']").each do |link|
-            link.add_next_sibling(fn)
+        chapters.each do |chapter|
+          footnotes = chapter.css(".footnotes li")
+
+          footnotes.each do |fn|
+            # Get current footnote number
+            footnote_number = footnote_count
+            footnote_count += 1
+
+            # Remove rev links
+            fn.css('[rev=footnote]').map(&:remove)
+
+            # Create an element for storing the footnote description
+            fn_desc = Nokogiri::XML::Node.new('span', Nokogiri::HTML::DocumentFragment.parse(''))
+            fn_desc.set_attribute 'class', 'fn-desc'
+            fn_desc.inner_html = fn.css('p').map(&:inner_html).join("\n")
+
+            # Find ref based on footnote's id
+            fn_id = fn.get_attribute('id')
+            ref = chapter.css("a[href='##{fn_id}']").first
+
+            # Go up to parent and reformat it.
+            sup = ref.parent
+            sup.delete("id")
+            sup.set_attribute 'class', 'fn-ref'
+            sup.inner_html = ''
+
+            # Finally, add the description after the <sup> tag.
+            sup.after(fn_desc)
           end
+
+          # Remove the footnotes element
+          chapter.css('.footnotes').map(&:remove)
         end
 
-        File.open(with_footnotes_file, "w") {|f| f << html.to_xhtml}
+        create_html_file(html_for_print, html, 'print')
+        create_html_file(html_for_pdf, html, 'pdf')
       end
 
-      def with_footnotes_file
+      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
@@ -39,6 +79,10 @@ module Kitabu
       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/version.rb

@@ -1,8 +1,8 @@
 module Kitabu
   module Version
-    MAJOR = 1
+    MAJOR = 2
     MINOR = 0
-    PATCH = 6
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/kitabu/cli/export_spec.rb

@@ -3,15 +3,15 @@ require "spec_helper"
 describe Kitabu::Cli do
   context "while running export" do
     it "exits with status 1 when an invalid --only option is provided" do
-      expect {
+      expect(->{
         capture(:stderr){ Kitabu::Cli.start(["export", "--only=invalid"]) }
-      }.to exit_with_code(1)
+      }).to exit_with_code(1)
     end
 
     it "exits with status 1 when no config file is found" do
-      expect {
+      expect(->{
         capture(:stderr){ Kitabu::Cli.start(["export"]) }
-      }.to exit_with_code(1)
+      }).to exit_with_code(1)
     end
   end
 end

data/spec/kitabu/cli/new_spec.rb

@@ -13,9 +13,9 @@ describe Kitabu::Cli do
     end
 
     it "exits with status 1 when no path is provided" do
-      expect {
+      expect(->{
         capture(:stderr){ Kitabu::Cli.start(["new"]) }
-      }.to exit_with_code(1)
+      }).to exit_with_code(1)
 
       expect(File).not_to be_directory(tmpdir.join("mybook"))
     end

data/spec/kitabu/markdown_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Kitabu::Markdown do
+  it 'enables fenced code blocks' do
+    html = Kitabu::Markdown.render <<-TEXT.strip_heredoc
+      ```ruby
+      class User
+      end
+      ```
+    TEXT
+
+    expect(html).to include('<pre class="highlight ruby">')
+  end
+
+  it 'enables options' do
+    html = Kitabu::Markdown.render <<-TEXT.strip_heredoc
+    ```php?start_inline=true
+    echo 'Hello';
+    ```
+    TEXT
+
+    expect(html).to include('<span class="k">echo</span>')
+  end
+end

data/spec/kitabu/parser/html_spec.rb

@@ -18,24 +18,23 @@ describe Kitabu::Parser::HTML do
     end
 
     it "skips files that start with underscore" do
-      expect(relative).not_to include("_00_Introduction.markdown")
+      expect(relative).not_to include("_00_Introduction.md")
     end
 
     it "skips other files" do
-      expect(relative).not_to include("CHANGELOG.textile")
-      expect(relative).not_to include("TOC.textile")
+      expect(relative).not_to include("CHANGELOG.md")
+      expect(relative).not_to include("TOC.md")
     end
 
     it "returns only first-level entries" do
-      expect(relative).not_to include("04_With_Directory/Some_Chapter.mkdn")
+      expect(relative).not_to include("03_With_Directory/Some_Chapter.md")
     end
 
     it "returns entries" do
-      expect(relative.first).to eq("01_Markdown_Chapter.markdown")
-      expect(relative.second).to eq("02_Textile_Chapter.textile")
-      expect(relative.third).to eq("03_HTML_Chapter.html")
-      expect(relative.fourth).to eq("04_With_Directory")
-      expect(relative.fifth).to be_nil
+      expect(relative.first).to eq("01_Markdown_Chapter.md")
+      expect(relative.second).to eq("02_ERB_Chapter.md.erb")
+      expect(relative.third).to eq("03_With_Directory")
+      expect(relative.fourth).to be_nil
     end
   end
 
@@ -44,24 +43,12 @@ describe Kitabu::Parser::HTML do
     let(:html) { File.read(file) }
     before { parser.parse }
 
-    it "has several chapters" do
-      expect(html).to have_tag("div.chapter", 4)
-    end
-
-    it "renders .markdown" do
-      expect(html).to have_tag("div.chapter > h2#markdown", "Markdown")
-    end
-
-    it "renders .mkdn" do
-      expect(html).to have_tag("div.chapter > h2#some-chapter", "Some Chapter")
-    end
-
-    it "renders .textile" do
-      expect(html).to have_tag("div.chapter > h2#textile", "Textile")
+    it "keeps html file around" do
+      expect(file).to be_file
     end
 
-    it "renders .html" do
-      expect(html).to have_tag("div.chapter > h2#html", "HTML")
+    it "has several chapters" do
+      expect(html).to have_tag("div.chapter", 3)
     end
 
     it "uses config file" do
@@ -71,5 +58,13 @@ describe Kitabu::Parser::HTML do
     it "renders changelog" do
       expect(html).to have_tag("div.changelog h2", "Revisions")
     end
+
+    it "renders erb" do
+      expect(html).to have_tag("h2", "ERB")
+    end
+
+    it "renders erb blocks" do
+      expect(html).to have_tag("div.note.info > p", "This is a note!")
+    end
   end
 end

data/spec/kitabu/parser/mobi_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe Kitabu::Parser::Mobi, kindlegen: Kitabu::Dependency.kindlegen? do
+  let(:root) { SPECDIR.join("support/mybook") }
+
+  before do
+    Kitabu::Parser::HTML.parse(root)
+    Kitabu::Parser::Mobi.parse(root)
+  end
+
+  it "generates mobi" do
+    expect(root.join("output/mybook.mobi")).to be_file
+  end
+end

data/spec/kitabu/parser/pdf_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Kitabu::Parser::PDF do
+describe Kitabu::Parser::PDF, prince: Kitabu::Dependency.prince? do
   let(:root) { SPECDIR.join("support/mybook") }
 
   before do
@@ -8,6 +8,23 @@ describe Kitabu::Parser::PDF do
     Kitabu::Parser::PDF.new(root).parse
   end
 
+  it "creates html with css identifier" do
+    expect(root.join("output/mybook.pdf.html").read).to have_tag('html.pdf')
+    expect(root.join("output/mybook.print.html").read).to have_tag('html.print')
+  end
+
+  it "sets stylesheet for print pdf" do
+    expect(root.join("output/mybook.print.html").read).to have_tag('link[rel=stylesheet][href="styles/print.css"]')
+  end
+
+  it "sets stylesheet for pdf" do
+    expect(root.join("output/mybook.pdf.html").read).to have_tag('link[rel=stylesheet][href="styles/pdf.css"]')
+  end
+
+  it "generates pdf file for print" do
+    expect(root.join("output/mybook.print.pdf")).to be_file
+  end
+
   it "generates pdf file" do
     expect(root.join("output/mybook.pdf")).to be_file
   end

data/spec/kitabu/parser/txt_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe Kitabu::Parser::Txt, html2text: Kitabu::Dependency.html2text? do
+  let(:root) { SPECDIR.join("support/mybook") }
+
+  before do
+    Kitabu::Parser::HTML.parse(root)
+    Kitabu::Parser::Txt.parse(root)
+  end
+
+  it "generates text file" do
+    expect(root.join("output/mybook.txt")).to be_file
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "bundler/setup"
+
 require "kitabu"
 require "pathname"
 
@@ -17,15 +22,14 @@ RSpec.configure do |config|
   config.include(SpecHelper)
   config.include(Matchers)
 
+  config.filter_run_excluding html2text: false, kindlegen: false, prince: false
+
   cleaner = proc do
-    [
-      TMPDIR,
-      SPECDIR.join("support/mybook/output/mybook.pdf"),
-      SPECDIR.join("support/mybook/output/mybook.epub"),
-      SPECDIR.join("support/mybook/output/mybook.html")
-    ].each do |i|
+    [TMPDIR].each do |i|
       FileUtils.rm_rf(i) if File.exist?(i)
     end
+
+    Dir.chdir File.expand_path('../..', __FILE__)
   end
 
   config.before(&cleaner)

data/spec/support/mybook/config/helper.rb

@@ -1,29 +1,4 @@
-# Put any Ruby code in here.
-# Here's an example on how you can extend RedCloth (Textile) with new formatters.
-#
-#   module RedCloth
-#     module Formatters
-#       module HTML
-#         def attention(options)
-#           %[<p class="attention">#{options[:text]}</p>]
-#         end
-#       end
-#     end
-#   end
-#
-# Then you can just use `attention. This is an important note!` on your text.
-#
-# You can add inline formatters as well. The approach is slightly different,
-# but pretty straightforward.
-#
-# Add your formatter to `RedCloth::INLINE_FORMATTERS` and implement the method, making sure that it
-# replaces the content using `String#gsub!`.
-#
-#   module RedCloth
-#     def my_formatter(text)
-#       text.gsub!(/Hello/, "Hi")
-#     end
-#   end
-#
-#   RedCloth::INLINE_FORMATTERS << :my_formatter
-#
+module Kitabu
+  module Helpers
+  end
+end

data/spec/support/mybook/config/kitabu.yml

@@ -43,13 +43,3 @@ authors:
 
 # The base URL from your source code.
 base_url: http://example.com
-
-# You can rename your text structure automatically.
-# All you have to do is using a list will all your chapters and
-# then you can run `kitabu rearrange`.
-structure:
-  - Markdown_Chapter.markdown
-  - Textile_Chapter.textile
-  - HTML_Chapter.html
-  - With_Directory
-    - Some_Chapter.mkdn

data/spec/support/mybook/templates/epub/cover.erb

@@ -2,15 +2,16 @@
 <!DOCTYPE html PUBLIC
 	  "-//W3C//DTD XHTML 1.1//EN"
 	  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= language %>">
+<html class="epub" xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= language %>">
   <head>
     <title><%= title %></title>
-    <link rel="stylesheet" href="style.css" type="text/css" />
+    <link rel="stylesheet" href="styles/epub.css" type="text/css" />
     <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
   </head>
+
   <body>
     <div>
-		<h1><%= title %></h1>
+      <h1><%= title %></h1>
     </div>
   </body>
 </html>

data/spec/support/mybook/templates/epub/page.erb

@@ -1,10 +1,11 @@
 <?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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= language %>">
+<html class="epub" xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= language %>">
   <head>
     <title></title>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-    <link rel="stylesheet" type="text/css" href="style.css"/>
+    <link rel="stylesheet" type="text/css" href="styles/epub.css"/>
+    <%= highlight_theme('github') %>
   </head>
 
   <body>

data/spec/support/mybook/templates/html/layout.erb

@@ -1,17 +1,14 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html>
+<!doctype html>
+<html class="html">
   <head>
     <title><%= title %></title>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-    <link rel="stylesheet" type="text/css" href="../templates/html/layout.css"/>
-    <link rel="stylesheet" type="text/css" href="../templates/html/syntax.css"/>
-    <link rel="stylesheet" type="text/css" href="../templates/html/user.css"/>
-
+    <link name="stylesheet" rel="stylesheet" type="text/css" href="styles/html.css" />
     <meta name="author" content="<%= authors.join(', ') %>" />
     <meta name="subject" content="<%= subject %>" />
     <meta name="keywords" content="<%= keywords %>" />
     <meta name="date" content="<%= published_at %>" />
+    <%= highlight_theme('github') %>
   </head>
   <body>
     <div class="frontcover container">
@@ -33,6 +30,12 @@
       <%= content %>
     </div>
 
+    <% if changelog %>
+      <div class="container changelog">
+        <%= changelog %>
+      </div>
+    <% end %>
+
     <div class="imprint container">
       <div>
         <h2><%= title %></h2>
@@ -40,11 +43,5 @@
         <p><%= copyright %></p>
       </div>
     </div>
-
-    <% if changelog %>
-      <div class="container changelog">
-        <%= changelog %>
-      </div>
-    <% end %>
   </body>
 </html>