yard 0.9.26 → 0.9.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b26148831eae874a1a8f704e19bb86e0f3924ba3482337edfe70d1a1c320a00b
-  data.tar.gz: 60d089381ca93b8b7b732317eafe7da0f56fbd727effaca34a52d1040a217e09
+  metadata.gz: d0e3a62dcbb66515f56fe9a2cb919aa97881dced6e7cf052a7ce0201ff9222cf
+  data.tar.gz: 06714cb7f3e754d10fb2e784c0a0d49a5fee20aaee75778565daea8b61c453c1
 SHA512:
-  metadata.gz: 6e298247ed74a5db2d7f561feaaa6d84a19914c91bc4b9b7e701fa1e33efd7d07e9284eab6c6aad03b61e89268bb105e01a5dcd88beccaf212507cee794d161d
-  data.tar.gz: 9207539dc74b76b2f02a384ed97bafafc13a2b42dab3cb5130d927bc3a6c53976e802856d2be6c6f566f7811ca33eaa5c2c52a1357df8d950402fa2d949d7005
+  metadata.gz: 4a993609ba381fdc0419ac8332605b10a3995ff818626c20e64095f4f845e28297d38a81c890aa95a187ca8fd7d8e7d9f291d7251ac96ba1bee7a5a249f2db3d
+  data.tar.gz: f71cc60bc0fbe36419f8f142e07bbee5fd19b9e539099256bb644f1f61f57e9fa61c96ff95e879d584bdb48b3f988d5e945277acbc6e0f083cf1a6c8584c45df

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,35 +8,23 @@ 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
+        ruby: [2.2, 2.3, 2.4, 2.5, 2.6, 2.7, "3.0"]
+        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
           bundle exec rake
         env:
           CI: true
-  build_ruby3:
-    name: "Ruby: 3.0 OS: Linux"
-    runs-on: ubuntu-latest
-    container: ruby:3.0-rc-alpine
-    steps:
-      - uses: actions/checkout@v2
-      - run: apk add -U build-base
-      - run: gem update --system --no-document --conservative
-      - run: bundle install --jobs=3 --retry=3
-      - run: ruby -v && bundle exec rake
-        env:
-          CI: true

data/.github/workflows/gem.yml

@@ -9,18 +9,10 @@ jobs:
   release_version:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - id: tag
-        run: echo ::set-output name=TAG::$(echo $GITHUB_REF | cut -d / -f 3)
-      - run: ruby -e 'tag=ENV["GITHUB_REF"].sub("refs/tags/", "").sub("v", "v?");puts File.read("CHANGELOG.md")[/#\s+#{tag}[^\r\n]+\r?\n(.+?)(^#|\Z)/mi,1].strip' > extracted_changelog.md
-      - name: Create Release
-        uses: actions/create-release@v1
+      - uses: actions/checkout@v2
+      - uses: lsegal/github-release-from-changelog-action@latest
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ steps.tag.outputs.TAG }}
-          release_name: Release ${{ steps.tag.outputs.TAG }}
-          body_path: extracted_changelog.md
       - name: Publish RubyGem
         uses: dawidd6/action-publish-gem@v1
         with:

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # main
 
+# 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

data/Gemfile

@@ -18,6 +18,7 @@ end
 
 group :markdown do
   gem 'redcarpet'
