asciidoctor 0.0.1

data/test/fixtures/ascshort.txt

@@ -0,0 +1,32 @@
+AsciiDoc User Guide
+===================
+Stuart Rackham <srackham@gmail.com>
+:Author Initials: SJR
+:toc:
+:icons:
+:numbered:
+:website: http://www.methods.co.nz/asciidoc/
+
+AsciiDoc is a text document format for writing notes, documentation,
+articles, books, ebooks, slideshows, web pages, blogs and UNIX man
+pages.
+
+.This document
+**********************************************************************
+This is an overly large document, it probably needs to be refactored
+into a Tutorial, Quick Reference and Formal Reference.
+
+If you're new to AsciiDoc read this section and the <<X6,Getting
+Started>> section and take a look at the example AsciiDoc (`*.txt`)
+source files in the distribution `doc` directory.
+**********************************************************************
+
+
+Introduction
+------------
+AsciiDoc is a plain text human readable/writable document format that
+can be translated to DocBook or HTML using the asciidoc(1) command.
+
+asciidoc(1) comes with a set of configuration files to translate
+AsciiDoc articles, books and man pages to HTML or DocBook backend
+formats.

data/test/fixtures/list_elements.asciidoc

@@ -0,0 +1,10 @@
+AsciiDoc Home Page
+==================
+
+Example Articles
+~~~~~~~~~~~~~~~~
+- Item 1
+
+- Item 2
+
+- Item 3

data/test/headers_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+context "Headers" do
+  test "main header" do
+    assert_xpath "//h1", render_string("My Title\n=======")
+  end
+
+  context "level 1" do 
+    test "with multiline syntax" do
+      assert_xpath "//h2", render_string("My Section\n-----------")
+    end
+
+    test "with single line syntax" do
+      assert_xpath "//h2", render_string("== My Title")
+    end
+  end  
+
+  context "level 2" do 
+    test "with multiline syntax" do
+      assert_xpath "//h3", render_string("My Section\n~~~~~~~~~~~")
+    end
+
+    test "with single line syntax" do
+      assert_xpath "//h3", render_string("=== My Title")
+    end
+  end  
+
+  context "level 3" do 
+    test "with multiline syntax" do
+      assert_xpath "//h4", render_string("My Section\n^^^^^^^^^^")
+    end
+
+    test "with single line syntax" do
+      assert_xpath "//h4", render_string("==== My Title")
+    end
+  end
+
+  context "level 4" do 
+    test "with multiline syntax" do
+      assert_xpath "//h5", render_string("My Section\n++++++++++")
+    end
+
+    test "with single line syntax" do
+      assert_xpath "//h5", render_string("===== My Title")
+    end
+  end  
+end

data/test/list_elements_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+context "Bulleted lists (:ulist)" do
+  context "Simple lists" do
+    test "dash elements with no blank lines" do
+      output = render_string("Blah\n====\n- Foo\n- Boo\n- Blech")
+      assert_xpath '//ul', output, 1
+      assert_xpath '//ul/li', output, 3
+    end
+
+    test "dash elements with blank lines" do
+      assert_xpath '//ul/li', render_string("Blah\n====\n- Foo\n\n- Boo\n\n- Blech"), 3
+    end
+
+    test "asterisk elements with no blank lines" do
+      assert_xpath '//ul/li', render_string("Blah\n====\n* Foo\n* Boo\n* Blech"), 3
+    end
+
+    test "asterisk elements with blank lines" do
+      assert_xpath '//ul/li', render_string("Blah\n====\n* Foo\n\n* Boo\n\n* Blech"), 3
+    end
+  end
+
+  context "Nested lists" do
+    test "nested mixed elements (asterisk and dash)" do
+      output = render_string("Blah\n====\n- Foo\n* Boo\n- Blech")
+      assert_xpath '//ul', output, 1
+      assert_xpath '//ul/li', output, 3
+    end
+
+    test "nested elements (2) with asterisks" do
+      output = render_string("Blah\n====\n* Foo\n** Boo\n* Blech")
+      assert_xpath '//ul', output, 2
+      assert_xpath '//ul/li', output, 3
+    end
+
+    test "nested elements (3) with asterisks" do
+      output = render_string("Blah\n====\n* Foo\n** Boo\n*** Snoo\n* Blech")
+      assert_xpath '//ul', output, 3
+      assert_xpath '//ul/li', output, 4
+    end
+
+    test "nested elements (4) with asterisks" do
+      output = render_string("Blah\n====\n* Foo\n** Boo\n*** Snoo\n**** Froo\n* Blech")
+      assert_xpath '//ul', output, 4
+      assert_xpath '//ul/li', output, 5
+    end
+
+    test "nested elements (5) with asterisks" do
+      output = render_string("Blah\n====\n* Foo\n** Boo\n*** Snoo\n**** Froo\n***** Groo\n* Blech")
+      assert_xpath '//ul', output, 5
+      assert_xpath '//ul/li', output, 6
+    end
+  end
+end

