kitabu 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd86f5ee69244e8b29bfaece12650d010841a669
-  data.tar.gz: 9e091f5f94a6c452f6e76722ad690902999c52a4
+  metadata.gz: 6e80a74dc472390fc4a60fa9d1efcb58883ab3a8
+  data.tar.gz: 5d0ff304f818d482a9d7553b6d338f789c38b799
 SHA512:
-  metadata.gz: ab2dd6d9710198b3a7da0027826b108e074e4ef35c43c3012cc89e160c9d2d13d39723c26dffae53b9a00f665f95b0bf92a98417a737ca317a67ba46832abcfb
-  data.tar.gz: 345c9f9fb488991a3c7507c4eb15d5b2454b75846a85cc29b30881b1fe81aba00203eded8401be5a13ef5385787ac81abb700a3d4bd4b95ae60f6973aed3ad26
+  metadata.gz: 7517d568da3ccbd2804f42c7fa9dc7905778acca3a26a82e58ffab6965dab7bd232b1bf2134f10fff62559a1e3fedbbb6471b51c1f0d48412775990c59c303f5
+  data.tar.gz: 1dc60c65a50467a337dd6db0b4da2a01da2260b0257810b315e336e4fdfc58f4b428e39561bcf43d55c0be76572b80b3da8ba8ad188634981170052bb51b0c5f

data/.gitignore

@@ -4,3 +4,4 @@
 /spec/support/mybook/output
 /coverage
 .sass-cache
+*.lock

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## v2.0.4
+
+- Support fonts directory
+- Allow having any element as the chapter title (e.g. h1). Previously you could only use h2.
+- Bug fix: unknown Rouge lexer was raising an error.
+
+## v2.0.3
+
+- Bug fix: footnote label wasn't updated with current count
+
+## v2.0.2
+
+- Bug fix: generate valid HTML markup
+
+## v2.0.1
+
+- Improve footnote generation
+
 ## v2.0.0
 
 - Remove support for different markdown processors; now using Redcarpet.

data/README.md

@@ -125,7 +125,7 @@ To print the TOC, you need to print a variable called `toc`, using the eRb tag.
 
     <%= toc %>
 
-#### Using ERB
+### Using ERB
 
 You can also have `.erb` files. You can mix Markdown and HTML, like the following:
 
@@ -189,7 +189,28 @@ The following Redcarpet options are enabled:
 * `superscript`
 * `tables`
 
-### References
+### Using custom fonts
+
+You can use custom fonts for your PDF. Just add them to the `fonts` directory (you can create this directory on your book's root directory if it doesn't exist).
+
+Then, on `templates/styles/pdf.scss` you can add the `@font-face` declaration.
+
+```css
+@font-face {
+  font-family: 'Open Sans Condensed Bold';
+  src: url('../fonts/OpenSans-CondBold.ttf');
+}
+```
+
+Finally, to use this font, do something like this:
+
+```css
+.chapter > h2 {
+  font-family: 'Open Sans Condensed Bold';
+}
+```
+
+## References
 
 * Markdown: <http://daringfireball.net/projects/markdown/syntax>
 * Markdown PHP: <https://michelf.ca/projects/php-markdown/extra/>

data/lib/kitabu.rb

@@ -37,7 +37,6 @@ module Kitabu
   require "kitabu/errors"
   require "kitabu/version"
   require "kitabu/generator"
-  require "kitabu/toc"
   require "kitabu/cli"
   require "kitabu/markdown"
   require "kitabu/source_list"
@@ -52,7 +51,9 @@ module Kitabu
   require "kitabu/footnotes/base"
   require "kitabu/footnotes/html"
   require "kitabu/footnotes/pdf"
-  require "kitabu/stream"
+  require "kitabu/toc/html"
+  require "kitabu/toc/html/stream"
+  require "kitabu/toc/epub"
   require "kitabu/dependency"
   require "kitabu/stats"
   require "kitabu/helpers"

data/lib/kitabu/exporter/base.rb

@@ -64,6 +64,8 @@ module Kitabu
       end
 
       def copy_directory(source, target)
+        return unless root_dir.join(source).directory?
+
         source = root_dir.join("#{source}/.")
         target = root_dir.join(target)
 

data/lib/kitabu/exporter/css.rb

