kitabu 0.4.5

data/spec/exit_matcher.rb

@@ -0,0 +1,45 @@
+module ExitMatcher
+  class ExitWithStatus
+    attr_reader :expected
+    attr_reader :actual
+    
+    def initialize(expected)
+      @expected = expected
+    end
+    
+    def matches?(given_proc)
+      status = nil
+      
+      begin
+        given_proc.call
+      rescue SystemExit
+        status = $!.status
+      end
+      
+      @actual = status
+      
+      @actual == @expected
+    end
+    
+    def failure_message_for_should
+      if actual.nil?
+        "expected block to exit with #{expected.inspect} status, but didn't exit"
+      else
+        "expected block to exit with #{expected.inspect} status, but did it with #{actual.inspect}"
+      end
+    end
+    
+    def failure_message_for_should_not
+      "expected block to not exit with #{actual.inspect} status, but did it"
+    end
+    
+    private
+      def negative_expectation?
+        caller.first(3).find { |s| s =~ /should_not/ }
+      end
+  end
+  
+  def exit_with(expected)
+    ExitWithStatus.new(expected)
+  end
+end

data/spec/fixtures/rails-guides/code/sample.rb

@@ -0,0 +1,7 @@
+class Sample
+  # begin: method
+  def hello(name)
+    "hi, #{name}!"
+  end
+  # end: method
+end

data/spec/kitabu/base_spec.rb

