yard 0.9.23 → 0.9.27

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

@@ -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

@@ -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

@@ -202,8 +202,7 @@ module YARD
             begin; undef on_#{event}; rescue NameError; end
             def on_#{event}(tok)
               unless @last_ns_token == [:kw, "def"] ||
-                  (@tokens.last && @tokens.last[0] == :symbeg) ||
-                  (!@newline && %w(if while until unless).include?(tok))
+                  (@tokens.last && @tokens.last[0] == :symbeg)
                 (@map[tok] ||= []) << [lineno, charno]
               end
               visit_ns_token(:#{event}, tok, true)
@@ -371,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)
@@ -412,7 +411,7 @@ module YARD
         end
 
         def on_dyna_symbol(sym)
-          rng = if sym.source_range.size == 0 # rubocop:disable Style/ZeroLengthPredicate
+          rng = if sym.source_range.to_a.size == 0 # rubocop:disable Style/ZeroLengthPredicate
                   (sym.source_range.begin - 3)...sym.source_range.end
                 else
                   (sym.source_range.begin - 2)..(sym.source_range.end + 1)
@@ -442,6 +441,8 @@ module YARD
           module_eval(<<-eof, __FILE__, __LINE__ + 1)
             begin; undef on_#{kw}; rescue NameError; end
             def on_#{kw}(*args)
