bitclust-core 1.2.1 → 1.2.6

data/lib/bitclust/syntax_highlighter.rb

@@ -122,17 +122,18 @@ module BitClust
       @stack = []
       @name_buffer = []
       @__lexer.define_singleton_method(:on_parse_error) do |message|
-        raise ParseError.new(filename, self.lineno, self.column, message)
+        raise ParseError.new(filename, self.lineno, self.column, "#{message}\n#{src}")
       end
       @__lexer.define_singleton_method(:compile_error) do |message|
-        raise CompileError.new(filename, self.lineno, self.column, message)
+        raise CompileError.new(filename, self.lineno, self.column, "#{message}\n#{src}")
       end
     end
 
     def on_default(event, token, data)
       event_name = event.to_s.sub(/\Aon_/, "")   # :on_event --> "event"
       style = COLORS[event_name.to_sym]
-      data << (style ? "<span class=\"#{style}\">#{escape_html(token)}</span>" : token)
+      escaped_token = escape_html(token)
+      data << (style ? "<span class=\"#{style}\">#{escaped_token}</span>" : escaped_token)
       data
     end
 
@@ -215,6 +216,7 @@ module BitClust
       when token == "::" && [:class, :module].include?(@stack.last)
         @name_buffer << token
       else
+        @stack.pop if @stack.last == :method_call
         on_default(:on_op, token, data)
       end
       data

data/lib/bitclust/version.rb

@@ -1,3 +1,3 @@
 module BitClust
-  VERSION = "1.2.1"
+  VERSION = "1.2.6"
 end

data/test/test_bitclust.rb

@@ -31,7 +31,7 @@ HERE
   end
 
   def search_capi(command, *argv)
-    db = BitClust::FunctionDatabase.new(@tmpdir)
+    _db = BitClust::FunctionDatabase.new(@tmpdir)
     cmd = case command
           when "lookup"
             BitClust::Subcommands::LookupCommand.new

data/test/test_entry.rb

@@ -9,6 +9,14 @@ alias HogeHoge
 alias HogeHogeHoge
 == Class Methods
 --- hoge
+hoge
+--- fuga
+@undef
+fuga
+== Instance Methods
+--- fugafuga
+@undef
+fugafuga
 = class Bar < Hoge
 == Class Methods
 --- bar
@@ -19,7 +27,7 @@ HERE
   end
 
   def test_entries
-    assert_equal(['bar', 'hoge'],
+    assert_equal(['bar', 'fuga', 'fugafuga', 'hoge'],
                  @lib.fetch_class("Bar").entries(1).map{|e| e.name}.sort)
   end
 
@@ -45,6 +53,11 @@ HERE
     assert(@lib.fetch_class("ErrErr").error_class?)
   end
 
+  def test_partitioned_entries
+    parts = @lib.fetch_class('Hoge').partitioned_entries
+    assert_equal(['fuga', 'fugafuga'], parts.undefined.map(&:name))
+  end
+
   def test_superclass
     assert('Exception', @lib.fetch_class("Err").superclass.name)
     assert('Exception', @lib.fetch_class("ErrErr").superclass.name)

data/test/test_functionreferenceparser.rb

@@ -33,12 +33,12 @@ HERE
          :version   => "1.9.3",
          :expected  => ["some text 2\n"],
        },
