bitclust-core 0.5.5 → 0.6.0

data/ChangeLog

@@ -1,3 +1,10 @@
+2013-04-06  Sho Hashimoto  <sho-h@netlab.jp>
+
+	* lib/bitclust/nameutils.rb
+	(BitClust::NameUtils::CLASS_NAME_RE): support main and
+	*::compatible class. (see #8186)
+	(BitClust::NameUtils::CLASS_PATH_RE): ditto.
+
 2012-10-09  Ippei Obayashi  <ohai@kmc.gr.jp>
 
 	* lib/bitclust/subcommands/server_command.rb

data/bitclust.gemspec

@@ -27,5 +27,7 @@ EOD
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
   s.add_development_dependency "test-unit", ">= 2.3.0"
+  s.add_development_dependency "test-unit-notify"
+  s.add_development_dependency "test-unit-rr"
   s.add_runtime_dependency "rack"
 end

data/data/bitclust/catalog/ja_JP.UTF-8

@@ -46,6 +46,8 @@ FileFormat
 ファイルフォーマット
 Function Index
 関数一覧
+Index
+目次
 I/O
 入出力
 Inherited Methods

data/data/bitclust/template.offline/class

@@ -38,14 +38,34 @@
 
 <%
     ents =  @entry.partitioned_entries(@alevel)
+    items =
     [[_('Singleton Methods'),         ents.singleton_methods          ],
      [_('Instance Methods'),          ents.instance_methods           ],
      [_('Private Singleton Methods'), ents.private_singleton_methods  ],
      [_('Private Instance Methods'),  ents.private_instance_methods   ],
      [_('Module Functions'),          ents.module_functions           ],
      [_('Constants'),                 ents.constants                  ],
-     [_('Special Variables'),         ents.special_variables          ]]\
-    .each do |label, entries|
+     [_('Special Variables'),         ents.special_variables          ,'$']] %>
+<%= headline(_("Index")) %>
+<dl>
+<% items.each do |label, entries, prefix| next if entries.empty? %>
+<dt><%= label %></dt>
+<dd>
+<%
+  entries.each do |m|
+    m.names.each do |mname|
+%>
+<a href="#<%= m.index_id(mname, false) %>"><%= "#{prefix}#{mname}" %></a>
+<%
+    end
+  end
+%>
+</dd>
+<% end %>
+</dl>
+
+<%
+    items.each do |label, entries|
       unless entries.empty? %>
 <%=     headline(label) %>
 <dl>

data/lib/bitclust/methodentry.rb

@@ -122,6 +122,11 @@ module BitClust
       "#{t == '#' ? '' : t}#{m}"
     end
 
+    def index_id(name, remove_prefix = true)
+      name = name.sub(/^\$/, '') if remove_prefix
+      "#{methodid2typechar(@id)}_#{encodename_fs(name).gsub(/=/, '--')}".upcase
+    end
+
     def labels
       c, t, m, lib = methodid2specparts(@id)
       names().map {|name| "#{c}#{t}#{name}" }

data/lib/bitclust/nameutils.rb

@@ -18,8 +18,8 @@ module BitClust
     LIBNAME_RE     = %r<[\w\-]+(/[\w\-]+)*>
     CONST_RE       = /[A-Z]\w*/
     CONST_PATH_RE  = /#{CONST_RE}(?:::#{CONST_RE})*/
