yard 0.9.25 → 0.9.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '069382132042276687f3551fe9f55d143635a028d5e4a1c5796e122a6871af8d'
-  data.tar.gz: f9b76a7d6051ce84375ba417a80f477961bfd2a03e9d8b9908615d7958bf96a0
+  metadata.gz: 2a014685561249bd72bd38eea2db5386c7a3f5d814ec2cbd0218fc76803d4d88
+  data.tar.gz: fbbb78841e6f41798c14cde55e5d55da409bc550005a1f8d67a2491332a9378c
 SHA512:
-  metadata.gz: a270998fd0d1efc6b41fa43c0b273935953c57cc17c95a11b7faa91476f2edeae14e481570acdaa3b3e824eaf9da9dd4bc3941b9e2cdbee76a193ac129251573
-  data.tar.gz: f196bef07edee0bdbca743d03db9e13f589ab9b19f5ebe7fefdee2b7fadf784b88d0c811cf8f67471fd58718247f780abaa67a7a16556729944e6f56ebc7abf0
+  metadata.gz: 37666343d2e629ce4cd1c9c1d7e82b678ade120151e79b52ce3110bdbd9c0bdf65c76aa3661a5d6ffd34fe40f9ff90f100b1f7b2c898951737e6ba14f4bacaa3
+  data.tar.gz: 6235690efed8749d45e513842f689a273c68ef6424a4881a9e77db2a1590ebc1fb7d55d6d68c2f6013bda045e49e1285169c93a9c7736f3b2ef7a6e8fe1fc4de

data/.gitattributes

@@ -0,0 +1,4 @@
+# Auto detect text files and perform LF normalization
+* text eol=lf
+
+*.png binary

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: lsegal

data/.github/ISSUE_TEMPLATE.md

@@ -22,12 +22,12 @@ visual issues.]
 
 ## Environment details:
 
-* OS: [Enter operating system / version here]
-* Ruby version (`ruby -v`): [Enter output of `ruby -v`]
-* YARD version (`yard -v`): [Enter output of `yard -v`]
-* Relevant software dependency/versions:
-  * [Any 3rd party libs required to reproduce, omit if none]
+- OS: [Enter operating system / version here]
+- Ruby version (`ruby -v`): [Enter output of `ruby -v`]
+- YARD version (`yard -v`): [Enter output of `yard -v`]
+- Relevant software dependency/versions:
+  - [Any 3rd party libs required to reproduce, omit if none]
 
 I have read the [Contributing Guide][contrib].
 
-[contrib]: https://github.com/lsegal/yard/blob/master/CONTRIBUTING.md
+[contrib]: https://github.com/lsegal/yard/blob/main/CONTRIBUTING.md

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -4,9 +4,9 @@ Describe your pull request and problem statement here.
 
 # Completed Tasks
 
-* [ ] I have read the [Contributing Guide][contrib].
-* [ ] The pull request is complete (implemented / written).
-* [ ] Git commits have been cleaned up (squash WIP / revert commits).
-* [ ] I wrote tests and ran `bundle exec rake` locally (if code is attached to PR).
+- [ ] I have read the [Contributing Guide][contrib].
+- [ ] The pull request is complete (implemented / written).
+- [ ] Git commits have been cleaned up (squash WIP / revert commits).
+- [ ] I wrote tests and ran `bundle exec rake` locally (if code is attached to PR).
 
-[contrib]: https://github.com/lsegal/yard/blob/master/CONTRIBUTING.md
+[contrib]: https://github.com/lsegal/yard/blob/main/CONTRIBUTING.md

data/.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 name: Unit Tests
 
-on: [push, pull_request]
+on: [push, pull_request, workflow_dispatch]
 jobs:
   build:
     name: "Ruby: ${{ matrix.ruby }} OS: ${{ matrix.os }}"
@@ -8,20 +8,20 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-        ruby: ["2.4", "2.5", "2.6", "2.7"]
+        os: [ubuntu-20.04, macos-10.15, windows-2019]
+        # 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 }
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Select Ruby Version
-        uses: eregon/use-ruby-action@master
+      - name: Install Ruby & 'bundle install'
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          base: update
-      - name: Update RubyGems & Bundler
-        run: gem update --system --no-document --conservative
-      - name: Install Dependencies
-        run: bundle install --jobs=3 --retry=3
+          bundler-cache: true
       - name: Run Test
         run: |
           ruby -v

data/.github/workflows/gem.yml

@@ -0,0 +1,19 @@
+name: Release Version
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release_version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: lsegal/github-release-from-changelog-action@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Publish RubyGem
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{secrets.RUBYGEMS_API_KEY}}

data/CHANGELOG.md

@@ -1,6 +1,38 @@
-# master
+# main
 
