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

data/lib/kitabu/syntax/highlight.rb ADDED

@@ -0,0 +1,22 @@
+module Kitabu
+  class Syntax
+    class Highlight
+      def self.apply(code, language)
+        if Dependency.pygments_rb?
+          pygments(code, language)
+        else
+          coderay(code, language)
+        end
+      end
+      private
+      def self.pygments(code, language)
+        Pygments.highlight(code, :lexer => language, :options => {:encoding => "utf-8"})
+      end
+      def self.coderay(code, language)
+        CodeRay.scan(code, language).div(:css => :class)
+      end
+    end
+  end
+end

data/lib/kitabu/toc.rb CHANGED

@@ -1,80 +1,6 @@
 module Kitabu
-  class Toc
-    # Return the table of contents in hash format.
-    #
-    attr_reader :toc
-    private_class_method :new
-    attr_reader :buffer # :nodoc:
-    attr_reader :attrs # :nodoc:
-    attr_accessor :content # :nodoc:
-    # Traverse every title and add a +id+ attribute.
-    # Return the modified content.
-    #
-    def self.normalize(content)
-      counter = {}
-      html = Nokogiri::HTML.parse(content)
-      html.search("h2, h3, h4, h5, h6").each do |tag|
-        title = tag.inner_text
-        permalink = title.to_permalink
-        counter[permalink] ||= 0
-        counter[permalink] += 1
-        permalink = "#{permalink}-#{counter[permalink]}" if counter[permalink] > 1
-        tag.set_attribute("id", permalink)
-      end
-      html = html.to_xhtml
-      html.force_encoding("UTF-8") if html.encoding_aware?
-      _, content = *html.match(/<body>(.*?)<\/body>/m)
-      content
-    end
-    # Traverse every title normalizing its content as a permalink.
-    #
-    def self.generate(content)
-      content = normalize(content)
-      listener = new
-      listener.content = content
-      Stream.new(content, listener).parse
-      listener
-    end
-    def initialize # :nodoc:
-      @toc = []
-      @counters = {}
-    end
-    def tag(node) # :nodoc:
-      toc << {
-        :level     => node.name.gsub(/[^\d]/, "").to_i,
-        :text      => node.text,
-        :permalink => node["id"]
-      }
-    end
-    # Return a hash with all normalized attributes.
-    #
-    def to_hash
-      {
-        :content => content,
-        :html => to_html,
-        :toc => toc
-      }
-    end
-    # Return the table of contents in HTML format.
-    #
-    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>]
-        end
-      end
-    end
+  module TOC
+    autoload :HTML, "kitabu/toc/html"
+    autoload :Epub, "kitabu/toc/epub"
   end
-end
+end

data/lib/kitabu/toc/epub.rb ADDED

@@ -0,0 +1,41 @@
+module Kitabu
+  module TOC
+    class Epub
+      attr_accessor :navigation
+      def initialize(navigation)
+        @navigation = navigation
+      end
+      def to_html
+        ERB.new(template).result OpenStruct.new(:navigation => navigation).instance_eval{ binding }
+      end
+      def template
+        <<-HTML.strip_heredoc.force_encoding("utf-8")
+          <?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 http-equiv="Content-type" content="text/html; charset=utf-8" />
+              <link rel="stylesheet" type="text/css" href="epub.css"/>
+              <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
+              <title>Table of Contents</title>
+            </head>
+            <body>
+              <div id="toc">
+                <ul>
+                  <% navigation.each do |nav| %>
+                    <li>
+                      <a href="<%= nav[:content] %>"><%= nav[:label] %></a>
+                    </li>
+                  <% end %>
+                </ul>
+              </div>
+            </body>
+          </html>
+        HTML
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+module Kitabu
+  module TOC
+    class HTML
+      # Return the table of contents in hash format.
+      #
+      attr_reader :toc
+      private_class_method :new
+      attr_reader :buffer # :nodoc:
+      attr_reader :attrs # :nodoc:
+      attr_accessor :content # :nodoc:
+      # Traverse every title and add a +id+ attribute.
+      # Return the modified content.
+      #
+      def self.normalize(content)
+        counter = {}
+        html = Nokogiri::HTML.parse(content)
+        html.search("h2, h3, h4, h5, h6").each do |tag|
+          title = tag.inner_text
+          permalink = title.to_permalink
+          counter[permalink] ||= 0
+          counter[permalink] += 1
+          permalink = "#{permalink}-#{counter[permalink]}" if counter[permalink] > 1
+          tag.set_attribute("id", permalink)
+        end
+        html.css("body").inner_html
+      end
+      # Traverse every title normalizing its content as a permalink.
+      #
+      def self.generate(content)
+        content = normalize(content)
+        listener = new
+        listener.content = content
+        Stream.new(content, listener).parse
+        listener
+      end
+      def initialize # :nodoc:
+        @toc = []
+        @counters = {}
+      end
+      def tag(node) # :nodoc:
+        toc << {
+          :level     => node.name.gsub(/[^\d]/, "").to_i,
+          :text      => node.text,
+          :permalink => node["id"]
+        }
+      end
+      # Return a hash with all normalized attributes.
+      #
+      def to_hash
+        {
+          :content => content,
+          :html => to_html,
+          :toc => toc
+        }
+      end
+      # Return the table of contents in HTML format.
+      #
+      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>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitabu/version.rb CHANGED

