kitabu 2.0.0 → 2.0.1

data/lib/kitabu/footnotes/pdf.rb

@@ -0,0 +1,47 @@
+module Kitabu
+  module Footnotes
+    class PDF < Base
+      def process
+        remove_duplicated_attributes
+        html.css(".chapter").each(&method(:process_chapter))
+      end
+
+      def remove_duplicated_attributes
+        # https://github.com/sparklemotion/nokogiri/issues/339
+        html.css('html').first.tap do |element|
+          next unless element
+          element.delete('xmlns')
+          element.delete('xml:lang')
+        end
+      end
+
+      def process_chapter(chapter)
+        chapter.css('.footnotes li').each do |footnote|
+          process_footnote(chapter, footnote)
+          increment_footnote_index!
+        end
+
+        chapter.css('.footnotes').each(&:remove)
+      end
+
+      def process_footnote(chapter, footnote)
+        # Remove rev links
+        footnote.css('[rev=footnote]').map(&:remove)
+
+        # Create an element for storing the footnote description
+        description = Nokogiri::XML::Node.new('span', Nokogiri::HTML::DocumentFragment.parse(''))
+        description.set_attribute 'class', 'footnote'
+        description.inner_html = footnote.css('p').map(&:inner_html).join("\n")
+
+        # Find ref based on footnote's id
+        fn_id = footnote.get_attribute('id')
+
+        refs = chapter.css("a[href='##{fn_id}']").each do |ref|
+          sup = ref.parent
+          sup.after(description)
+          sup.remove
+        end
+      end
+    end
+  end
+end

data/lib/kitabu/source_list.rb

@@ -0,0 +1,73 @@
+module Kitabu
+  class SourceList
+    # List of directories that should be skipped.
+    #
+    IGNORE_DIR = %w[. .. .svn .git]
+
+    # Files that should be skipped.
+    #
+    IGNORE_FILES = /^(CHANGELOG|TOC)\..*?$/
+
+    # List of recognized extensions.
+    #
+    EXTENSIONS = %w[md erb]
+
+    attr_reader :root_dir
+    attr_reader :source
+
+    def initialize(root_dir)
+      @root_dir = root_dir
+      @source = root_dir.join('text')
+    end
+
+    #
+    #
+    def each_chapter(&block)
+      files_grouped_by_chapter.each(&block)
+    end
+
+    def files_grouped_by_chapter
+      entries.each_with_object([]) do |entry, buffer|
+        files = chapter_files(entry)
+        buffer << files unless files.empty?
+      end
+    end
+
+    def chapter_files(entry)
+      # Chapters can be files outside a directory.
+      if File.file?(entry)
+        [entry]
+      else
+        Dir["#{entry}/**/*.{#{EXTENSIONS.join(",")}}"].sort
+      end
+    end
+
+    # Return a list of all recognized files.
+    #
+    def entries
+      Dir.entries(source).sort.each_with_object([]) do |entry, buffer|
+        buffer << source.join(entry) if valid_entry?(entry)
+      end
+    end
+
+    # Check if path is a valid entry.
+    # Files/directories that start with a dot or underscore will be skipped.
+    #
+    def valid_entry?(entry)
+      entry !~ /^(\.|_)/ && (valid_directory?(entry) || valid_file?(entry))
+    end
+
+    # Check if path is a valid directory.
+    #
+    def valid_directory?(entry)
+      File.directory?(source.join(entry)) && !IGNORE_DIR.include?(File.basename(entry))
+    end
+
+    # Check if path is a valid file.
+    #
+    def valid_file?(entry)
+      ext = File.extname(entry).gsub(/\./, "").downcase
+      File.file?(source.join(entry)) && EXTENSIONS.include?(ext) && entry !~ IGNORE_FILES
+    end
+  end
+end

data/lib/kitabu/stats.rb

@@ -39,7 +39,7 @@ module Kitabu
     end
 
     def content
-      @content ||= Parser::HTML.new(root_dir).content
+      @content ||= Exporter::HTML.new(root_dir).content
     end
   end
 end

data/lib/kitabu/stream.rb

@@ -21,7 +21,7 @@ module Kitabu
     end
 
     def emit(node)
-      listener.send(:tag, node) if node.name =~ /h[1-6]/
+      listener.tag(node) if node.name =~ /h[1-6]/
     end
   end
 end

data/lib/kitabu/toc/html.rb

