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,79 +1,53 @@
-# encoding: utf-8
-require File.dirname(__FILE__) + "/../spec_helper"
+# -*- encoding: utf-8 -*-
+require "spec_helper"
-HTML = <<-HTML
-  <h1>Item 1</h1>
-  <h2>Item 1.2</h2>
-  <h3>Item 1.1.3</h3>
-  <h4>Item 1.1.1.4</h4>
-  <h5>Item 1.1.1.1.5</h5>
-  <h6>Item 1.1.1.1.1.6</h6>
-  <h2>Item 2.1</h2>
-  <h2>Item 2.1 again</h2>
-  <h2>Internacionalização</h2>
-HTML
+describe Kitabu::Toc do
+  HTML = <<-HTML
+    <h1>Item 1</h1>
+    <h2>Item 1.2</h2>
+    <h3>Item 1.1.3</h3>
+    <h4>Item 1.1.1.4</h4>
+    <h5>Item 1.1.1.1.5</h5>
+    <h6>Item 1.1.1.1.1.6</h6>
-HTML.force_encoding("utf-8") if RUBY_VERSION >= '1.9'
+    <h2>Item 2.1</h2>
+    <h2>Item 2.1 again</h2>
+    <h2>Internacionalização</h2>
+  HTML
+  HTML.force_encoding("utf-8")
+  let(:toc) { Kitabu::Toc.generate(HTML) }
+  let(:html) { toc.to_html }
+  let(:content) { toc.content }
-shared_examples_for "Table of contents" do
   it "should not have body tag" do
-    @contents.should_not have_tag("body")
+    content.should_not match(/<body>/)
   end
   it "should generate toc" do
-    @toc.should have_tag("div.level2.item-1-2", "Item 1.2")
-    @toc.should have_tag("div.level3.item-1-1-3", "Item 1.1.3")
-    @toc.should have_tag("div.level4.item-1-1-1-4", "Item 1.1.1.4")
-    @toc.should have_tag("div.level5.item-1-1-1-1-5", "Item 1.1.1.1.5")
-    @toc.should have_tag("div.level6.item-1-1-1-1-1-6", "Item 1.1.1.1.1.6")
-    @toc.should have_tag("div.level2.item-2-1", "Item 2.1")
-    @toc.should have_tag("div.level2.item-2-1-again", "Item 2.1 again")
-    @toc.should have_tag("div.level2.internacionalizacao", "Internacionalização")
+    html.should have_tag("div.level2.item-1-2", "Item 1.2")
+    html.should have_tag("div.level3.item-1-1-3", "Item 1.1.3")
+    html.should have_tag("div.level4.item-1-1-1-4", "Item 1.1.1.4")
+    html.should have_tag("div.level5.item-1-1-1-1-5", "Item 1.1.1.1.5")
+    html.should have_tag("div.level6.item-1-1-1-1-1-6", "Item 1.1.1.1.1.6")
+    html.should have_tag("div.level2.item-2-1", "Item 2.1")
+    html.should have_tag("div.level2.item-2-1-again", "Item 2.1 again")
+    html.should have_tag("div.level2.internacionalizacao", "Internacionalização")
   end
   it "should add ID attribute to content" do
