yard 0.9.24 → 0.9.25

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/templates/helpers/html_helper.rb

@@ -81,9 +81,13 @@ module YARD
         if provider.to_s == '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
+          provider.new(text, :autolink,
+                             :fenced_code,
+                             :gh_blockcode,
+                             :lax_spacing,
+                             :tables,
+                             :with_toc_data,
+                             :no_intraemphasis).to_html
         else
           provider.new(text).to_html
         end
@@ -316,6 +320,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/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module YARD
-  VERSION = '0.9.24'
+  VERSION = '0.9.25'
 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/yard.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   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=)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.24
+  version: 0.9.25
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-05-03 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -296,211 +296,7 @@ files:
 - lib/yard/version.rb
 - po/ja.po
 - samus.json
-- spec/cli/command_parser_spec.rb
-- spec/cli/command_spec.rb
-- spec/cli/config_spec.rb
-- spec/cli/diff_spec.rb
-- spec/cli/display_spec.rb
-- spec/cli/gems_spec.rb
-- spec/cli/graph_spec.rb
-- spec/cli/help_spec.rb
-- spec/cli/i18n_spec.rb
-- spec/cli/list_spec.rb
-- spec/cli/markup_types_spec.rb
-- spec/cli/server_spec.rb
-- spec/cli/stats_spec.rb
-- spec/cli/yard_on_yard_spec.rb
-- spec/cli/yardoc_spec.rb
-- spec/cli/yri_spec.rb
-- spec/code_objects/base_spec.rb
-- spec/code_objects/class_object_spec.rb
-- spec/code_objects/code_object_list_spec.rb
-- spec/code_objects/constants_spec.rb
-- spec/code_objects/extra_file_object_spec.rb
-- spec/code_objects/macro_object_spec.rb
-- spec/code_objects/method_object_spec.rb
-- spec/code_objects/module_object_spec.rb
-- spec/code_objects/namespace_mapper_spec.rb
-- spec/code_objects/namespace_object_spec.rb
-- spec/code_objects/proxy_spec.rb
-- spec/code_objects/spec_helper.rb
-- spec/config_spec.rb
-- spec/core_ext/array_spec.rb
-- spec/core_ext/file_spec.rb
-- spec/core_ext/hash_spec.rb
-- spec/core_ext/insertion_spec.rb
-- spec/core_ext/module_spec.rb
-- spec/core_ext/string_spec.rb
-- spec/core_ext/symbol_hash_spec.rb
-- spec/docstring_parser_spec.rb
-- spec/docstring_spec.rb
-- spec/handlers/alias_handler_spec.rb
-- spec/handlers/attribute_handler_spec.rb
-- spec/handlers/base_spec.rb
-- spec/handlers/c/alias_handler_spec.rb
-- spec/handlers/c/attribute_handler_spec.rb
-- spec/handlers/c/class_handler_spec.rb
-- spec/handlers/c/constant_handler_spec.rb
-- spec/handlers/c/init_handler_spec.rb
-- spec/handlers/c/method_handler_spec.rb
-- spec/handlers/c/mixin_handler_spec.rb
-- spec/handlers/c/module_handler_spec.rb
-- spec/handlers/c/override_comment_handler_spec.rb
-- spec/handlers/c/path_handler_spec.rb
-- spec/handlers/c/spec_helper.rb
-- spec/handlers/c/struct_handler_spec.rb
-- spec/handlers/class_condition_handler_spec.rb
-- spec/handlers/class_handler_spec.rb
-- spec/handlers/class_method_handler_shared_examples.rb
-- spec/handlers/class_variable_handler_spec.rb
-- spec/handlers/constant_handler_spec.rb
-- spec/handlers/decorator_handler_methods_spec.rb
-- spec/handlers/dsl_handler_spec.rb
-- spec/handlers/examples/alias_handler_001.rb.txt
-- spec/handlers/examples/attribute_handler_001.rb.txt
-- spec/handlers/examples/class_condition_handler_001.rb.txt
-- spec/handlers/examples/class_handler_001.rb.txt
-- spec/handlers/examples/class_variable_handler_001.rb.txt
-- spec/handlers/examples/constant_handler_001.rb.txt
-- spec/handlers/examples/dsl_handler_001.rb.txt
-- spec/handlers/examples/exception_handler_001.rb.txt
-- spec/handlers/examples/extend_handler_001.rb.txt
-- spec/handlers/examples/method_condition_handler_001.rb.txt
-- spec/handlers/examples/method_handler_001.rb.txt
-- spec/handlers/examples/mixin_handler_001.rb.txt
-- spec/handlers/examples/module_handler_001.rb.txt
-- spec/handlers/examples/private_constant_handler_001.rb.txt
-- spec/handlers/examples/process_handler_001.rb.txt
-- spec/handlers/examples/visibility_handler_001.rb.txt
-- spec/handlers/examples/yield_handler_001.rb.txt
-- spec/handlers/exception_handler_spec.rb
-- spec/handlers/extend_handler_spec.rb
-- spec/handlers/legacy_base_spec.rb
-- spec/handlers/method_condition_handler_spec.rb
-- spec/handlers/method_handler_spec.rb
-- spec/handlers/mixin_handler_spec.rb
-- spec/handlers/module_function_handler_spec.rb
-- spec/handlers/module_handler_spec.rb
-- spec/handlers/private_class_method_handler_spec.rb
-- spec/handlers/private_constant_handler_spec.rb
-- spec/handlers/processor_spec.rb
-- spec/handlers/public_class_method_handler_spec.rb
-- spec/handlers/ruby/base_spec.rb
-- spec/handlers/ruby/legacy/base_spec.rb
-- spec/handlers/spec_helper.rb
-- spec/handlers/visibility_handler_spec.rb
-- spec/handlers/yield_handler_spec.rb
-- spec/i18n/locale_spec.rb
-- spec/i18n/message_spec.rb
-- spec/i18n/messages_spec.rb
-- spec/i18n/pot_generator_spec.rb
-- spec/i18n/text_spec.rb
-- spec/logging_spec.rb
-- spec/options_spec.rb
-- spec/parser/base_spec.rb
-- spec/parser/c_parser_spec.rb
-- spec/parser/examples/array.c.txt
-- spec/parser/examples/example1.rb.txt
-- spec/parser/examples/extrafile.c.txt
-- spec/parser/examples/file.c.txt
-- spec/parser/examples/multifile.c.txt
-- spec/parser/examples/namespace.cpp.txt
-- spec/parser/examples/override.c.txt
-- spec/parser/examples/parse_in_order_001.rb.txt
-- spec/parser/examples/parse_in_order_002.rb.txt
-- spec/parser/examples/tag_handler_001.rb.txt
-- spec/parser/ruby/ast_node_spec.rb
-- spec/parser/ruby/legacy/statement_list_spec.rb
-- spec/parser/ruby/legacy/token_list_spec.rb
-- spec/parser/ruby/ruby_parser_spec.rb
-- spec/parser/ruby/token_resolver_spec.rb
-- spec/parser/source_parser_spec.rb
-- spec/parser/tag_parsing_spec.rb
-- spec/rake/yardoc_task_spec.rb
-- spec/registry_resolver_spec.rb
-- spec/registry_spec.rb
-- spec/registry_store_spec.rb
-- spec/rubygems/doc_manager_spec.rb
-- spec/serializers/data/serialized_yardoc/checksums
-- spec/serializers/data/serialized_yardoc/objects/Foo.dat
-- spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat
-- spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat
-- spec/serializers/data/serialized_yardoc/objects/root.dat
-- spec/serializers/data/serialized_yardoc/proxy_types
-- spec/serializers/file_system_serializer_spec.rb
-- spec/serializers/spec_helper.rb
-- spec/serializers/yardoc_serializer_spec.rb
-- spec/server/adapter_spec.rb
-- spec/server/commands/base_spec.rb
-- spec/server/commands/library_command_spec.rb
-- spec/server/doc_server_helper_spec.rb
-- spec/server/doc_server_serializer_spec.rb
-- spec/server/rack_adapter_spec.rb
-- spec/server/router_spec.rb
-- spec/server/spec_helper.rb
-- spec/server/static_caching_spec.rb
-- spec/server/webrick_servlet_spec.rb
-- spec/server_spec.rb
-- spec/spec_helper.rb
-- spec/tags/default_factory_spec.rb
-- spec/tags/default_tag_spec.rb
-- spec/tags/directives_spec.rb
-- spec/tags/library_spec.rb
-- spec/tags/overload_tag_spec.rb
-- spec/tags/ref_tag_list_spec.rb
-- spec/tags/types_explainer_spec.rb
-- spec/templates/class_spec.rb
-- spec/templates/constant_spec.rb
-- spec/templates/engine_spec.rb
-- spec/templates/examples/class001.html
-- spec/templates/examples/class001.txt
-- spec/templates/examples/class002.html
-- spec/templates/examples/constant001.txt
-- spec/templates/examples/constant002.txt
-- spec/templates/examples/constant003.txt
-- spec/templates/examples/method001.html
-- spec/templates/examples/method001.txt
-- spec/templates/examples/method002.html
-- spec/templates/examples/method002.txt
-- spec/templates/examples/method003.html
-- spec/templates/examples/method003.txt
-- spec/templates/examples/method004.html
-- spec/templates/examples/method004.txt
-- spec/templates/examples/method005.html
-- spec/templates/examples/method005.txt
-- spec/templates/examples/method006.html
-- spec/templates/examples/method006.txt
-- spec/templates/examples/module001.dot
-- spec/templates/examples/module001.html
-- spec/templates/examples/module001.txt
-- spec/templates/examples/module002.html
-- spec/templates/examples/module003.html
-- spec/templates/examples/module004.html
-- spec/templates/examples/module005.html
-- spec/templates/examples/tag001.txt
-- spec/templates/helpers/base_helper_spec.rb
-- spec/templates/helpers/html_helper_spec.rb
-- spec/templates/helpers/html_syntax_highlight_helper_spec.rb
-- spec/templates/helpers/markup/rdoc_markup_spec.rb
-- spec/templates/helpers/markup_helper_spec.rb
-- spec/templates/helpers/method_helper_spec.rb
-- spec/templates/helpers/module_helper_spec.rb
-- spec/templates/helpers/shared_signature_examples.rb
-- spec/templates/helpers/text_helper_spec.rb
-- spec/templates/markup_processor_integrations/asciidoctor_spec.rb
-- spec/templates/markup_processor_integrations/integration_spec_helper.rb
-- spec/templates/markup_processor_integrations/rdoc_markdown_spec.rb
-- spec/templates/markup_processor_integrations/rdoc_spec.rb
-- spec/templates/markup_processor_integrations/redcarpet_spec.rb
-- spec/templates/markup_processor_integrations/redcloth_spec.rb
-- spec/templates/method_spec.rb
-- spec/templates/module_spec.rb
-- spec/templates/onefile_spec.rb
-- spec/templates/section_spec.rb
-- spec/templates/spec_helper.rb
-- spec/templates/tag_spec.rb
-- spec/templates/template_spec.rb
-- spec/verifier_spec.rb
+- tasks/update_error_map.rake
 - templates/default/class/dot/setup.rb
 - templates/default/class/dot/superklass.erb
 - templates/default/class/html/constructor_details.erb

