asciidoctor 0.0.5 → 0.0.6

data/test/paragraphs_test.rb

@@ -18,10 +18,25 @@ context "Paragraphs" do
   end
 
   context "code" do
-    test "literal paragraph" do
+    test "single-line literal paragraphs" do
+      output = render_string("    LITERALS\n\n    ARE LITERALLY\n\n    AWESOMMMME.")
       assert_xpath "//pre/tt", render_string("    LITERALS\n\n    ARE LITERALLY\n\n    AWESOMMMME.")
     end
 
+    test "multi-line literal paragraph" do
+      input = <<-EOS
+Install instructions:
+
+ yum install ruby rubygems
+ gem install asciidoctor
+
+You're good to go!
+      EOS
+      output = render_string(input)
+      assert_xpath "//pre/tt", output, 1
+      assert_match /^gem install asciidoctor/, output, "Indentation should be trimmed from literal block"
+    end
+
     test "listing paragraph" do
       assert_xpath "//div[@class='highlight']", render_string("----\nblah blah blah\n----")
     end
@@ -31,13 +46,98 @@ context "Paragraphs" do
     end
   end
 
+  context "quote" do
+    test "quote block" do
+      output = render_string("____\nFamous quote.\n____")
+      assert_xpath '//*[@class = "quoteblock"]', output, 1
+      assert_xpath '//*[@class = "quoteblock"]//p[text() = "Famous quote."]', output, 1
+    end
+
+    test "quote block with attribution" do
+      output = render_string("[quote, A famous person, A famous book]\n____\nFamous quote.\n____")
+      assert_xpath '//*[@class = "quoteblock"]', output, 1
+      assert_xpath '//*[@class = "quoteblock"]/*[@class = "attribution"]', output, 1
+      assert_xpath '//*[@class = "quoteblock"]/*[@class = "attribution"]/em[text() = "A famous book"]', output, 1
+      # TODO I can't seem to match the attribution (author) w/ xpath
+    end
+
+    test "quote block with section body" do
+      output = render_string("____\nFamous quote.\n\nNOTE: That was inspiring.\n____")
+      assert_xpath '//*[@class = "quoteblock"]', output, 1
+      assert_xpath '//*[@class = "quoteblock"]//*[@class = "admonitionblock"]', output, 1
+    end
+
+    test "single-line quote paragraph" do
+      output = render_string("[quote]\nFamous quote.")
+      assert_xpath '//*[@class = "quoteblock"]', output, 1
+      assert_xpath '//*[@class = "quoteblock"]//p', output, 0
+      assert_xpath '//*[@class = "quoteblock"]//*[contains(text(), "Famous quote.")]', output, 1
+    end
+
+    test "verse paragraph" do
+      output = render_string("[verse]\nFamous verse.")
+      assert_xpath '//*[@class = "verseblock"]', output, 1
+      assert_xpath '//*[@class = "verseblock"]/pre', output, 1
+      assert_xpath '//*[@class = "verseblock"]//p', output, 0
+      assert_xpath '//*[@class = "verseblock"]/pre[normalize-space(text()) = "Famous verse."]', output, 1
+    end
+
+    test "single-line verse block" do
+      output = render_string("[verse]\n____\nFamous verse.\n____")
+      assert_xpath '//*[@class = "verseblock"]', output, 1
+      assert_xpath '//*[@class = "verseblock"]/pre', output, 1
+      assert_xpath '//*[@class = "verseblock"]//p', output, 0
+      assert_xpath '//*[@class = "verseblock"]/pre[normalize-space(text()) = "Famous verse."]', output, 1
+    end
+
+    test "multi-line verse block" do
+      output = render_string("[verse]\n____\nFamous verse.\n\nStanza two.\n____")
+      assert_xpath '//*[@class = "verseblock"]', output, 1
+      assert_xpath '//*[@class = "verseblock"]/pre', output, 1
+      assert_xpath '//*[@class = "verseblock"]//p', output, 0
+      assert_xpath '//*[@class = "verseblock"]/pre[contains(text(), "Famous verse.")]', output, 1
+      assert_xpath '//*[@class = "verseblock"]/pre[contains(text(), "Stanza two.")]', output, 1
+    end
+
+    test "verse block does not contain block elements" do
+      output = render_string("[verse]\n____\nFamous verse.\n\n....\nnot a literal\n....\n____")
+      assert_xpath '//*[@class = "verseblock"]', output, 1
+      assert_xpath '//*[@class = "verseblock"]/pre', output, 1
+      assert_xpath '//*[@class = "verseblock"]//p', output, 0
+      assert_xpath '//*[@class = "verseblock"]//*[@class = "literalblock"]', output, 0
+    end
+  end
+
   context "special" do
     test "note multiline syntax" do
