yard 0.9.34 → 0.9.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7531850cba319c703685684605433173f6b55d2d39df481c65492772fe31bc86
-  data.tar.gz: 61cbee634cd9292024ca7f126f867abbe9b8f9e6087c90f75ea18e87991cd4f2
+  metadata.gz: e1f492861606b6ce24d390317f2a97ccbd67bbf73b8b964ea6f9e61bb4096d9e
+  data.tar.gz: 1a4ec96bd604c8ab68cf6c971fc22aff400f2d8ed853d3b0b5fc222f4c8e7767
 SHA512:
-  metadata.gz: 98abb79648eec38f9b035138e664f251b10530d7b1f38e70f6307749a224fc8237a8a4217be9a8792b4593a8938e199d760ff3b5d73a340cb91c8b3ffb63ba70
-  data.tar.gz: 7b691f28627be2337780cadd32d4212f9dfe13b5d4c2493ee8720ce7e9d80c28135e96257f46527c10c3924fd8474bd23f0da84558f76060e5a15ab924507c08
+  metadata.gz: 04b727cb198fd9559a9314989fae7bcf60202531f5ab634d211780b5bbf15b60341d8a8f5fa6fd890c743c7d1b953e7b49d3c8e73997f3397b7344a70442fd29
+  data.tar.gz: c3df5e59c450adfc6d6088bd7c6a6c64f4477c1de65eae7cbd21e1c4ca410d606179bc88c84ed084b22d7b3f8bf66cc67426e9c103558b0a25c5ab01c1900ab9

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # main
 
+# [0.9.36] - February 29th, 2024
+
+[0.9.36]: https://github.com/lsegal/yard/compare/v0.9.35...v0.9.36
+
+- Further XSS fixes for generated frameset pages (#1538)
+- Improve tests for Ruby 3.3 compatibility (#1519, #1531)
+- Documentation improvements (#1524)
+
+# [0.9.35] - February 28th, 2024
+
+[0.9.35]: https://github.com/lsegal/yard/compare/v0.9.34...v0.9.35
+
+- Fix possible XSS on generated YARD frameset pages (thanks to @RedYetiDev for finding and patching) (2069e2b).
+- Fix errors when using `@option` on non-method objects (#1508)
+- Support Ruby 3.3 changes in Ripper parser (#1510)
+
 # [0.9.34] - April 12nd, 2023
 
 [0.9.34]: https://github.com/lsegal/yard/compare/v0.9.33...v0.9.34

data/docs/Tags.md

@@ -206,7 +206,7 @@ also be a list of types separated by commas.
 An order dependent list is a set of types surrounded by "()" and separated by
 commas. This list must contain exactly those types in exactly the order specified.
 For instance, an Array containing a String, Fixnum and Hash in that order (and
-having exactly those 3 elements) would be listed as: `Array<(String, Fixnum, Hash)>`.
+having exactly those 3 elements) would be listed as: `Array(String, Fixnum, Hash)`.
 
 #### Literals
 

data/lib/yard/code_objects/base.rb

@@ -303,6 +303,7 @@ module YARD
       # definitions with docstrings first.
       #
       # @return [String] a filename
+      # @return [nil] if there is no file associated with the object
       def file
         @files.first ? @files.first[0] : nil
       end

data/lib/yard/parser/source_parser.rb

@@ -476,9 +476,8 @@ module YARD
           content.force_encoding('binary')
           ENCODING_BYTE_ORDER_MARKS.each do |encoding, bom|
             bom.force_encoding('binary')
-            if content[0, bom.size] == bom
-              content.force_encoding(encoding)
-              return content
+            if content.start_with?(bom)
+              return content.sub(bom, '').force_encoding(encoding)
             end
           end
           content.force_encoding('utf-8') # UTF-8 is default encoding

data/lib/yard/version.rb

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

data/templates/default/fulldoc/html/frames.erb

@@ -5,10 +5,15 @@
 	<title><%= options.title %></title>
 </head>
 <script type="text/javascript">
-  var match = unescape(window.location.hash).match(/^#!(.+)/);
-  var name = match ? match[1] : '<%= url_for_main %>';
-  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
-  window.top.location = name;
+var mainUrl = '<%= url_for_main %>';
+try {
+    var match = decodeURIComponent(window.location.hash).match(/^#!(.+)/);
+    var name = match ? match[1] : mainUrl;
+    var url = new URL(name, location.href);
+    window.top.location.replace(url.origin === location.origin ? name : mainUrl);
+} catch (e) {
+    window.top.location.replace(mainUrl);
+}
 </script>
 <noscript>
   <h1>Oops!</h1>

data/templates/default/tags/html/option.erb

@@ -1,4 +1,4 @@
-<% if object.has_tag?(:option) %>
+<% if object.has_tag?(:option) && object.respond_to?(:parameters) %>
   <% object.parameters.each do |param, default| %>
     <% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s.sub(/^\*+|:$/, '') } %>
     <% next if tags.empty? %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.34
+  version: 0.9.36
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.