yard 0.9.27 → 0.9.35

data/benchmarks/ri_vs_yri.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-require "benchmark"
-
-TIMES = 10
-Benchmark.bmbm do |x|
-  x.report("ri") { TIMES.times { `ri -T YARD::Tags::Library` } }
-  x.report("yri") { TIMES.times { `./bin/yri -T YARD::Tags::Library` } }
-end
-
-__END__
-
-Rehearsal ---------------------------------------
-ri    0.000000   0.020000   6.880000 (  6.929591)
-yri   0.000000   0.000000   1.060000 (  1.074840)
------------------------------- total: 7.940000sec
-
-          user     system      total        real
-ri    0.000000   0.020000   6.850000 (  6.871660)
-yri   0.000000   0.010000   1.060000 (  1.067585)

data/benchmarks/ripper_parser.rb

@@ -1,13 +0,0 @@
-# encoding: utf-8
-# frozen_string_literal: true
-require 'benchmark'
-require File.dirname(__FILE__) + '/../lib/yard'
-
-$files = Dir[File.dirname(__FILE__) + '/../lib/**/*.rb'].map {|f| File.read(f) }
-$files_rip = Dir[File.dirname(__FILE__) + '/../lib/**/*.rb'].map {|f| [File.read(f), f] }
-
-TIMES = 2
-Benchmark.bmbm do |x|
-  x.report("rip-parser") { TIMES.times { $files_rip.each {|f| YARD::Parser::Ruby::RubyParser.parse(*f) } } }
-  x.report("yard-parser  ") { TIMES.times { $files.each {|f| YARD::Parser::Ruby::Legacy::StatementList.new(f) } } }
-end

data/benchmarks/splat_vs_flatten.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-require "benchmark"
-
-# To prove that flattening a small list is not significantly slower than
-# calling *list (used to get around create_tag list issue)
-$a = "FOO BAR BAZ"
-def foo(*args) args.last.inspect end
-
-TESTS = 10_000
-Benchmark.bmbm do |x|
-  x.report("splat") { TESTS.times { foo(*$a) } }
-  x.report("flatten") { TESTS.times { foo(*[$a].flatten) } }
-end

data/benchmarks/template_erb.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-require "benchmark"
-require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
-
-YARD::Registry.load_yardoc(File.join(File.dirname(__FILE__), '..', '.yardoc'))
-obj = YARD::Registry.at("YARD::CodeObjects::Base")
-
-TIMES = 3
-Benchmark.bm do |x|
-  x.report("trim-line") { TIMES.times { obj.format(:format => :html) } }
-  module YARD
-    module Templates
-      module Template
-        def erb(section, &block)
-          erb = ERB.new(cache(section))
-          erb.filename = cache_filename(section).to_s
-          erb.result(binding, &block)
-        end
-      end
-    end
-  end
-  x.report("no-trim  ") { TIMES.times { obj.format(:format => :html) } }
-end

data/benchmarks/template_format.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-require "benchmark"
-require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
-
-YARD::Registry.load_yardoc(File.join(File.dirname(__FILE__), '..', '.yardoc'))
-obj = YARD::Registry.at("YARD::CodeObjects::Base")
-log.puts Benchmark.measure { obj.format(:format => :html) }

data/benchmarks/template_profile.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-require 'rubygems'
-require 'ruby-prof'
-# require 'benchmark'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
-
-YARD::Registry.load_yardoc(File.join(File.dirname(__FILE__), '..', '.yardoc'))
-obj = YARD::Registry.at("YARD::CodeObjects::Base")
-
-# PerfTools::CpuProfiler.start("template_profile") do
-# end
-
-result = RubyProf.profile do
-  obj.format(:format => :html, :no_highlight => true)
-end
-
-printer = RubyProf::CallTreePrinter.new(result)
-printer.print(STDOUT)

data/benchmarks/yri_cache.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + "/../lib/yard"
-require "benchmark"
-include YARD::CLI
-
-class YARD::CLI::YRI
-  def print_object(object) end
-end
-
-def remove_cache
-  File.unlink(YRI::CACHE_FILE)
-end
-
-TIMES = 10
-NAME = 'YARD'
-remove_cache; YRI.run(NAME)
-Benchmark.bmbm do |x|
-  x.report("cache   ") { TIMES.times { YRI.run(NAME) } }
-  x.report("no-cache") { TIMES.times { remove_cache; YRI.run(NAME) } }
-end

data/samus.json

@@ -1,49 +0,0 @@
-{
-  "actions": [
-    {
-      "action": "fs-sedfiles",
-      "files": [
-        "lib/*/version.rb"
-      ],
-      "arguments": {
-        "search": "VERSION = ['\"](.+?)['\"]",
-        "replace": "VERSION = '$version'"
-      }
-    },
-    {
-      "action": "chmod-files",
-      "files": [
-        "**/*,644",
-        "bin/*,755"
-      ]
-    },
-    {
-      "action": "changelog-rotate",
-      "files": [
-        "CHANGELOG.md"
-      ],
-      "arguments": {
-        "title_format": "$version - %B %-d$day_nth, %Y"
-      }
-    },
-    {
-      "action": "git-commit",
-      "files": [
-        "CHANGELOG.md",
-        "lib/*/version.rb"
-      ]
-    },
-    {
-      "action": "git-merge",
-      "arguments": {
-        "branch": "main"
-      }
-    },
-    {
-      "action": "ruby-bundle"
-    },
-    {
-      "action": "rake-task"
-    }
-  ]
-}

data/tasks/prepare_tag.rake

@@ -1,45 +0,0 @@
-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

@@ -1,53 +0,0 @@
-# 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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-require File.expand_path('../lib/yard/version', __FILE__)
-
-Gem::Specification.new do |s|
-  s.name          = "yard"
-  s.summary       = "Documentation tool for consistent and usable documentation in Ruby."
-  s.description   = <<-eof
-    YARD is a documentation generation tool for the Ruby programming language.
-    It enables the user to generate consistent, usable documentation that can be
-    exported to a number of formats very easily, and also supports extending for
-    custom Ruby constructs such as custom class level definitions.
-  eof
-  s.version       = YARD::VERSION
-  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+/).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