data/spec/cli/command_parser_spec.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::CLI::CommandParser do
-  describe "#run" do
-    before do
-      @cmd = CLI::CommandParser.new
-    end
-
-    it "shows help if --help is provided" do
-      command = double(:command)
-      expect(command).to receive(:run).with('--help')
-      CLI::CommandParser.commands[:foo] = command
-      @cmd.class.default_command = :foo
-      @cmd.run(*%w(foo --help))
-    end
-
-    it "uses default command if first argument is a switch" do
-      command = double(:command)
-      expect(command).to receive(:run).with('--a', 'b', 'c')
-      CLI::CommandParser.commands[:foo] = command
-      @cmd.class.default_command = :foo
-      @cmd.run(*%w(--a b c))
-    end
-
-    it "uses default command if no arguments are provided" do
-      command = double(:command)
-      expect(command).to receive(:run)
-      CLI::CommandParser.commands[:foo] = command
-      @cmd.class.default_command = :foo
-      @cmd.run
-    end
-
-    it "lists commands if command is not found" do
-      expect(@cmd).to receive(:list_commands)
-      @cmd.run(*%w(unknown_command --args))
-    end
-
-    it "lists commands if --help is provided as sole argument" do
-      expect(@cmd).to receive(:list_commands)
-      @cmd.run(*%w(--help))
-    end
-  end
-end

