yard 0.9.37 → 0.9.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0774d1772b133075737690acbc502767f6fef28d3765a14929074259248f3981
-  data.tar.gz: '068103b3caf24a6c6071a6c9b0f52bd58641fd0c03e22220fb2d1b09a104385c'
+  metadata.gz: a3a536051e6077e89b4ef2bc4ac2f30e60b8e65d33cdca957fed25644bf901a7
+  data.tar.gz: 6f4a7736baaeec0a55e7595b12f5828927fc46115e20e4dd919e96543541cbbd
 SHA512:
-  metadata.gz: 64a799b2f45d7ad6aad8684c805344f242c8e2f8ef1c60a43094bc237bccd449ee1c93c60c0f54a36f05a79e5b652636d7170dce85941b1f74a4bcc173c92c21
-  data.tar.gz: b19ba690f1a244b0c7df5c1524f77355323fa9164e9496c609f258b3d0691c0a3d807cd985f20f335884ba1d8e97193149d4a7b9e1eebd9ed3a43431492a1ce3
+  metadata.gz: b9a5348496a1778b2f4a7793df24716329a665fdabbe237932cd126c8309be4543d35b35a279e4ddb3cb31978c1b6e88ae0b799004ee79f2316d6896b9057201
+  data.tar.gz: f5c993f3808b9f5baca0c8fc1f92abeb7a113b1be7164dfd71b0b4bff98c58416ea5a82baf473780995d132bbbd7ffbbbffceddb01fda40993fac04bdb790cf8

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # main
 