-      assert_xpath "//div[@class='admonitionblock']", render_string("[NOTE]\nThis is a winner.")
+      Asciidoctor::ADMONITION_STYLES.each do |style|
+        assert_xpath "//div[@class='admonitionblock']", render_string("[#{style}]\nThis is a winner.")
+      end
+    end
+
+    test "note block syntax" do
+      Asciidoctor::ADMONITION_STYLES.each do |style|
+        assert_xpath "//div[@class='admonitionblock']", render_string("[#{style}]\n====\nThis is a winner.\n====")
+      end
     end
 
     test "note inline syntax" do
-      assert_xpath "//div[@class='admonitionblock']", render_string("NOTE: This is important, fool!")
+      Asciidoctor::ADMONITION_STYLES.each do |style|
+        assert_xpath "//div[@class='admonitionblock']", render_string("#{style}: This is important, fool!")
+      end
+    end
+
+    test "sidebar block" do
+      input = <<-EOS
+== Section
+
+.Sidebar
+****
+Content goes here
+****
+      EOS
+      result = render_string(input)
+      assert_xpath "//*[@class='sidebarblock']//p", result, 1
     end
   end
 

data/test/preamble_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+context 'Preamble' do
+
+  test 'title and single paragraph preamble before section' do
+    input = <<-EOS
+Title
+=====
+
+Preamble paragraph 1.
+
+== First Section
+
+Section paragraph 1.
+    EOS
+    result = render_string(input)
+    assert_xpath '//p', result, 2
+    assert_xpath '//*[@id="preamble"]', result, 1
+    assert_xpath '//*[@id="preamble"]//p', result, 1
+    assert_xpath '//*[@id="preamble"]/following-sibling::*//h2[@id="_first_section"]', result, 1
+    assert_xpath '//*[@id="preamble"]/following-sibling::*//p', result, 1
+  end
+
+  test 'title and multi-paragraph preamble before section' do
+    input = <<-EOS
+Title
+=====
+
+Preamble paragraph 1.
+
+Preamble paragraph 2.
+
+== First Section
+
+Section paragraph 1.
+    EOS
+    result = render_string(input)
+    assert_xpath '//p', result, 3
+    assert_xpath '//*[@id="preamble"]', result, 1
+    assert_xpath '//*[@id="preamble"]//p', result, 2
+    assert_xpath '//*[@id="preamble"]/following-sibling::*//h2[@id="_first_section"]', result, 1
+    assert_xpath '//*[@id="preamble"]/following-sibling::*//p', result, 1
+  end
+
+  test 'title and preamble only' do
+    input = <<-EOS
+Title
+=====
+
+Preamble paragraph 1.
+    EOS
+    result = render_string(input)
+    assert_xpath '//p', result, 1
+    assert_xpath '//*[@id="preamble"]', result, 1
+    assert_xpath '//*[@id="preamble"]//p', result, 1
+    assert_xpath '//*[@id="preamble"]/following-sibling::*', result, 0
+  end
+
+  test 'title and section without preamble' do
+    input = <<-EOS
+Title
+=====
+
+== First Section
+
+Section paragraph 1.
+    EOS
+    result = render_string(input)
+    assert_xpath '//p', result, 1
+    assert_xpath '//*[@id="preamble"]', result, 0
+    assert_xpath '//h2[@id="_first_section"]', result, 1
+  end
+
+  test 'no title with preamble and section' do
+    input = <<-EOS
+Preamble paragraph 1.
+
+== First Section
+
+Section paragraph 1.
+    EOS
+    result = render_string(input)
+    assert_xpath '//p', result, 2
+    assert_xpath '//*[@id="preamble"]', result, 0
+    assert_xpath '//h2[@id="_first_section"]/preceding::p', result, 1
+  end
+
+end