@@ -48,9 +48,9 @@ module Kitabu
 
       def tag(node) # :nodoc:
         toc << {
-          :level     => node.name.gsub(/[^\d]/, "").to_i,
-          :text      => node.text,
-          :permalink => node["id"]
+          level: node.name.gsub(/[^\d]/, "").to_i,
+          text: node.text,
+          permalink: node["id"]
         }
       end
 
@@ -58,9 +58,9 @@ module Kitabu
       #
       def to_hash
         {
-          :content => content,
-          :html => to_html,
-          :toc => toc
+          content: content,
+          html: to_html,
+          toc: toc
         }
       end
 

data/lib/kitabu/version.rb

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

data/spec/kitabu/exporter/css_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Kitabu::Exporter::CSS do
+  let(:root) { SPECDIR.join("support/mybook") }
+
+  before do
+    Kitabu::Exporter::CSS.export(root)
+  end
+
+  it "generates css files" do
+    expect(root.join("output/styles/epub.css")).to be_file
+    expect(root.join("output/styles/pdf.css")).to be_file
+    expect(root.join("output/styles/print.css")).to be_file
+    expect(root.join("output/styles/html.css")).to be_file
+  end
+end

data/spec/kitabu/{parser → exporter}/epub_spec.rb

@@ -1,11 +1,11 @@
 require "spec_helper"
 
-describe Kitabu::Parser::Epub do
+describe Kitabu::Exporter::Epub do
   let(:root) { SPECDIR.join("support/mybook") }
 
   before do
-    Kitabu::Parser::HTML.parse(root)
-    Kitabu::Parser::Epub.parse(root)
+    Kitabu::Exporter::HTML.export(root)
+    Kitabu::Exporter::Epub.export(root)
   end
 
   it "generates e-pub" do

data/spec/kitabu/exporter/html_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Kitabu::Exporter::HTML do
+  let(:root) { SPECDIR.join("support/mybook") }
+  let(:format) { described_class.new(root) }
+
+  context "when generating HTML" do
+    let(:file) { SPECDIR.join("support/mybook/output/mybook.html") }
+    let(:html) { File.read(file) }
+    before { format.export }
+
+    it "keeps html file around" do
+      expect(file).to be_file
+    end
+
+    it "has several chapters" do
+      expect(html).to have_tag("div.chapter", 3)
+    end
+
+    it "uses config file" do
+      expect(html).to have_tag("div.imprint p", "Copyright (C) 2010 John Doe.")
+    end
+
+    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 → exporter}/mobi_spec.rb

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

data/spec/kitabu/{parser → exporter}/pdf_spec.rb

@@ -1,11 +1,11 @@
 require "spec_helper"
 
-describe Kitabu::Parser::PDF, prince: Kitabu::Dependency.prince? do
+describe Kitabu::Exporter::PDF, prince: Kitabu::Dependency.prince? do
   let(:root) { SPECDIR.join("support/mybook") }
 
   before do
-    Kitabu::Parser::HTML.new(root).parse
-    Kitabu::Parser::PDF.new(root).parse
+    Kitabu::Exporter::HTML.new(root).export
+    Kitabu::Exporter::PDF.new(root).export
   end
 
   it "creates html with css identifier" do

data/spec/kitabu/{parser → exporter}/txt_spec.rb

@@ -1,11 +1,11 @@
 require "spec_helper"
 
-describe Kitabu::Parser::Txt, html2text: Kitabu::Dependency.html2text? do
+describe Kitabu::Exporter::Txt, html2text: Kitabu::Dependency.html2text? do
   let(:root) { SPECDIR.join("support/mybook") }
 
   before do
-    Kitabu::Parser::HTML.parse(root)
-    Kitabu::Parser::Txt.parse(root)
+    Kitabu::Exporter::HTML.export(root)
+    Kitabu::Exporter::Txt.export(root)
   end
 
   it "generates text file" do