+# [0.9.38] - December 5th, 2025
+
+[0.9.38]: https://github.com/lsegal/yard/compare/v0.9.37...v0.9.38
+
+- Add support for complex constant assignment (#1599)
+- Add support for Data type structs (#1600)
+- Support multi method duck type syntax in type explainer (#1631)
+- Improve Ruby 3.5 compatibility (#1616)
+- Update documentation for various type annotations (#1615)
+- JavaScript frontend updates (resizer, JS bugs, reduce console verbosity) for default template
+- Fix beginless/endless range errors (#1549, #1625)
+- Fix path structure in Templates.md documentation (#1588)
+- Fix signature handling in overload (#1590)
+- Fix handling of **nil with named block (#1623)
+- Fix directives in empty class bodies (#1624)
+- Fix parsing of array within array syntax (#1604)
+- Fix parsing of visibility keywords in front of class methods (#1632)
+
 # [0.9.37] - September 4th, 2024
 
 [0.9.37]: https://github.com/lsegal/yard/compare/v0.9.36...v0.9.37

data/README.md

@@ -134,7 +134,7 @@ gems further up in the list to your Gemfile.
 There are a couple of ways to use YARD. The first is via command-line, and the
 second is the Rake task.
 
-**1. yard Command-line Tool**
+### 1. yard Command-line Tool
 
 YARD comes packaged with a executable named `yard` which can control the many
 functions of YARD, including generating documentation, graphs running the YARD
@@ -147,7 +147,7 @@ $ yard --help
 Plugins can also add commands to the `yard` executable to provide extra
 functionality.
 
-### Generating Documentation
+#### Generating Documentation
 
 <span class="note">The `yardoc` executable is a shortcut for `yard doc`.</span>
 
@@ -194,7 +194,7 @@ switches separated by whitespace (newlines or space) to pass to yardoc whenever
 it is run. A full overview of the `.yardopts` file can be found in
 [YARD::CLI::Yardoc](https://rubydoc.info/gems/yard/YARD/CLI/Yardoc#label-Options+File+-28.yardopts-29).
 
-### Queries
+#### Queries
 
 The `yardoc` tool also supports a `--query` argument to only include objects
 that match a certain data or meta-data query. The query syntax is Ruby, though a
@@ -221,7 +221,7 @@ following two lines both check for the existence of a return and param tag:
 
 For more information about the query syntax, see the {YARD::Verifier} class.
 
-**2. Rake Task**
+### 2. Rake Task
 
 The second most obvious is to generate docs via a Rake task. You can do this by
 adding the following to your `Rakefile`:
@@ -247,7 +247,7 @@ environment variable:
 $ rake yard OPTS='--any --extra --opts'
 ```
 
-**3. `yri` RI Implementation**
+### 3. `yri` RI Implementation
 
 The yri binary will use the cached .yardoc database to give you quick ri-style
 access to your documentation. It's way faster than ri but currently does not
@@ -271,7 +271,7 @@ $ yard gems
 If you don't have sudo access, it will write these files to your `~/.yard`
 directory. `yri` will also cache lookups there.
 
-**4. `yard server` Documentation Server**
+### 4. `yard server` Documentation Server
 
 The `yard server` command serves documentation for a local project or all
 installed RubyGems. To serve documentation for a project you are working on,
@@ -285,14 +285,14 @@ And the project inside the current directory will be parsed (if the source has
 not yet been scanned by YARD) and served at
 [http://localhost:8808](http://localhost:8808).
 
-### Live Reloading
+#### Live Reloading
 
 If you want to serve documentation on a project while you document it so that
 you can preview the results, simply pass `--reload` (`-r`) to the above command
 and YARD will reload any changed files on each request. This will allow you to
 change any documentation in the source and refresh to see the new contents.
 
-### Serving Gems
+#### Serving Gems
 
 To serve documentation for all installed gems, call:
 
@@ -304,7 +304,7 @@ This will also automatically build documentation for any gems that have not been
 previously scanned. Note that in this case there will be a slight delay between
 the first request of a newly parsed gem.
 
-**5. `yard graph` Graphviz Generator**
+### 5. `yard graph` Graphviz Generator
 
 You can use `yard graph` to generate dot graphs of your code. This, of course,
 requires [Graphviz](http://www.graphviz.org) and the `dot` binary. By default

data/docs/Templates.md

@@ -280,10 +280,11 @@ seen above by creating such a path in our '/path/to/mytemplates' custom template
 path:
 
     /path/to/mytemplates/:
-    |-- class
-    |   |-- html
-    |   |   |-- customsection.erb
-    |   |-- setup.rb
+    |--default
+    |   |-- class
+    |   |   |-- html
+    |   |   |   |-- customsection.erb
+    |   |   |-- setup.rb
 
 The `setup.rb` file would look like:
 

data/lib/yard/code_objects/base.rb

@@ -228,7 +228,7 @@ module YARD
       # @example Create class Z inside namespace X::Y
       #   CodeObjects::Base.new(P("X::Y"), :Z) # or
       #   CodeObjects::Base.new(Registry.root, "X::Y")
-      # @param [NamespaceObject] namespace the namespace the object belongs in,
+      # @param [NamespaceObject, :root, nil] namespace the namespace the object belongs in,
       #   {Registry.root} or :root should be provided if it is associated with
       #   the top level namespace.
       # @param [Symbol, String] name the name (or complex path) of the object.

data/lib/yard/code_objects/extra_file_object.rb

@@ -127,6 +127,7 @@ module YARD::CodeObjects
     end
 
     def translate(data)
+      return data if locale.nil?
       text = YARD::I18n::Text.new(data, :have_header => true)
       text.translate(YARD::Registry.locale(locale))
     end

data/lib/yard/handlers/base.rb

@@ -462,6 +462,18 @@ module YARD
           end
         end
 
+        if docstring.is_a?(String)
+          if (m = docstring.match(/^\s*@!?visibility\s+(public|private|protected)\b/m))
+            vis_sym = m[1].to_sym
+
+            if object.nil?
+              globals.visibility_origin = :directive
+            elsif object.is_a?(CodeObjects::MethodObject)
+              object.visibility = vis_sym
+            end
+          end
+        end
+
         register_transitive_tags(object)
       end
 
@@ -511,7 +523,17 @@ module YARD
       def register_visibility(object, visibility = self.visibility)
         return unless object.respond_to?(:visibility=)
         return if object.is_a?(NamespaceObject)
-        object.visibility = visibility
+
+        if object.is_a?(CodeObjects::MethodObject)
+          origin = globals.visibility_origin
+          if origin == :keyword
+            object.visibility = visibility if object.scope == scope
+          else
+            object.visibility = visibility
+          end
+        else
+          object.visibility = visibility
+        end
       end
 
       # Registers the same method information on the module function, if

data/lib/yard/handlers/ruby/constant_handler.rb

@@ -9,6 +9,9 @@ class YARD::Handlers::Ruby::ConstantHandler < YARD::Handlers::Ruby::Base
     if statement[1].call? && statement[1][0][0] == s(:const, "Struct") &&
        statement[1][2] == s(:ident, "new")
       process_structclass(statement)
+    elsif statement[1].call? && statement[1][0][0] == s(:const, "Data") &&
+       statement[1][2] == s(:ident, "define")
+      process_dataclass(statement)
     elsif statement[0].type == :var_field && statement[0][0].type == :const
       process_constant(statement)
     elsif statement[0].type == :const_path_field
@@ -31,20 +34,34 @@ class YARD::Handlers::Ruby::ConstantHandler < YARD::Handlers::Ruby::Base
   end
 
   def process_structclass(statement)
-    lhs = statement[0][0]
-    if lhs.type == :const
-      klass = create_class(lhs[0], P(:Struct))
+    lhs = statement[0]
+    if (lhs.type == :var_field && lhs[0].type == :const) || lhs.type == :const_path_field
+      klass = create_class(lhs.source, P(:Struct))
       create_attributes(klass, extract_parameters(statement[1]))
       parse_block(statement[1].block[1], :namespace => klass) unless statement[1].block.nil?
     else
-      raise YARD::Parser::UndocumentableError, "Struct assignment to #{statement[0].source}"
+      raise YARD::Parser::UndocumentableError, "Struct assignment to #{lhs.source}"
     end
   end
 
-  # Extract the parameters from the Struct.new AST node, returning them as a list
+  def process_dataclass(statement)
+    lhs = statement[0]
+    if (lhs.type == :var_field && lhs[0].type == :const) || lhs.type == :const_path_field
+      klass = create_class(lhs.source, P(:Data))
+      extract_parameters(statement[1]).each do |member|
+        klass.attributes[:instance][member] = SymbolHash[:read => nil, :write => nil]
+        create_reader(klass, member)
+      end
+      parse_block(statement[1].block[1], :namespace => klass) unless statement[1].block.nil?
+    else
+      raise YARD::Parser::UndocumentableError, "Data assignment to #{lhs.source}"
+    end
+  end
+
+  # Extract the parameters from the Struct.new or Data.define AST node, returning them as a list
   # of strings
   #
-  # @param [MethodCallNode] superclass the AST node for the Struct.new call
+  # @param [MethodCallNode] superclass the AST node for the Struct.new or Data.define call
   # @return [Array<String>] the member names to generate methods for
   def extract_parameters(superclass)
     return [] unless superclass.parameters

data/lib/yard/handlers/ruby/legacy/visibility_handler.rb

@@ -8,9 +8,10 @@ class YARD::Handlers::Ruby::Legacy::VisibilityHandler < YARD::Handlers::Ruby::Le
     vis = statement.tokens.first.text
     if statement.tokens.size == 1
       self.visibility = vis
+      globals.visibility_origin = :keyword
     else
       tokval_list(statement.tokens[2..-1], :attr).each do |name|
-        MethodObject.new(namespace, name, scope) {|o| o.visibility = vis }
+        MethodObject.new(namespace, name, scope) { |o| o.visibility = vis }
       end
     end
   end

data/lib/yard/handlers/ruby/visibility_handler.rb

@@ -13,6 +13,7 @@ class YARD::Handlers::Ruby::VisibilityHandler < YARD::Handlers::Ruby::Base
     case statement.type
     when :var_ref, :vcall
       self.visibility = ident.first.to_sym
+      globals.visibility_origin = :keyword
     when :command
       if RUBY_VERSION >= '3.' && is_attribute_method?(statement.parameters.first)
         parse_block(statement.parameters.first, visibility: ident.first.to_sym)

data/lib/yard/parser/ruby/ast_node.rb

@@ -271,7 +271,7 @@ module YARD
 
         # @return [Fixnum] the starting line number of the node
         def line
-          line_range && line_range.first
+          line_range && (line_range.begin || line_range.end)
         end
 
         # @return [String] the first line of source represented by the node.
@@ -345,8 +345,8 @@ module YARD
           elsif !children.empty?
             f = children.first
             l = children.last
-            self.line_range = Range.new(f.line_range.first, l.line_range.last)
-            self.source_range = Range.new(f.source_range.first, l.source_range.last)
+            self.line_range = Range.new(f.line_range.begin, l.line_range.end)
+            self.source_range = Range.new(f.source_range.begin, l.source_range.end)
           elsif @fallback_line || @fallback_source
             self.line_range = @fallback_line
             self.source_range = @fallback_source
@@ -431,7 +431,8 @@ module YARD
           # shape is (required, optional, rest, more, keyword, keyword_rest, block)
           # Ruby 3.1 moves :args_forward from rest to keyword_rest
           args_index = YARD.ruby31? ? -2 : 2
-          self[args_index].type == :args_forward if self[args_index]
+          node = self[args_index]
+          node.is_a?(AstNode) && node.type == :args_forward
         end
       end
 

data/lib/yard/parser/ruby/legacy/ruby_lex.rb

@@ -978,7 +978,7 @@ module YARD
       end
 
       def identify_identifier
-        token = ""
+        token = String.new
         token.concat getc if peek(0) =~ /[$@]/
         token.concat getc if peek(0) == "@"
 

data/lib/yard/parser/ruby/ruby_parser.rb

@@ -236,14 +236,25 @@ module YARD
 
         def visit_event(node)
           map = @map[MAPPINGS[node.type]]
-          lstart, sstart = *(map ? map.pop : [lineno, @ns_charno - 1])
+
+          # Pattern matching and `in` syntax creates :case nodes without 'case' tokens,
+          # fall back to the first child node.
+          if node.type == :case && (!map || map.empty?) && (child_node = node[0])
+            lstart = child_node.line_range.first
+            sstart = child_node.source_range.first
+          else
+            lstart, sstart = *(map ? map.pop : [lineno, @ns_charno - 1])
+          end
+
+          raise "Cannot determine start of node #{node} around #{file}:#{lineno}" if lstart.nil? || sstart.nil?
+
           node.source_range = Range.new(sstart, @ns_charno - 1)
           node.line_range = Range.new(lstart, lineno)
           if node.respond_to?(:block)
             sr = node.block.source_range
             lr = node.block.line_range
-            node.block.source_range = Range.new(sr.first, @tokens.last[2][1] - 1)
-            node.block.line_range = Range.new(lr.first, @tokens.last[2][0])
+            node.block.source_range = Range.new(sr.begin, @tokens.last[2][1] - 1)
+            node.block.line_range = Range.new(lr.begin, @tokens.last[2][0])
           end
           node
         end
@@ -259,7 +270,10 @@ module YARD
         def visit_ns_token(token, data, ast_token = false)
           add_token(token, data)
           ch = charno
-          @last_ns_token = [token, data]
+
+          # For purposes of tracking parsing state, don't treat keywords as such
+          # where used as a symbol identifier.
+          @last_ns_token = [@last_ns_token && @last_ns_token.first == :symbeg ? :symbol : token, data]
           @charno += data.length
           @ns_charno = charno
           @newline = [:semicolon, :comment, :kw, :op, :lparen, :lbrace].include?(token)
@@ -272,14 +286,14 @@ module YARD
           if @percent_ary
             if token == :words_sep && data !~ /\s\z/
               rng = @percent_ary.source_range
-              rng = Range.new(rng.first, rng.last + data.length)
+              rng = Range.new(rng.begin, rng.end.to_i + data.length)
               @percent_ary.source_range = rng
               @tokens << [token, data, [lineno, charno]]
               @percent_ary = nil
               return
             elsif token == :tstring_end && data =~ /\A\s/
               rng = @percent_ary.source_range
-              rng = Range.new(rng.first, rng.last + data.length)
+              rng = Range.new(rng.begin, rng.end.to_i + data.length)
               @percent_ary.source_range = rng
               @tokens << [token, data, [lineno, charno]]
               @percent_ary = nil
@@ -377,8 +391,8 @@ module YARD
         def on_aref(*args)
           @map[:lbracket].pop
           ll, lc = *@map[:aref].shift
-          sr = args.first.source_range.first..lc
-          lr = args.first.line_range.first..ll
+          sr = args.first.source_range.begin..lc
+          lr = args.first.line_range.begin..ll
           AstNode.new(:aref, args, :char => sr, :line => lr)
         end
 
@@ -390,7 +404,7 @@ module YARD
 
         def on_array(other)
           node = AstNode.node_class_for(:array).new(:array, [other])
-          map = @map[MAPPINGS[node.type]]
+          map = @map[MAPPINGS[node.type]] if other.nil? || other.type == :list
           if map && !map.empty?
             lstart, sstart = *map.pop
             node.source_range = Range.new(sstart, @ns_charno - 1)
@@ -449,8 +463,8 @@ module YARD
             def on_#{kw}(*args)
               mapping = @map[#{kw.to_s.sub(/_mod$/, '').inspect}]
               mapping.pop if mapping
-              sr = args.last.source_range.first..args.first.source_range.last
-              lr = args.last.line_range.first..args.first.line_range.last
+              sr = args.last.source_range.begin..args.first.source_range.end
+              lr = args.last.line_range.begin..args.first.line_range.end
               #{node_class}.new(:#{kw}, args, :line => lr, :char => sr)
             end
           eof
@@ -473,8 +487,8 @@ module YARD
             begin; undef on_#{kw}_add; rescue NameError; end
             def on_#{kw}_add(list, item)
               last = @source[@ns_charno,1] == "\n" ? @ns_charno - 1 : @ns_charno
-              list.source_range = (list.source_range.first..last)
-              list.line_range = (list.line_range.first..lineno)
+              list.source_range = (list.source_range.begin..last)
+              list.line_range = (list.line_range.begin..lineno)
               list.push(item)
               list
             end
@@ -485,9 +499,9 @@ module YARD
           node = visit_event_arr(LiteralNode.new(:string_literal, args))
           if args.size == 1
             r = args[0].source_range
-            if node.source_range != Range.new(r.first - 1, r.last + 1)
+            if node.source_range != Range.new(r.begin - 1, r.end + 1)
               klass = AstNode.node_class_for(node[0].type)
-              r = Range.new(node.source_range.first + 1, node.source_range.last - 1)
+              r = Range.new(node.source_range.begin + 1, node.source_range.end - 1)
               node[0] = klass.new(node[0].type, [@source[r]], :line => node.line_range, :char => r)
             end
           end
@@ -573,7 +587,7 @@ module YARD
             @comments_flags[lineno] = @comments_flags[lineno - 1]
             @comments_flags.delete(lineno - 1)
             range = @comments_range.delete(lineno - 1)
-            source_range = range.first..source_range.last
+            source_range = range.begin..source_range.end
             comment = append_comment + "\n" + comment
           end
 
@@ -627,11 +641,13 @@ module YARD
             end
 
             # check upwards from line before node; check node's line at the end
-            ((node.line - 1).downto(node.line - 2).to_a + [node.line]).each do |line|
-              comment = @comments[line]
-              if comment && !comment.empty?
-                add_comment(line, node)
-                break
+            if (n_l = node.line)
+              ((n_l - 1).downto(n_l - 2).to_a + [n_l]).each do |line|
+                comment = @comments[line]
+                if comment && !comment.empty?
+                  add_comment(line, node)
+                  break
+                end
               end
             end
 
@@ -656,6 +672,23 @@ module YARD
             end
           end unless @comments.empty?
 
+          # Attach comments that fall within an otherwise empty
+          # class or module body. Without this step, a comment used
+          # solely for directives (like @!method) would be treated as
+          # a top-level comment and its directives would not be scoped
+          # to the namespace.
+          unless @comments.empty?
+            root.traverse do |node|
+              next unless [:class, :module, :sclass].include?(node.type)
+              body = node.children.last
+              next unless body && body.type == :list && body.empty?
+              @comments.keys.each do |line|
+                next unless node.line_range.include?(line)
+                add_comment(line, nil, body, true)
+              end
+            end
+          end
+
           # insert all remaining comments
           @comments.each do |line, _comment|
             add_comment(line, nil, root, true)

data/lib/yard/tags/overload_tag.rb

@@ -60,7 +60,8 @@ module YARD
           args = YARD::Handlers::Ruby::Legacy::Base.new(nil, nil).send(:tokval_list, toks, :all)
           args = args.map do |a|
             k, v = *a.split(/:|=/, 2)
-            [k.strip.to_s + (a[k.size, 1] == ':' ? ':' : ''), (v ? v.strip : nil)]
+            v.strip! if v
+            [k.strip.to_s + (a[k.size, 1] == ':' ? ':' : ''), (v && v.empty? ? nil : v)]
           end if args
           @name = meth.to_sym
           @parameters = args

data/lib/yard/tags/tag.rb

@@ -38,7 +38,7 @@ module YARD
       # +raise+, etc.
       #
       # @param [#to_s] tag_name        the tag name to create the tag for
-      # @param [String] text           the descriptive text for this tag
+      # @param [String, nil] text      the descriptive text for this tag, or nil if none provided
       # @param [Array<String>] types   optional type list of formally declared types
       #                                for the tag
       # @param [String] name           optional key name which the tag refers to

data/lib/yard/tags/types_explainer.rb

@@ -32,7 +32,7 @@ module YARD
 
         def to_s(singular = true)
           if name[0, 1] == "#"
-            singular ? "an object that responds to #{name}" : "objects that respond to #{name}"
+            (singular ? "an object that responds to " : "objects that respond to ") + list_join(name.split(/ *& */), with: "and")
           elsif name[0, 1] =~ /[A-Z]/
             singular ? "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} " + name : "#{name}#{name[-1, 1] =~ /[A-Z]/ ? "'" : ''}s"
           else
@@ -42,12 +42,12 @@ module YARD
 
         private
 
-        def list_join(list)
+        def list_join(list, with: "or")
           index = 0
           list.inject(String.new) do |acc, el|
             acc << el.to_s
             acc << ", " if index < list.size - 2
-            acc << " or " if index == list.size - 2
+            acc << " #{with} " if index == list.size - 2
             index += 1
             acc
           end

data/lib/yard/templates/helpers/html_helper.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
-require 'cgi'
+if RUBY_VERSION < '3.5'
+  require 'cgi/util'
+else
+  require 'cgi/escape'
+end
 
 module YARD
   module Templates::Helpers

data/lib/yard/templates/helpers/markup/rdoc_markup.rb

@@ -38,6 +38,7 @@ module YARD
           @@formatter = nil
           @@markup = nil
 
+          # @param text [String]
           def initialize(text)
             @text = text
 
@@ -47,6 +48,7 @@ module YARD
             end
           end
 
+          # @return [String]
           def to_html
             html = nil
             @@mutex.synchronize do

data/lib/yard/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module YARD
-  VERSION = '0.9.37'
+  VERSION = '0.9.38'
 end

data/templates/default/fulldoc/html/css/style.css

@@ -9,8 +9,6 @@ body {
   margin: 0;
   padding: 0;
   display: flex;
-  display: -webkit-flex;
-  display: -ms-flexbox;
 }
 
 #nav {
@@ -28,11 +26,7 @@ body {
   height: 100%;
   position: relative;
   display: flex;
-  display: -webkit-flex;
-  display: -ms-flexbox;
   flex-shrink: 0;
-  -webkit-flex-shrink: 0;
-  -ms-flex: 1 0;
 }
 #resizer {
   position: absolute;
@@ -45,8 +39,6 @@ body {
 }
 #main {
   flex: 5 1;
-  -webkit-flex: 5 1;
-  -ms-flex: 5 1;
   outline: none;
   position: relative;
   background: #fff;
@@ -56,7 +48,8 @@ body {
 }
 
 @media (max-width: 920px) {
-  .nav_wrap { width: 100%; top: 0; right: 0; overflow: visible; position: absolute; }
+  body { display: block; }
+  .nav_wrap { width: 80vw !important; top: 0; right: 0; overflow: visible; position: absolute; }
   #resizer { display: none; }
   #nav {
     z-index: 9999;
@@ -205,13 +198,9 @@ p.inherited {
   width: 100%;
   font-size: 1em;
   display: flex;
-  display: -webkit-flex;
-  display: -ms-flexbox;
 }
 .box_info dl dt {
   flex-shrink: 0;
-  -webkit-flex-shrink: 1;
-  -ms-flex-shrink: 1;
   width: 100px;
   text-align: right;
   font-weight: bold;
@@ -222,8 +211,6 @@ p.inherited {
 }
 .box_info dl dd {
   flex-grow: 1;
-  -webkit-flex-grow: 1;
-  -ms-flex: 1;
   max-width: 420px;
   padding: 6px 0;
   padding-right: 20px;

data/templates/default/fulldoc/html/js/app.js

@@ -1,4 +1,4 @@
-(function () {
+window.__app = function () {
   var localStorage = {},
     sessionStorage = {};
   try {
@@ -153,7 +153,6 @@
           });
           // Add the value of the constant as "Tooltip" to the summary object
           list.find("pre.code").each(function () {
-            console.log($(this).parent());
             var dt_element = $(this).parent().prev();
             var tooltip = $(this).text();
             if (dt_element.hasClass("deprecated")) {
@@ -250,37 +249,46 @@
     );
   }
 
-  function navResizeFn(e) {
-    if (e.which !== 1) {
-      navResizeFnStop();
-      return;
-    }
-
-    sessionStorage.navWidth = e.pageX.toString();
-    $(".nav_wrap").css("width", e.pageX);
-    $(".nav_wrap").css("-ms-flex", "inherit");
-  }
-
-  function navResizeFnStop() {
-    $(window).unbind("mousemove", navResizeFn);
-    window.removeEventListener("message", navMessageFn, false);
-  }
-
-  function navMessageFn(e) {
-    if (e.data.action === "mousemove") navResizeFn(e.data.event);
-    if (e.data.action === "mouseup") navResizeFnStop();
-  }
-
   function navResizer() {
-    $("#resizer").mousedown(function (e) {
-      e.preventDefault();
-      $(window).mousemove(navResizeFn);
-      window.addEventListener("message", navMessageFn, false);
-    });
-    $(window).mouseup(navResizeFnStop);
+    const resizer = document.getElementById("resizer");
+    resizer.addEventListener(
+      "pointerdown",
+      function (e) {
+        resizer.setPointerCapture(e.pointerId);
+        e.preventDefault();
+        e.stopPropagation();
+      },
+      false
+    );
+    resizer.addEventListener(
+      "pointerup",
+      function (e) {
+        resizer.releasePointerCapture(e.pointerId);
+        e.preventDefault();
+        e.stopPropagation();
+      },
+      false
+    );
+    resizer.addEventListener(
+      "pointermove",
+      function (e) {
+        if ((e.buttons & 1) === 0) {
+          return;
+        }
+
+        sessionStorage.navWidth = e.pageX.toString();
+        $(".nav_wrap").css("width", Math.max(200, e.pageX));
+        e.preventDefault();
+        e.stopPropagation();
+      },
+      false
+    );
 
     if (sessionStorage.navWidth) {
-      navResizeFn({ which: 1, pageX: parseInt(sessionStorage.navWidth, 10) });
+      $(".nav_wrap").css(
+        "width",
+        Math.max(200, parseInt(sessionStorage.navWidth, 10))
+      );
     }
   }
 
@@ -295,15 +303,6 @@
       document.getElementById("nav").contentWindow.postMessage(opts, "*");
       done = true;
     }
-
-    window.addEventListener(
-      "message",
-      function (event) {
-        if (event.data === "navReady") postMessage();
-        return false;
-      },
-      false
-    );
   }
 
   function mainFocus() {
@@ -341,4 +340,56 @@
     mainFocus();
     navigationChange();
   });
-})();
+};
+window.__app();
+
+window.addEventListener(
+  "message",
+  async (e) => {
+    if (e.data.action === "navigate") {
+      const response = await fetch(e.data.url);
+      const text = await response.text();
+      const parser = new DOMParser();
+      const doc = parser.parseFromString(text, "text/html");
+
+      const classListLink =
+        document.getElementById("class_list_link").classList;
+
+      const content = doc.querySelector("#main").innerHTML;
+      document.querySelector("#main").innerHTML = content;
+      document.title = doc.head.querySelector("title").innerText;
+      document.head.querySelectorAll("script").forEach((script) => {
+        if (
+          !script.type ||
+          (script.type.includes("text/javascript") && !script.src)
+        ) {
+          script.remove();
+        }
+      });
+
+      doc.head.querySelectorAll("script").forEach((script) => {
+        if (
+          !script.type ||
+          (script.type.includes("text/javascript") && !script.src)
+        ) {
+          const newScript = document.createElement("script");
+          newScript.type = "text/javascript";
+          newScript.textContent = script.textContent;
+          document.head.appendChild(newScript);
+        }
+      });
+
+      window.__app();
+
+      document.getElementById("class_list_link").classList = classListLink;
+
+      const url = new URL(e.data.url, "https://localhost");
+      const hash = decodeURIComponent(url.hash ?? "");
+      if (hash) {
+        document.getElementById(hash.substring(1)).scrollIntoView();
+      }
+      history.pushState({}, document.title, e.data.url);
+    }
+  },
+  false
+);

data/templates/default/fulldoc/html/js/full_list.js

@@ -20,17 +20,6 @@ function escapeShortcut() {
   });
 }
 
-function navResizer() {
-  $(window).mousemove(function(e) {
-    window.parent.postMessage({
-      action: 'mousemove', event: {pageX: e.pageX, which: e.which}
-    }, '*');
-  }).mouseup(function(e) {
-    window.parent.postMessage({action: 'mouseup'}, '*');
-  });
-  window.parent.postMessage("navReady", "*");
-}
-
 function clearSearchTimeout() {
   clearTimeout(searchTimeout);
   searchTimeout = null;
@@ -44,14 +33,21 @@ function enableLinks() {
     $clicked.addClass('clicked');
     evt.stopPropagation();
 
-    if (evt.target.tagName === 'A') return true;
+    if (window.origin === "null") {
+      if (evt.target.tagName === 'A') return true;
 
-    var elem = $clicked.find('> .item .object_link a')[0];
-    var e = evt.originalEvent;
-    var newEvent = new MouseEvent(evt.originalEvent.type);
-    newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
-    elem.dispatchEvent(newEvent);
-    evt.preventDefault();
+      var elem = $clicked.find('> .item .object_link a')[0];
+      var e = evt.originalEvent;
+      var newEvent = new MouseEvent(evt.originalEvent.type);
+      newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
+      elem.dispatchEvent(newEvent);
+      evt.preventDefault();
+    } else {
+      window.top.postMessage({
+        action: "navigate",
+        url: $clicked.find('.object_link a').attr('href'),
+      }, "*");
+    }
     return false;
   });
 }
@@ -199,6 +195,13 @@ function highlight() {
   });
 }
 
+function isInView(element) {
+  const rect = element.getBoundingClientRect();
+  const windowHeight =
+    window.innerHeight || document.documentElement.clientHeight;
+  return rect.left >= 0 && rect.bottom <= windowHeight;
+}
+  
 /**
  * Expands the tree to the target element and its immediate
  * children.
@@ -214,7 +217,7 @@ function expandTo(path) {
     $(el).find('> div > a.toggle').attr('aria-expanded', 'true');
   });
 
-  if($target[0]) {
+  if($target[0] && !isInView($target[0])) {
     window.scrollTo(window.scrollX, $target.offset().top - 250);
     highlight();
   }
@@ -232,7 +235,6 @@ window.addEventListener("message", windowEvents, false);
 
 $(document).ready(function() {
   escapeShortcut();
-  navResizer();
   enableLinks();
   enableToggles();
   populateSearchCache();

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.37
+  version: 0.9.38
 platform: ruby
 authors:
 - Loren Segal
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2025-12-05 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -398,7 +398,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -413,8 +413,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: Documentation tool for consistent and usable documentation in Ruby.
 test_files: []