yard-rustdoc 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4967b9c11e8b1ae8ee17256f03033e05312d501c80c0d7b064b406be63b5855d
-  data.tar.gz: 43b2bd77f9fc7c99ec64ae6d499c55fbf9882cbe65a9d550b08cf03ea2c7bf55
+  metadata.gz: 2865669c4e16cefc604ce146b03c11130e44986ef1a6360cf6ab56dd38c98743
+  data.tar.gz: f79735602e4918682e65414fba5385481bac96c458a3b457d2c19ce9d6944baf
 SHA512:
-  metadata.gz: 0433a034cdf09fe3187b4d206bc857353ee79e56177908157c9c894b5149dc9433f1676ab06dbd7b524fb7a803c4ec5e4072a9f4846e7c995600382f29253fc8
-  data.tar.gz: 258f273a75c1ed52c12a8718641e6ae459acf0d45edba16826d7903d39072e55f4b23bf6fa27fd9f6920a19c9728a1d4f7383c013e7571b45a95d3ff59ac42b6
+  metadata.gz: f81d966d9cf1282bda8958b23be4a9ffa9d99011ac9d0935f1128cdcfb2921bc558a7d4b047703de8b8a179519c63a40c12710cde93938fc5386a5ae3ec2131c
+  data.tar.gz: f20846eba5aed1f53aa05818a5ad573b2cbd1088b1c2575038cd6f5ff01d74bcd034e2c7178f9e5c702b3ed1250772b65412b9438c9179201168025f9353bdf2

data/README.md

@@ -58,7 +58,7 @@ The `@rename` tag renames the class to `Foo::Baz`.
 
 ```rust
 /// @yard
-/// @remame Foo::Baz
+/// @rename Foo::Baz
 pub struct InnerName { }
 ```
 
@@ -68,7 +68,7 @@ Defines `Foo::Bar.new` -- class method because the first argument isn't `self`.
 impl Bar {
     /// @yard
     /// @return [Foo::Bar]
-    fn build() -> Self {}
+    fn new() -> Self {}
 }
 ```
 
@@ -109,7 +109,7 @@ impl Bar {
 
 #### Tips
 
-YARD's syntax differs from what Rustdoc expects. Linters you man want to disable:
+YARD's syntax differs from what Rustdoc expects. Linters you might want to disable:
 
 ```rust
 #![allow(rustdoc::broken_intra_doc_links)]

data/lib/yard-rustdoc/parser.rb

@@ -30,13 +30,21 @@ module YARD::Parser::Rustdoc
 
       @rustdoc_json.each do |id, entry|
         next unless relevant_entry?(entry)
-        next unless TOP_LEVEL_KINDS.include?(entry["kind"])
 
-        methods = entry
-          .dig("inner", "impls")
-          .flat_map { |impl_id| @rustdoc_json.dig(impl_id, "inner", "items") }
+        # "inner" is a Rust enum serialized with serde, resulting in a
+        # { "variant": { ...variant fields... } } structure.
+        # See https://github.com/rust-lang/rust/blob/f79a912d9edc3ad4db910c0e93672ed5c65133fa/src/rustdoc-json-types/lib.rs#L104
+        kind, inner = entry["inner"].first
+
+        next unless TOP_LEVEL_KINDS.include?(kind)
+
+        methods = inner
+          .fetch("impls")
+          .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)
@@ -45,6 +53,9 @@ module YARD::Parser::Rustdoc
         @entries << Statements::Struct.new(entry, methods)
       end
 
+      # Ensure Foo comes before Foo::Bar
+      @entries.sort_by!(&:name)
+
       self
     end
 

data/lib/yard-rustdoc/statements.rb

@@ -101,9 +101,20 @@ module YARD::Parser::Rustdoc
         @name || @rustdoc.fetch("name")
       end
 
+      # Infers the scope (instance vs class) based on the usage of "self" or
+      # "rb_self" as an arg name.
       def scope
-        first_arg = @rustdoc.dig("inner", "decl", "inputs", 0, 0)
-        if first_arg == "self" || first_arg == "rb_self"
+        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
+
+        if arg_names.include?("self") || arg_names.include?("rb_self")
           :instance
         else
           :class

data/lib/yard-rustdoc/version.rb

@@ -2,6 +2,6 @@
 
 module YARD
   module Rustdoc
-    VERSION = "0.3.2"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yard-rustdoc
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Jimmy Bourassa
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +79,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-description:
 email:
 - jbourassa@gmail.com
 executables: []
@@ -100,7 +98,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/oxidize-rb/yard-rustdoc
   source_code_uri: https://github.com/oxidize-rb/yard-rustdoc
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Generate YARD documentation for Magnus-based Rust gems.
 test_files: []