asciidoctor 0.0.4 → 0.0.5

data/asciidoctor.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'asciidoctor'
-  s.version           = '0.0.4'
-  s.date              = '2012-08-14'
+  s.version           = '0.0.5'
+  s.date              = '2012-12-11'
   s.rubyforge_project = 'asciidoctor'
 
   ## Make sure your summary is short. The description may be as long
@@ -85,6 +85,7 @@ Gem::Specification.new do |s|
     test/fixtures/list_elements.asciidoc
     test/headers_test.rb
     test/lexer_test.rb
+    test/links_test.rb
     test/list_elements_test.rb
     test/paragraphs_test.rb
     test/reader_test.rb

data/lib/asciidoctor.rb

@@ -29,10 +29,23 @@ $:.unshift(File.join(File.dirname(__FILE__), '..', 'vendor'))
 #
 # Examples:
 #
-#   lines = File.readlines(filename)
+# Use built-in templates:
 #
-#   doc  = Asciidoctor::Document.new(lines)
-#   html = doc.render(template_path)
+#   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
+#
+# Use custom (Tilt-supported) templates:
+#
+#   lines = File.readlines("your_file.asc")
+#   doc = Asciidoctor::Document.new(lines, :template_dir => 'templates')
+#   html = doc.render
+#   File.open("your_file.html", "w+") do |file|
+#     file.puts html
+#   end
 module Asciidoctor
   REGEXP = {
     # [[Foo]]  (also allows, say, [[[]] or [[[Foo[f]], but I don't think it is supposed to (TODO))
@@ -57,8 +70,13 @@ module Asciidoctor
     # <1> Foo
     :colist           => /^(\<\d+\>)\s*(.*)/,
 
+    # ////
+    # comment block
+    # ////
+    :comment_blk      => /^\/{4,}\s*$/,
+
     # // (and then whatever)
-    :comment          => /^\/\/\s/,
+    :comment          => /^\/\/[^\/]/,
 
     # foo::  ||  foo;;
     # Should be followed by a definition line, e.g.,
@@ -126,7 +144,7 @@ module Asciidoctor
     # ____
     :quote            => /^_{4,}\s*$/,
 
-    # ''''
+    # '''
     :ruler            => /^'{3,}\s*$/,
 
     # ****
@@ -149,16 +167,38 @@ module Asciidoctor
   INTRINSICS = Hash.new{|h,k| STDERR.puts "Missing intrinsic: #{k.inspect}"; "{#{k}}"}.merge(
     'startsb'    => '[',
     'endsb'      => ']',
+    'brvbar'     => '|',
     'caret'      => '^',
     'asterisk'   => '*',
     'tilde'      => '~',
     'litdd'      => '--',
     'plus'       => '+',
-    'apostrophe' => "'",
-    'backslash'  => "\\",
-    'backtick'   => '`'
+    'apostrophe' => '\'',
+    'backslash'  => '\\',
+    'backtick'   => '`',
+    'empty'      => '',
+    'sp'         => ' ',
+    'two-colons' => '::',
+    'two-semicolons' => ';;',
+    'nbsp'       => '&#160;',
+    'deg'        => '&#176;',
+    'zwsp'       => '&#8203;',
+    'lsquo'      => '&#8216;',
+    'rsquo'      => '&#8217;',
+    'ldquo'      => '&#8220;',
+    'rdquo'      => '&#8221;',
+    'wj'         => '&#8288;',
+    'amp'        => '&',
+    'lt'         => '<',
+    'gt'         => '>',
   )
 
+  SPECIAL_CHARS = {
+    '<' => '&lt;',
+    '>' => '&gt;',
+    '&' => '&amp;'
+  }
+
   HTML_ELEMENTS = {
     'br-asciidoctor' => '<br/>'
   }

data/lib/asciidoctor/block.rb

@@ -192,8 +192,9 @@ class Asciidoctor::Block
 
     result = lines.map do |line|
       Asciidoctor.debug "#{__method__} -> Processing line: #{line}"
+      f = sub_special_chars(line)
       # gsub! doesn't have lookbehind, so we have to capture and re-insert
-      f = line.gsub(/ (^|[^\\]) \{ (\w[\w\-_]+\w) \} /x) do
+      f = f.gsub(/ (^|[^\\]) \{ (\w([\w\-_]+)?\w) \} /x) do
         if self.document.defines.has_key?($2)
           # Substitute from user defines first
           $1 + self.document.defines[$2]
@@ -273,7 +274,7 @@ class Asciidoctor::Block
       html.gsub!( /(^|[^<])<<([^<>,]+)(,([^>]*))?>>/ ) { "#{$1}link:##{$2}[" + ($4.nil? ? document.references[$2] : $4).to_s + "]" }
 
       # Do the same with URLs
-      html.gsub!( /(^|[^`])(https?:\/\/[^\[ ]+)(\[+[^\]]*\]+)?/ ) do
+      html.gsub!( /(^|[^(`|link:)])(https?:\/\/[^\[ ]+)(\[+[^\]]*\]+)?/ ) do
         pre = $1
         url = $2
         link = ( $3 || $2 ).gsub( /(^\[|\]$)/,'' )