data/test/paragraphs_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+context "Paragraphs" do
+  test "rendered correctly" do
+    assert_xpath "//p", render_string("Plain text for the win.\n\nYes, plainly."), 2
+  end
+
+  test "with title" do
+    rendered = render_string(".Titled\nParagraph.\n\nWinning")
+    
+    assert_xpath "//div[@class='title']", rendered
+    assert_xpath "//p", rendered, 2
+  end
+
+  context "code" do
+    test "literal paragraph" do
+      assert_xpath "//pre/tt", render_string("    LITERALS\n\n    ARE LITERALLY\n\n    AWESOMMMME.")
+    end
+
+    test "listing paragraph" do
+      assert_xpath "//div[@class='highlight']", render_string("----\nblah blah blah\n----")
+    end
+
+    test "source code paragraph" do
+      assert_xpath "//div[@class='highlight']", render_string("[source, perl]\ndie 'zomg perl sucks';")
+    end
+  end
+
+  context "special" do
+    test "note multiline syntax" do
+      assert_xpath "//div[@class='admonitionblock']", render_string("[NOTE]\nThis is a winner.")
+    end
+
+    test "note inline syntax" do
+      assert_xpath "//div[@class='admonitionblock']", render_string("NOTE: This is important, fool!")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,143 @@
+require 'fileutils'
+require 'test/unit'
+
+require "#{File.expand_path(File.dirname(__FILE__))}/../lib/asciidoctor.rb"
+
+require 'mocha'
+require 'htmlentities'
+require 'nokogiri'
+
+ENV['SUPPRESS_DEBUG'] = 'true'
+
+class Test::Unit::TestCase
+  def sample_doc_path(name)
+    name = name.to_s
+    unless name.include?('.')
+      ['asciidoc', 'txt'].each do |ext|
+        if File.exist?(fixture_path("#{name}.#{ext}"))
+          name = "#{name}.#{ext}"
+          break
+        end
+      end
+    end
+    fixture_path(name)
+  end
+
+  def fixture_path(name)
+    File.join(File.dirname(__FILE__), "fixtures", name )
+  end
+
+  def example_document(name)
+    Asciidoctor::Document.new(File.readlines(sample_doc_path(name)))
+  end
+
+  def assert_difference(expression, difference = 1, message = nil, &block)
+    expressions = [expression]
+
+    exps = expressions.map { |e|
+      e.respond_to?(:call) ? e : lambda { eval(e, block.binding) }
+    }
+    before = exps.map { |e| e.call }
+
+    yield
+
+    expressions.zip(exps).each_with_index do |(code, e), i|
+      error  = "#{code.inspect} didn't change by #{difference}"
+      error  = "#{message}.\n#{error}" if message
+      assert_equal(before[i] + difference, e.call, error)
+    end
+  end
+
+  def assert_xpath(xpath, html, count = nil)
+    results = Nokogiri::HTML::DocumentFragment.parse(html).xpath(".#{xpath}")
+
+    if (count && results.length != count)
+      flunk "XPath #{xpath} yielded #{results.length} elements rather than #{count} for:\n#{html}"
+    elsif (count.nil? && results.empty?)
+      flunk "XPath #{xpath} not found in:\n#{html}"
+    else
+      assert true
+    end
+  end
+
+  def render_string(src)
+    Asciidoctor::Document.new(src.split("\n")).render
+  end
+end
+
+###
+# 
+# Context goodness provided by @citrusbyte's contest
+#
+###
+
+# Test::Unit loads a default test if the suite is empty, whose purpose is to
+# fail. Since having empty contexts is a common practice, we decided to
+# overwrite TestSuite#empty? in order to allow them. Having a failure when no
+# tests have been defined seems counter-intuitive.
+class Test::Unit::TestSuite
+  def empty?
+    false
+  end
+end
+
+# Contest adds +teardown+, +test+ and +context+ as class methods, and the
+# instance methods +setup+ and +teardown+ now iterate on the corresponding
+# blocks. Note that all setup and teardown blocks must be defined with the
+# block syntax. Adding setup or teardown instance methods defeats the purpose
+# of this library.
+class Test::Unit::TestCase
+  def self.setup(&block)
+    define_method :setup do
+      super(&block)
+      instance_eval(&block)
+    end
+  end
+
+  def self.teardown(&block)
+    define_method :teardown do
+      instance_eval(&block)
+      super(&block)
+    end
+  end
+
+  def self.context(*name, &block)
+    subclass = Class.new(self)
+    remove_tests(subclass)
+    subclass.class_eval(&block) if block_given?
+    const_set(context_name(name.join(" ")), subclass)
+  end
+
+  def self.test(name, &block)
+    define_method(test_name(name), &block)
+  end
+
+  class << self
+    alias_method :should, :test
+    alias_method :describe, :context
+  end
+
+private
+
+  def self.context_name(name)
+    "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
+  end
+
+  def self.test_name(name)
+    "test_#{sanitize_name(name).gsub(/\s+/,'_')}".to_sym
+  end
+
+  def self.sanitize_name(name)
+    name.gsub(/\W+/, ' ').strip
+  end
+
+  def self.remove_tests(subclass)
+    subclass.public_instance_methods.grep(/^test_/).each do |meth|
+      subclass.send(:undef_method, meth.to_sym)
+    end
+  end
+end
+
+def context(*name, &block)
+  Test::Unit::TestCase.context(name, &block)
+end