@@ -5,6 +5,7 @@ module Kitabu
 
       def export
         files = Dir[root_dir.join("templates/styles/*.{scss,sass}").to_s]
+
         options = {
           style: :expanded,
           line_numbers: true,

data/lib/kitabu/exporter/epub.rb

@@ -129,7 +129,7 @@ module Kitabu
       def navigation
         sections.map do |section|
           {
-            label: section.html.css("h2:first-of-type").text,
+            label: section.html.css(":first-child").text,
             content: section.filename
           }
         end

data/lib/kitabu/exporter/html.rb

@@ -13,6 +13,7 @@ module Kitabu
       #
       def export
         copy_images!
+        copy_fonts!
         export_stylesheets!
 
         File.open(root_dir.join("output/#{name}.html"), "w") do |file|
@@ -99,6 +100,12 @@ module Kitabu
         copy_directory("images", "output/images")
       end
 
+      # Copy font files
+      #
+      def copy_fonts!
+        copy_directory("fonts", "output/fonts")
+      end
+
       # Export all root stylesheets.
       #
       def export_stylesheets!

data/lib/kitabu/extensions/rouge.rb

@@ -2,7 +2,8 @@ module Rouge
   module Plugins
     module Redcarpet
       def rouge_formatter(lexer)
-        Formatters::HTML.new({css_class: "highlight #{lexer.tag}"}.merge(lexer.options))
+        options = lexer.respond_to?(:options) ? lexer.options : {}
+        Formatters::HTML.new({css_class: "highlight #{lexer.tag}"}.merge(options))
       end
     end
   end

data/lib/kitabu/generator.rb

@@ -43,12 +43,15 @@ module Kitabu
 
     def create_directories
       empty_directory "output"
+      empty_directory "fonts"
     end
 
     def create_git_files
       create_file ".gitignore" do
         "/output"
       end
+
+      create_file "fonts/.keep"
     end
 
     def copy_guardfile

data/lib/kitabu/toc/html.rb

@@ -69,7 +69,13 @@ module Kitabu
       def to_html
         String.new.tap do |html|
           toc.each do |options|
-            html << %[<div class="level#{options[:level]} #{options[:permalink]}"><a href="##{options[:permalink]}"><span>#{CGI.escape_html(options[:text])}</span></a></div>]
+            html << %[
+              <div class="level#{options[:level]} #{options[:permalink]}">
+                <a href="##{options[:permalink]}">
+                  <span>#{CGI.escape_html(options[:text])}</span>
+                </a>
+              </div>
+            ]
           end
         end
       end

data/lib/kitabu/toc/html/stream.rb

@@ -0,0 +1,31 @@
+module Kitabu
+  module TOC
+    class HTML
+      class Stream
+        attr_accessor :listener, :content
+        attr_reader :html
+
+        def initialize(content, listener)
+          @content  = content
+          @listener = listener
+          @html = Nokogiri::HTML.parse(content)
+        end
+
+        def parse
+          traverse(html)
+        end
+
+        def traverse(node)
+          node.children.each do |child|
+            emit(child)
+            traverse(child)
+          end
+        end
+
+        def emit(node)
+          listener.tag(node) if node.name =~ /h[1-6]/
+        end
+      end
+    end
+  end
+end

data/lib/kitabu/version.rb

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

data/spec/kitabu/exporter/html_spec.rb

@@ -42,5 +42,16 @@ describe Kitabu::Exporter::HTML do
     it "renders erb blocks" do
       expect(html).to have_tag("div.note.info > p", "This is a note!")
     end
+
+    it "copies fonts" do
+      expect(root.join('output/fonts/OpenSans-CondBold.ttf')).to be_file
+    end
+
+    it "exports css files" do
+      expect(root.join('output/styles/epub.css')).to be_file
+      expect(root.join('output/styles/html.css')).to be_file
+      expect(root.join('output/styles/pdf.css')).to be_file
+      expect(root.join('output/styles/print.css')).to be_file
+    end
   end
 end

data/spec/kitabu/markdown_spec.rb

@@ -21,4 +21,14 @@ describe Kitabu::Markdown do
 
     expect(html).to include('<span class="k">echo</span>')
   end
+
+  it 'does not raise with unknown lexers' do
+    expect {
+      Kitabu::Markdown.render <<-TEXT.strip_heredoc
+      ```terminal
+      Text plain.
+      ```
+      TEXT
+    }.not_to raise_error
+  end
 end

data/spec/kitabu/toc/html_spec.rb

@@ -2,6 +2,10 @@
 require "spec_helper"
 
 describe Kitabu::TOC::HTML do
+  def regexp(text)
+    /#{Regexp.escape(text)}/
+  end
+
   HTML = <<-HTML
     <h1>Item 1</h1>
     <h2>Item 1.2</h2>
@@ -26,30 +30,30 @@ describe Kitabu::TOC::HTML do
   end
 
   it "generates toc" do
-    expect(html).to have_tag("div.level1.item-1", "Item 1")
-    expect(html).to have_tag("div.level2.item-1-2", "Item 1.2")
-    expect(html).to have_tag("div.level3.item-1-1-3", "Item 1.1.3")
-    expect(html).to have_tag("div.level4.item-1-1-1-4", "Item 1.1.1.4")
-    expect(html).to have_tag("div.level5.item-1-1-1-1-5", "Item 1.1.1.1.5")
-    expect(html).to have_tag("div.level6.item-1-1-1-1-1-6", "Item 1.1.1.1.1.6")
+    expect(html).to have_tag("div.level1.item-1", regexp("Item 1"))
+    expect(html).to have_tag("div.level2.item-1-2", regexp("Item 1.2"))
+    expect(html).to have_tag("div.level3.item-1-1-3", regexp("Item 1.1.3"))
+    expect(html).to have_tag("div.level4.item-1-1-1-4", regexp("Item 1.1.1.4"))
+    expect(html).to have_tag("div.level5.item-1-1-1-1-5", regexp("Item 1.1.1.1.5"))
+    expect(html).to have_tag("div.level6.item-1-1-1-1-1-6", regexp("Item 1.1.1.1.1.6"))
 
-    expect(html).to have_tag("div.level2.item-2-1", "Item 2.1")
-    expect(html).to have_tag("div.level2.item-2-1-again", "Item 2.1 again")
+    expect(html).to have_tag("div.level2.item-2-1", regexp("Item 2.1"))
+    expect(html).to have_tag("div.level2.item-2-1-again", regexp("Item 2.1 again"))
 
-    expect(html).to have_tag("div.level2.internacionalizacao", "Internacionalização")
+    expect(html).to have_tag("div.level2.internacionalizacao", regexp("Internacionalização"))
   end
 
   it "adds id attribute to content" do
-    expect(content).to have_tag("h1#item-1", "Item 1")
-    expect(content).to have_tag("h2#item-1-2", "Item 1.2")
-    expect(content).to have_tag("h3#item-1-1-3", "Item 1.1.3")
-    expect(content).to have_tag("h4#item-1-1-1-4", "Item 1.1.1.4")
-    expect(content).to have_tag("h5#item-1-1-1-1-5", "Item 1.1.1.1.5")
-    expect(content).to have_tag("h6#item-1-1-1-1-1-6", "Item 1.1.1.1.1.6")
+    expect(content).to have_tag("h1#item-1", regexp("Item 1"))
+    expect(content).to have_tag("h2#item-1-2", regexp("Item 1.2"))
+    expect(content).to have_tag("h3#item-1-1-3", regexp("Item 1.1.3"))
+    expect(content).to have_tag("h4#item-1-1-1-4", regexp("Item 1.1.1.4"))
+    expect(content).to have_tag("h5#item-1-1-1-1-5", regexp("Item 1.1.1.1.5"))
+    expect(content).to have_tag("h6#item-1-1-1-1-1-6", regexp("Item 1.1.1.1.1.6"))
 
-    expect(content).to have_tag("h2#item-2-1", "Item 2.1")
-    expect(content).to have_tag("h2#item-2-1-again", "Item 2.1 again")
+    expect(content).to have_tag("h2#item-2-1", regexp("Item 2.1"))
+    expect(content).to have_tag("h2#item-2-1-again", regexp("Item 2.1 again"))
 
-    expect(content).to have_tag("h2#internacionalizacao", "Internacionalização")
+    expect(content).to have_tag("h2#internacionalizacao", regexp("Internacionalização"))
   end
 end

data/spec/support/shared.rb

@@ -13,6 +13,10 @@ shared_examples_for "e-book" do
     expect(mybook.join("text")).to be_directory
   end
 
+  it "creates fonts directory" do
+    expect(mybook.join("fonts")).to be_directory
+  end
+
   it "creates template directory" do
     expect(mybook.join("templates")).to be_directory
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitabu
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -250,7 +250,6 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - attachments/browser-version.png
@@ -282,11 +281,10 @@ files:
 - lib/kitabu/markdown.rb
 - lib/kitabu/source_list.rb
 - lib/kitabu/stats.rb
-- lib/kitabu/stream.rb
 - lib/kitabu/syntax/highlight.rb
-- lib/kitabu/toc.rb
 - lib/kitabu/toc/epub.rb
 - lib/kitabu/toc/html.rb
+- lib/kitabu/toc/html/stream.rb
 - lib/kitabu/version.rb
 - spec/kitabu/cli/export_spec.rb
 - spec/kitabu/cli/new_spec.rb
@@ -315,6 +313,7 @@ files:
 - spec/support/mybook/code/code.rb
 - spec/support/mybook/config/helper.rb
 - spec/support/mybook/config/kitabu.yml
+- spec/support/mybook/fonts/OpenSans-CondBold.ttf
 - spec/support/mybook/images/.gitkeep
 - spec/support/mybook/images/logo.gif
 - spec/support/mybook/templates/epub/cover.erb
@@ -417,6 +416,7 @@ test_files:
 - spec/support/mybook/code/code.rb
 - spec/support/mybook/config/helper.rb
 - spec/support/mybook/config/kitabu.yml
+- spec/support/mybook/fonts/OpenSans-CondBold.ttf
 - spec/support/mybook/images/.gitkeep
 - spec/support/mybook/images/logo.gif
 - spec/support/mybook/templates/epub/cover.erb

data/Gemfile.lock

@@ -1,108 +0,0 @@
-PATH
-  remote: .
-  specs:
-    kitabu (2.0.3)
-      activesupport
-      eeepub-with-cover-support
-      i18n
-      nokogiri
-      notifier
-      redcarpet
-      rouge
-      rubyzip
-      sass
-      sass-globbing
-      thor
-      zip-zip
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (4.2.0)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    awesome_print (1.6.1)
-    builder (3.2.2)
-    byebug (3.5.1)
-      columnize (~> 0.8)
-      debugger-linecache (~> 1.2)
-      slop (~> 3.6)
-    codeclimate-test-reporter (0.4.7)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
-    columnize (0.9.0)
-    debugger-linecache (1.2.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    eeepub-with-cover-support (0.8.8)
-      builder
-      rubyzip
-    i18n (0.7.0)
-    json (1.8.2)
-    method_source (0.8.2)
-    mini_portile (0.6.2)
-    minitest (5.5.1)
-    multi_json (1.11.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    notifier (0.5.0)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.0.1)
-      byebug (~> 3.4)
-      pry (~> 0.10)
-    pry-meta (0.0.10)
-      awesome_print
-      pry
-      pry-byebug
-      pry-remote
-    pry-remote (0.1.8)
-      pry (~> 0.9)
-      slop (~> 3.0)
-    rake (10.4.2)
-    redcarpet (3.2.2)
-    rouge (1.8.0)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.2)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    rubyzip (1.1.7)
-    sass (3.4.13)
-    sass-globbing (1.1.1)
-      sass (>= 3.1)
-    simplecov (0.9.2)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
-    slop (3.6.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    zip-zip (0.3)
-      rubyzip (>= 1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  codeclimate-test-reporter
-  kitabu!
-  pry-meta
-  rake
-  rspec

data/lib/kitabu/stream.rb

@@ -1,27 +0,0 @@
-module Kitabu
-  class Stream
-    attr_accessor :listener, :content
-    attr_reader :html
-
-    def initialize(content, listener)
-      @content  = content
-      @listener = listener
-      @html = Nokogiri::HTML.parse(content)
-    end
-
-    def parse
-      traverse(html)
-    end
-
-    def traverse(node)
-      node.children.each do |child|
-        emit(child)
-        traverse(child)
-      end
-    end
-
-    def emit(node)
-      listener.tag(node) if node.name =~ /h[1-6]/
-    end
-  end
-end

data/lib/kitabu/toc.rb

@@ -1,6 +0,0 @@
-module Kitabu
-  module TOC
-    autoload :HTML, "kitabu/toc/html"
-    autoload :Epub, "kitabu/toc/epub"
-  end
-end