+  gem 'commonmarker'
 end
 
 group :textile do

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=main)](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

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

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

@@ -67,7 +67,7 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
   end
 
   def format_args
-    args = statement.parameters
+    return [] unless args = statement.parameters
 
     params = []
 

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

@@ -41,7 +41,9 @@ class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
   end
 
   def recipient(mixin)
-    if statement[0].type == :var_ref && statement[0][0] != s(:kw, "self")
+    if statement[0].type == :const_path_ref
+      Proxy.new(namespace, statement[0].source)
+    elsif statement[0].type == :var_ref && statement[0][0] != s(:kw, "self")
       statement[0][0].type == :const ?
         Proxy.new(namespace, statement.namespace.source) :
         nil

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

@@ -2,6 +2,8 @@
 # Handles module_function calls to turn methods into public class methods.
 # Also creates a private instance copy of the method.
 class YARD::Handlers::Ruby::ModuleFunctionHandler < YARD::Handlers::Ruby::Base
+  include YARD::Handlers::Ruby::DecoratorHandlerMethods
+
   handles method_call(:module_function)
   namespace_only
 
@@ -13,15 +15,25 @@ class YARD::Handlers::Ruby::ModuleFunctionHandler < YARD::Handlers::Ruby::Base
     when :fcall, :command
       statement[1].traverse do |node|
         case node.type
+        when :def
+          process_decorator do |instance_method|
+            make_module_function(instance_method, namespace)
+          end
+          break
         when :symbol; name = node.first.source
         when :string_content; name = node.source
         else next
         end
+
         instance_method = MethodObject.new(namespace, name)
-        class_method = MethodObject.new(namespace, name, :module)
-        instance_method.copy_to(class_method)
-        class_method.visibility = :public
+        make_module_function(instance_method, namespace)
       end
     end
   end
+
+  def make_module_function(instance_method, namespace)
+    class_method = MethodObject.new(namespace, instance_method.name, :module)
+    instance_method.copy_to(class_method)
+    class_method.visibility = :public
+  end
 end

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

@@ -480,7 +480,7 @@ module YARD
         end
 
         def parameters(include_block_param = true)
-          params = self[1 + index_adjust]
+          return unless params = self[1 + index_adjust]
           params = params[0] if params.type == :paren
           include_block_param ? params : params[0...-1]
         end
@@ -488,7 +488,7 @@ module YARD
         def signature
           params_src = ''
           params = self[1 + index_adjust]
-          if params.first
+          if params and params.first
             params_src = params.type == :paren ? '' : ' '
             params_src += params.source.gsub(/\s+(\s|\))/m, '\1')
           end

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

@@ -370,7 +370,7 @@ module YARD
 
         def on_aref(*args)
           @map[:lbracket].pop
-          ll, lc = *@map[:aref].pop
+          ll, lc = *@map[:aref].shift
           sr = args.first.source_range.first..lc
           lr = args.first.line_range.first..ll
           AstNode.new(:aref, args, :char => sr, :line => lr)

data/lib/yard/server/commands/library_command.rb

@@ -31,7 +31,7 @@ module YARD
       # @abstract
       class LibraryCommand < Base
         begin
-          Process.fork { exit 0 }
+          Process.fork { }
           CAN_FORK = true
         rescue Exception # rubocop:disable Lint/RescueException
           CAN_FORK = false

data/lib/yard/tags/directives.rb

@@ -74,6 +74,13 @@ module YARD
       def after_parse; end
 
       protected :parser
+
+      protected
+
+      def inside_directive?
+        return true if parser.state.inside_directive
+        parser.directives.any? { |d| d.is_a?(MethodDirective) && d.tag.text.empty? }
+      end
     end
 
     # Ends a group listing definition. Group definition automatically end
@@ -574,6 +581,8 @@ module YARD
         if %w(class instance module).include?(tag.text)
           if object.is_a?(CodeObjects::MethodObject)
             object.scope = tag.text.to_sym
+          elsif handler && !inside_directive?
+            handler.scope = tag.text.to_sym
           else
             parser.state.scope = tag.text.to_sym
           end
@@ -604,7 +613,7 @@ module YARD
         if %w(public protected private).include?(tag.text)
           if object.is_a?(CodeObjects::Base)
             object.visibility = tag.text.to_sym
-          elsif handler && !parser.state.inside_directive
+          elsif handler && !inside_directive?
             handler.visibility = tag.text.to_sym
           else
             parser.state.visibility = tag.text.to_sym

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

@@ -78,9 +78,10 @@ module YARD
       def html_markup_markdown(text)
         # TODO: other libraries might be more complex
         provider = markup_class(:markdown)
-        if provider.to_s == 'RDiscount'
+        case provider.to_s
+        when  'RDiscount'
           provider.new(text, :autolink).to_html
-        elsif provider.to_s == 'RedcarpetCompat'
+        when 'RedcarpetCompat'
           provider.new(text, :autolink,
                              :fenced_code,
                              :gh_blockcode,
@@ -88,6 +89,8 @@ module YARD
                              :tables,
                              :with_toc_data,
                              :no_intraemphasis).to_html
+        when 'CommonMarker'
+          CommonMarker.render_html(text, %i[DEFAULT GITHUB_PRE_LANG], %i[autolink])
         else
           provider.new(text).to_html
         end

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

@@ -29,7 +29,8 @@ module YARD
           {:lib => :bluecloth, :const => 'BlueCloth'},
           {:lib => :maruku, :const => 'Maruku'},
           {:lib => :'rpeg-markdown', :const => 'PEGMarkdown'},