-    CLASS_NAME_RE  = /(?:#{CONST_RE}|fatal|ARGF.class)/
-    CLASS_PATH_RE  = /(?:#{CONST_PATH_RE}|fatal|ARGF.class)/
+    CLASS_NAME_RE  = /(?:#{CONST_RE}(?:::compatible)?|fatal|ARGF.class|main)/
+    CLASS_PATH_RE  = /(?:#{CONST_PATH_RE}(?:::compatible)?|fatal|ARGF.class|main)/
     METHOD_NAME_RE = /\w+[?!=]?|===|==|=~|<=>|<=|>=|!=|!|!@|!~|\[\]=|\[\]|\*\*|>>|<<|\+@|\-@|[~+\-*\/%&|^<>`]/
     TYPEMARK_RE    = /(?:\.|\#|\.\#|::|\$)/
     METHOD_SPEC_RE = /#{CLASS_PATH_RE}#{TYPEMARK_RE}#{METHOD_NAME_RE}/

data/lib/bitclust/rdcompiler.rb

@@ -93,8 +93,10 @@ module BitClust
 
     def method_entry_chunk
       @out.puts '<dl>' if @option[:force]
+      first = true
       @f.while_match(/\A---/) do |line|
-        method_signature line
+        method_signature(line, first)
+        first = false
       end
       props = {}
       @f.while_match(/\A:/) do |line|
@@ -327,13 +329,20 @@ module BitClust
       f.span(%r<\A(?!---|=|//emlist\{|@[a-z])\S>)
     end
 
-    def method_signature(sig_line)
+    def method_signature(sig_line, first)
       # FIXME: check parameters, types, etc.
       sig = MethodSignature.parse(sig_line)
-      string '<dt class="method-heading"><code>'
+      string %Q(<dt class="method-heading")
+      string %Q( id="#{@method.index_id(sig.name)}") if first
+      string '><code>'
       string @method.klass.name + @method.typemark if @opt
       string escape_html(sig.friendly_string)
       string '</code>'
+      if first
+        string '<span class="permalink">['
+        string a_href(@urlmapper.method_url(methodid2specstring(@method.id)), "permalink")
+        string ']</span>'
+      end
       if @method and not @method.defined?
         line %Q( <span class="kindinfo">[#{@method.kind} by #{library_link(@method.library.name)}]</span>)
       end

data/lib/bitclust/refsdatabase.rb

@@ -20,7 +20,7 @@ module BitClust
       buf.each_line{|l|
         if /((?:\\,|[^,])+),((?:\\,|[^,])+),((?:\\,|[^,])+),((?:\\,|[^,])+)\n/ =~ l
           type, id, linkid, desc = [$1, $2, $3, $4].map{|e| e.gsub(/\\(.)/){|s| $1 == ',' ? ',' : s } }
-          refs[type, id, linkid] = desc          
+          refs[type, id, linkid] = desc
         end
       }
       refs
@@ -51,6 +51,7 @@ module BitClust
       @h.each{|k, v|
         io.write(  [k, v].flatten.map{|e| e.gsub(/,/, '\\,') }.join(',') + "\n" )
       }
+      io.close
     end
 
     def extract(entry)

data/lib/bitclust/runner.rb

@@ -56,7 +56,7 @@ Global Options:
       @parser.on('-d', '--database=PATH', 'Database prefix.') {|path|
         @prefix = path
       }
-      @parser.on('-t', '--targer=VERSION', 'Specify Ruby version.') {|v|
+      @parser.on('-t', '--target=VERSION', 'Specify Ruby version.') {|v|
         @version = v
       }
       @parser.on('--capi', 'Process C API database.') {

data/lib/bitclust/subcommands/server_command.rb

@@ -186,7 +186,7 @@ module BitClust::Subcommands
           @browser = "start"
         end
       end
-      system("#{browser} http://localhost:#{params[:Port]}/") if @browser
+      system("#{@browser} http://localhost:#{@params[:Port]}/") if @browser
       server.start
     end
 

data/lib/bitclust/subcommands/setup_command.rb

@@ -16,7 +16,7 @@ module BitClust::Subcommands
     def initialize
       @prepare = nil
       @cleanup = nil
-      @versions = ["1.8.7", "1.9.3"]
+      @versions = ["1.8.7", "1.9.3", "2.0.0"]
       @parser = OptionParser.new {|opt|
         opt.banner = "Usage: #{File.basename($0, '.*')} setup [options]"
         opt.on('--prepare', 'Prepare config file and checkout repository. Do not create database.') {

data/lib/bitclust/version.rb

@@ -1,3 +1,3 @@
 module BitClust
-  VERSION = "0.5.5"
+  VERSION = "0.6.0"
 end

data/test/test_nameutils.rb

@@ -60,6 +60,7 @@ class TestNameUtils < Test::Unit::TestCase
        "Net::HTTP"            => [true,  "Net::HTTP"],
        "Test::Unit::TestCase" => [true,  "Test::Unit::TestCase"],
        "ARGF.class"           => [true,  "ARGF.class"],
+       "Complex::compatible"  => [true,  "Complex::compatible"],
        "empty string"         => [false, ""],
        "following space"      => [false, "Array "],
        "leading space"        => [false, " Array"],
@@ -80,17 +81,19 @@ class TestNameUtils < Test::Unit::TestCase
        "String"               => ["String",             "String"],
        "Net::HTTP"            => ["Net=HTTP",           "Net::HTTP"],
        "Test::Unit::TestCase" => ["Test=Unit=TestCase", "Test::Unit::TestCase"],
-       "ARGF.class"           => ["ARGF.class",         "ARGF.class"])
+       "ARGF.class"           => ["ARGF.class",         "ARGF.class"],
+       "Complex::compatible"  => ["Complex=compatible", "Complex::compatible"])
   def test_classname2id(data)
     expected, target = data
     assert_equal(expected, classname2id(target))
   end
 
-    data("Array"              => ["Array",                "Array"],
-         "String"             => ["String",               "String"],
-         "Net=HTTP"           => ["Net::HTTP",            "Net=HTTP"],
-         "Test=Unit=TestCase" => ["Test::Unit::TestCase", "Test=Unit=TestCase"],
-         "ARGF.class"         => ["ARGF.class",           "ARGF.class"])
+  data("Array"              => ["Array",                "Array"],
+       "String"             => ["String",               "String"],
+       "Net=HTTP"           => ["Net::HTTP",            "Net=HTTP"],
+       "Test=Unit=TestCase" => ["Test::Unit::TestCase", "Test=Unit=TestCase"],
+       "ARGF.class"         => ["ARGF.class",           "ARGF.class"],
+       "Complex=compatible" => ["Complex::compatible",  "Complex=compatible"])
   def test_classid2name(data)
     expected, target = data
     assert_equal(expected, classid2name(target))
@@ -134,10 +137,10 @@ class TestNameUtils < Test::Unit::TestCase
     assert_equal(expected, methodid2classid(target))
   end
 
-    data("String/i.index._builtin"     => [:instance_method,  "String/i.index._builtin"],
-         "CGI/i.accept.cgi"            => [:instance_method,  "CGI/i.accept.cgi"],
-         "Net=HTTP/i.ca_path.net.http" => [:instance_method,  "Net=HTTP/i.ca_path.net.http"],
-         "String/s.new._builtin"       => [:singleton_method, "String/s.new._builtin"])
+  data("String/i.index._builtin"     => [:instance_method,  "String/i.index._builtin"],
+       "CGI/i.accept.cgi"            => [:instance_method,  "CGI/i.accept.cgi"],
+       "Net=HTTP/i.ca_path.net.http" => [:instance_method,  "Net=HTTP/i.ca_path.net.http"],
+       "String/s.new._builtin"       => [:singleton_method, "String/s.new._builtin"])
   def test_methodid2typename(data)
     expected, target = data
     assert_equal(expected, methodid2typename(target))
@@ -151,61 +154,61 @@ class TestNameUtils < Test::Unit::TestCase
     assert_equal(expected, methodid2mname(target))
   end
 
-    data("index"         => [true,  "index"],
-         "accept"        => [true,  "accept"],
-         "get"           => [true,  "get"],
-         "Array"         => [true,  "Array"],
-         "getIndex"      => [true,  "getIndex"],
-         "PROXY"         => [true,  "PROXY"],
-         "HTTP_PROXY"    => [true,  "HTTP_PROXY"],
-         "gsub!"         => [true,  "gsub!"],
-         "empty? "       => [true,  "empty?"],
-         "instance_eval" => [true,  "instance_eval"],
-         "__send"        => [true,  "__send"],
-         "__send__"      => [true,  "__send__"],
-         "__send!"       => [true,  "__send!"],
-         "+"             => [true,  "+"],
-         "-"             => [true,  "-"],
-         "*"             => [true,  "*"],
-         "/"             => [true,  "/"],
-         "&"             => [true,  "&"],
-         "|"             => [true,  "|"],
-         "^"             => [true,  "^"],
-         "`"             => [true,  "`"],
-         ">>"            => [true,  ">>"],
-         "<<"            => [true,  "<<"],
-         "+@"            => [true,  "+@"],
-         "-@"            => [true,  "-@"],
-         "!"             => [true,  "!"],
-         "!@"            => [true,  "!@"],
-         "~"             => [true,  "~"],
-         "**"            => [true,  "**"],
-         "<"             => [true,  "<"],
-         ">"             => [true,  ">"],
-         "<="            => [true,  "<="],
-         ">="            => [true,  ">="],
-         "=="            => [true,  "=="],
-         "==="           => [true,  "==="],
-         "=~"            => [true,  "=~"],
-         "[]"            => [true,  "[]"],
-         "[]="           => [true,  "[]="],
-         ""              => [false, ""],
-         "!="            => [true,  "!="],
-         "!~"            => [true,  "!~"],
-         "&&"            => [false, "&&"],
-         "||"            => [false, "||"],
-         "++"            => [false, "++"],
-         ">>>"           => [false, ">>>"],
-         "***"           => [false, "***"],
-         "===="          => [false, "===="],
-         "#accept"       => [false, "#accept"],
-         ".new"          => [false, ".new"],
-         ".#cp"          => [false, ".#cp"],
-         "$gvar"         => [false, "$gvar"],
-         "CGI#accept"    => [false, "CGI#accept"],
-         "String.new"    => [false, "String.new"],
-         "Net::HTTP.get" => [false, "Net::HTTP.get"],
-         "Net::HTTP.new" => [false, "Net::HTTP.new"])
+  data("index"         => [true,  "index"],
+       "accept"        => [true,  "accept"],
+       "get"           => [true,  "get"],
+       "Array"         => [true,  "Array"],
+       "getIndex"      => [true,  "getIndex"],
+       "PROXY"         => [true,  "PROXY"],
+       "HTTP_PROXY"    => [true,  "HTTP_PROXY"],
+       "gsub!"         => [true,  "gsub!"],
+       "empty? "       => [true,  "empty?"],
+       "instance_eval" => [true,  "instance_eval"],
+       "__send"        => [true,  "__send"],
+       "__send__"      => [true,  "__send__"],
+       "__send!"       => [true,  "__send!"],
+       "+"             => [true,  "+"],
+       "-"             => [true,  "-"],
+       "*"             => [true,  "*"],
+       "/"             => [true,  "/"],
+       "&"             => [true,  "&"],
+       "|"             => [true,  "|"],
+       "^"             => [true,  "^"],
+       "`"             => [true,  "`"],
+       ">>"            => [true,  ">>"],
+       "<<"            => [true,  "<<"],
+       "+@"            => [true,  "+@"],
+       "-@"            => [true,  "-@"],
+       "!"             => [true,  "!"],
+       "!@"            => [true,  "!@"],
+       "~"             => [true,  "~"],
+       "**"            => [true,  "**"],
+       "<"             => [true,  "<"],
+       ">"             => [true,  ">"],
+       "<="            => [true,  "<="],
+       ">="            => [true,  ">="],
+       "=="            => [true,  "=="],
+       "==="           => [true,  "==="],
+       "=~"            => [true,  "=~"],
+       "[]"            => [true,  "[]"],
+       "[]="           => [true,  "[]="],
+       ""              => [false, ""],
+       "!="            => [true,  "!="],
+       "!~"            => [true,  "!~"],
+       "&&"            => [false, "&&"],
+       "||"            => [false, "||"],
+       "++"            => [false, "++"],
+       ">>>"           => [false, ">>>"],
+       "***"           => [false, "***"],
+       "===="          => [false, "===="],
+       "#accept"       => [false, "#accept"],
+       ".new"          => [false, ".new"],
+       ".#cp"          => [false, ".#cp"],
+       "$gvar"         => [false, "$gvar"],
+       "CGI#accept"    => [false, "CGI#accept"],
+       "String.new"    => [false, "String.new"],
+       "Net::HTTP.get" => [false, "Net::HTTP.get"],
+       "Net::HTTP.new" => [false, "Net::HTTP.new"])
   def test_methodname?(data)
     expected, target = data
     assert_equal(expected, methodname?(target))
@@ -344,7 +347,7 @@ class TestNameUtils < Test::Unit::TestCase
        "=2a=2a"     => ["=2a=2a",        "=2a=2a"],
        "open=2duri" => ["open=2duri",    "open=2duri"],
        "Net=HTTP"   => ["-net=-h-t-t-p", "Net=HTTP"])
-  def test_encodeid
+  def test_encodeid(data)
     expected, target = data
     assert_equal(expected, encodeid(target))
   end
@@ -356,7 +359,7 @@ class TestNameUtils < Test::Unit::TestCase
        "=2a=2a"        => ["=2a=2a",     "=2a=2a"],
        "open=2duri"    => ["open=2duri", "open=2duri"],
        "-net=-h-t-t-p" => ["Net=HTTP",   "-net=-h-t-t-p"])
-  def test_decodeid
+  def test_decodeid(data)
     expected, target = data
     assert_equal(expected, decodeid(target))
   end
@@ -368,7 +371,7 @@ class TestNameUtils < Test::Unit::TestCase
        "**"       => ["=2a=2a",     "**"],
        "open-uri" => ["open=2duri", "open-uri"],
        "net.http" => ["net=2ehttp", "net.http"])
-  def test_encodename_fs
+  def test_encodename_fs(data)
     expected, target = data
     assert_equal(expected, encodename_fs(target))
   end
@@ -380,7 +383,7 @@ class TestNameUtils < Test::Unit::TestCase
        "=2a=2a"     => ["**",       "=2a=2a"],
        "open=2duri" => ["open-uri", "open=2duri"],
        "net=2ehttp" => ["net.http", "net=2ehttp"])
-  def test_decodename_fs
+  def test_decodename_fs(data)
     expected, target = data
     assert_equal(expected, decodename_fs(target))
   end

data/test/test_rdcompiler.rb

@@ -13,8 +13,17 @@ class TestRDCompiler < Test::Unit::TestCase
     @c = BitClust::RDCompiler.new(@u, 1, {:database => BitClust::MethodDatabase.dummy})
   end
 
-  def compile_and_assert_equal(expected, src)
-    assert_equal expected, @c.compile(src)
+  def assert_compiled_source(expected, src)
+    assert_equal(expected, @c.compile(src))
+  end
+
+  def assert_compiled_method_source(expected, src)
+    method_entry = Object.new
+    mock(method_entry).source{ src }
+    mock(method_entry).index_id(anything).any_times{ "dummy" }
+    mock(method_entry).defined?.any_times{ true }
+    mock(method_entry).id.any_times{ "String/i.index._builtin" }
+    assert_equal(expected, @c.compile_method(method_entry))
   end
 
   def test_dlist
@@ -42,8 +51,10 @@ c2-2
 </dd>
 </dl>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
+  end
 
+  def test_dlist_with_empty_line
     src = <<HERE
 : t1
  c1
@@ -72,8 +83,10 @@ c3
 </dd>
 </dl>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
+  end
 
+  def test_dlist_with_emlist
     src = <<HERE
 : t1
  c1
@@ -102,8 +115,10 @@ c2
 </dd>
 </dl>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
+  end
 
+  def test_dlist_with_paragraph
     src = <<HERE
 : t1
  c1
@@ -128,7 +143,7 @@ c2
 text
 </p>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
   end
 
   def test_pre
@@ -146,7 +161,7 @@ hoge
 foo
 </pre>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
 
     src = <<'HERE'
  pretext
@@ -160,7 +175,7 @@ pretext
 * hoge1
 </pre>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
   end
 
   def test_method
@@ -171,7 +186,7 @@ bar
  text
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>hoge</code></dt>
+<dt class="method-heading" id="dummy"><code>hoge</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <p>
 foo
@@ -182,8 +197,10 @@ text
 </pre>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
+  end
 
+  def test_method_with_emlist
     src = <<'HERE'
 --- <=>
 
@@ -193,7 +210,7 @@ text
 //}
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>self &lt;=&gt; </code></dt>
+<dt class="method-heading" id="dummy"><code>self &lt;=&gt; </code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <p>
 abs
@@ -203,8 +220,10 @@ text
 </pre>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
+  end
 
+  def test_method_with_dlist
     src = <<'HERE'
 --- method
 
@@ -212,7 +231,7 @@ HERE
   dsc
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>method</code></dt>
+<dt class="method-heading" id="dummy"><code>method</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <dl>
 <dt>word1</dt>
@@ -224,8 +243,10 @@ dsc
 </dl>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
+  end
 
+  def test_method_with_tags
     src = <<'HERE'
 --- method
 dsc
@@ -237,7 +258,7 @@ dsc
 @see hoge
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>method</code></dt>
+<dt class="method-heading" id="dummy"><code>method</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <p>
 dsc
@@ -261,8 +282,10 @@ dsc
 </p>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
+  end
 
+  def test_method_with_formatted_text
     src = <<'HERE'
 --- method
 
@@ -272,7 +295,7 @@ HERE
            dsc3
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>method</code></dt>
+<dt class="method-heading" id="dummy"><code>method</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <dl>
 <dt class='method-param'>[PARAM] arg:</dt>
@@ -286,8 +309,10 @@ dsc3
 </pre>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
+  end
 
+  def test_method_with_param_and_emlist
     src = <<'HERE'
 --- method
 
@@ -298,7 +323,7 @@ dsc3
 //}
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>method</code></dt>
+<dt class="method-heading" id="dummy"><code>method</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <dl>
 <dt class='method-param'>[PARAM] arg:</dt>
@@ -312,8 +337,7 @@ dsc3
 </dl>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
-
+    assert_compiled_method_source(expected, src)
   end
 
   def test_method2
@@ -325,7 +349,7 @@ bar
 HERE
     expected = <<'HERE'
 <dl>
-<dt class="method-heading"><code>hoge1</code></dt>
+<dt class="method-heading" id="dummy"><code>hoge1</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dt class="method-heading"><code>hoge2</code></dt>
 <dd class="method-description">
 <p>
@@ -334,7 +358,7 @@ bar
 </dd>
 </dl>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
   end
 
   def test_ulist
@@ -348,7 +372,7 @@ HERE
 <li>hoge2</li>
 </ul>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
 
     src = <<'HERE'
  * hoge1
@@ -363,7 +387,7 @@ HERE
 <li>hoge2</li>
 </ul>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
 
     src = <<'HERE'
  * hoge1
@@ -377,7 +401,7 @@ bar</li>
 <li>hoge2</li>
 </ul>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
 
   end
 
@@ -394,7 +418,7 @@ bar</li>
 <li>hoge2</li>
 </ol>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_source(expected, src)
   end
 
 
@@ -411,48 +435,43 @@ HERE
     end
   end
 
-  def test_bracket_link
-    [
-     ['[[c:String]]',      '<a href="dummy/class/String">String</a>'           ],
-     ['[[c:String ]]',     '[[c:String ]]'           ],
-     ['[[String]]',        '[[String]]'              ],
-     ['[[c:File::Stat]]',  '<a href="dummy/class/File=Stat">File::Stat</a>'    ],
-     ['[[m:String.new]]',  '<a href="dummy/method/String/s/new">String.new</a>'],
-     ['[[m:String#dump]]', '<a href="dummy/method/String/i/dump">String#dump</a>'],
-     ['[[m:String#[] ]]',  '<a href="dummy/method/String/i/=5b=5d">String#[]</a>'],
-     ['[[f:rb_ary_new3]]', '<a href="dummy/function/rb_ary_new3">rb_ary_new3</a>'],
-     ['[[f:/]]',           '<a href="dummy/function/">All C API</a>'],
-     ['[[f:_index]]',           '<a href="dummy/function/">All C API</a>'],
-     ['[[lib:jcode]]',     '<a href="dummy/library/jcode">jcode</a>'],
-     ['[[man:tr(1)]]',     '<a class="external" href="http://www.opengroup.org/onlinepubs/009695399/utilities/tr.html">tr(1)</a>'],
-     ['[[man:sys/socket.h(header)]]', '<a class="external" href="http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/socket.h.html">sys/socket.h(header)</a>'],
-     ['[[man:fopen(3linux)]]', '<a class="external" href="http://man7.org/linux/man-pages/man3/fopen.3.html">fopen(3linux)</a>'],
-     ['[[RFC:2822]]',      '<a class="external" href="http://www.ietf.org/rfc/rfc2822.txt">[RFC2822]</a>'],
-     ['[[m:$~]]',          '<a href="dummy/method/Kernel/v/=7e">$~</a>'],
-     ['[[m:$,]]',          '<a href="dummy/method/Kernel/v/=2c">$,</a>'],
-     ['[[c:String]]]', '<a href="dummy/class/String">String</a>]'],
-     ['[[c:String]][[c:String]]',
-      '<a href="dummy/class/String">String</a><a href="dummy/class/String">String</a>'],
-     ['[[m:File::SEPARATOR]]',          '<a href="dummy/method/File/c/SEPARATOR">File::SEPARATOR</a>'],
-     ['[[url:http://i.loveruby.net]]', '<a class="external" href="http://i.loveruby.net">http://i.loveruby.net</a>'],
-     ['[[ruby-list:12345]]',
-      '<a class="external" href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/12345">[ruby-list:12345]</a>'],
-    ].each{|src, expected|
-      assert_equal expected, @c.send(:compile_text, src), src
-    }
-
-    [
-     ['[[d:hoge/bar]]',             '<a href="dummy/hoge/bar">.*</a>'],
-     ['[[ref:d:hoge/bar#frag]]',    '<a href="dummy/hoge/bar#frag">.*</a>'],
-     ['[[ref:c:Hoge#frag]]',        '<a href="dummy/class/Hoge#frag">.*</a>'],
-     ['[[ref:m:$~#frag]]',          '<a href="dummy/method/Kernel/v/=7e#frag">.*</a>'],
-     ['[[ref:lib:jcode#frag]]',     '<a href="dummy/library/jcode#frag">.*</a>'],
-
-     ['[[ref:c:Hoge]]',             'compileerror'],
-     ['[[ref:ref:hoge/bar#frag]]',  'compileerror'],
-    ].each{|src, expected|
-      assert_match /#{expected}/, @c.send(:compile_text, src), src
-    }
+  data("class"               => ['[[c:String]]',      '<a href="dummy/class/String">String</a>'],
+       "with garbage"        => ['[[c:String ]]',     '[[c:String ]]'],
+       "missing type"        => ['[[String]]',        '[[String]]'],
+       "nested class"        => ['[[c:File::Stat]]',  '<a href="dummy/class/File=Stat">File::Stat</a>'],
+       "singleton method"    => ['[[m:String.new]]',  '<a href="dummy/method/String/s/new">String.new</a>'],
+       "instance method"     => ['[[m:String#dump]]', '<a href="dummy/method/String/i/dump">String#dump</a>'],
+       "indexer"             => ['[[m:String#[] ]]',  '<a href="dummy/method/String/i/=5b=5d">String#[]</a>'],
+       "C API"               => ['[[f:rb_ary_new3]]', '<a href="dummy/function/rb_ary_new3">rb_ary_new3</a>'],
+       "C API root"          => ['[[f:/]]',           '<a href="dummy/function/">All C API</a>'],
+       "C API index"         => ['[[f:_index]]',      '<a href="dummy/function/">All C API</a>'],
+       "standard library"    => ['[[lib:jcode]]',     '<a href="dummy/library/jcode">jcode</a>'],
+       "man command"         => ['[[man:tr(1)]]',     '<a class="external" href="http://www.opengroup.org/onlinepubs/009695399/utilities/tr.html">tr(1)</a>'],
+       "man header"          => ['[[man:sys/socket.h(header)]]', '<a class="external" href="http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/socket.h.html">sys/socket.h(header)</a>'],
+       "man system call"     => ['[[man:fopen(3linux)]]', '<a class="external" href="http://man7.org/linux/man-pages/man3/fopen.3.html">fopen(3linux)</a>'],
+       "RFC"                 => ['[[RFC:2822]]',      '<a class="external" href="http://www.ietf.org/rfc/rfc2822.txt">[RFC2822]</a>'],
+       "special var $~"      => ['[[m:$~]]',          '<a href="dummy/method/Kernel/v/=7e">$~</a>'],
+       "special var $,"      => ['[[m:$,]]',          '<a href="dummy/method/Kernel/v/=2c">$,</a>'],
+       "extra close bracket" => ['[[c:String]]]', '<a href="dummy/class/String">String</a>]'],
+       "continuity"          => ['[[c:String]][[c:String]]', '<a href="dummy/class/String">String</a><a href="dummy/class/String">String</a>'],
+       "constant"            => ['[[m:File::SEPARATOR]]', '<a href="dummy/method/File/c/SEPARATOR">File::SEPARATOR</a>'],
+       "url"                 => ['[[url:http://i.loveruby.net]]', '<a class="external" href="http://i.loveruby.net">http://i.loveruby.net</a>'],
+       "ruby-list"           => ['[[ruby-list:12345]]', '<a class="external" href="http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-list/12345">[ruby-list:12345]</a>'],)
+  def test_bracket_link(data)
+    target, expected = data
+    assert_equal(expected, @c.send(:compile_text, target), target)
+  end
+
+  data("doc"             => ['[[d:hoge/bar]]',            '<a href="dummy/hoge/bar">.*</a>'],
+       "ref doc"         => ['[[ref:d:hoge/bar#frag]]',   '<a href="dummy/hoge/bar#frag">.*</a>'],
+       "ref class"       => ['[[ref:c:Hoge#frag]]',       '<a href="dummy/class/Hoge#frag">.*</a>'],
+       "ref special var" => ['[[ref:m:$~#frag]]',         '<a href="dummy/method/Kernel/v/=7e#frag">.*</a>'],
+       "ref library"     => ['[[ref:lib:jcode#frag]]',    '<a href="dummy/library/jcode#frag">.*</a>'],
+       "ref class"       => ['[[ref:c:Hoge]]',            'compileerror'],
+       "ref ref"         => ['[[ref:ref:hoge/bar#frag]]', 'compileerror'],)
+  def test_bracket_link_doc(data)
+    target, expected = data
+    assert_match(/#{expected}/, @c.send(:compile_text, target), target)
   end
 
   def test_array_join
@@ -462,14 +481,14 @@ HERE
 @see [[m:Array#*]], [[m:$,]]
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>join(sep = $,) -&gt; String</code></dt>
+<dt class="method-heading" id="dummy"><code>join(sep = $,) -&gt; String</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <p>
 [SEE_ALSO] <a href="dummy/method/Array/i/=2a">Array#*</a>, <a href="dummy/method/Kernel/v/=2c">$,</a>
 </p>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
   end
 
   def test_todo
@@ -480,7 +499,7 @@ HERE
 description
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>puts(str) -&gt; String</code></dt>
+<dt class="method-heading" id="dummy"><code>puts(str) -&gt; String</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <p class="todo">
 [TODO]
@@ -490,7 +509,7 @@ description
 </p>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
   end
 
   def test_todo_with_comment
@@ -501,7 +520,7 @@ HERE
 description
 HERE
     expected = <<'HERE'
-<dt class="method-heading"><code>puts(str) -&gt; String</code></dt>
+<dt class="method-heading" id="dummy"><code>puts(str) -&gt; String</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>]</span></dt>
 <dd class="method-description">
 <p class="todo">
 [TODO] 1.9.2
@@ -511,24 +530,37 @@ description
 </p>
 </dd>
 HERE
-    compile_and_assert_equal(expected, src)
+    assert_compiled_method_source(expected, src)
   end
 
-  
+
   class BitClust::RDCompiler; public :man_url; end
-  
-  def test_man_url
-    assert_equal("http://www.opengroup.org/onlinepubs/009695399/utilities/tr.html",
-                 @c.man_url("1", "tr"))
-    assert_equal("http://www.opengroup.org/onlinepubs/009695399/functions/fopen.html",
-                 @c.man_url("3", "fopen"))
-    assert_equal("http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/socket.h.html",
-                 @c.man_url("header", "sys/socket.h"))
-    assert_equal("http://man7.org/linux/man-pages/man3/fopen.3.html",
-                 @c.man_url("3linux", "fopen"))
-    assert_equal("http://www.freebsd.org/cgi/man.cgi?query=fopen&sektion=3&manpath=FreeBSD+9.0-RELEASE",
-                 @c.man_url("3freebsd", "fopen"))
-    assert_equal(nil, @c.man_url("foo", "tr"))
-    
+
+  data("tr(1)" => {
+         :params => ["1", "tr"],
+         :expected => "http://www.opengroup.org/onlinepubs/009695399/utilities/tr.html"
+       },
+       "fopen(3)" => {
+         :params => ["3", "fopen"],
+         :expected => "http://www.opengroup.org/onlinepubs/009695399/functions/fopen.html"
+       },
+       "sys/socket.h(header)" => {
+         :params => ["header", "sys/socket.h"],
+         :expected => "http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/socket.h.html"
+       },
+       "fopen(3linux)" => {
+         :params => ["3linux", "fopen"],
+         :expected => "http://man7.org/linux/man-pages/man3/fopen.3.html"
+       },
+       "fopen(3freebsd)" => {
+         :params => ["3freebsd", "fopen"],
+         :expected => "http://www.freebsd.org/cgi/man.cgi?query=fopen&sektion=3&manpath=FreeBSD+9.0-RELEASE"
+       },
+       "tr(foo)" => {
+         :params => ["foo", "tr"],
+         :expected => nil
+       })
+  def test_man_url(data)
+    assert_equal(data[:expected], @c.man_url(*data[:params]))
   end
 end

data/theme/default/style.css

@@ -248,6 +248,11 @@ a.external:hover, a.external:focus, a.external:active {
     background-color: #33a;
 }
 
+span.permalink {
+    float: right;
+    font-weight: normal;
+}
+
 form {
     padding: 0px;
     margin: 0px;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitclust-core
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-19 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: test-unit-notify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -172,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3700746749855450805
+      hash: 1699377220203508
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,10 +213,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3700746749855450805
+      hash: 1699377220203508
 requirements: []
 rubyforge_project: ''
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: BitClust is a rurema document processor.