@@ -0,0 +1,159 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe "Kitabu::Base" do
+  before(:each) do
+    reset_env!
+  end
+  
+  describe "Defaults" do
+    it "should be a valid theme" do
+      Kitabu::Base.should be_theme(Kitabu::Base::DEFAULT_THEME)
+    end
+    
+    it "should be a valid layout" do
+      Kitabu::Base.should be_layout(Kitabu::Base::DEFAULT_LAYOUT)
+    end
+  end
+  
+  describe "Paths" do
+    it "should return PDF path" do
+      Kitabu::Base.pdf_path.should == File.join(Kitabu::Base.root_path, "output", "rails-guides.pdf")
+    end
+    
+    it "should return HTML path" do
+      Kitabu::Base.html_path.should == File.join(Kitabu::Base.root_path, "output", "rails-guides.html")
+    end
+    
+    it "should return layout template path" do
+      Kitabu::Base.template_path.should == File.join(Kitabu::Base.root_path, "templates", "layout.html")
+    end
+    
+    it "should return config path" do
+      Kitabu::Base.config_path.should == File.join(Kitabu::Base.root_path, "config.yml")
+    end
+    
+    it "should return text directory" do
+      Kitabu::Base.text_dir.should == File.join(Kitabu::Base.root_path, "text")
+    end
+  end
+  
+  describe "Configuration" do
+    it "should load configuration file" do
+      YAML.should_receive(:load_file).with(Kitabu::Base.config_path)
+      Kitabu::Base.config
+    end
+  end
+  
+  describe "Helpers" do
+    it "should return app name" do
+      Kitabu::Base.app_name.should == "rails-guides"
+    end
+    
+    it "should return default app name" do
+      ENV["KITABU_NAME"] = nil
+      Kitabu::Base.app_name.should == "kitabu"
+    end
+    
+    it "should return permalink" do
+      Kitabu::Base.to_permalink("Internacionalização no Ruby on Rails").should == "internacionalizacao-no-ruby-on-rails"
+    end
+    
+    it "should return layout list" do
+      Kitabu::Base.layouts.should == %w(boom)
+    end
+    
+    it "should return theme list" do
+      Kitabu::Base.themes.should == %w(active4d blackboard dawn eiffel idle iplastic lazy mac_classic slush_poppies sunburst)
+    end
+    
+    it "should return syntax list" do
+      Kitabu::Base.syntaxes.should == Uv.syntaxes
+    end
+  end
+  
+  describe "Markdown processors" do
+    it "should return default processor" do
+      Kitabu::Base.stub!(:config).and_return({})
+      Kitabu::Base.markdown_processor_class.should == ::RDiscount
+    end
+    
+    it "should return maruku processor" do
+      ::Maruku = mock("Maruku")
+      Kitabu::Base.stub!(:config).and_return("markdown" => "maruku")
+      Kitabu::Base.markdown_processor_class.should == ::Maruku
+    end
+    
+    it "should return bluecloth processor" do
+      ::BlueCloth = mock("BlueCloth")
+      Kitabu::Base.stub!(:config).and_return("markdown" => "bluecloth")
+      Kitabu::Base.markdown_processor_class.should == ::BlueCloth
+    end
+    
+    it "should return bluecloth processor" do
+      ::PEGMarkdown = mock("PEGMarkdown")
+      Kitabu::Base.stub!(:config).and_return("markdown" => "peg_markdown")
+      Kitabu::Base.markdown_processor_class.should == ::PEGMarkdown
+    end
+  end
+  
+  describe "PDF generation" do
+    it "should execute command and close connection" do
+      cmd = "prince %s -o %s" % [Kitabu::Base.html_path, Kitabu::Base.pdf_path]
+      io = mock("IO")
+      
+      io.should_receive(:close)
+      IO.should_receive(:popen).with(cmd).and_return(io)
+      
+      Kitabu::Base.generate_pdf
+    end
+  end
+  
+  describe "HTML generation" do
+    before(:each) do
+      FileUtils.rm_rf(Kitabu::Base.root_path + "/output")
+      ENV["KITABU_NAME"] = File.basename(Kitabu::Base.root_path)
+      
+      Kitabu::Base.generate_html
+      @html = File.read(Kitabu::Base.html_path)
+    end
+    
+    it "should generate file" do
+      File.should be_file(Kitabu::Base.html_path)
+    end
+    
+    it "should set TOC" do
+      @html.should have_tag("#table-of-contents div.level2")
+    end
+    
+    it "should set meta tags" do
+      @html.should have_tag(%(meta[@name=author])) do |tag|
+        tag["content"].should == "The Ruby on Rails community"
+      end
+      
+      @html.should have_tag(%(meta[@name=subject])) do |tag|
+        tag["content"].should == "These guides are designed to make you immediately productive with Rails, and to help you understand how all of the pieces fit together."
+      end
+      
+      @html.should have_tag(%(meta[@name=keywords])) do |tag|
+        tag["content"].should == "ruby, ruby on rails, documentation"
+      end
+    end
+    
+    it "should set title" do
+      @html.should have_tag("#cover h1", "Rails Guides")
+    end
+    
+    it "should separate text into chapters" do
+      @html.should have_tag("div.chapter", :count => 3)
+    end
+    
+    it "should parse textile files" do
+      @html.should have_tag("div.chapter h2#introduction", "Introduction")
+    end
+    
+    it "should parse markdown files" do
+      @html.should have_tag("div.chapter h2#rails-internationalization-i18n-api", "Rails Internationalization (I18n) API")
+    end
+  end
+end