-          {:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkdown'}
+          {:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkdown'},
+          {:lib => :commonmarker, :const => 'CommonMarker'}
         ],
         :textile => [
           {:lib => :redcloth, :const => 'RedCloth'}

data/lib/yard/version.rb

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

data/lib/yard.rb

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

data/tasks/prepare_tag.rake

@@ -0,0 +1,45 @@
+require 'json'
+require 'tempfile'
+
+namespace :release do
+  desc 'Updates repository and tags VERSION=X.Y.Z'
+  task :tag do
+    restore_file = Tempfile.new
+    restore_file.close
+    at_exit { restore_file.unlink }
+
+    version = ENV['VERSION']
+    build_path = File.expand_path(File.join(`gem which samus`.strip, '..', '..', 'commands', 'build'))
+    samus_contents = File.read(File.join(__dir__, '..', 'samus.json'))
+    samus_json = JSON.parse(samus_contents.gsub('$version', version))
+
+    samus_json['actions'].each do |action|
+      env = {
+        '_VERSION' => version,
+        '__ORIG_BRANCH' => `git rev-parse --abbrev-ref HEAD`.strip,
+        '__RESTORE_FILE' => restore_file.path,
+      }
+      (action['arguments'] || {}).each {|k, v| env["_#{k.upcase}"] = v }
+      cmd = [File.join(build_path, action['action']), *action['files']]
+      puts "[C] #{action['action']} #{(action['files'] || []).join(' ')}"
+      output = ""
+      IO.popen(env, cmd) {|io| output = io.read }
+      status = $?
+      unless status.success?
+        puts "[F] Last command failed with: #{status.to_i}"
+        puts output
+        exit(status.to_i)
+      end
+    end
+
+    puts ""
+    puts "Tag v#{version} created. To publish, type the following:"
+    puts ""
+    puts "  bundle exec rake release:push VERSION=#{version}"
+  end
+
+  desc 'Pushes the main branch and tag for VERSION=X.Y.Z'
+  task :push do
+    sh "git push main v#{ENV['VERSION']}"
+  end
+end

data/yard.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |s|
   s.executables   = ['yard', 'yardoc', 'yri']
   s.license = 'MIT' if s.respond_to?(:license=)
   s.metadata['yard.run'] = 'yri'
+
+  s.add_runtime_dependency 'webrick', '~> 1.7.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.26
+  version: 0.9.27
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
-dependencies: []
+date: 2021-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
       It enables the user to generate consistent, usable documentation that can be
@@ -33,7 +47,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - ".yardopts_guide"
 - ".yardopts_i18n"
@@ -299,6 +312,7 @@ files:
 - lib/yard/version.rb
 - po/ja.po
 - samus.json
+- tasks/prepare_tag.rake
 - tasks/update_error_map.rake
 - templates/default/class/dot/setup.rb
 - templates/default/class/dot/superklass.erb
@@ -448,8 +462,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Documentation tool for consistent and usable documentation in Ruby.

data/.travis.yml

@@ -1,49 +0,0 @@
-# Build for Ruby
-language: ruby
-
-# Enables caching for bundler
-cache: bundler
-
-# Specify which ruby versions you wish to run your tests on, each version will be used
-rvm:
-  - "2.0"
-  - "2.1"
-  - "2.2"
-  - "2.3"
-  - "2.4"
-  - "2.5"
-  - "2.6"
-  - "2.7"
-  # - ruby-head
-  # - jruby
-
-# Define how to run your tests (defaults to `bundle exec rake` or `rake` depending on whether you have a `Gemfile`)
-script: "bundle exec rake"
-
-# Define tasks to be completed before and after tests run . Will allow folding of content on frontend
-#before_script:
-#  - command_1
-#  - command_2
-#
-#after_script:
-#  - command_1
-#  - command_2
-
-# Specify an ENV variable to run before: 'bundle install' and 'rake' (or your defined 'script')
-env:
-  - CI=1
-
-# Specify the recipients for email notification
-#notifications:
-#  recipients:
-#    - email-address-1
-#    - email-address-2
-
-# Disable email notifications
-#notifications:
-#  disabled: true
-
-# notifications:
-#   webhooks:
-#     urls:
-#       - https://webhooks.gitter.im/e/c6dbb9323007dfcf81df