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

kitabu 0.4.7 → 1.0.0.rc1

Files changed (544) hide show

@@ -1,51 +1,80 @@
-# encoding: utf-8
 module Kitabu
   class Toc
-    include REXML::StreamListener
+    # Return the table of contents in hash format.
+    #
+    attr_reader :toc
-    def initialize
-      @toc = ""
-      @previous_level = 0
-      @tag = nil
-      @stack = []
-    end
+    private_class_method :new
+    attr_reader :buffer # :nodoc:
+    attr_reader :attrs # :nodoc:
+    attr_accessor :content # :nodoc:
-    def header?(tag=nil)
-      tag ||= @tag_name
-      return false unless tag.to_s =~ /h[2-6]/
-      @tag_name = tag
-      return true
-    end
+    # 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?
-    def in_header?
-      @in_header
+      _, content = *html.match(/<body>(.*?)<\/body>/m)
+      content
     end
-    def tag_start(name, attrs)
-      @tag_name = name
-      return unless header?(name)
-      @in_header = true
-      @current_level = name.gsub!(/[^2-6]/, '').to_i
-      @stack << @current_level
-      @id = attrs["id"]
+    # 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 tag_end(name)
-      return unless header?(name)
-      @in_header = false
-      @previous_level = @current_level
+    def initialize # :nodoc:
+      @toc = []
+      @counters = {}
     end
-    def text(str)
-      return unless in_header?
-      @toc << %(<div class="level#{@current_level} #{@id}"><a href="##{@id}"><span>#{str}</span></a></div>)
+    def tag(node) # :nodoc:
+      toc << {
+        :level     => node.name.gsub(/[^\d]/, "").to_i,
+        :text      => node.text,
+        :permalink => node["id"]
+      }
     end
-    def method_missing(*args)
+    # Return a hash with all normalized attributes.
+    #
+    def to_hash
+      {
+        :content => content,
+        :html => to_html,
+        :toc => toc
+      }
     end
-    def to_s
-      @toc
+    # 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

data/lib/kitabu/version.rb ADDED

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

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

@@ -0,0 +1,17 @@
+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
+      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
+      expect {
+        capture(:stderr){ Kitabu::Cli.start(["export"]) }
+      }.to exit_with_code(1)
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require "spec_helper"
+describe Kitabu::Cli do
+  context "while running new" do
+    context "when all params are valid" do
+      before do
+        capture(:stdout){ Kitabu::Cli.start(["new", tmpdir.join("mybook").to_s]) }
+      end
+      it_behaves_like "e-book"
+    end
+    it "should exit with status 1 when no path is provided" do
+      expect {
+        capture(:stderr){ Kitabu::Cli.start(["new"]) }
+      }.to exit_with_code(1)
+      File.should_not be_directory(tmpdir.join("mybook"))
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,52 @@
+require "spec_helper"
+describe RedCloth do
+  describe "#figure" do
+    it "should render 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']")
+        p.should have_tag("span.caption", "The Rails logo")
+      end
+    end
+  end
+  describe "#note" do
+    it "should render 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
+      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
+      Kitabu.stub :config => { :base_url => "http://example.com" }
+      html = RedCloth.convert("file. app/models/users.rb")
+      html.should have_tag("p.file") do |p|
+        p.should have_tag("a[@href='http://example.com/app/models/users.rb']", "app/models/users.rb")
+      end
+    end
+  end
+  context "custom footnote helper" do
+    it "should render 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
+      html = RedCloth.convert("<http://example.com>")
+      html.should == %[<p><a href="http://example.com">http://example.com</a></p>]
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require "spec_helper"
+describe String do
+  describe "#to_permalink" do
+    it "should normalize 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',
+        'āčēģīķļņū' => 'acegiklnu',
+        '中文測試 chinese text' => 'chinese-text',
+        'some-)()()-ExtRa!/// .data==?>    to \/\/test' => 'some-extra-data-to-test',
+        'http://simplesideias.com.br/tags/' => 'http-simplesideias-com-br-tags',
+        "Don't Repeat Yourself (DRY)" => 'don-t-repeat-yourself-dry',
+        "Text\nwith\nline\n\n\tbreaks" => 'text-with-line-breaks'
+      }.each do |dirty, normalized|
+        dirty.to_permalink.should == normalized
+      end
+    end
+  end
+end

data/spec/kitabu/generator_spec.rb ADDED

@@ -0,0 +1,10 @@
+require "spec_helper"
+describe Kitabu::Generator do
+  before do
+    subject.destination_root = tmpdir.join("mybook")
+    capture(:stdout){ subject.invoke_all }
+  end
+  it_behaves_like "e-book"
+end

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