data/spec/kitabu/footnotes/html_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Kitabu::Footnotes::HTML do
+  let(:footnotes) {
+    Kitabu::Markdown.render <<-MARKDOWN.strip_heredoc
+      ohai[^1] and kthxbai[^2]
+
+      ohai[^1] again.
+
+      [^1]: Hello
+      [^2]: OK, thanks. Bye!
+    MARKDOWN
+  }
+
+  let(:content) {
+    <<-HTML.strip_heredoc
+      <div class="chapter">
+        #{footnotes}
+      </div>
+
+      <div class="chapter">
+        #{footnotes}
+      </div>
+    HTML
+  }
+
+  let(:html) {
+    Kitabu::Footnotes::HTML.process(content).html
+  }
+
+  let(:chapter1) { html.css('.chapter:first-of-type').first }
+  let(:chapter2) { html.css('.chapter:last-of-type').first }
+
+  it 'sets starting index' do
+    expect(chapter1).to have_tag('.footnotes ol[start="1"]')
+    expect(chapter2).to have_tag('.footnotes ol[start="3"]')
+  end
+
+  it 'sets footnotes id' do
+    html.css('.footnotes li').to_enum(:each).with_index(1) do |footnote, index|
+      expect(footnote.get_attribute('id')).to eq("fn#{index}")
+    end
+  end
+
+  it 'removes id from existing <sup>' do
+    expect(chapter1).to have_tag('sup:not([id])', count: 1)
+    expect(chapter2).to have_tag('sup:not([id])', count: 1)
+  end
+
+  it 'sets <sup> id' do
+    expect(chapter1).to have_tag('sup', count: 3)
+    expect(chapter1).to have_tag('sup[id=fnref1]', count: 1)
+    expect(chapter1).to have_tag('sup[id=fnref2]', count: 1)
+
+    expect(chapter2).to have_tag('sup', count: 3)
+    expect(chapter2).to have_tag('sup[id=fnref3]', count: 1)
+    expect(chapter2).to have_tag('sup[id=fnref4]', count: 1)
+  end
+
+  it 'sets footnote link-back' do
+    expect(chapter1).to have_tag('.footnotes li:nth-child(1) a[rev=footnote][href="#fnref1"]')
+    expect(chapter1).to have_tag('.footnotes li:nth-child(2) a[rev=footnote][href="#fnref2"]')
+
+    expect(chapter2).to have_tag('.footnotes li:nth-child(1) a[rev=footnote][href="#fnref3"]')
+    expect(chapter2).to have_tag('.footnotes li:nth-child(2) a[rev=footnote][href="#fnref4"]')
+  end
+end

data/spec/kitabu/{parser/html_spec.rb → source_list_spec.rb}

@@ -1,11 +1,12 @@
-require "spec_helper"
+require 'spec_helper'
 
-describe Kitabu::Parser::HTML do
+describe Kitabu::SourceList do
   let(:root) { SPECDIR.join("support/mybook") }
+  let(:format) { Kitabu::Exporter::HTML.new(root) }
+  let(:entries) { source_list.entries }
   let(:source) { root.join("text") }
-  let(:parser) { described_class.new(root) }
-  let(:entries) { parser.entries }
   let(:relative) { entries.collect {|e| e.to_s.gsub(/^#{Regexp.escape(source.to_s)}\//, "")} }
+  subject(:source_list) { Kitabu::SourceList.new(root) }
 
   context "when filtering entries" do
     it "skips dot directories" do
@@ -37,34 +38,4 @@ describe Kitabu::Parser::HTML do
       expect(relative.fourth).to be_nil
     end
   end
-
-  context "when generating HTML" do
-    let(:file) { SPECDIR.join("support/mybook/output/mybook.html") }
-    let(:html) { File.read(file) }
-    before { parser.parse }
-
-    it "keeps html file around" do
-      expect(file).to be_file
-    end
-
-    it "has several chapters" do
-      expect(html).to have_tag("div.chapter", 3)
-    end
-
-    it "uses config file" do
-      expect(html).to have_tag("div.imprint p", "Copyright (C) 2010 John Doe.")
-    end
-
-    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/stats_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Kitabu::Stats do
   let(:root_dir) { double("root dir").as_null_object }
-  let(:parser) { double("parser").as_null_object }
+  let(:format) { double("format").as_null_object }
   let(:content) { "" }
   subject(:stats) { Kitabu::Stats.new(root_dir) }
 
@@ -11,18 +11,18 @@ describe Kitabu::Stats do
   }
 
   context "getting content" do
-    it "parses content" do
-      expect(Kitabu::Parser::HTML)
+    it "generates content" do
+      expect(Kitabu::Exporter::HTML)
         .to receive(:new)
         .with(root_dir)
-        .and_return(parser)
+        .and_return(format)
 
       Kitabu::Stats.new(root_dir).content
     end
 
-    it "returns parser content" do
-      allow(Kitabu::Parser::HTML).to receive_message_chain(:new).and_return(parser)
-      allow(parser).to receive_message_chain(:content).and_return("some content")
+    it "returns content" do
+      allow(Kitabu::Exporter::HTML).to receive_message_chain(:new).and_return(format)
+      allow(format).to receive_message_chain(:content).and_return("some content")
 
       expect(Kitabu::Stats.new(root_dir).content).to eql("some content")
     end