@@ -3,6 +3,6 @@ module Kitabu
     MAJOR = 1
     MINOR = 0
     PATCH = 0
-    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}.rc1"
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}.rc2"
   end
 end

data/spec/kitabu/cli/export_spec.rb CHANGED

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

data/spec/kitabu/cli/new_spec.rb CHANGED

@@ -10,7 +10,7 @@ describe Kitabu::Cli do
       it_behaves_like "e-book"
     end
-    it "should exit with status 1 when no path is provided" do
+    it "exits with status 1 when no path is provided" do
       expect {
         capture(:stderr){ Kitabu::Cli.start(["new"]) }
       }.to exit_with_code(1)

data/spec/kitabu/cli/permalinks_spec.rb CHANGED

@@ -2,7 +2,7 @@ require "spec_helper"
 describe Kitabu::Cli do
   context "while running permalinks" do
-    it "should recognize command" do
+    it "recognizes command" do
       Dir.chdir SPECDIR.join("support/mybook")
       expect {
         capture(:stdout) { Kitabu::Cli.start(["permalinks"]) }

data/spec/kitabu/cli/version_spec.rb CHANGED

@@ -2,7 +2,7 @@ require "spec_helper"
 describe Kitabu::Cli do
   context "while running version" do
-    it "should output version" do
+    it "outputs version" do
       %w[version -v --version].each do |arg|
         output = capture(:stdout){ Kitabu::Cli.start([arg]) }.chomp
         output.should == "Kitabu version #{Kitabu::Version::STRING}"

data/spec/kitabu/extensions/redcloth_spec.rb CHANGED

@@ -2,7 +2,7 @@ require "spec_helper"
 describe RedCloth do
   describe "#figure" do
-    it "should render html" do
+    it "renders html" do
       html = RedCloth.convert("figure(The Rails logo). rails.png")
       html.should have_tag("p.figure") do |p|
         p.should have_tag("img[@src='../images/rails.png'][@alt='The Rails logo']")
@@ -12,21 +12,21 @@ describe RedCloth do
   end
   describe "#note" do
-    it "should render html" do
+    it "renders html" do
       html = RedCloth.convert("note. Some important note!")
       html.should have_tag("p.note", "Some important note!")
     end
   end
   describe "#attention" do
-    it "should render html" do
+    it "renders html" do
       html = RedCloth.convert("attention. Some warning note!")
       html.should have_tag("p.attention", "Some warning note!")
     end
   end
   describe "#file" do
-    it "should render html" do
+    it "renders html" do
       Kitabu.stub :config => { :base_url => "http://example.com" }
       html = RedCloth.convert("file. app/models/users.rb")
@@ -37,14 +37,14 @@ describe RedCloth do
   end
   context "custom footnote helper" do
-    it "should render html" do
+    it "renders html" do
       html = RedCloth.convert("Writing some text with a footnote %{this is a footnote}")
       html.should == %[<p>Writing some text with a footnote<span class="footnote">this is a footnote</span></p>]
     end
   end
   context "custom url helper" do
-    it "should render html" do
+    it "renders html" do
       html = RedCloth.convert("<http://example.com>")
       html.should == %[<p><a href="http://example.com">http://example.com</a></p>]
     end

data/spec/kitabu/extensions/string_spec.rb CHANGED

@@ -3,7 +3,7 @@ require "spec_helper"
 describe String do
   describe "#to_permalink" do
-    it "should normalize strings" do
+    it "normalizes strings" do
       {
         'This IS a Tripped out title!!.!1  (well/ not really)' => 'this-is-a-tripped-out-title-1-well-not-really',
         '////// meph1sto r0x ! \\\\\\' => 'meph1sto-r0x',

data/spec/kitabu/parser/epub_spec.rb CHANGED

@@ -3,8 +3,12 @@ require "spec_helper"
 describe Kitabu::Parser::Epub do
   let(:root) { SPECDIR.join("support/mybook") }
-  it "should generate e-pub" do
+  before do
+    Kitabu::Parser::HTML.parse(root)
     Kitabu::Parser::Epub.parse(root)
+  end
+  it "generates e-pub" do
     root.join("output/mybook.epub").should be_file
   end
 end

data/spec/kitabu/parser/html_spec.rb CHANGED

@@ -1,36 +1,36 @@
 require "spec_helper"
-describe Kitabu::Parser::Html do
+describe Kitabu::Parser::HTML do
   let(:root) { SPECDIR.join("support/mybook") }
   let(:source) { root.join("text") }
-  let(:parser) { Kitabu::Parser::Html.new(root) }
+  let(:parser) { described_class.new(root) }
   let(:entries) { parser.entries }
   let(:relative) { entries.collect {|e| e.to_s.gsub(/^#{Regexp.escape(source.to_s)}\//, "")} }
   context "when filtering entries" do
-    it "should skip dot directories" do
+    it "skips dot directories" do
       relative.should_not include(".")
       relative.should_not include("..")
     end
-    it "should skip dot files" do
+    it "skips dot files" do
       relative.should_not include(".gitkeep")
     end
-    it "should skip files that start with underscore" do
+    it "skips files that start with underscore" do
       relative.should_not include("_00_Introduction.markdown")
     end
-    it "should skip other files" do
+    it "skips other files" do
       relative.should_not include("CHANGELOG.textile")
       relative.should_not include("TOC.textile")
     end
-    it "should return only first-level entries" do
+    it "returns only first-level entries" do
       relative.should_not include("04_With_Directory/Some_Chapter.mkdn")
     end
-    it "should return entries" do
+    it "returns entries" do
       relative.first.should == "01_Markdown_Chapter.markdown"
       relative.second.should == "02_Textile_Chapter.textile"
       relative.third.should == "03_HTML_Chapter.html"
@@ -44,31 +44,31 @@ describe Kitabu::Parser::Html do
     let(:html) { File.read(file) }
     before { parser.parse }
-    it "should have several chapters" do
+    it "has several chapters" do
       html.should have_tag("div.chapter", 4)
     end
-    it "should render .markdown" do
+    it "renders .markdown" do
       html.should have_tag("div.chapter > h2#markdown", "Markdown")
     end
-    it "should render .mkdn" do
+    it "renders .mkdn" do
       html.should have_tag("div.chapter > h2#some-chapter", "Some Chapter")
     end
-    it "should render .textile" do
+    it "renders .textile" do
       html.should have_tag("div.chapter > h2#textile", "Textile")
     end
-    it "should render .html" do
+    it "renders .html" do
       html.should have_tag("div.chapter > h2#html", "HTML")
     end
-    it "should have use config file" do
+    it "uses config file" do
       html.should have_tag("div.imprint p", "Copyright (C) 2010 John Doe.")
     end
-    it "should render changelog" do
+    it "renders changelog" do
       html.should have_tag("div.changelog h2", "Revisions")
     end
   end

data/spec/kitabu/parser/pdf_spec.rb CHANGED

@@ -1,14 +1,14 @@
 require "spec_helper"
-describe Kitabu::Parser::Pdf do
+describe Kitabu::Parser::PDF do
   let(:root) { SPECDIR.join("support/mybook") }
   before do
-    Kitabu::Parser::Html.new(root).parse
-    Kitabu::Parser::Pdf.new(root).parse
+    Kitabu::Parser::HTML.new(root).parse
+    Kitabu::Parser::PDF.new(root).parse
   end
-  it "should generate pdf file" do
+  it "generates pdf file" do
     root.join("output/mybook.pdf").should be_file
   end
 end