yard 0.9.25 → 0.9.28

data/lib/yard/handlers/c/base.rb

@@ -1,164 +1,164 @@
-# frozen_string_literal: true
-module YARD
-  module Handlers
-    module C
-      class Base < Handlers::Base
-        include YARD::Parser::C
-        include HandlerMethods
-
-        # @return [Boolean] whether the handler handles this statement
-        def self.handles?(statement, processor)
-          processor.globals.cruby_processed_files ||= {}
-          processor.globals.cruby_processed_files[processor.file] = true
-
-          src = statement.respond_to?(:declaration) ?
-            statement.declaration : statement.source
-
-          handlers.any? do |a_handler|
-            statement_class >= statement.class &&
-              case a_handler
-              when String
-                src == a_handler
-              when Regexp
-                src =~ a_handler
-              end
-          end
-        end
-
-        def self.statement_class(type = nil)
-          if type
-            @statement_class = type
-          else
-            (defined?(@statement_class) && @statement_class) || Statement
-          end
-        end
-
-        # @group Registering objects
-
-        def register_docstring(object, docstring = nil, stmt = nil)
-          super(object, docstring, stmt) if docstring
-        end
-
-        def register_file_info(object, file = nil, line = nil, comments = nil)
-          super(object, file, line, comments) if file
-        end
-
-        def register_source(object, source = nil, type = nil)
-          super(object, source, type) if source
-        end
-
-        def register_visibility(object, visibility = nil)
-          super(object, visibility) if visibility
-        end
-
-        # @group Looking up Symbol and Var Values
-
-        def symbols
-          globals.cruby_symbols ||= {}
-        end
-
-        def override_comments
-          globals.cruby_override_comments ||= []
-        end
-
-        def namespace_for_variable(var)
-          return namespaces[var] if namespaces[var]
-
-          # The global variables for Ruby's core error classes does not
-          # represent their Ruby name. So we need to look up these names.
-          name = ERROR_CLASS_NAMES[var]
-          return P(name) if name
-
-          # Otherwise the name is inferred from the C variable name.
-          var = remove_var_prefix(var)
-          var.empty? ? nil : P(var)
-        end
-
-        def ensure_variable_defined!(var, max_retries = 1)
-          retries = 0
-          object = nil
-
-          loop do
-            object = namespace_for_variable(var)
-            break unless object.is_a?(Proxy)
-
-            raise NamespaceMissingError, object if retries > max_retries
-            log.debug "Missing namespace variable #{var} in file `#{parser.file}', moving it to the back of the line."
-            parser.parse_remaining_files
-            retries += 1
-          end
-
-          object
-        end
-
-        def namespaces
-          globals.cruby_namespaces ||= {}
-        end
-
-        def processed_files
-          globals.cruby_processed_files ||= {}
-        end
-
-        # @group Parsing an Inner Block
-
-        def parse_block(opts = {})
-          return if !statement.block || statement.block.empty?
-          push_state(opts) do
-            parser.process(statement.block)
-          end
-        end
-
-        # @group Processing other files
-
-        def process_file(file, object)
-          file = File.cleanpath(file)
-          return if processed_files[file]
-          processed_files[file] = file
-          begin
-            log.debug "Processing embedded call to C source #{file}..."
-            globals.ordered_parser.files.delete(file) if globals.ordered_parser
-            parser.process(Parser::C::CParser.new(File.read(file), file).parse)
-          rescue Errno::ENOENT
-            log.warn "Missing source file `#{file}' when parsing #{object}"
-          end
-        end
-
-        # @endgroup
-
-        private
-
-        # Generated by update_error_map.rb (Copy+past results)
-        ERROR_CLASS_NAMES = {
-          'rb_eArgError' => 'ArgumentError',
-          'rb_eEncodingError' => 'EncodingError',
-          'rb_eException' => 'Exception',
-          'rb_eFatal' => 'fatal',
-          'rb_eFrozenError' => 'FrozenError',
-          'rb_eIndexError' => 'IndexError',
-          'rb_eInterrupt' => 'Interrupt',
-          'rb_eKeyError' => 'KeyError',
-          'rb_eLoadError' => 'LoadError',
-          'rb_eNameError' => 'NameError',
-          'rb_eNoMatchingPatternError' => 'NoMatchingPatternError',
-          'rb_eNoMemError' => 'NoMemoryError',
-          'rb_eNoMethodError' => 'NoMethodError',
-          'rb_eNotImpError' => 'NotImplementedError',
-          'rb_eRangeError' => 'RangeError',
-          'rb_eRuntimeError' => 'RuntimeError',
-          'rb_eScriptError' => 'ScriptError',
-          'rb_eSecurityError' => 'SecurityError',
-          'rb_eSignal' => 'SignalException',
-          'rb_eStandardError' => 'StandardError',
-          'rb_eSyntaxError' => 'SyntaxError',
-          'rb_eSystemCallError' => 'SystemCallError',
-          'rb_eSystemExit' => 'SystemExit',
-          'rb_eTypeError' => 'TypeError',
-        }
-
-        def remove_var_prefix(var)
-          var.gsub(/^rb_[mc]|^[a-z_]+/, '')
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Handlers
+    module C
+      class Base < Handlers::Base
+        include YARD::Parser::C
+        include HandlerMethods
+
+        # @return [Boolean] whether the handler handles this statement
+        def self.handles?(statement, processor)
+          processor.globals.cruby_processed_files ||= {}
+          processor.globals.cruby_processed_files[processor.file] = true
+
+          src = statement.respond_to?(:declaration) ?
+            statement.declaration : statement.source
+
+          handlers.any? do |a_handler|
+            statement_class >= statement.class &&
+              case a_handler
+              when String
+                src == a_handler
+              when Regexp
+                src =~ a_handler
+              end
+          end
+        end
+
+        def self.statement_class(type = nil)
+          if type
+            @statement_class = type
+          else
+            (defined?(@statement_class) && @statement_class) || Statement
+          end
+        end
+
+        # @group Registering objects
+
+        def register_docstring(object, docstring = nil, stmt = nil)
+          super(object, docstring, stmt) if docstring
+        end
+
+        def register_file_info(object, file = nil, line = nil, comments = nil)
+          super(object, file, line, comments) if file
+        end
+
+        def register_source(object, source = nil, type = nil)
+          super(object, source, type) if source
+        end
+
+        def register_visibility(object, visibility = nil)
+          super(object, visibility) if visibility
+        end
+
+        # @group Looking up Symbol and Var Values
+
+        def symbols
+          globals.cruby_symbols ||= {}
+        end
+
+        def override_comments
+          globals.cruby_override_comments ||= []
+        end
+
+        def namespace_for_variable(var)
+          return namespaces[var] if namespaces[var]
+
+          # The global variables for Ruby's core error classes does not
+          # represent their Ruby name. So we need to look up these names.
+          name = ERROR_CLASS_NAMES[var]
+          return P(name) if name
+
+          # Otherwise the name is inferred from the C variable name.
+          var = remove_var_prefix(var)
+          var.empty? ? nil : P(var)
+        end
+
+        def ensure_variable_defined!(var, max_retries = 1)
+          retries = 0
+          object = nil
+
+          loop do
+            object = namespace_for_variable(var)
+            break unless object.is_a?(Proxy)
+
+            raise NamespaceMissingError, object if retries > max_retries
+            log.debug "Missing namespace variable #{var} in file `#{parser.file}', moving it to the back of the line."
+            parser.parse_remaining_files
+            retries += 1
+          end
+
+          object
+        end
+
+        def namespaces
+          globals.cruby_namespaces ||= {}
+        end
+
+        def processed_files
+          globals.cruby_processed_files ||= {}
+        end
+
+        # @group Parsing an Inner Block
+
+        def parse_block(opts = {})
+          return if !statement.block || statement.block.empty?
+          push_state(opts) do
+            parser.process(statement.block)
+          end
+        end
+
+        # @group Processing other files
+
+        def process_file(file, object)
+          file = File.cleanpath(file)
+          return if processed_files[file]
+          processed_files[file] = file
+          begin
+            log.debug "Processing embedded call to C source #{file}..."
+            globals.ordered_parser.files.delete(file) if globals.ordered_parser
+            parser.process(Parser::C::CParser.new(File.read(file), file).parse)
+          rescue Errno::ENOENT
+            log.warn "Missing source file `#{file}' when parsing #{object}"
+          end
+        end
+
+        # @endgroup
+
+        private
+
+        # Generated by update_error_map.rb (Copy+past results)
+        ERROR_CLASS_NAMES = {
+          'rb_eArgError' => 'ArgumentError',
+          'rb_eEncodingError' => 'EncodingError',
+          'rb_eException' => 'Exception',
+          'rb_eFatal' => 'fatal',
+          'rb_eFrozenError' => 'FrozenError',
+          'rb_eIndexError' => 'IndexError',
+          'rb_eInterrupt' => 'Interrupt',
+          'rb_eKeyError' => 'KeyError',
+          'rb_eLoadError' => 'LoadError',
+          'rb_eNameError' => 'NameError',
+          'rb_eNoMatchingPatternError' => 'NoMatchingPatternError',
+          'rb_eNoMemError' => 'NoMemoryError',
+          'rb_eNoMethodError' => 'NoMethodError',
+          'rb_eNotImpError' => 'NotImplementedError',
+          'rb_eRangeError' => 'RangeError',
+          'rb_eRuntimeError' => 'RuntimeError',
+          'rb_eScriptError' => 'ScriptError',
+          'rb_eSecurityError' => 'SecurityError',
+          'rb_eSignal' => 'SignalException',
+          'rb_eStandardError' => 'StandardError',
+          'rb_eSyntaxError' => 'SyntaxError',
+          'rb_eSystemCallError' => 'SystemCallError',
+          'rb_eSystemExit' => 'SystemExit',
+          'rb_eTypeError' => 'TypeError',
+        }
+
+        def remove_var_prefix(var)
+          var.gsub(/^rb_[mc]|^[a-z_]+/, '')
+        end
+      end
+    end
+  end
+end

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 = []
 