-    @contents.should have_tag("h2#item-1-2", "Item 1.2")
-    @contents.should have_tag("h3#item-1-1-3", "Item 1.1.3")
-    @contents.should have_tag("h4#item-1-1-1-4", "Item 1.1.1.4")
-    @contents.should have_tag("h5#item-1-1-1-1-5", "Item 1.1.1.1.5")
-    @contents.should have_tag("h6#item-1-1-1-1-1-6", "Item 1.1.1.1.1.6")
-    @contents.should have_tag("h2#item-2-1", "Item 2.1")
-    @contents.should have_tag("h2#item-2-1-again", "Item 2.1 again")
-    # the entity form is generated by nokogiri
-    @contents.should have_tag("h2#internacionalizacao", /(Internacionalização|Internacionaliza&#xE7;&#xE3;o)/)
-  end
-end
+    content.should have_tag("h2#item-1-2", "Item 1.2")
+    content.should have_tag("h3#item-1-1-3", "Item 1.1.3")
+    content.should have_tag("h4#item-1-1-1-4", "Item 1.1.1.4")
+    content.should have_tag("h5#item-1-1-1-1-5", "Item 1.1.1.1.5")
+    content.should have_tag("h6#item-1-1-1-1-1-6", "Item 1.1.1.1.1.6")
-describe "Kitabu::Base" do
-  describe "Hpricot" do
-    before(:each) do
-      Kitabu::Base.stub!(:nokogiri?).and_return(false)
-      Kitabu::Base.stub!(:hpricot?).and_return(true)
-      @contents, @toc = Kitabu::Base.table_of_contents(HTML)
-    end
-    it_should_behave_like "Table of contents"
-  end
-  describe "Nokogiri" do
-    before(:each) do
-      Kitabu::Base.stub!(:nokogiri?).and_return(true)
-      Kitabu::Base.stub!(:hpricot?).and_return(false)
-      @contents, @toc = Kitabu::Base.table_of_contents(HTML)
-    end
-    it_should_behave_like "Table of contents"
-    it "should output XHTML tags" do
-      @contents, @toc = Kitabu::Base.table_of_contents("<br/>")
-      @contents.should match(/<br *\/>/)
-    end
+    content.should have_tag("h2#item-2-1", "Item 2.1")
+    content.should have_tag("h2#item-2-1-again", "Item 2.1 again")
+    content.should have_tag("h2#internacionalizacao", "Internacionalização")
   end
 end

data/spec/kitabu_spec.rb ADDED

@@ -0,0 +1,4 @@
+require "spec_helper"
+describe Kitabu do
+end

data/spec/spec_helper.rb CHANGED

@@ -1,30 +1,26 @@
-# encoding: utf-8
-require "rubygems"
-require "spec"
-require "rspec-hpricot-matchers"
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
 require "kitabu"
+require "pathname"
+require "test_notifier/runner/rspec"
-# Do require libs that are used by the tasks.rb file
-require "kitabu/redcloth"
-require "kitabu/blackcloth"
-require "rdiscount"
-require "hpricot"
-require "nokogiri"
+SPECDIR = Pathname.new(File.dirname(__FILE__))
+TMPDIR = SPECDIR.join("tmp")
-require File.dirname(__FILE__) + "/exit_matcher"
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|r| require r}
-Spec::Runner.configure do |config|
-  config.include(HpricotSpec::Matchers)
-  config.include(ExitMatcher)
-end
+RSpec.configure do |config|
+  config.include(SpecHelper)
+  config.include(Matchers)
-def reset_env!
-  ENV["KITABU_ROOT"] = File.dirname(__FILE__) + "/fixtures/rails-guides"
-  ENV["KITABU_NAME"] = File.basename(ENV["KITABU_ROOT"])
-  ENV.delete("NO_SYNTAX_HIGHLIGHT")
-end
+  config.around do
+    [
+      TMPDIR,
+      SPECDIR.join("support/mybook/output/mybook.pdf"),
+      SPECDIR.join("support/mybook/output/mybook.epub"),
+      SPECDIR.join("support/mybook/output/mybook.html")
+    ].each do |i|
+      FileUtils.rm_rf(i) if File.exist?(i)
+    end
+  end
-alias :doing :lambda
+  config.before { FileUtils.mkdir_p(TMPDIR) }
+end

data/spec/support/exit_with_code.rb ADDED

@@ -0,0 +1,26 @@
+RSpec::Matchers.define :exit_with_code do |code|
+  actual = nil
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual && actual == code
+  end
+  failure_message_for_should do |block|
+    "expected block to call exit(#{code}) but exit" +
+    (actual ? "(#{actual}) was called" : " not called")
+  end
+  failure_message_for_should_not do |block|
+    "expected block not to call exit(#{code})"
+  end
+  description do
+    "expect block to call exit(#{code})"
+  end
+end

data/spec/support/have_tag.rb ADDED

@@ -0,0 +1,115 @@
+module Matchers
+  def have_tag(selector, options = {}, &block)
+    HaveTag.new(:html, selector, options, &block)
+  end
+  def have_node(selector, options = {}, &block)
+    HaveTag.new(:xml, selector, options, &block)
+  end
+  class HaveTag
+    attr_reader :options, :selector, :actual, :actual_count, :doc, :type
+    def initialize(type, selector, options = {}, &block)
+      @selector = selector
+      @type = type
+      case options
+      when Hash
+        @options = options
+      when Numeric
+        @options = {:count => options}
+      else
+        @options = {:text => options}
+      end
+    end
+    def doc_for(input)
+      engine = type == :xml ? Nokogiri::XML : Nokogiri::HTML
+      if input.respond_to?(:body)
+        engine.parse(input.body.to_s)
+      elsif Nokogiri::XML::Element === input
+        input
+      else
+        engine.parse(input.to_s)
+      end
+    end
+    def matches?(actual, &block)
+      @actual = actual
+      @doc = doc_for(actual)
+      matches = doc.css(selector)
+      return options[:count] == 0 if matches.empty?
+      matches = filter_on_inner_text(matches) if options[:text]
+      matches = filter_on_nested_expectations(matches, block) if block
+      @actual_count = matches.size
+      return false if not acceptable_count?(actual_count)
+      !matches.empty?
+    end
+    def description
+      "have tag #{selector.inspect} with #{options.inspect}"
+    end
+    def failure_message
+      explanation = actual_count ? "but found #{actual_count}" : "but did not"
+      "expected\n#{doc.to_s}\nto have #{failure_count_phrase} #{failure_selector_phrase}, #{explanation}"
+    end
+    def negative_failure_message
+      explanation = actual_count ? "but found #{actual_count}" : "but did"
+      "expected\n#{doc.to_s}\nnot to have #{failure_count_phrase} #{failure_selector_phrase}, #{explanation}"
+    end
+    private
+    def filter_on_inner_text(elements)
+      elements.select do |el|
+        next(el.inner_text =~ options[:text]) if options[:text].is_a?(Regexp)
+        el.inner_text == options[:text]
+      end
+    end
+    def filter_on_nested_expectations(elements, block)
+      elements.select do |el|
+        begin
+          block[el]
+        rescue RSpec::Expectations::ExpectationNotMetError
+          false
+        else
+          true
+        end
+      end
+    end
+    def acceptable_count?(count)
+      return false unless options[:count] === count if options[:count]
+      return false unless count >= options[:minimum] if options[:minimum]
+      return false unless count <= options[:maximum] if options[:maximum]
+      true
+    end
+    def failure_count_phrase
+      if options[:count]
+        "#{options[:count]} elements matching"
+      elsif options[:minimum] || options[:maximum]
+        count_explanations = []
+        count_explanations << "at least #{options[:minimum]}" if options[:minimum]
+        count_explanations << "at most #{options[:maximum]}"  if options[:maximum]
+        "#{count_explanations.join(' and ')} elements matching"
+      else
+        "an element matching"
+      end
+    end
+    def failure_selector_phrase
+      phrase = selector.inspect
+      phrase << (options[:text] ? " with inner text #{options[:text].inspect}" : "")
+    end
+  end
+end

data/spec/support/helper.rb ADDED

@@ -0,0 +1,18 @@
+module SpecHelper
+  def tmpdir
+    TMPDIR
+  end
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+    result
+  end
+end

data/spec/support/mybook/.gitignore ADDED

	@@ -0,0 +1 @@
1	+ output/*.{html,epub,pdf}

data/spec/support/mybook/code/.gitkeep ADDED

File without changes

data/spec/support/mybook/code/code.rb ADDED

@@ -0,0 +1,13 @@
+class HelloWorld
+  # @begin: method
+  def self.say
+    "Hello World"
+  end
+  # @end: method
+  # @begin: another_method
+  def self.shout
+    "HELLO WORLD"
+  end
+  # @end: another_method
+end

data/spec/support/mybook/config/helper.rb ADDED

@@ -0,0 +1,29 @@
+# Put any Ruby code in here.
+# Here's an example on how you can extend RedCloth (Textile) with new formatters.
+#
+#   module RedCloth
+#     module Formatters
+#       module HTML
+#         def attention(options)
+#           %[<p class="attention">#{options[:text]}</p>]
+#         end
+#       end
+#     end
+#   end
+#
+# Then you can just use `attention. This is an important note!` on your text.
+#
+# You can add inline formatters as well. The approach is slightly different,
+# but pretty straightforward.
+#
+# Add your formatter to `RedCloth::INLINE_FORMATTERS` and implement the method, making sure that it
+# replaces the content using `String#gsub!`.
+#
+#   module RedCloth
+#     def my_formatter(text)
+#       text.gsub!(/Hello/, "Hi")
+#     end
+#   end
+#
+#   RedCloth::INLINE_FORMATTERS << :my_formatter
+#

data/spec/support/mybook/config/kitabu.yml ADDED

@@ -0,0 +1,59 @@
+# The book's title. Will be used everywhere!
+title: "Testing Kitabu"
+# The book's language.
+language: "pt-BR"
+# Your book copyright info.
+# Here's some examples:
+#
+#   Copyright 2010 by John Doe.
+#   Copyright 2010 by John Doe. This work is licensed under MIT License.
+#   This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
+#   This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+#   This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
+#
+copyright: "Copyright (C) 2010 John Doe."
+# Who's publishing this book.
+publisher: "John Doe"
+# When this book was published.
+published_at: "2010-12-19"
+# Some book description.
+subject: "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
+# Some keywords that identify this book.
+keywords: "demo, book, pdf, epub, kitabu, textile, html, markdown"
+# Some unique identification. Works great with your domain
+# like `http://yourbook.example.com`.
+uid: "MFXx9nj7uz"
+# Your book identification like ISBN or ISSN.
+identifier:
+  id: "http://kitabu.example.com.br"
+  type: "URL" # can be ISBN, ISSN or URL
+# This book's authors.
+authors:
+  - "John Doe"
+  - "Mary Doe"
+# The theme that will be used for source
+# code syntax highlighting.
+theme: idle
+# The base URL from your source code.
+base_url: http://example.com
+# You can rename your text structure automatically.
+# All you have to do is using a list will all your chapters and
+# then you can run `kitabu rearrange`.
+structure:
+  - Markdown_Chapter.markdown
+  - Textile_Chapter.textile
+  - HTML_Chapter.html
+  - With_Directory
+    - Some_Chapter.mkdn