Merge pull request #219 from znz/meta-description-plain-text

meta description の改行由来の空白とブラケットリンクを整形する

Author: znz

lib/bitclust/classentry.rb

@@ -425,7 +425,7 @@ def inherited_method_specs
     end
 
     def description
-      display_text(source.split(/\n\n+/, 2)[0].strip)
+      description_text(source.split(/\n\n+/, 2)[0].strip)
     end
 
     def clear_cache

lib/bitclust/docentry.rb

@@ -84,7 +84,7 @@ def libraries
     end
 
     def description
-      display_text(source.split(/\n\n/, 2)[0].strip)
+      description_text(source.split(/\n\n/, 2)[0].strip)
     end
   end
 end

lib/bitclust/entry.rb

@@ -165,6 +165,25 @@ def display_text(text)
     end
     private :display_text
 
+    # BitClust::RDCompiler::BracketLink と同等の正規表現(/n なし)
+    BracketLink = /\[\[[\w-]+?:[!-~]+?(?:\[\] )?\]\]/
+
+    # meta description など、コンパイラを通さずマークアップも解釈されない
+    # 場所に使うテキスト。非 ASCII 文字間の改行は削除し(ブラウザでは
+    # 空白扱いになり日本語文中に不自然な空白が見えるため)、残りの改行は
+    # 空白に変換、ブラケットリンクはリンク先名のみにする
+    def description_text(text)
+      text = display_text(text)
+      return text unless text
+      text = text.split("\n").map(&:strip).join("\n")
+        .gsub(/(\P{ascii})\n(?=\P{ascii})/) { $1 || raise }
+        .tr("\n", ' ')
+      text.gsub(BracketLink) {|link|
+        ((link[2..-3] || raise).split(':', 2).last || raise).rstrip
+      }
+    end
+    private :description_text
+
     def type_id
       self.class.type_id
     end

lib/bitclust/functionentry.rb

@@ -79,7 +79,7 @@ def header
     end
 
     def description
-      display_text(source.split(/\n\n+/, 2)[0].strip)
+      description_text(source.split(/\n\n+/, 2)[0].strip)
     end
   end
 end

lib/bitclust/libraryentry.rb

@@ -80,7 +80,7 @@ def inspect
     end
 
     def description
-      display_text(source.split(/\n\n+/, 2)[0])
+      description_text(source.split(/\n\n+/, 2)[0])
     end
 
     def check_link(path = [])

lib/bitclust/methodentry.rb

@@ -216,7 +216,7 @@ def undefined?
     end
 
     def description
-      display_text(source.split(/\n\n+/, 3)[1])
+      description_text(source.split(/\n\n+/, 3)[1])
     end
   end
 end

sig/bitclust/entry.rbs

@@ -42,6 +42,12 @@ module BitClust
     # サブクラスで定義されている
     def self.type_id: () -> Symbol
 
+    BracketLink: ::Regexp
+
+    def display_text: (String? text) -> String?
+
+    def description_text: (String? text) -> String?
+
     def type_id: () -> Symbol
 
     # for entry_class.type_id

test/test_entry.rb

@@ -72,3 +72,73 @@ def test_instance_method?
     assert(hoge.instance_method?('fugafuga', false))
   end
 end
+
+class TestEntryDescription < Test::Unit::TestCase
+  def parse_class(class_source)
+    lib, = BitClust::RRDParser.parse(class_source, 'hoge')
+    lib.fetch_class('Hoge')
+  end
+
+  def test_description_truncates_newline_between_non_ascii
+    klass = parse_class(<<HERE)
+= class Hoge
+これは1行目で
+あとに続きます。
+
+以降の段落は含まれません。
+HERE
+    assert_equal('これは1行目であとに続きます。', klass.description)
+  end
+
+  def test_description_truncates_consecutive_newlines_between_non_ascii
+    klass = parse_class(<<HERE)
+= class Hoge
+あい
+うえ
+おか。
+HERE
+    assert_equal('あいうえおか。', klass.description)
+  end
+
+  def test_description_converts_newline_to_space_around_ascii
+    klass = parse_class(<<HERE)
+= class Hoge
+first line
+second line
+HERE
+    assert_equal('first line second line', klass.description)
+  end
+
+  def test_description_replaces_bracket_link_with_plain_text
+    klass = parse_class(<<HERE)
+= class Hoge
+自身の hostname を文字列で返します。また、[[m:URI::Generic#host]] が設
+定されていない場合は [[c:Array]] を返します。
+HERE
+    assert_equal('自身の hostname を文字列で返します。また、URI::Generic#host が設定されていない場合は Array を返します。',
+                 klass.description)
+  end
+
+  def test_description_replaces_indexer_bracket_link
+    klass = parse_class(<<HERE)
+= class Hoge
+[[m:String#[] ]] を参照。
+HERE
+    assert_equal('String#[] を参照。', klass.description)
+  end
+
+  def test_method_description_is_plain_text
+    klass = parse_class(<<HERE)
+= class Hoge
+== Instance Methods
+--- fuga
+
+[[c:Array]] を日本語で
+返します。
+
+次の段落。
+HERE
+    method = klass.entries.detect {|m| m.name == 'fuga' }
+    assert_equal('Array を日本語で返します。', method.description)
+  end
+end