yard 0.9.27 → 0.9.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0e3a62dcbb66515f56fe9a2cb919aa97881dced6e7cf052a7ce0201ff9222cf
-  data.tar.gz: 06714cb7f3e754d10fb2e784c0a0d49a5fee20aaee75778565daea8b61c453c1
+  metadata.gz: 2a014685561249bd72bd38eea2db5386c7a3f5d814ec2cbd0218fc76803d4d88
+  data.tar.gz: fbbb78841e6f41798c14cde55e5d55da409bc550005a1f8d67a2491332a9378c
 SHA512:
-  metadata.gz: 4a993609ba381fdc0419ac8332605b10a3995ff818626c20e64095f4f845e28297d38a81c890aa95a187ca8fd7d8e7d9f291d7251ac96ba1bee7a5a249f2db3d
-  data.tar.gz: f71cc60bc0fbe36419f8f142e07bbee5fd19b9e539099256bb644f1f61f57e9fa61c96ff95e879d584bdb48b3f988d5e945277acbc6e0f083cf1a6c8584c45df
+  metadata.gz: 37666343d2e629ce4cd1c9c1d7e82b678ade120151e79b52ce3110bdbd9c0bdf65c76aa3661a5d6ffd34fe40f9ff90f100b1f7b2c898951737e6ba14f4bacaa3
+  data.tar.gz: 6235690efed8749d45e513842f689a273c68ef6424a4881a9e77db2a1590ebc1fb7d55d6d68c2f6013bda045e49e1285169c93a9c7736f3b2ef7a6e8fe1fc4de

data/.github/workflows/ci.yml

@@ -9,11 +9,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-20.04, macos-10.15, windows-2019]
-        # 3.0 is interpreted as 3
-        ruby: [2.2, 2.3, 2.4, 2.5, 2.6, 2.7, "3.0"]
+        # 3.0 is interpreted as 3. also disable 2.5 due to bundler crashes
+        ruby: [2.2, 2.3, 2.4, 2.6, 2.7, "3.0", 3.1]
         exclude:
-          - { os: windows-2019 , ruby: 2.2 }
-          - { os: windows-2019 , ruby: 2.3 }
+          - { os: windows-2019, ruby: 2.2 }
+          - { os: windows-2019, ruby: 2.3 }
     steps:
       - name: Checkout
         uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # main
 