data/test/test_helper.rb

@@ -50,7 +50,8 @@ class Test::Unit::TestCase
   end
 
   def assert_xpath(xpath, html, count = nil)
-    results = Nokogiri::HTML::DocumentFragment.parse(html).xpath(".#{xpath}")
+    doc = (html =~ /\s*<!DOCTYPE/) ? Nokogiri::HTML::Document.parse(html) : Nokogiri::HTML::DocumentFragment.parse(html)
+    results = doc.xpath("#{xpath.sub('/', './')}")
 
     if (count && results.length != count)
       flunk "XPath #{xpath} yielded #{results.length} elements rather than #{count} for:\n#{html}"
@@ -61,12 +62,12 @@ class Test::Unit::TestCase
     end
   end
 
-  def document_from_string(src)
-    Asciidoctor::Document.new(src.split("\n"))
+  def document_from_string(src, opts = {})
+    Asciidoctor::Document.new(src.lines.entries, opts)
   end
 
-  def render_string(src)
-    document_from_string(src).render
+  def render_string(src, opts = {})
+    document_from_string(src, opts).render
   end
 end
 

data/test/text_test.rb

@@ -16,7 +16,8 @@ context "Text" do
   end
 
   test "separator" do
-    assert_xpath "//hr", render_string("This is separated.\n\n'''\n\n...from this!"), 1
+    # for some reason, the html enclosure breaks the xpath //*[@id='content']//hr
+    assert_xpath "//*[@id='content']//hr", render_string("This is separated.\n\n'''\n\n...from this!"), 1
   end
 
   test "emphasized text" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2012-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -118,7 +118,7 @@ extra_rdoc_files:
 - LICENSE
 files:
 - LICENSE
-- README.md
+- README.asciidoc
 - Rakefile
 - asciidoctor.gemspec
 - bin/asciidoctor
@@ -145,8 +145,9 @@ files:
 - test/headers_test.rb
 - test/lexer_test.rb
 - test/links_test.rb
-- test/list_elements_test.rb
+- test/lists_test.rb
 - test/paragraphs_test.rb
+- test/preamble_test.rb
 - test/reader_test.rb
 - test/test_helper.rb
 - test/text_test.rb
@@ -181,7 +182,8 @@ test_files:
 - test/headers_test.rb
 - test/lexer_test.rb
 - test/links_test.rb
-- test/list_elements_test.rb
+- test/lists_test.rb
 - test/paragraphs_test.rb
+- test/preamble_test.rb
 - test/reader_test.rb
 - test/text_test.rb

data/README.md