data/spec/cli/command_spec.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-require 'optparse'
-
-RSpec.describe YARD::CLI::Command do
-  describe "#parse_options" do
-    before do
-      @options = OptionParser.new
-      @saw_foo = false
-      @options.on('--foo') { @saw_foo = true }
-    end
-
-    def parse(*args)
-      CLI::Command.new.send(:parse_options, @options, args)
-      args
-    end
-
-    it "skips unrecognized options but continue to next option" do
-      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
-      expect(log).to receive(:warn).with(/Unrecognized.*--list2/)
-      parse('--list', '--list2', '--foo')
-      expect(@saw_foo).to be true
-    end
-
-    it "skips unrecognized options and any extra non-option arg that follows" do
-      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
-      parse('--list', 'foo', '--foo')
-      expect(@saw_foo).to be true
-    end
-
-    it "stops retrying to parse at non-switch argument" do
-      expect(log).to receive(:warn).with(/Unrecognized.*--list/)
-      args = parse('--list', 'foo', 'foo', 'foo')
-      expect(args).to eq %w(foo foo)
-    end
-  end
-end

data/spec/cli/config_spec.rb

@@ -1,148 +0,0 @@
-# frozen_string_literal: true
-require 'yaml'
-
-RSpec.describe YARD::CLI::Config do
-  before do
-    @config = YARD::CLI::Config.new
-    YARD::Config.options = YARD::Config::DEFAULT_CONFIG_OPTIONS.dup
-    allow(YARD::Config).to receive(:save)
-  end
-
-  def run(*args)
-    @config.run(*args)
-  end
-
-  describe "Listing configuration" do
-    it "accepts --list" do
-      opts = YARD::Config.options
-      expect(YAML).to receive(:dump).twice.and_return("--- foo\nbar\nbaz")
-      expect(log).to receive(:puts).twice.with("bar\nbaz")
-      run
-      run('--list')
-      expect(YARD::Config.options).to eq opts
-    end
-  end
-
-  describe "Viewing an item" do
-    it "views item if no value is given" do
-      YARD::Config.options[:foo] = 'bar'
-      expect(log).to receive(:puts).with('"bar"')
-      run 'foo'
-      expect(YARD::Config.options[:foo]).to eq 'bar'
-    end
-  end
-
-  describe "Modifying an item" do
-    it "accepts --reset to set value" do
-      YARD::Config.options[:load_plugins] = 'foo'
-      run('--reset', 'load_plugins')
-      expect(YARD::Config.options[:load_plugins]).to be false
-    end
-
-    it "accepts --as-list to force single item as list" do
-      run('--as-list', 'foo', 'bar')
-      expect(YARD::Config.options[:foo]).to eq ['bar']
-    end
-
-    it "accepts --append to append values to existing key" do
-      YARD::Config.options[:foo] = ['bar']
-      run('--append', 'foo', 'baz', 'quux')
-      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz', 'quux']
-      run('-a', 'foo', 'last')
-      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz', 'quux', 'last']
-    end
-
-    it "turns key into list if --append is used on single item" do
-      YARD::Config.options[:foo] = 'bar'
-      run('-a', 'foo', 'baz')
-      expect(YARD::Config.options[:foo]).to eq ['bar', 'baz']
-    end
-
-    it "modifies item if value is given" do
-      run('foo', 'xxx')
-      expect(YARD::Config.options[:foo]).to eq 'xxx'
-    end
-
-    it "turns list of values into array of values" do
-      run('foo', 'a', 'b', '1', 'true', 'false')
-      expect(YARD::Config.options[:foo]).to eq ['a', 'b', 1, true, false]
-    end
-
-    it "turns number into numeric Ruby type" do
-      run('foo', '1')
-      expect(YARD::Config.options[:foo]).to eq 1
-    end
-
-    it "turns true into TrueClass" do
-      run('foo', 'true')
-      expect(YARD::Config.options[:foo]).to be true
-    end
-
-    it "turns false into FalseClass" do
-      run('foo', 'false')
-      expect(YARD::Config.options[:foo]).to be false
-    end
-
-    it "saves on modification" do
-      expect(YARD::Config).to receive(:save)
-      run('foo', 'true')
-    end
-  end
-
-  describe "RubyGems hooks" do
-    require 'rubygems'
-
-    class FakeGemConfig < Hash
-      attr_accessor :written
-      def write; @written = true end
-      def path; nil end
-    end
-
-    before do
-      allow(Gem).to receive(:configuration).and_return(FakeGemConfig.new)
-    end
-
-    it "accepts --gem-install-yri" do
-      @config.send(:optparse, '--gem-install-yri')
-      expect(@config.gem_install_cmd).to eq 'yri'
-    end
-
-    it "accepts --gem-install-yard" do
-      @config.send(:optparse, '--gem-install-yard')
-      expect(@config.gem_install_cmd).to eq 'yard'
-    end
-
-    it "does not change back to yri if yard was specified" do
-      @config.send(:optparse, '--gem-install-yard', '--gem-install-yri')
-      expect(@config.gem_install_cmd).to eq 'yard'
-    end
-
-    it "ignores actual config options" do
-      run('--gem-install-yri', 'foo', 'true')
-      expect(YARD::Config).not_to receive(:save)
-    end
-
-    it "updates configuration as :gem if no configuration exists" do
-      run('--gem-install-yri')
-      expect(Gem.configuration[:gem]).to eq "--document=yri"
-      expect(Gem.configuration.written).to eq true
-    end
-
-    [:install, "install", :gem, "gem"].each do |type|
-      it "finds existing config in #{type.inspect} and updates that line without changing anything else" do
-        Gem.configuration[type] = "--opts x"
-        run('--gem-install-yri')
-        expect(Gem.configuration[type]).to eq "--opts x --document=yri"
-        ([:install, "install", :gem, "gem"] - [type]).each do |other|
-          expect(Gem.configuration[other]).to eq nil
-        end
-      end
-    end
-
-    it "scrubs --document values from existing config" do
-      Gem.configuration["gem"] = "--document=yri,ri --no-document --opts x"
-      run('--gem-install-yri')
-      expect(Gem.configuration["gem"]).to eq "--opts x --document=yri"
-    end
-  end
-end