data/spec/kitabu/blackcloth_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe "BlackCloth" do
+  it "should parse figure tag" do
+    @html = BlackCloth.new("figure(The Rails logo). rails.png").to_html
+    @html.should have_tag("p.figure") do |p|
+      p.should have_tag("img[@src=../images/rails.png][@style='width: 87px; height: 111px'][@alt='The Rails logo']")
+      p.should have_tag("span.caption", "The Rails logo")
+    end
+  end
+  
+  it "should parse note tag" do
+    @html = BlackCloth.new("note. Some important note!").to_html
+    @html.should have_tag("p.note", "Some important note!")
+  end
+  
+  it "should link to file" do
+    Kitabu::Base.should_receive(:config).and_return("base_url" => "http://example.com")
+    @html = BlackCloth.new("file. app/models/users.rb").to_html
+    
+    @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
+  
+  it "should create footnote" do
+    @html = BlackCloth.new("Writing some text with a footnote %{this is a footnote}").to_html
+    @html.should == %(<p>Writing some text with a footnote<span class="footnote">this is a footnote</span></p>)
+  end
+  
+  it "should link url" do
+    @html = BlackCloth.new("<http://example.com>").to_html
+    @html.should == %(<a href="http://example.com">http://example.com</a>)
+  end
+end

data/spec/kitabu/bug_fix_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe "Bug Fix" do
+  describe "Issue #3" do
+    before(:each) do
+      ENV["KITABU_ROOT"] = File.dirname(__FILE__) + "/../fixtures/wikipedia"
+      ENV["KITABU_NAME"] = "wikipedia"
+    end
+    
+    it "should generate HTML when syntax highlight is disabled" do
+      ENV["NO_SYNTAX_HIGHLIGHT"] = "1"
+      Kitabu::Base.generate_html
+      @html = File.read(Kitabu::Base.root_path + "/output/wikipedia.html")
+      @html.should have_tag("h2", :count => 2)
+    end
+    
+    it "should generate HTML when syntax highlight is disabled" do
+      ENV.delete("NO_SYNTAX_HIGHLIGHT")
+      Kitabu::Base.generate_html
+      @html = File.read(Kitabu::Base.root_path + "/output/wikipedia.html")
+      @html.should have_tag("h2", :count => 2)
+    end
+  end
+end

data/spec/kitabu/command_spec.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + "/../spec_helper"
+require "kitabu/command"
+
+OUTPUT = []
+
+module Kitabu
+  module Command
+    extend self
+    
+    def output(*args)
+      args.each {|v| OUTPUT << v}
+    end
+  end
+end
+
+describe "Kitabu::Command" do
+  before(:each) do
+    @dir = "/tmp/kitabu-sample"
+    
+    OUTPUT.delete_if { true }
+    ARGV.delete_if { true }
+    FileUtils.rm_rf(@dir)
+  end
+  
+  it "should copy templates" do
+    run_with(@dir)
+
+    File.should be_file(@dir + "/Rakefile")
+    File.should be_file(@dir + "/config.yml")
+    File.should be_file(@dir + "/templates/layout.css")
+    File.should be_file(@dir + "/templates/layout.html")
+    File.should be_file(@dir + "/templates/syntax.css")
+    File.should be_file(@dir + "/templates/user.css")
+    
+    File.should be_directory(@dir + "/text")
+    File.should be_directory(@dir + "/output")
+  end
+  
+  it "should display help when no arg is provided" do
+    doing {
+      run_with
+    }.should exit_with(0)
+    
+    OUTPUT.first.should == KITABU_HELP
+  end
+  
+  it "should require valid layout" do
+    doing {
+      run_with @dir, "-l", "invalid"
+    }.should exit_with(1)
+    
+    OUTPUT.first.should == "Invalid layout"
+  end
+  
+  it "should accept valid layout" do
+    run_with @dir, "-l", "boom"
+    
+    File.should be_file(@dir + "/templates/layout.css")
+    File.should be_file(@dir + "/templates/layout.html")
+  end
+  
+  it "should exit on existing path" do
+    run_with @dir
+    
+    doing {
+      run_with @dir
+    }.should exit_with(1)
+    
+    OUTPUT.first.should == "Output path already exists"
+  end
+  
+  private
+    def argv!(*args)
+      args.each {|v| ARGV << v }
+    end
+    
+    def run_with(*args)
+      argv!(*args)
+      Kitabu::Command.run!
+    end
+end

data/spec/kitabu/syntax_spec.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + "/../spec_helper"
+
+INLINE = '
+    syntax(ruby). class Sample
+      def hello(name)
+        puts "hi, #{name}"
+      end
+    end
+'
+
+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)
+
+      html.should have_tag("pre.idle.ruby")
+    end
+
+    it "should return code for markdown" do
+      markup = RDiscount.new(INLINE)
+      html = Kitabu::Syntax.process(markup.to_html, markup)
+
+      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)
+
+      html.should have_tag("pre.idle.ruby")
+      Hpricot(html).inner_text.should match(/class Sample/)
+    end
+
+    it "should return code for markdown" do
+      markup = RDiscount.new("\tsyntax(ruby). sample.rb")
+      html = Kitabu::Syntax.process(markup.to_html, markup)
+
+      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)
+
+      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 return code for markdown" do
+      markup = RDiscount.new("\tsyntax(ruby#method). 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
+  
+  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)
+
+      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 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
+end