@@ -1,154 +0,0 @@
-Asciidoctor
-===========
-
-Asciidoctor is a pure-ruby processor for turning
-[Asciidoc](http://www.methods.co.nz/asciidoc/index.html) documents
-into HTML (and, eventually, other formats perhaps).
-
-Asciidoctor uses simple built-in ERB templates to style the output in
-a way that roughly matches the default HTML output of the native
-Python processor. You can override this behavior by providing
-[Tilt]-compatible templates. See the Usage section for more details.
-
-Asciidoctor currently works with Ruby 1.8.7 and 1.9.3, though I don't
-know of any reason it shouldn't work with more exotic Ruby versions,
-and would welcome help in testing that out.
-
-The initial code from which asciidoctor started was from the [Git SCM
-site repo][gitscm-next].
-
-[gitscm-next]: https://github.com/github/gitscm-next
-
-# Installation
-
-NOTE: This gem is very immature, and as yet only supports a small
-subset of Asciidoc features.  Thus, you should only use it if you have
-a high tolerance for bugs, failures, and generally bad and intemperate
-behavior.
-
-To install the gem:
-
-    gem install 'asciidoctor'
-
-Or if you prefer bundler:
-
-    bundle install 'asciidoctor'
-
-# Usage
-
-To render a file of Asciidoc-marked-up text to html
-
-    lines = File.readlines("your_file.asc")
-    doc = Asciidoctor::Document.new(lines)
-    html = doc.render
-    File.open("your_file.html", "w+") do |file|
-      file.puts html
-    end
-
-Render an Asciidoc-formatted string
-
-    doc = Asciidoctor::Document.new("*This* is it.")
-    puts doc.render
-
-Asciidoctor allows you to override the default template used to render
-almost any individual Asciidoc elements. If you provide a directory of
-[Tilt]-compatible templates, named in a way Asciidoctor can figure out
-which template goes with which element, Asciidoctor will use the
-templates in this directory instead of its built-in templates for any
-elements for which it finds a matching template.  It will use its
-default templates for everything else.
-
-    doc = Asciidoctor::Document.new("*This* is it.", :template_dir => 'templates')
-    puts doc.render
-
-The Document and Section templates should begin with `document.` and
-`section.`, respectively. The file extension will depend on which
-Tilt-compatible format you've chosen. For ERB, they would be
-`document.html.erb` and `section.html.erb`, for instance.
-
-Specific elements, like a Paragraph or Anchor, would begin with
-`section_<element>.`. So to override the default Paragraph template
-with an ERB template you'd put a file called
-`section_paragraph.html.erb` in the template directory you pass in to
-`Document.new`.
-
-For more usage examples, see the test suite.
-
-[Tilt]: https://github.com/rtomayko/tilt
-
-## Contributing
-In the spirit of [free software][free-sw], **everyone** is encouraged to help
-improve this project.
-
-[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
-
-Here are some ways *you* can contribute:
-
-* by using alpha, beta, and prerelease versions
-* by reporting bugs
-* by suggesting new features
-* by writing or editing documentation
-* by writing specifications
-* by writing code (**no patch is too small**: fix typos, add comments, clean up
-  inconsistent whitespace)
-* by refactoring code
-* by fixing [issues][]
-* by reviewing patches
-
-[issues]: https://github.com/erebor/asciidoctor/issues
-
-## Submitting an Issue
-We use the [GitHub issue tracker][issues] to track bugs and
-features. Before submitting a bug report or feature request, check to
-make sure it hasn't already been submitted. When submitting a bug
-report, please include a [Gist][] that includes any details that may
-help reproduce the bug, including your gem version, Ruby version, and
-operating system.
-
-Most importantly, since asciidoctor is a text processor, reproducing
-most bugs requires that we have some snippet of text on which
-asciidoctor exhibits the bad behavior.
-
-An ideal bug report would include a pull request with failing
-specs.
-
-[gist]: https://gist.github.com/
-
-## Submitting a Pull Request
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add tests for your unimplemented feature or bug fix.
-4. Run `bundle exec rake`. If your tests pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `bundle exec rake`. If your tests fail, return to step 5.
-7. Add documentation for your feature or bug fix.
-8. If your changes are not 100% documented, go back to step 7.
-9. Add, commit, and push your changes.
-10. [Submit a pull request.][pr]
-
-[fork]: http://help.github.com/fork-a-repo/
-[branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/
-
-## Supported Ruby Versions
-This library aims to support the following Ruby implementations:
-
-* Ruby 1.8.7
-* Ruby 1.9.3
-
-If something doesn't work on one of these interpreters, it should be
-considered a bug.
-
-If you would like this library to support another Ruby version, you
-may volunteer to be a maintainer. Being a maintainer entails making
-sure all tests run and pass on that implementation. When something
-breaks on your implementation, you will be personally responsible for
-providing patches in a timely fashion. If critical issues for a
-particular implementation exist at the time of a major release,
-support for that Ruby version may be dropped.
-
-## Copyright
-Copyright (c) 2012 Ryan Waldron.
-See [LICENSE][] for details.
-
-[license]: https://github.com/erebor/asciidoctor/blob/master/LICENSE