-# 0.9.25 - May 3rd, 2020
+# [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
+
+- Add support for Ruby 3.0 endless method definitions. (#1376, #1381)
+- Add existence check for README file (#1367)
+- Support module_function decorator (#1365)
+- Add CommonMarker markup support (`-m commonmarker`) (#1157, #1388)
+- Fix nested array parsing (#1389)
+- Add WEBrick as a runtime dependency for Ruby 3.0 support (#1400)
+- Support `fail_on_warning` option in `yard stats` command (#1392)
+- Better integration with Sorbet (#1401)
+- Handle include mixins on complex paths (#1386)
+- Fix `@!scope` maintaining state in lone comment blocks (#1411)
+- Remove support for Travis CI
+
+# [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]: https://github.com/lsegal/yard/compare/v0.9.24...v0.9.25
 
@@ -15,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
 
@@ -23,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
 
@@ -52,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
 
@@ -62,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/CONTRIBUTING.md

@@ -42,7 +42,7 @@ If you believe you have found a bug, please include a few things in your report:
    if the behavior is intentional or not.
 
 Finally, please **DO NOT** submit a report that states a feature simply
-*"does not work"* without any additional information in the report. Consider
+_"does not work"_ without any additional information in the report. Consider
 the issue from the maintainer's perspective: in order to fix your bug, we
 need to drill down to the broken line of code, and in order to do this,
 we must be able to reproduce the issue on our end to find that line of
@@ -132,7 +132,7 @@ help handle day-to-day operations, such as releases, bug fixes, and triage.
 You can do some of this as a non-maintainer too, but if you like this project,
 we can always use more hands on deck!
 
-[code]: https://github.com/lsegal/yard/blob/master/CODE_OF_CONDUCT.md
+[code]: https://github.com/lsegal/yard/blob/main/CODE_OF_CONDUCT.md
 [issues]: http://github.com/lsegal/yard/issues
 [commit]: http://chris.beams.io/posts/git-commit/
 [pr]: https://help.github.com/articles/using-pull-requests/

data/Gemfile

@@ -2,13 +2,14 @@
 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.8', :require => false
-  gem 'coveralls', :require => false
+  gem 'samus', '~> 3.0.9', :require => false
+  gem 'coveralls_reborn', :require => false
+  gem 'webrick'
 end
 
 group :asciidoc do
@@ -17,6 +18,7 @@ end
 
 group :markdown do
   gem 'redcarpet'
+  gem 'commonmarker'
 end
 
 group :textile do

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/README.md

@@ -5,7 +5,7 @@
 [![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/yard/frames)
 
 [![Gem Version](https://badge.fury.io/rb/yard.svg)](http://github.com/lsegal/yard/releases)
-[![Build Status](https://travis-ci.org/lsegal/yard.svg?branch=master)](https://travis-ci.org/lsegal/yard)
+[![Unit Tests](https://github.com/lsegal/yard/actions/workflows/ci.yml/badge.svg)](https://github.com/lsegal/yard/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/github/lsegal/yard/badge.svg)](https://coveralls.io/github/lsegal/yard)
 [![License](https://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 

data/Rakefile

@@ -2,7 +2,6 @@
 require File.dirname(__FILE__) + '/lib/yard'
 require File.dirname(__FILE__) + '/lib/yard/rubygems/specification'
 require 'rbconfig'
-require 'samus'
 
 YARD::VERSION.replace(ENV['YARD_VERSION']) if ENV['YARD_VERSION']
 
@@ -35,5 +34,3 @@ task :default => [:spec, :test_doc]
 YARD::Rake::YardocTask.new do |t|
   t.options += ['--title', "YARD #{YARD::VERSION} Documentation"]
 end
-
-Samus::Rake::DockerReleaseTask.new

data/lib/yard/cli/stats.rb

@@ -43,6 +43,8 @@ module YARD
 
         print_statistics
         print_undocumented_objects
+
+        abort if fail_on_warning && log.warned
       end
 
       # Prints statistics for different object types
@@ -223,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

@@ -295,9 +295,10 @@ module YARD
         self.files = Parser::SourceParser::DEFAULT_PATH_GLOB if files.empty?
         files.delete_if {|x| x =~ /\A\s*\Z/ } # remove empty ones
         readme = Dir.glob('README{,*[^~]}').
+          select {|f| extra_file_valid?(f)}.
           sort_by {|r| [r.count('.'), r.index('.'), r] }.first
         readme ||= Dir.glob(files.first).first if options.onefile && !files.empty?
-        options.readme ||= CodeObjects::ExtraFileObject.new(readme) if readme
+        options.readme ||= CodeObjects::ExtraFileObject.new(readme) if readme && extra_file_valid?(readme)
         options.files.unshift(options.readme).uniq! if options.readme
 
         Tags::Library.visible_tags -= hidden_tags
@@ -649,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/code_objects/method_object.rb

@@ -145,7 +145,7 @@ module YARD::CodeObjects
     end
 
     # Returns all alias names of the object
-    # @return [Array<Symbol>] the alias names
+    # @return [Array<MethodObject>] the alias names
     def aliases
       list = []
       return list unless namespace.is_a?(NamespaceObject)

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