yard-rustdoc 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4967b9c11e8b1ae8ee17256f03033e05312d501c80c0d7b064b406be63b5855d
-  data.tar.gz: 43b2bd77f9fc7c99ec64ae6d499c55fbf9882cbe65a9d550b08cf03ea2c7bf55
+  metadata.gz: 78e74a92126b3580032529eaa4f17361eb6d4dd885b1dcb42ce1ccae71afa130
+  data.tar.gz: c978d783880150a402baf41aca076ca0a736c988b32e6283ac953ca0b86c0377
 SHA512:
-  metadata.gz: 0433a034cdf09fe3187b4d206bc857353ee79e56177908157c9c894b5149dc9433f1676ab06dbd7b524fb7a803c4ec5e4072a9f4846e7c995600382f29253fc8
-  data.tar.gz: 258f273a75c1ed52c12a8718641e6ae459acf0d45edba16826d7903d39072e55f4b23bf6fa27fd9f6920a19c9728a1d4f7383c013e7571b45a95d3ff59ac42b6
+  metadata.gz: 50e53c9f30f82fd56bfa040176b127ac72cb5015463a5d738a01a73814fba8ba984862b3ac0b81968063654d0031237a390878073edd50a1978505df911f30b8
+  data.tar.gz: 53743f0a93ada894d5532d7d86d57cd88a6e68446f8c065582012cae96c02431f995c4146049c36e893b4912691ce9d5635bf89ab7d5c2d46ec2f8e469028e0b

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,11 +30,17 @@ 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 { |impl_id| @rustdoc_json.dig(impl_id, "inner", "impl", "items") }
           .filter_map do |method_id|
             method_entry = @rustdoc_json.fetch(method_id)
             next unless relevant_entry?(method_entry)
@@ -45,6 +51,9 @@ module YARD::Parser::Rustdoc
         @entries << Statements::Struct.new(entry, methods)
       end
 
+      # Ensure Foo comes before Foo::Bar
+      @entries.sort! { |a, b| a.name <=> b.name }
+
       self
     end
 

data/lib/yard-rustdoc/statements.rb

@@ -101,9 +101,15 @@ 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"
+        arg_names = @rustdoc
+          .dig("inner", "function", "decl", "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.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-rustdoc
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Jimmy Bourassa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Generate YARD documentation for Magnus-based Rust gems.