+              mapping = @map[#{kw.to_s.sub(/_mod$/, '').inspect}]
+              mapping.pop if mapping
               sr = args.last.source_range.first..args.first.source_range.last
               lr = args.last.line_range.first..args.first.line_range.last
               #{node_class}.new(:#{kw}, args, :line => lr, :char => sr)
@@ -612,7 +613,7 @@ module YARD
 
         def insert_comments
           root.traverse do |node|
-            next if %i{comment void_stmt list}.include?(node.type) || node.parent.type != :list
+            next if [:comment, :void_stmt, :list].include?(node.type) || node.parent.type != :list
 
             # never attach comments to if/unless mod nodes
             if node.type == :if_mod || node.type == :unless_mod
@@ -684,6 +685,7 @@ module YARD
         end
 
         def freeze_tree(node = nil)
+          @tokens = @tokens.sort_by {|t| t.last }
           nodes = [node || root]
           until nodes.empty?
             p_node = nodes.shift

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

@@ -7,6 +7,7 @@ module YARD
       # constant or identifier token.
       class TokenResolver
         include Enumerable
+        include CodeObjects::NamespaceMapper
 
         # Creates a token resolver for given source.
         #
@@ -114,7 +115,8 @@ module YARD
 
           if toktype == :const
             types.any? do |type|
-              prefix = (type ? type.path : "") + last_sep.to_s
+              prefix = type ? type.path : ""
+              prefix += last_sep.to_s if separators.include?(last_sep.to_s)
               self.object = Registry.resolve(@default_namespace, "#{prefix}#{name}", true)
             end
           else # ident

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

@@ -16,6 +16,9 @@ module YARD
     def initialize(registry = Registry)
       @registry = registry
       @default_sep = nil
+
+      # Preload all code objects for separator declarations
+      YARD::CodeObjects.constants.map {|t| YARD::CodeObjects.const_get(t) }
     end
 
     # Performs a lookup on a given path in the registry. Resolution will occur
@@ -186,46 +189,29 @@ module YARD
       nss
     end
 
-    # @see NamespaceMapper#register_separator
-    def register_separator(*)
-      super
-      invalidate_memoized_matchers
-    end
-
-    # @see NamespaceMapper#clear_separators
-    def clear_separators
-      super
-      invalidate_memoized_matchers
-    end
-
-    # @see NamespaceMapper#default_separator
-    def default_separator(value = nil)
-      @starts_with_default_separator_match = nil if value
-      super
-    end
-
     # @return [Regexp] the regexp match of the default separator
     def starts_with_default_separator_match
-      @starts_with_default_separator_match ||= /\A#{default_separator}/
+      @@starts_with_default_separator_match ||= /\A#{default_separator}/
     end
 
     # @return [Regexp] the regexp that matches strings starting with
     #   a separator
     def starts_with_separator_match
-      @starts_with_separator_match ||= /\A(#{separators_match})/
+      @@starts_with_separator_match ||= /\A(#{separators_match})/
     end
 
     # @return [Regexp] the regexp that can be used to split a string on all
     #   occurrences of separator tokens
     def split_on_separators_match
-      @split_on_separators_match ||= /(.+?)(#{separators_match}|$)/
+      @@split_on_separators_match ||= /(.+?)(#{separators_match}|$)/
     end
 
     # Additional invalidations to done when NamespaceMapper API methods are
     # called on this class
-    def invalidate_memoized_matchers
-      @starts_with_separator_match = nil
-      @split_on_separators_match = nil
+    YARD::CodeObjects::NamespaceMapper.on_invalidate do
+      @@starts_with_default_separator_match = nil
+      @@starts_with_separator_match = nil
+      @@split_on_separators_match = nil
     end
   end
 end

data/lib/yard/registry_store.rb

@@ -291,7 +291,7 @@ module YARD
     def load_checksums
       return unless File.file?(checksums_path)
       lines = File.readlines(checksums_path).map do |line|
-        line.strip.split(/\s+/)
+        line.strip.rpartition(' ').tap { |p| p.delete_at(1) }
       end
       @checksums = Hash[lines]
     end

data/lib/yard/serializers/yardoc_serializer.rb

@@ -77,7 +77,7 @@ module YARD
               p.gsub(/[^\w\.-]/) do |x|
                 encoded = '_'
 
-                x.each_byte {|b| encoded << ("%X" % b) }
+                x.each_byte {|b| encoded += ("%X" % b) }
                 encoded
               end
             end.join('/') + '.' + extension

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,12 +78,19 @@ 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'
-          provider.new(text, :no_intraemphasis, :gh_blockcode,
-                             :fenced_code, :autolink, :tables,
-                             :lax_spacing).to_html
+        when 'RedcarpetCompat'
+          provider.new(text, :autolink,
+                             :fenced_code,
+                             :gh_blockcode,
+                             :lax_spacing,
+                             :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
@@ -316,6 +323,9 @@ module YARD
         link = url_for(obj, anchor, relative)
         link = link ? link_url(link, title, :title => h("#{obj.title} (#{obj.type})")) : title
         "<span class='object_link'>" + link + "</span>"
+      rescue Parser::UndocumentableError
+        log.warn "The namespace of link #{obj.inspect} is a constant or invalid."
+        title || obj.to_s
       end
 
       # (see BaseHelper#link_url)

data/lib/yard/templates/helpers/markup/rdoc_markup.rb

@@ -34,16 +34,17 @@ module YARD
         class RDocMarkup
           attr_accessor :from_path
 
+          @@mutex = Mutex.new
           @@formatter = nil
           @@markup = nil
-          @@mutex = nil
 
           def initialize(text)
             @text = text
 
-            @@formatter ||= RDocMarkupToHtml.new
-            @@markup ||= MARKUP.new
-            @@mutex ||= Mutex.new
+            @@mutex.synchronize do
+              @@formatter ||= RDocMarkupToHtml.new
+              @@markup ||= MARKUP.new
+            end
           end
 
           def to_html

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

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module YARD
-  VERSION = '0.9.23'
+  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/samus.json

@@ -2,7 +2,9 @@
   "actions": [
     {
       "action": "fs-sedfiles",
-      "files": ["lib/*/version.rb"],
+      "files": [
+        "lib/*/version.rb"
+      ],
       "arguments": {
         "search": "VERSION = ['\"](.+?)['\"]",
         "replace": "VERSION = '$version'"
@@ -10,23 +12,31 @@
     },
     {
       "action": "chmod-files",
-      "files": ["**/*,644", "bin/*,755"]
+      "files": [
+        "**/*,644",
+        "bin/*,755"
+      ]
     },
     {
       "action": "changelog-rotate",
-      "files": ["CHANGELOG.md"],
+      "files": [
+        "CHANGELOG.md"
+      ],
       "arguments": {
         "title_format": "$version - %B %-d$day_nth, %Y"
       }
     },
     {
       "action": "git-commit",
-      "files": ["CHANGELOG.md", "lib/*/version.rb"]
+      "files": [
+        "CHANGELOG.md",
+        "lib/*/version.rb"
+      ]
     },
     {
       "action": "git-merge",
       "arguments": {
-        "branch": "master"
+        "branch": "main"
       }
     },
     {
@@ -34,47 +44,6 @@
     },
     {
       "action": "rake-task"
-    },
-    {
-      "action": "archive-git-full",
-      "files": ["git.tgz"],
-      "publish": [
-        {
-          "action": "git-push",
-          "credentials": "lsegal.github.ssh",
-          "arguments": {
-            "remotes": "origin",
-            "refs": "master v$version"
-          }
-        }
-      ]
-    },
-    {
-      "action": "gem-build",
-      "files": ["*.gemspec"],
-      "publish": [
-        {
-          "action": "gem-push",
-          "files": ["*.gem"],
-          "credentials": "lsegal.rubygems"
-        }
-      ]
-    },
-    {
-      "action": "changelog-parse",
-      "files": ["CHANGELOG.md"],
-      "publish": [
-        {
-          "action": "github-release",
-          "credentials": "lsegal.github",
-          "files": [],
-          "arguments": {
-            "repository": "lsegal/yard",
-            "tag": "v$version",
-            "changelog": "CHANGELOG.md"
-          }
-        }
-      ]
     }
   ]
 }

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/tasks/update_error_map.rake

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Script to generate the Error class name map in:
+# lib/yard/handlers/c/base.rb
+
+require 'open-uri'
+require 'stringio'
+
+desc 'Update the error class names map'
+task :update_error_map do
+
+  ERROR_C_URL = 'https://raw.githubusercontent.com/ruby/ruby/master/error.c'
+
+  INIT_MATCH = /void\s+Init_Exception\(void\)\s*\{(.+?)^\}/m
+  NAME_MATCH = /(\w+)\s*=\s*rb_define_class\("([^"]+)"/
+
+  $stderr.puts "Downloading #{ERROR_C_URL} ..."
+  content = open(ERROR_C_URL) { |io| io.read }
+
+  $stderr.puts "Extracting class names ..."
+  init_source = content.match(INIT_MATCH).captures.first
+  map = init_source.scan(NAME_MATCH).sort_by { |key, value| key }
+
+  $stderr.puts "Generating new lookup table ..."
+  indent = '  ' * 4
+  source = StringIO.new
+  source.puts "#{indent}ERROR_CLASS_NAMES = {"
+  map.each do |variable, name|
+    source.puts "#{indent}  '#{variable}' => '#{name}',"
+  end
+  source.puts "#{indent}}"
+
+  $stderr.puts source.string
+
+  $stderr.puts "Patching 'lib/yard/handlers/c/base.rb' ..."
+  CLASS_NAME_MAP_MATCH = /^\s+ERROR_CLASS_NAMES = {[^}]+}/
+
+  PROJECT_PATH = File.expand_path('..', __dir__)
+  C_BASE_HANDLER = File.join(PROJECT_PATH, 'lib/yard/handlers/c/base.rb')
+
+  File.open(C_BASE_HANDLER, 'r+') { |file|
+    content = file.read
+    # .rstrip is added to avoid adding new empty lines due to the new lines
+    # added by `.puts` when building the string.
+    content.gsub!(CLASS_NAME_MAP_MATCH, source.string.rstrip)
+    file.rewind
+    file.truncate(0)
+    file.write(content)
+  }
+
+  $stderr.puts "Done!"
+
+end

data/templates/default/fulldoc/html/css/style.css

@@ -52,6 +52,7 @@ body {
   background: #fff;
   padding: 1.2em;
   padding-top: 0.2em;
+  box-sizing: border-box;
 }
 
 @media (max-width: 920px) {

data/yard.gemspec

@@ -11,14 +11,15 @@ Gem::Specification.new do |s|
     custom Ruby constructs such as custom class level definitions.
   eof
   s.version       = YARD::VERSION
-  s.date          = Time.now.strftime('%Y-%m-%d')
   s.author        = "Loren Segal"
   s.email         = "lsegal@soen.ca"
   s.homepage      = "http://yardoc.org"
   s.platform      = Gem::Platform::RUBY
-  s.files         = `git ls-files`.strip.split(/\s+/)
+  s.files         = `git ls-files`.strip.split(/\s+/).reject {|f| f.match(%r{^spec/}) }
   s.require_paths = ['lib']
   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