Merge pull request #191 from znz/feature/drop-source-location-line

source_location の行番号を削除して生成ドキュメントの差分肥大化を防ぐ

Author: znz

lib/bitclust/entry.rb

@@ -117,7 +117,7 @@ def deserializer
         when '[LibraryEntry]' then "restore_libraries(h['#{@name}'])"
         when '[ClassEntry]'   then "restore_classes(h['#{@name}'])"
         when '[MethodEntry]'  then "restore_methods(h['#{@name}'])"
-        when 'Location'       then "h['#{@name}']&.tap { |loc| break if loc.empty?; break Location.new(*loc.split(?:)) }"
+        when 'Location'       then "h['#{@name}']&.tap { |loc| break if loc.empty?; break Location.new(loc.split(?:).first, nil) }"
         else
           raise "must not happen: @type=#{@type.inspect}"
         end
@@ -135,7 +135,7 @@ def serializer
         when '[LibraryEntry]' then "serialize_entries(@#{@name})"
         when '[ClassEntry]'   then "serialize_entries(@#{@name})"
         when '[MethodEntry]'  then "serialize_entries(@#{@name})"
-        when 'Location'       then "@#@name.to_s"
+        when 'Location'       then "(@#{@name} && @#{@name}.file).to_s"
         else
           raise "must not happen: @type=#{@type.inspect}"
         end

lib/bitclust/functionreferenceparser.rb

@@ -61,7 +61,7 @@ def entry(header, body)
         f.name = h.name
         f.params = h.params
         f.source = body.join('')
-        f.source_location = body[0]&.location&.tap {|loc| break Location.new(@path, loc.line - 1) }
+        f.source_location = body[0]&.location && Location.new(@path, nil)
       }
     end
 

lib/bitclust/subcommands/statichtml_command.rb

@@ -91,7 +91,7 @@ def canonical_url(current_url)
         end
 
         def edit_url(location)
-          "#{@edit_base_url}/#{location.file}#L#{location.line}".sub(/([^:])\/\/+/, "\\1/")
+          "#{@edit_base_url}/#{location.file}".sub(/([^:])\/\/+/, "\\1/")
         end
 
         def encodename_package(str)

test/test_functionreferenceparser.rb

@@ -48,4 +48,15 @@ def test_parse_file(data)
       assert_equal data[:expected], result.collect(&:source)
     }
   end
+
+  # source_location points at the file only; the line number is no longer
+  # recorded (it would only churn the generated diffs).
+  def test_source_location_has_no_line_number
+    @db.transaction {
+      result = @parser.parse_file(@path, "test.c", {"version" => "2.6.0"})
+      location = result.first.source_location
+      assert_equal @path, location.file
+      assert_nil location.line
+    }
+  end
 end

test/test_methoddatabase.rb

@@ -57,6 +57,22 @@ def test_dynamic_include
                  @db.get_class("B").dynamically_included.map{|m| m.name})
   end
 
+  # source_location must be stored without a line number so that regenerating
+  # the database does not churn the persisted entries (and the generated HTML).
+  def test_source_location_serialized_without_line_number
+    entry = @db.search_methods(BitClust::MethodNamePattern.new(nil, nil, 'at_exit')).records.first.entry
+    entry.source_location = BitClust::Location.new('refm/api/src/_builtin/Kernel', 42)
+    assert_equal('refm/api/src/_builtin/Kernel', entry._get_properties['source_location'])
+  end
+
+  def test_source_location_roundtrip_drops_line_number
+    entry = @db.search_methods(BitClust::MethodNamePattern.new(nil, nil, 'at_exit')).records.first.entry
+    entry.source_location = BitClust::Location.new('refm/api/src/_builtin/Kernel', 42)
+    entry._set_properties(entry._get_properties)
+    assert_equal('refm/api/src/_builtin/Kernel', entry.source_location.file)
+    assert_nil(entry.source_location.line)
+  end
+
   private
   def setup_files
     FileUtils.mkdir_p("#{@root}/_builtin")

test/test_statichtml_command.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'bitclust'
+require 'bitclust/subcommands/statichtml_command'
+
+class TestStatichtmlURLMapperEx < Test::Unit::TestCase
+  def setup
+    @urlmapper = BitClust::Subcommands::StatichtmlCommand::URLMapperEx.new(
+      :suffix => 'html',
+      :edit_base_url => 'https://github.com/rurema/doctree/edit/master',
+    )
+  end
+
+  # The edit URL must not contain a line number, so that shifting source lines
+  # does not churn the generated HTML diff.
+  def test_edit_url_has_no_line_number
+    location = BitClust::Location.new('refm/api/src/_builtin/Array', 42)
+    assert_equal('https://github.com/rurema/doctree/edit/master/refm/api/src/_builtin/Array',
+                 @urlmapper.edit_url(location))
+  end
+
+  # A location restored from the database has no line number (nil); the edit URL
+  # must still be a clean file link without a trailing "#L".
+  def test_edit_url_without_line_in_location
+    location = BitClust::Location.new('refm/api/src/_builtin/Array', nil)
+    assert_equal('https://github.com/rurema/doctree/edit/master/refm/api/src/_builtin/Array',
+                 @urlmapper.edit_url(location))
+  end
+end