@@ -0,0 +1,10 @@
+require "spec_helper"
+describe Kitabu::Parser::Epub do
+  let(:root) { SPECDIR.join("support/mybook") }
+  it "should generate e-pub" do
+    Kitabu::Parser::Epub.parse(root)
+    root.join("output/mybook.epub").should be_file
+  end
+end

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

@@ -0,0 +1,75 @@
+require "spec_helper"
+describe Kitabu::Parser::Html do
+  let(:root) { SPECDIR.join("support/mybook") }
+  let(:source) { root.join("text") }
+  let(:parser) { Kitabu::Parser::Html.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
+      relative.should_not include(".")
+      relative.should_not include("..")
+    end
+    it "should skip dot files" do
+      relative.should_not include(".gitkeep")
+    end
+    it "should skip files that start with underscore" do
+      relative.should_not include("_00_Introduction.markdown")
+    end
+    it "should skip other files" do
+      relative.should_not include("CHANGELOG.textile")
+      relative.should_not include("TOC.textile")
+    end
+    it "should return only first-level entries" do
+      relative.should_not include("04_With_Directory/Some_Chapter.mkdn")
+    end
+    it "should return entries" do
+      relative.first.should == "01_Markdown_Chapter.markdown"
+      relative.second.should == "02_Textile_Chapter.textile"
+      relative.third.should == "03_HTML_Chapter.html"
+      relative.fourth.should == "04_With_Directory"
+      relative.fifth.should 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 "should have several chapters" do
+      html.should have_tag("div.chapter", 4)
+    end
+    it "should render .markdown" do
+      html.should have_tag("div.chapter > h2#markdown", "Markdown")
+    end
+    it "should render .mkdn" do
+      html.should have_tag("div.chapter > h2#some-chapter", "Some Chapter")
+    end
+    it "should render .textile" do
+      html.should have_tag("div.chapter > h2#textile", "Textile")
+    end
+    it "should render .html" do
+      html.should have_tag("div.chapter > h2#html", "HTML")
+    end
+    it "should have use config file" do
+      html.should have_tag("div.imprint p", "Copyright (C) 2010 John Doe.")
+    end
+    it "should render changelog" do
+      html.should have_tag("div.changelog h2", "Revisions")
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require "spec_helper"
+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
+  end
+  it "should generate pdf file" do
+    root.join("output/mybook.pdf").should be_file
+  end
+end

data/spec/kitabu/syntax_spec.rb CHANGED

@@ -1,90 +1,94 @@
-# encoding: utf-8
-require File.dirname(__FILE__) + "/../spec_helper"
+# -*- encoding: utf-8 -*-
+require "spec_helper"
-INLINE = '
-    syntax(ruby). class Sample
-      def hello(name)
-        puts "hi, #{name}"
-      end
-    end
-'
+describe Kitabu::Syntax do
+  INLINE = <<-CODE
+    @@@ ruby
+  	class Sample
+  	  def hello(name)
+  	    puts "hi, #{name}"
+  	  end
+  	end
+  	@@@
+	CODE
-describe "Kitabu::Syntax" do
-  before(:each) do
-    reset_env!
-  end
-  describe "Inline" do
-    it "should return code for textile" do
-      markup = BlackCloth.new(INLINE)
-      html = Kitabu::Syntax.process(markup.to_html, markup)
+	let(:root) { SPECDIR.join("support/mybook") }
-      html.should have_tag("pre.idle.ruby")
-    end
+	it "should render inline code" do
+	  content = Kitabu::Syntax.render(root, :markdown, INLINE)
+	  content.should have_tag("pre", 1)
+	  Nokogiri::HTML(content).text.should match(/class Sample/)
+	end
-    it "should return code for markdown" do
-      markup = RDiscount.new(INLINE)
-      html = Kitabu::Syntax.process(markup.to_html, markup)
+	it "should render line range" do
+	  content = Kitabu::Syntax.render(root, :markdown, "@@@ ruby code.rb:3,5 @@@")
+	  content.should have_tag("pre", 1)
+	  html = Nokogiri::HTML(content)
+	  html.text.should_not match(/class HelloWorld/)
+	  html.text.should match(/def self\.say/)
+	end
-      html.should have_tag("pre.idle.ruby")
-    end
-  end
-  describe "File" do
-    it "should return code for textile" do
-      markup = BlackCloth.new("syntax(ruby). sample.rb")
-      html = Kitabu::Syntax.process(markup.to_html, markup)
+	it "should render first block by its name" do
+	  content = Kitabu::Syntax.render(root, :markdown, "@@@ ruby code.rb#method @@@")
+	  content.should have_tag("pre", 1)
+	  html = Nokogiri::HTML(content)
+	  html.text.should_not match(/class HelloWorld/)
+	  html.text.should_not match(/def self\.shout/)
+	  html.text.should match(/def self\.say/)
+	end
-      html.should have_tag("pre.idle.ruby")
-      Hpricot(html).inner_text.should match(/class Sample/)
-    end
+	it "should render second block by its name" do
+	  content = Kitabu::Syntax.render(root, :markdown, "@@@ ruby code.rb#another_method @@@")
+	  content.should have_tag("pre", 1)
+	  html = Nokogiri::HTML(content)
+	  html.text.should_not match(/class HelloWorld/)
+	  html.text.should_not match(/def self\.say/)
+	  html.text.should match(/def self\.shout/)
+	end
-    it "should return code for markdown" do
-      markup = RDiscount.new("\tsyntax(ruby). sample.rb")
-      html = Kitabu::Syntax.process(markup.to_html, markup)
+	it "should render missing block message" do
+	  content = Kitabu::Syntax.render(root, :markdown, "@@@ ruby code.rb#invalid @@@")
+	  content.should have_tag("pre", 1)
+	  html = Nokogiri::HTML(content)
+	  html.text.should_not match(/class HelloWorld/)
+	  html.text.should_not match(/def self\.say/)
+	  html.text.should_not match(/def self\.shout/)
+	  html.text.should match(/\[missing 'invalid' block name\]/)
+	end
-      html.should have_tag("pre.idle.ruby")
-      Hpricot(html).inner_text.should match(/class Sample/)
-    end
-  end
-  describe "Named block" do
-    it "should return code for textile" do
-      markup = BlackCloth.new("syntax(ruby#method). sample.rb")
-      html = Kitabu::Syntax.process(markup.to_html, markup)
+	it "should render missing file message" do
+	  content = Kitabu::Syntax.render(root, :markdown, "@@@ ruby invalid.rb @@@")
+	  content.should have_tag("pre", 1)
+	  html = Nokogiri::HTML(content)
+	  html.text.should_not match(/class HelloWorld/)
+	  html.text.should_not match(/def self\.say/)
+	  html.text.should_not match(/def self\.shout/)
+	  html.text.should match(/\[missing 'code\/invalid.rb' file\]/)
+	end
-      html.should have_tag("pre.idle.ruby")
-      Hpricot(html).inner_text.should_not match(/class Sample/)
-      Hpricot(html).inner_text.should match(/def hello/)
-    end
+	it "should render file" do
+	  content = Kitabu::Syntax.render(root, :markdown, "@@@ ruby code.rb @@@")
+	  html = Nokogiri::HTML(content)
+	  html.text.should match(/class HelloWorld/)
+	  html.text.should match(/def self\.say/)
+	end
-    it "should return code for markdown" do
-      markup = RDiscount.new("\tsyntax(ruby#method). sample.rb")
-      html = Kitabu::Syntax.process(markup.to_html, markup)
+	it "should add highlight class" do
+	  Kitabu::Syntax.render(root, :markdown, "@@@ ruby code.rb @@@").should have_tag("div.highlight", 1)
+	end
-      html.should have_tag("pre.idle.ruby")
-      Hpricot(html).inner_text.should_not match(/class Sample/)
-      Hpricot(html).inner_text.should match(/def hello/)
-    end
-  end
-  describe "Line range" do
-    it "should return code for textile" do
-      markup = BlackCloth.new("syntax(ruby 3,5). sample.rb")
-      html = Kitabu::Syntax.process(markup.to_html, markup)
+	it "should wrap code in pre tag" do
+	  Kitabu::Syntax.render(root, :markdown, "@@@ ruby code.rb @@@").should have_tag("pre", 1)
+	end
-      html.should have_tag("pre.idle.ruby")
-      Hpricot(html).inner_text.should_not match(/class Sample/)
-      Hpricot(html).inner_text.should match(/def hello/)
-    end
+	it "should wrap code in notextile tag" do
+  	Kitabu::Syntax.render(root, :textile, "@@@ ruby code.rb @@@").should have_tag("notextile", 1)
+	end
-    it "should return code for markdown" do
-      markup = BlackCloth.new("syntax(ruby 3,5). sample.rb")
-      html = Kitabu::Syntax.process(markup.to_html, markup)
-      html.should have_tag("pre.idle.ruby")
-      Hpricot(html).inner_text.should_not match(/class Sample/)
-      Hpricot(html).inner_text.should match(/def hello/)
-    end
-  end
+	it "should remove block annotations" do
+    content = Kitabu::Syntax.render(root, :markdown, "@@@ ruby code.rb @@@")
+	  html = Nokogiri::HTML(content)
+	  html.text.should_not match(/@begin/)
+	  html.text.should_not match(/@end/)
+	end
 end