-       "2.0.0" => {
-         :version   => "2.0.0",
+       "2.5.0" => {
+         :version   => "2.5.0",
          :expected  => ["some text 1\n"],
        },
-       "2.1.0" => {
-         :version   => "2.1.0",
+       "2.6.0" => {
+         :version   => "2.6.0",
          :expected  => ["some text 1\n"],
        })
   def test_parse_file(data)

data/test/test_preprocessor.rb

@@ -109,6 +109,27 @@ HERE
     assert_equal(expected, ret.join)
   end
 
+  def test_nested_condition
+    params = { 'version' => '2.4.0' }
+    src = <<~'HERE'
+      #@until 2.4.0
+      #@since 1.8.7
+      #@since 1.9.3
+      #@since 2.0.0
+      Not display here!
+      #@end
+      #@end
+      #@end
+      #@end
+      Display here!
+    HERE
+    expected = <<~HERE
+      Display here!
+    HERE
+    ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+    assert_equal(expected, ret.join)
+  end
+
   sub_test_case("samplecode") do
 
     def test_samplecode

data/test/test_rdcompiler.rb

@@ -3,6 +3,7 @@ require 'bitclust/database'
 require 'bitclust/methoddatabase'
 require 'bitclust/screen'
 require 'test/unit'
+require 'test/unit/rr'
 require 'timeout'
 
 class TestRDCompiler < Test::Unit::TestCase
@@ -835,4 +836,243 @@ HERE
   def test_rdoc_link(data)
     assert_equal(data[:expected], @c.rdoc_link(data[:method_id], data[:version]))
   end
+
+  def test_paragraph_with_single_line
+    source = <<~SOURCE
+      a
+    SOURCE
+    expected = <<~HTML
+      <p>
+      a
+      </p>
+    HTML
+    assert_equal(
+      expected,
+      @c.compile(source)
+    )
+  end
+
+  def test_paragraph_with_newline_between_ascii_and_ascii
+    source = <<~SOURCE
+      a
+      a
+    SOURCE
+    expected = <<~HTML
+      <p>
+      a
+      a
+      </p>
+    HTML
+    assert_equal(
+      expected,
+      @c.compile(source)
+    )
+  end
+
+  def test_paragraph_with_newline_between_ascii_and_non_ascii
+    source = <<~SOURCE
+      a
+      あ
+    SOURCE
+    expected = <<~HTML
+      <p>
+      a
+      あ
+      </p>
+    HTML
+    assert_equal(
+      expected,
+      @c.compile(source)
+    )
+  end
+
+  def test_paragraph_with_newline_between_non_ascii_and_ascii
+    source = <<~SOURCE
+      あ
+      a
+    SOURCE
+    expected = <<~HTML
+      <p>
+      あ
+      a
+      </p>
+    HTML
+    assert_equal(
+      expected,
+      @c.compile(source)
+    )
+  end
+
+  def test_paragraph_with_newline_between_non_ascii_and_non_ascii
+    source = <<~SOURCE
+      あ
+      あ
+    SOURCE
+    expected = <<~HTML
+      <p>
+      ああ
+      </p>
+    HTML
+    assert_equal(
+      expected,
+      @c.compile(source)
+    )
+  end
+
+  def test_definition_list_with_ascii
+    source = <<~SOURCE
+      : b
+        あ
+        あ
+    SOURCE
+    expected = <<~HTML
+      <dl>
+      <dt>b</dt>
+      <dd>
+      <p>
+      ああ
+      </p>
+      </dd>
+      </dl>
+    HTML
+    assert_equal(
+      expected,
+      @c.compile(source)
+    )
+  end
+
+  def test_definition_list_with_non_ascii
+    source = <<~SOURCE
+      : b
+        a
+        a
+    SOURCE
+    expected = <<~HTML
+      <dl>
+      <dt>b</dt>
+      <dd>
+      <p>
+      a
+      a
+      </p>
+      </dd>
+      </dl>
+    HTML
+    assert_equal(
+      expected,
+      @c.compile(source)
+    )
+  end
+
+  def test_entry_info_with_ascii
+    source = <<~SOURCE
+      --- b
+
+      @param arg あ
+        あ
+    SOURCE
+    expected = <<~HTML
+      <dt class="method-heading" id="dummy"><code>b</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>][<a href="https://docs.ruby-lang.org/en/2.0.0/String.html#method-i-index">rdoc</a>]</span></dt>
+      <dd class="method-description">
+      <dl>
+      <dt class='method-param'>[PARAM] arg:</dt>
+      <dd>
+      ああ
+      </dd>
+      </dl>
+      </dd>
+    HTML
+    assert_compiled_method_source(expected, source)
+  end
+
+  def test_entry_info_with_non_ascii
+    source = <<~SOURCE
+      --- b
+      @param arg a
+        a
+    SOURCE
+    expected = <<~HTML
+      <dt class="method-heading" id="dummy"><code>b</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>][<a href="https://docs.ruby-lang.org/en/2.0.0/String.html#method-i-index">rdoc</a>]</span></dt>
+      <dd class="method-description">
+      <dl>
+      <dt class='method-param'>[PARAM] arg:</dt>
+      <dd>
+      a
+      a
+      </dd>
+      </dl>
+      </dd>
+    HTML
+    assert_compiled_method_source(expected, source)
+  end
+
+  def test_entry_paragraph_with_ascii
+    source = <<~SOURCE
+      --- b
+      あ
+      あ
+    SOURCE
+    expected = <<~HTML
+      <dt class="method-heading" id="dummy"><code>b</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>][<a href="https://docs.ruby-lang.org/en/2.0.0/String.html#method-i-index">rdoc</a>]</span></dt>
+      <dd class="method-description">
+      <p>
+      ああ
+      </p>
+      </dd>
+    HTML
+    assert_compiled_method_source(expected, source)
+  end
+
+  def test_entry_paragraph_with_non_ascii
+    source = <<~SOURCE
+      --- b
+      a
+      a
+    SOURCE
+    expected = <<~HTML
+      <dt class="method-heading" id="dummy"><code>b</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>][<a href="https://docs.ruby-lang.org/en/2.0.0/String.html#method-i-index">rdoc</a>]</span></dt>
+      <dd class="method-description">
+      <p>
+      a
+      a
+      </p>
+      </dd>
+    HTML
+    assert_compiled_method_source(expected, source)
+  end
+
+  def test_entry_see_with_ascii
+    source = <<~SOURCE
+      --- b
+      @see あ
+        あ
+    SOURCE
+    expected = <<~HTML
+      <dt class="method-heading" id="dummy"><code>b</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>][<a href="https://docs.ruby-lang.org/en/2.0.0/String.html#method-i-index">rdoc</a>]</span></dt>
+      <dd class="method-description">
+      <p>
+      [SEE_ALSO] ああ
+      </p>
+      </dd>
+    HTML
+    assert_compiled_method_source(expected, source)
+  end
+
+  def test_entry_see_with_non_ascii
+    source = <<~SOURCE
+      --- b
+      @see a
+        a
+    SOURCE
+    expected = <<~HTML
+      <dt class="method-heading" id="dummy"><code>b</code><span class="permalink">[<a href="dummy/method/String/i/index">permalink</a>][<a href="https://docs.ruby-lang.org/en/2.0.0/String.html#method-i-index">rdoc</a>]</span></dt>
+      <dd class="method-description">
+      <p>
+      [SEE_ALSO] a
+      a
+      </p>
+      </dd>
+    HTML
+    assert_compiled_method_source(expected, source)
+  end
 end