@@ -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/handlers/ruby/mixin_handler.rb

@@ -2,6 +2,7 @@
 # Handles the 'include' statement to mixin a module in the instance scope
 class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
   handles method_call(:include)
+  handles method_call(:prepend)
   namespace_only
 
   process do
@@ -34,11 +35,15 @@ class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
 
     rec = recipient(mixin)
     return if rec.nil? || rec.mixins(scope).include?(obj)
-    rec.mixins(scope).unshift(obj)
+
+    shift = statement.method_name(true) == :include ? :unshift : :push
+    rec.mixins(scope).send(shift, obj)
   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

@@ -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
@@ -480,7 +487,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 +495,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/parser/source_parser.rb

@@ -64,7 +64,7 @@ module YARD
     class SourceParser
       SHEBANG_LINE  = /\A\s*#!\S+/
       ENCODING_LINE = %r{\A(?:\s*#*!.*\r?\n)?\s*(?:#+|/\*+|//+).*coding\s*[:=]{1,2}\s*([a-z\d_\-]+)}i
-      FROZEN_STRING_LINE = /frozen(-|_)string(-|_)literal: true/i
+      FROZEN_STRING_LINE = /frozen(-|_)string(-|_)literal:\s+(true|false)/i
 
       # The default glob of files to be parsed.
       # @since 0.9.0

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

@@ -183,7 +183,7 @@ module YARD
           self.body = "Not found: #{request.path}"
           headers['Content-Type'] = 'text/plain'
           headers['X-Cascade'] = 'pass'
-          headers.delete('Cache-Control')
+          headers['Cache-Control'] = 'nocache'
         end
 
         # Sets the headers and status code for a redirection to a given URL
@@ -201,7 +201,7 @@ module YARD
         # requests served with "?1234567890" style timestamp query strings.
         def add_cache_control
           return if request.query_string.to_i == 0
-          headers['Cache-Control'] = 'private, max-age=300'
+          headers['Cache-Control'] ||= 'public, max-age=300'
         end
       end
     end

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/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/section.rb

@@ -20,9 +20,7 @@ module YARD
 
       def [](*args)
         if args.first.is_a?(Range) || args.size > 1
-          obj = super(*args)
-          obj.name = name
-          return obj
+          return self.class.new(name, *super(*args))
         elsif args.first.is_a?(Integer)
           return super(*args)
         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.25'
+  VERSION = '0.9.28'
 end

data/lib/yard.rb

@@ -48,6 +48,12 @@ 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
+
+  # @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