data/test/text_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+context "Text" do
+  test "line breaks" do
+    assert_xpath "//br", render_string("Well this is +\njust fine and dandy, isn't it?"), 1
+  end
+
+  test "quotes" do
+    rendered = render_string("``Where?,'' she said, flipping through her copy of `The New Yorker.'")
+    assert_match /”/, rendered
+    assert_match /“/, rendered
+    assert_match /’/, rendered
+    assert_match /‘/, rendered
+  end
+
+  test "separator" do
+    assert_xpath "//hr", render_string("This is separated.\n\n''''\n\n...from this!"), 1
+  end
+
+  test "emphasized quotes" do
+    assert_xpath "//em", render_string("An 'emphatic' no")
+  end
+
+  test "unquoted text" do
+    assert_no_match /#/, render_string("An #unquoted# word")
+  end
+
+  context "basic styling" do 
+    setup do
+      @rendered = render_string("A *BOLD* word.  An _italic_ word.  A +mono+ word.  ^superscript!^ and some ~subscript~.")
+    end
+
+    test "bold" do
+      assert_xpath "//strong", @rendered 
+    end
+
+    test "italic" do
+      assert_xpath "//em", @rendered 
+    end
+
+    test "monospaced" do
+      assert_xpath "//tt", @rendered 
+    end
+
+    test "superscript" do
+      assert_xpath "//sup", @rendered 
+    end
+
+    test "subscript" do
+      assert_xpath "//sub", @rendered 
+    end
+
+    test "backticks" do
+      assert_xpath "//tt", render_string("This is `totally cool`.")
+    end
+
+    test "combined styles" do
+      rendered = render_string("Winning *big _time_* in the +city *boyeeee*+.")
+      
+      assert_xpath "//strong/em", rendered
+      assert_xpath "//tt/strong", rendered
+    end
+
+    test "characters" do
+      rendered_chars = render_string("**B**__I__++M++")
+      assert_xpath "//strong", rendered_chars 
+      assert_xpath "//em", rendered_chars 
+      assert_xpath "//tt", rendered_chars 
+    end
+  end  
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: asciidoctor
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Waldron
+- Jeremy McAnally
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-14 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: htmlentities
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Render all the AsciiDocs! The time, she is now, for all good renders.
+email: rew@erebor.com
+executables: 
+- asciidoctor
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- asciidoctor.gemspec
+- bin/asciidoctor
+- lib/asciidoctor.rb
+- lib/asciidoctor/block.rb
+- lib/asciidoctor/debug.rb
+- lib/asciidoctor/document.rb
+- lib/asciidoctor/errors.rb
+- lib/asciidoctor/list_item.rb
+- lib/asciidoctor/render_templates.rb
+- lib/asciidoctor/renderer.rb
+- lib/asciidoctor/section.rb
+- lib/asciidoctor/string.rb
+- lib/asciidoctor/version.rb
+- noof.rb
+- test/document_test.rb
+- test/fixtures/asciidoc.txt
+- test/fixtures/asciidoc_index.txt
+- test/fixtures/ascshort.txt
+- test/fixtures/list_elements.asciidoc
+- test/headers_test.rb
+- test/list_elements_test.rb
+- test/paragraphs_test.rb
+- test/test_helper.rb
+- test/text_test.rb
+has_rdoc: true
+homepage: http://github.com/erebor/asciidoctor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: asciidoctor
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 2
+summary: Pure Ruby Asciidoc to HTML rendering.
+test_files: 
+- test/document_test.rb
+- test/headers_test.rb
+- test/list_elements_test.rb
+- test/paragraphs_test.rb
+- test/text_test.rb