@@ -282,7 +283,6 @@ class Asciidoctor::Block
         "#{pre}link:#{url}[#{link}]"
       end
 
-      html = CGI.escapeHTML(html)
       html.gsub!(Asciidoctor::REGEXP[:biblio], '<a name="\1">[\1]</a>')
       html.gsub!(Asciidoctor::REGEXP[:ruler], '<hr>\n')
       html.gsub!(/``([^`']*)''/m, '&ldquo;\1&rdquo;')
@@ -307,12 +307,14 @@ class Asciidoctor::Block
 
       # "Constrained" quotes, which must be bounded by white space or
       # common punctuation characters
-      html.gsub!(/([\s\W])\*([^\*]+)\*([\s\W])/m, '\1<strong>\2</strong>\3')
-      html.gsub!(/([\s\W])'(.+?)'([\s\W])/m, '\1<em>\2</em>\3')
-      html.gsub!(/([\s\W])_([^_]+)_([\s\W])/m, '\1<em>\2</em>\3')
-      html.gsub!(/([\s\W])\+([^\+]+)\+([\s\W])/m, '\1<tt>\2</tt>\3')
-      html.gsub!(/([\s\W])\^([^\^]+)\^([\s\W])/m, '\1<sup>\2</sup>\3')
-      html.gsub!(/([\s\W])\~([^\~]+)\~([\s\W])/m, '\1<sub>\2</sub>\3')
+      html.gsub!(/(^|\s|\W)\*([^\*]+)\*(\s|\W|$)/m, '\1<strong>\2</strong>\3')
+      html.gsub!(/(^|\s|\W)'(.+?)'(\s|\W|$)/m, '\1<em>\2</em>\3')
+      # restore escaped single quotes after processing emphasis
+      html.gsub!(/(\w)\\'(\w)/, '\1\'\2')
+      html.gsub!(/(^|\s|\W)_([^_]+)_(\s|\W|$)/m, '\1<em>\2</em>\3')
+      html.gsub!(/(^|\s|\W)\+([^\+]+)\+(\s|\W|$)/m, '\1<tt>\2</tt>\3')
+      html.gsub!(/(^|\s|\W)\^([^\^]+)\^(\s|\W|$)/m, '\1<sup>\2</sup>\3')
+      html.gsub!(/(^|\s|\W)\~([^\~]+)\~(\s|\W|$)/m, '\1<sub>\2</sub>\3')
 
       html.gsub!(/\\([\{\}\-])/, '\1')
       html.gsub!(/linkgit:([^\]]+)\[(\d+)\]/, '<a href="\1.html">\1(\2)</a>')
@@ -321,5 +323,9 @@ class Asciidoctor::Block
       html
     end
   end
+
+  def sub_special_chars(str)
+    str.gsub(/[#{Asciidoctor::SPECIAL_CHARS.keys.join}]/) {|match| Asciidoctor::SPECIAL_CHARS[match] }
+  end
   # end private
 end

data/lib/asciidoctor/debug.rb

@@ -3,8 +3,12 @@ module Asciidoctor
     puts *args if self.show_debug_output?
   end
 
+  def self.set_debug(value)
+    @show_debug = value
+  end
+
   def self.show_debug_output?
-    ENV['DEBUG'] == 'true' && ENV['SUPPRESS_DEBUG'] != 'true'
+    @show_debug || (ENV['DEBUG'] == 'true' && ENV['SUPPRESS_DEBUG'] != 'true')
   end
 
   def self.puts_indented(level, *args)

data/lib/asciidoctor/lexer.rb

@@ -63,7 +63,11 @@ class Asciidoctor::Lexer
       this_line = reader.get_line
       next_line = reader.peek_line || ''
 
-      if this_line.match(REGEXP[:comment])
+      if this_line.match(REGEXP[:comment_blk])
+        Reader.new(reader.grab_lines_until {|line| line.match( REGEXP[:comment_blk] ) })
+        next
+
+      elsif this_line.match(REGEXP[:comment])
         next
 
       elsif match = this_line.match(REGEXP[:title])
@@ -659,8 +663,10 @@ class Asciidoctor::Lexer
     while section_reader.has_lines?
       section_reader.skip_blank
 
-      new_block = next_block(section_reader, section) if section_reader.has_lines?
-      section << new_block unless new_block.nil?
+      if section_reader.has_lines?
+        new_block = next_block(section_reader, section)
+        section << new_block unless new_block.nil?
+      end
     end
 
     section

data/lib/asciidoctor/section.rb

@@ -68,7 +68,7 @@ class Asciidoctor::Section
   #   section.section_id
   #   => "_foo"
   def section_id
-    "_#{name && name.downcase.gsub(' ','_')}"
+    "_#{name && name.downcase.gsub(/\W+/,'_').gsub(/_+$/, '')}".tr_s('_', '_')
   end
 
   # Public: Get the Asciidoctor::Document instance to which this Block belongs

data/lib/asciidoctor/version.rb

@@ -1,3 +1,3 @@
 module Asciidoctor
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/noof.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'ap'
-require 'lib/asciidoctor'
+require_relative 'lib/asciidoctor'
 
 lines = File.readlines("test/fixtures/asciidoc_index.txt")
 #lines = File.read("test/fixtures/asciidoc_index.txt")

data/test/attributes_test.rb

@@ -77,12 +77,26 @@ context "Attributes" do
     pending "whut?"
   end
 
-  test "Intrinsics" do
-    Asciidoctor::INTRINSICS.each_pair do |key, value|
-      html = render_string("Look, a {#{key}} is here")
-      result = Nokogiri::HTML(html)
-      assert_equal("Look, a #{value} is here", result.css("p").first.content.strip)
+  context "intrinsics" do
+
+    test "substitute intrinsics" do
+      Asciidoctor::INTRINSICS.each_pair do |key, value|
+        html = render_string("Look, a {#{key}} is here")
+        # can't use Nokogiri because it interprets the HTML entities and we can't match them
+        assert_match /Look, a #{Regexp.escape(value)} is here/, html
+      end
+    end
+
+    test "don't escape intrinsic substitutions" do
+      html = render_string('happy{nbsp}together')
+      assert_match /happy together/, html
+    end
+
+    test "escape special characters" do
+      html = render_string('<node>&</node>')
+      assert_match /&lt;node&gt;&amp;&lt;\/node&gt;/, html
     end
+    
   end
 
 end

data/test/headers_test.rb

@@ -7,13 +7,21 @@ context "Headers" do
 
   context "level 1" do 
     test "with multiline syntax" do
-      assert_xpath "//h2", render_string("My Section\n-----------")
+      assert_xpath "//h2[@id='_my_section']", render_string("My Section\n-----------")
     end
 
     test "with single line syntax" do
-      assert_xpath "//h2", render_string("== My Title")
+      assert_xpath "//h2[@id='_my_title']", render_string("== My Title")
     end
-  end  
+
+    test "with non-word character" do
+      assert_xpath "//h2[@id='_where_s_the_love']", render_string("== Where's the love?")
+    end
+
+    test "with sequential non-word characters" do
+      assert_xpath "//h2[@id='_what_the_is_that']", render_string('== What the #@$ is that')
+    end
+  end
 
   context "level 2" do 
     test "with multiline syntax" do
@@ -44,4 +52,4 @@ context "Headers" do
       assert_xpath "//h5", render_string("===== My Title")
     end
   end  
-end
+end

data/test/links_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+context "Links" do
+
+  test "absolute url with link prefix" do
+    assert_xpath "//a[@href='http://asciidoc.org']", render_string("We're parsing link:http://asciidoc.org[AsciiDoc] markup")
+  end
+
+end

data/test/paragraphs_test.rb

@@ -12,6 +12,11 @@ context "Paragraphs" do
     assert_xpath "//p", rendered, 2
   end
 
+  test "no duplicate block before next section" do
+    rendered = render_string("Title\n=====\n\nPreamble.\n\n== First Section\n\nParagraph 1\n\nParagraph 2\n\n\n== Second Section\n\nLast words")
+    assert_xpath '//p[text()="Paragraph 2"]', rendered, 1
+  end
+
   context "code" do
     test "literal paragraph" do
       assert_xpath "//pre/tt", render_string("    LITERALS\n\n    ARE LITERALLY\n\n    AWESOMMMME.")
@@ -35,4 +40,14 @@ context "Paragraphs" do
       assert_xpath "//div[@class='admonitionblock']", render_string("NOTE: This is important, fool!")
     end
   end
-end
+
+  context "comments" do
+    test "line comment" do
+      assert_no_match /comment/, render_string("first paragraph\n\n//comment\n\nsecond paragraph")
+    end
+
+    test "comment block" do
+      assert_no_match /comment/, render_string("first paragraph\n\n////\ncomment\n////\n\nsecond paragraph")
+    end
+  end
+end

data/test/test_helper.rb

@@ -3,7 +3,7 @@ require 'test/unit'
 
 require "#{File.expand_path(File.dirname(__FILE__))}/../lib/asciidoctor.rb"
 
-require 'mocha'
+require 'mocha/setup'
 require 'htmlentities'
 require 'nokogiri'
 require 'pending'
@@ -145,4 +145,4 @@ end
 
 def context(*name, &block)
   Test::Unit::TestCase.context(name, &block)
-end
+end

data/test/text_test.rb

@@ -16,13 +16,33 @@ context "Text" do
   end
 
   test "separator" do
-    assert_xpath "//hr", render_string("This is separated.\n\n''''\n\n...from this!"), 1
+    assert_xpath "//hr", render_string("This is separated.\n\n'''\n\n...from this!"), 1
   end
 
   test "emphasized text" do
     assert_xpath "//em", render_string("An 'emphatic' no")
   end
 
+  test "emphasized text with escaped single quote" do
+    assert_xpath "//em[text()=\"Johnny's\"]", render_string("It's 'Johnny\\'s' phone")
+  end
+
+  test "escaped single quote is restore as single quote" do
+    assert_xpath "//p[contains(text(), \"Let's do it!\")]", render_string("Let\\'s do it!")
+  end
+
+  test "emphasized text at end of line" do
+    assert_xpath "//em", render_string("This library is 'awesome'")
+  end
+
+  test "emphasized text at beginning of line" do
+    assert_xpath "//em", render_string("'drop' it")
+  end
+
+  test "emphasized text across line" do
+    assert_xpath "//em", render_string("'check it'")
+  end
+
   test "unquoted text" do
     assert_no_match /#/, render_string("An #unquoted# word")
   end
@@ -74,4 +94,4 @@ context "Text" do
       assert_xpath "//tt", rendered_chars
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-14 00:00:00.000000000 Z
+date: 2012-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -144,6 +144,7 @@ files:
 - test/fixtures/list_elements.asciidoc
 - test/headers_test.rb
 - test/lexer_test.rb
+- test/links_test.rb
 - test/list_elements_test.rb
 - test/paragraphs_test.rb
 - test/reader_test.rb
@@ -179,6 +180,7 @@ test_files:
 - test/document_test.rb
 - test/headers_test.rb
 - test/lexer_test.rb
+- test/links_test.rb
 - test/list_elements_test.rb
 - test/paragraphs_test.rb
 - test/reader_test.rb