data/test/test_rrdparser.rb

@@ -23,4 +23,20 @@ a
 HERE
     assert_equal(["", "==[a:hoge]hoge\na\n"], result)
   end
+
+  def test_undef
+    result = BitClust::RRDParser.parse(<<HERE, 'dummy')
+= module Dummy
+== Instance Methods
+--- test_undef
+
+@undef
+
+このメソッドは利用できない
+
+HERE
+    _library, methoddatabase = result
+    test_undef_spec = BitClust::MethodSpec.parse('Dummy#test_undef')
+    assert_equal(:undefined, methoddatabase.get_method(test_undef_spec).kind)
+  end
 end

data/test/test_syntax_highlighter.rb

@@ -7,15 +7,15 @@ class TestSyntaxHighlighter < Test::Unit::TestCase
 
   sub_test_case "syntax error" do
     test "single line" do
-      src = "...\n"
-      assert_raise(BitClust::SyntaxHighlighter::ParseError.new("-", 1, 3, "syntax error, unexpected ...")) do
+      src = "foo(\n"
+      assert_raise(BitClust::SyntaxHighlighter::ParseError.new("-", 1, 5, "syntax error, unexpected end-of-input, expecting ')'\n#{src}")) do
         highlight(src)
       end
     end
 
     test "multiple line" do
-      src = "a = 1\n...\n"
-      assert_raise(BitClust::SyntaxHighlighter::ParseError.new("-", 2, 3, "syntax error, unexpected ..., expecting end-of-input")) do
+      src = "a = 1\nfoo(\n"
+      assert_raise(BitClust::SyntaxHighlighter::ParseError.new("-", 2, 5, "syntax error, unexpected end-of-input, expecting ')'\n#{src}")) do
         highlight(src)
       end
     end
@@ -64,4 +64,22 @@ class TestSyntaxHighlighter < Test::Unit::TestCase
       assert_equal(expected, highlight(source))
     end
   end
+
+  test 'htmlescape' do
+    source = 'puts /<a>/'
+    expected = '<span class="nb">puts</span> <span class="sr">/&lt;a&gt;/</span>'
+    assert_equal(expected, highlight(source))
+  end
+
+  test 'symbol method' do
+    source = <<~END
+      p 1.!
+      p 2
+    END
+    expected = <<~END
+      <span class="nb">p</span> <span class="mi">1</span><span class="p">.</span><span class="o">!</span>
+      <span class="nb">p</span> <span class="mi">2</span>
+    END
+    assert_equal(expected, highlight(source))
+  end
 end

data/theme/default/rurema.svg

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<svg width="16" height="16" viewBox="0 0 16 16" version="1.1" xmlns="http://www.w3.org/2000/svg">
+  <rect x="2" y="1" width="12" height="12" fill="#33a"/>
+
+  <rect x="4" y="2" width="8" height="10" fill="#f00"/>
+  <rect x="3" y="3" width="1" height="8" fill="#000"/>
+  <rect x="5" y="1" width="6" height="1" fill="#000"/>
+  <rect x="12" y="3" width="1" height="8" fill="#000"/>
+  <rect x="5" y="12" width="6" height="1" fill="#000"/>
+
+  <rect x="4" y="2" width="1" height="1" fill="#300"/>
+  <rect x="11" y="2" width="1" height="1" fill="#300"/>
+  <rect x="4" y="11" width="1" height="1" fill="#300"/>
+  <rect x="11" y="11" width="1" height="1" fill="#300"/>
+
+  <rect x="5" y="3" width="1" height="1" fill="#600"/>
+  <rect x="10" y="3" width="1" height="1" fill="#600"/>
+  <rect x="5" y="10" width="1" height="1" fill="#600"/>
+  <rect x="10" y="10" width="1" height="1" fill="#600"/>
+
+  <rect x="6" y="4" width="4" height="6" fill="#000"/>
+  <rect x="7" y="5" width="2" height="4" fill="#f00"/>
+
+  <rect x="2" y="0" width="12" height="1" fill="#000"/>
+  <rect x="14" y="0" width="1" height="14" fill="#000"/>
+  <rect x="2" y="13" width="12" height="1" fill="#000"/>
+  <rect x="1" y="1" width="1" height="14" fill="#000"/>
+  <rect x="2" y="14" width="11" height="1" fill="#ccc"/>
+  <rect x="13" y="14" width="1" height="1" fill="#000"/>
+  <rect x="2" y="15" width="13" height="1" fill="#000"/>
+</svg>