Support rustdoc JSON format v39

The change should be backward compatible: the tests pass on v39 and v33.

Author: jbourassa

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Adjust Rustdoc's json parsing for format v39.
+
 ## v0.4.0
 
 - Adjust Rustdoc's json parsing for format v26.

lib/yard-rustdoc/parser.rb

@@ -40,9 +40,11 @@ def parse
 
         methods = inner
           .fetch("impls")
-          .flat_map { |impl_id| @rustdoc_json.dig(impl_id, "inner", "impl", "items") }
+          .flat_map do |impl_id|
+            @rustdoc_json.dig(impl_id.to_s, "inner", "impl", "items")
+          end
           .filter_map do |method_id|
-            method_entry = @rustdoc_json.fetch(method_id)
+            method_entry = @rustdoc_json.fetch(method_id.to_s)
             next unless relevant_entry?(method_entry)
 
             Statements::Method.new(method_entry)

lib/yard-rustdoc/statements.rb

@@ -104,8 +104,13 @@ def name
       # Infers the scope (instance vs class) based on the usage of "self" or
       # "rb_self" as an arg name.
       def scope
-        arg_names = @rustdoc
-          .dig("inner", "function", "decl", "inputs")
+        inputs =
+          # JSON rustdoc FORMAT_VERSION < 34
+          @rustdoc.dig("inner", "function", "decl", "inputs") ||
+          # >= 34
+          @rustdoc.dig("inner", "function", "sig", "inputs")
+
+        arg_names = inputs
           .map(&:first)
           .slice(0, 2) # Magnus may inject a Ruby handle as arg0, hence we check 2 args
 

test/integration_test.rb

@@ -3,38 +3,44 @@
 require "test_helper"
 
 class IntegrationTest < Minitest::Test
-  def setup
-    super
-    parse_example
+  SUPPORTED_VERSIONS = ["v33", "v39"].freeze
+
+  def self.test(name, &block)
+    SUPPORTED_VERSIONS.each do |version|
+      define_method(:"test_#{name}_#{version}") do
+        parse_example(version)
+        instance_exec(&block)
+      end
+    end
   end
 
-  def test_class_can_be_renamed
+  test("class_can_be_renamed") do
     assert_defined("Example::Renamed")
   end
 
-  def test_method_can_be_renamed
+  test("method_can_be_renamed") do
     assert_defined("Example::Foo#renamed")
   end
 
-  def test_only_tagged_code_is_documented
+  test("only_tagged_code_is_documented") do
     assert_defined("Example::Foo.new")
     assert_defined("Example::Foo#bar")
     assert_defined("Example::SomeEnum")
     refute_defined("Example::Foo#secret")
     refute_defined("Example::Secret")
   end
 
-  def test_rb_self_as_first_param_defines_instance_method
+  test("rb_self_as_first_param_defines_instance_method") do
     refute_defined("Example::Foo.with_rb_self")
     assert_defined("Example::Foo#with_rb_self")
   end
 
-  def test_self_and_rb_self_works_with_ruby_arg
+  test("self_works_with_ruby_arg") do
     refute_defined("Example::Foo.with_ruby_and_rb_self")
     assert_defined("Example::Foo#with_ruby_and_rb_self")
   end
 
-  def test_params_are_extracted_from_def
+  test("params_are_extracted_from_def") do
     foo_bar = YARD::Registry.at("Example::Foo#bar")
     params = foo_bar.parameters.to_h
     expected = {
@@ -50,12 +56,12 @@ def test_params_are_extracted_from_def
     assert_equal(expected, params)
   end
 
-  def test_removes_atyard_tag
+  test("removes_atyard_tag") do
     foobar = YARD::Registry.at("Example::Foo#bar")
     refute(foobar.has_tag?("yard"), "@yard tag should be removed")
   end
 
-  def test_struct_can_be_a_module
+  test("struct_can_be_a_module") do
     not_class = YARD::Registry.at("NotClass")
     assert_equal(:module, not_class.type)
   end

test/samples/example-ext/Rakefile

@@ -15,17 +15,27 @@ namespace :doc do
 
   desc "Generate Rust documentation as JSON"
   task :rustdoc do
-    target_dir = "tmp"
+    require "fileutils"
+    require "json"
+
     ext_name = "example"
+    nightly = "+nightly"
+    nightly += "-#{ENV["NIGHTLY_VERSION"]}" if ENV["NIGHTLY_VERSION"]
+
     run(<<~CMD)
-      cargo +nightly rustdoc \
-        --target-dir #{target_dir} \
+      cargo #{nightly} rustdoc \
+        --target-dir tmp \
         -p #{ext_name} \
         -- \
         -Zunstable-options --output-format json --document-private-items
     CMD
 
+    rustdoc_path = "tmp/doc/#{ext_name}.json"
+    version = JSON.load_file(rustdoc_path).fetch("format_version")
+
+    FileUtils.mkdir_p("rustdoc")
     run("cp #{rustdoc_path} rustdoc.json")
+    run("cp #{rustdoc_path} rustdoc/v#{version}.json")
   end
 
   def run(cmd)

test/samples/example-ext/rustdoc.json

@@ -9,9 +9,9 @@
 class Minitest::Test
   private
 
-  def parse_example
+  def parse_example(version)
     Dir.chdir("test/samples/example-ext") do
-      parse_file("rustdoc.json")
+      parse_file("rustdoc/#{version}.json")
     end
   end