-# 0.9.27 - November 29th, 2021
+# [0.9.28] - June 1st, 2022
+
+[0.9.28]: https://github.com/lsegal/yard/compare/v0.9.27...v0.9.28
+
+- Safe load config YAML files (#1385)
+- Handle empty string constants (#1415)
+- Pre-emptively support removal of `Object#taint` in Ruby 3.2 (#1419)
+- Fix Ruby 3.1 forward args Ripper change (#1431)
+
+# [0.9.27] - November 29th, 2021
 
 [0.9.27]: https://github.com/lsegal/yard/compare/v0.9.26...v0.9.27
 
@@ -16,14 +25,14 @@
 - Fix `@!scope` maintaining state in lone comment blocks (#1411)
 - Remove support for Travis CI
 
-# 0.9.26 - December 26th, 2020
+# [0.9.26] - December 26th, 2020
 
 [0.9.26]: https://github.com/lsegal/yard/compare/v0.9.25...v0.9.26
 
 - Add support for Ruby 3.0 and fix tests
 - Fix support for `frozen_string_literal: false` magic comments (#1363)
 
-# 0.9.25 - May 3rd, 2020
+# [0.9.25] - May 3rd, 2020
 
 [0.9.25]: https://github.com/lsegal/yard/compare/v0.9.24...v0.9.25
 
@@ -38,7 +47,7 @@
 - Omit spec files in gem package (#1307)
 - README updates (#1322)
 
-# 0.9.24 - January 8th, 2020
+# [0.9.24] - January 8th, 2020
 
 [0.9.24]: https://github.com/lsegal/yard/compare/v0.9.23...v0.9.24
 
@@ -46,20 +55,20 @@
   cache is changed.
 - Fix issue where Registry fails to resolve first-time lookups on instance methods.
 
-# 0.9.23 - January 5th, 2020
+# [0.9.23] - January 5th, 2020
 
 [0.9.23]: https://github.com/lsegal/yard/compare/v0.9.22...v0.9.23
 
 - Fix issues with double encoded code blocks when highlighted from an extra
   file.
 
-# 0.9.22 - December 31st, 2019
+# [0.9.22] - December 31st, 2019
 
 [0.9.22]: https://github.com/lsegal/yard/compare/v0.9.21...v0.9.22
 
 - Revert jquery update in last release since it requires more changes. (#1298)
 
-# 0.9.21 - December 31st, 2019
+# [0.9.21] - December 31st, 2019
 
 [0.9.21]: https://github.com/lsegal/yard/compare/v0.9.20...v0.9.21
 
@@ -75,7 +84,7 @@
 - Update jquery to 3.4.1 (#1294)
 - Test fixes (#1244)
 
-# 0.9.20 - June 27th, 2019
+# [0.9.20] - June 27th, 2019
 
 [0.9.20]: https://github.com/lsegal/yard/compare/v0.9.19...v0.9.20
 
@@ -85,7 +94,7 @@
   `yard server` host under certain conditions. Thanks to CuongMX from
   Viettel Cyber Security for discovering this vulnerability.
 
-# 0.9.19 - April 2nd, 2019
+# [0.9.19] - April 2nd, 2019
 
 [0.9.19]: https://github.com/lsegal/yard/compare/v0.9.16...v0.9.19
 

data/Gemfile

@@ -2,13 +2,13 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'rspec'
+  gem 'rspec', '>= 3.11.0'
   gem 'rake'
   gem 'rdoc'
   gem 'json'
   gem 'simplecov'
   gem 'samus', '~> 3.0.9', :require => false
-  gem 'coveralls', :require => false
+  gem 'coveralls_reborn', :require => false
   gem 'webrick'
 end
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2018 Loren Segal
+Copyright (c) 2007-2022 Loren Segal
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/lib/yard/cli/stats.rb

@@ -225,7 +225,8 @@ module YARD
         end
 
         opts.on('--query QUERY', "Only includes objects that match a specific query") do |query|
-          options[:verifier].add_expressions(query.taint)
+          query.taint if query.respond_to?(:taint)
+          options[:verifier].add_expressions(query)
         end
       end
     end

data/lib/yard/cli/yardoc.rb

@@ -650,7 +650,8 @@ module YARD
 
         opts.on('--query QUERY', "Only show objects that match a specific query") do |query|
           next if YARD::Config.options[:safe_mode]
-          options.verifier.add_expressions(query.taint)
+          query.taint if query.respond_to?(:taint)
+          options.verifier.add_expressions(query)
         end
 
         opts.on('--title TITLE', 'Add a specific title to HTML documents') do |title|

data/lib/yard/config.rb

@@ -236,7 +236,11 @@ module YARD
     def self.read_config_file
       if File.file?(CONFIG_FILE)
         require 'yaml'
-        YAML.load_file(CONFIG_FILE)
+        if YAML.respond_to?(:safe_load_file)
+          YAML.safe_load_file(CONFIG_FILE, permitted_classes: [SymbolHash, Symbol])
+        else
+          YAML.load_file(CONFIG_FILE)
+        end
       else
         {}
       end

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

@@ -97,7 +97,7 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
       params << ['**' + args.double_splat_param.source, nil]
     end
 
-    params << ['&' + args.block_param.source, nil] if args.block_param
+    params << ['&' + args.block_param.source, nil] if args.block_param && !args.args_forward
 
     params
   end

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

@@ -426,6 +426,13 @@ module YARD
         def block_param
           self[-1] ? self[-1][0] : nil
         end
+
+        def args_forward
+          # 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]
+        end
       end
 
       class MethodCallNode < AstNode

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

@@ -66,7 +66,9 @@ module YARD
 
       # @return [String] formats source code of a constant value
       def format_constant(value)
-        sp = value.split("\n").last[/^(\s+)/, 1]
+        # last can return nil, so default to empty string
+        sp = value.split("\n").last || ""
+        sp = sp[/^(\s+)/, 1]
         num = sp ? sp.size : 0
         html_syntax_highlight value.gsub(/^\s{#{num}}/, '')
       end

data/lib/yard/templates/template.rb

@@ -176,7 +176,9 @@ module YARD
         def load_setup_rb
           setup_file = File.join(full_path, 'setup.rb')
           if File.file? setup_file
-            module_eval(File.read(setup_file).taint, setup_file, 1)
+            setup_code = File.read(setup_file)
+            setup_code.taint if setup_code.respond_to?(:taint)
+            module_eval(setup_code, setup_file, 1)
           end
         end
       end

data/lib/yard/version.rb

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

data/lib/yard.rb

@@ -51,6 +51,9 @@ module YARD
 
   # @return [Boolean] whether YARD is being run in Ruby 3.0
   def self.ruby3?; @ruby3 ||= (RUBY_VERSION >= '3.0.0') end
+
+  # @return [Boolean] whether YARD is being run in Ruby 3.1
+  def self.ruby31?; @ruby31 ||= (RUBY_VERSION >= '3.1.0') end
 end
 
 # Keep track of Ruby version for compatibility code

data/templates/default/layout/html/footer.erb

@@ -1,5 +1,5 @@
 <div id="footer">
   Generated on <%= Time.now.strftime("%c") %> by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
 </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.27
+  version: 0.9.28
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webrick