yard 0.9.16 → 0.9.17

data/Rakefile

@@ -1,47 +1,53 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/lib/yard'
-require File.dirname(__FILE__) + '/lib/yard/rubygems/specification'
-require 'rbconfig'
-
-YARD::VERSION.replace(ENV['YARD_VERSION']) if ENV['YARD_VERSION']
-
-desc "Publish gem"
-task :publish do
-  ver = ENV['VERSION']
-
-  raise "missing VERSION=x.y.z" if ver.nil? || ver.empty?
-  if ver < YARD::VERSION
-    raise "invalid version `#{ver}' (must be >= `#{YARD::VERSION}')"
-  end
-
-  file = "release-v#{ver}.tar.gz"
-  cmd = "bundle exec samus"
-  sh "#{cmd} build #{ver} && #{cmd} publish #{file} && rm #{file}"
-end
-
-desc "Builds the gem"
-task :gem do
-  sh "gem build yard.gemspec"
-end
-
-desc "Installs the gem"
-task :install => :gem do
-  sh "gem install yard-#{YARD::VERSION}.gem --no-document"
-end
-
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-  nil # noop
-end
-
-task :rubocop do
-  sh "rubocop"
-end
-
-task :default => [:rubocop, :spec]
-
-YARD::Rake::YardocTask.new do |t|
-  t.options += ['--title', "YARD #{YARD::VERSION} Documentation"]
-end
+# frozen_string_literal: true
+require File.dirname(__FILE__) + '/lib/yard'
+require File.dirname(__FILE__) + '/lib/yard/rubygems/specification'
+require 'rbconfig'
+
+YARD::VERSION.replace(ENV['YARD_VERSION']) if ENV['YARD_VERSION']
+
+desc "Publish gem"
+task :publish do
+  ver = ENV['VERSION']
+
+  raise "missing VERSION=x.y.z" if ver.nil? || ver.empty?
+  if ver < YARD::VERSION
+    raise "invalid version `#{ver}' (must be >= `#{YARD::VERSION}')"
+  end
+
+  file = "release-v#{ver}.tar.gz"
+  cmd = "bundle exec samus"
+  sh "#{cmd} build #{ver} && #{cmd} publish #{file} && rm #{file}"
+end
+
+desc "Builds the gem"
+task :gem do
+  sh "gem build yard.gemspec"
+end
+
+desc "Installs the gem"
+task :install => :gem do
+  sh "gem install yard-#{YARD::VERSION}.gem --no-document"
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  nil # noop
+end
+
+desc "Check code style with Rubocop"
+task :rubocop do
+  sh "rubocop"
+end
+
+desc "Generate documentation for Yard, and fail if there are any warnings"
+task :test_doc do
+  sh "ruby bin/yard --fail-on-warning #{"--no-progress" if ENV["CI"]}"
+end
+
+task :default => [:rubocop, :spec, :test_doc]
+
+YARD::Rake::YardocTask.new do |t|
+  t.options += ['--title', "YARD #{YARD::VERSION} Documentation"]
+end

data/benchmarks/builtins_vs_eval.rb

@@ -1,24 +1,24 @@
-# frozen_string_literal: true
-require 'benchmark'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
-
-TIMES = (ARGV[0] || 10_000).to_i
-
-def bench_builtins(name)
-  YARD::CodeObjects::BUILTIN_EXCEPTIONS_HASH.key? name
-end
-
-def bench_eval(name)
-  eval(name).is_a?(Class)
-rescue
-  false
-end
-
-Benchmark.bmbm do |b|
-  b.report("builtins PASS") { TIMES.times { YARD::CodeObjects::BUILTIN_EXCEPTIONS.each {|y| bench_builtins(y) } } }
-  b.report("eval PASS") { TIMES.times { YARD::CodeObjects::BUILTIN_EXCEPTIONS.each {|y| bench_eval(y) } } }
-  b.report("builtins FAIL") { TIMES.times { YARD::CodeObjects::BUILTIN_MODULES.each {|y| bench_builtins(y) } } }
-  b.report("eval FAIL") { TIMES.times { YARD::CodeObjects::BUILTIN_MODULES.each {|y| bench_eval(y) } } }
-  b.report("builtins ANY") { TIMES.times { YARD::CodeObjects::BUILTIN_CLASSES.each {|y| bench_builtins(y) } } }
-  b.report("eval ANY") { TIMES.times { YARD::CodeObjects::BUILTIN_CLASSES.each {|y| bench_eval(y) } } }
-end
+# frozen_string_literal: true
+require 'benchmark'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
+
+TIMES = (ARGV[0] || 10_000).to_i
+
+def bench_builtins(name)
+  YARD::CodeObjects::BUILTIN_EXCEPTIONS_HASH.key? name
+end
+
+def bench_eval(name)
+  eval(name).is_a?(Class)
+rescue
+  false
+end
+
+Benchmark.bmbm do |b|
+  b.report("builtins PASS") { TIMES.times { YARD::CodeObjects::BUILTIN_EXCEPTIONS.each {|y| bench_builtins(y) } } }
+  b.report("eval PASS") { TIMES.times { YARD::CodeObjects::BUILTIN_EXCEPTIONS.each {|y| bench_eval(y) } } }
+  b.report("builtins FAIL") { TIMES.times { YARD::CodeObjects::BUILTIN_MODULES.each {|y| bench_builtins(y) } } }
+  b.report("eval FAIL") { TIMES.times { YARD::CodeObjects::BUILTIN_MODULES.each {|y| bench_eval(y) } } }
+  b.report("builtins ANY") { TIMES.times { YARD::CodeObjects::BUILTIN_CLASSES.each {|y| bench_builtins(y) } } }
+  b.report("eval ANY") { TIMES.times { YARD::CodeObjects::BUILTIN_CLASSES.each {|y| bench_eval(y) } } }
+end

data/benchmarks/concat_vs_join.rb

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-require "benchmark"
-
-STR1 = "Hello"
-JOIN = "::"
-STR2 = "World"
-
-TESTS = 100_000
-Benchmark.bmbm do |results|
-  results.report("concat") { TESTS.times { "".concat(STR1).concat(JOIN).concat(STR2) } }
-  results.report("add   ") { TESTS.times { STR1 + JOIN + STR2 } }
-  results.report("join  ") { TESTS.times { [STR1, STR2].join(JOIN) } }
-end
+# frozen_string_literal: true
+require "benchmark"
+
+STR1 = "Hello"
+JOIN = "::"
+STR2 = "World"
+
+TESTS = 100_000
+Benchmark.bmbm do |results|
+  results.report("concat") { TESTS.times { "".concat(STR1).concat(JOIN).concat(STR2) } }
+  results.report("add   ") { TESTS.times { STR1 + JOIN + STR2 } }
+  results.report("join  ") { TESTS.times { [STR1, STR2].join(JOIN) } }
+end

data/benchmarks/erb_vs_erubis.rb

@@ -1,54 +1,54 @@
-# frozen_string_literal: true
-require 'rubygems'
-require 'erubis'
-require 'erubis/tiny'
-require 'erb'
-require "benchmark"
-require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
-
-def rungen
-  YARD::Registry.load_yardoc(File.join(File.dirname(__FILE__), '..', '.yardoc'))
-  YARD::Registry.at("YARD::CodeObjects::Base").format(:format => :html)
-end
-
-Benchmark.bmbm do |x|
-  x.report("erubis") do
-    eval <<-eof
-      module YARD; module Templates; module Template
-        def erb_with(str, x) Erubis::Eruby.new(str) end
-      end end end
-    eof
-
-    rungen
-  end
-
-  x.report("fast-erubis") do
-    eval <<-eof
-      module YARD; module Templates; module Template
-        def erb_with(str, x) Erubis::FastEruby.new(str) end
-      end end end
-    eof
-
-    rungen
-  end
-
-  x.report("tiny-erubis") do
-    eval <<-eof
-      module YARD; module Templates; module Template
-        def erb_with(str, x) Erubis::TinyEruby.new(str) end
-      end end end
-    eof
-
-    rungen
-  end
-
-  x.report("erb") do
-    eval <<-eof
-       module YARD; module Templates; module Template
-        def erb_with(str, x) ERB.new(str) end
-      end end end
-    eof
-
-    rungen
-  end
-end
+# frozen_string_literal: true
+require 'rubygems'
+require 'erubis'
+require 'erubis/tiny'
+require 'erb'
+require "benchmark"
+require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
+
+def rungen
+  YARD::Registry.load_yardoc(File.join(File.dirname(__FILE__), '..', '.yardoc'))
+  YARD::Registry.at("YARD::CodeObjects::Base").format(:format => :html)
+end
+
+Benchmark.bmbm do |x|
+  x.report("erubis") do
+    eval <<-eof
+      module YARD; module Templates; module Template
+        def erb_with(str, x) Erubis::Eruby.new(str) end
+      end end end
+    eof
+
+    rungen
+  end
+
+  x.report("fast-erubis") do
+    eval <<-eof
+      module YARD; module Templates; module Template
+        def erb_with(str, x) Erubis::FastEruby.new(str) end
+      end end end
+    eof
+
+    rungen
+  end
+
+  x.report("tiny-erubis") do
+    eval <<-eof
+      module YARD; module Templates; module Template
+        def erb_with(str, x) Erubis::TinyEruby.new(str) end
+      end end end
+    eof
+
+    rungen
+  end
+
+  x.report("erb") do
+    eval <<-eof
+       module YARD; module Templates; module Template
+        def erb_with(str, x) ERB.new(str) end
+      end end end
+    eof
+
+    rungen
+  end
+end

data/benchmarks/format_args.rb

@@ -1,47 +1,47 @@
-# frozen_string_literal: true
-require "benchmark"
-require 'lib/yard'
-
-def format_args_regex(object)
-  if object.signature
-    object.signature[/#{Regexp.quote object.name.to_s}\s*(.*)/, 1]
-  else
-    ""
-  end
-end
-
-def format_args_parameters(object)
-  if !object.parameters.empty?
-    args = object.parameters.map {|n, v| v ? "#{n} = #{v}" : n.to_s }.join(", ")
-    "(#{args})"
-  else
-    ""
-  end
-end
-
-YARD::Registry.load
-$object = YARD::Registry.at('YARD::Generators::Base#G')
-
-log.puts "regex:  " + format_args_regex($object)
-log.puts "params: " + format_args_parameters($object)
-log.puts
-
-TIMES = 100_000
-Benchmark.bmbm do |x|
-  x.report("regex")      { TIMES.times { format_args_regex($object) } }
-  x.report("parameters") { TIMES.times { format_args_parameters($object) } }
-end
-
-=begin LAST RUN Jun 23 2008
-regex:  (generator, opts = {})
-params: (generator, opts = {})
-
-Rehearsal ----------------------------------------------
-regex        1.270000   0.020000   1.290000 (  1.294558)
-parameters   0.690000   0.000000   0.690000 (  0.693324)
-------------------------------------- total: 1.980000sec
-
-                 user     system      total        real
-regex        1.260000   0.010000   1.270000 (  1.268214)
-parameters   0.670000   0.000000   0.670000 (  0.679114)
-=end
+# frozen_string_literal: true
+require "benchmark"
+require 'lib/yard'
+
+def format_args_regex(object)
+  if object.signature
+    object.signature[/#{Regexp.quote object.name.to_s}\s*(.*)/, 1]
+  else
+    ""
+  end
+end
+
+def format_args_parameters(object)
+  if !object.parameters.empty?
+    args = object.parameters.map {|n, v| v ? "#{n} = #{v}" : n.to_s }.join(", ")
+    "(#{args})"
+  else
+    ""
+  end
+end
+
+YARD::Registry.load
+$object = YARD::Registry.at('YARD::Generators::Base#G')
+
+log.puts "regex:  " + format_args_regex($object)
+log.puts "params: " + format_args_parameters($object)
+log.puts
+
+TIMES = 100_000
+Benchmark.bmbm do |x|
+  x.report("regex")      { TIMES.times { format_args_regex($object) } }
+  x.report("parameters") { TIMES.times { format_args_parameters($object) } }
+end
+
+=begin LAST RUN Jun 23 2008
+regex:  (generator, opts = {})
+params: (generator, opts = {})
+
+Rehearsal ----------------------------------------------
+regex        1.270000   0.020000   1.290000 (  1.294558)
+parameters   0.690000   0.000000   0.690000 (  0.693324)
+------------------------------------- total: 1.980000sec
+
+                 user     system      total        real
+regex        1.260000   0.010000   1.270000 (  1.268214)
+parameters   0.670000   0.000000   0.670000 (  0.679114)
+=end

data/benchmarks/generation.rb

@@ -1,38 +1,38 @@
-# frozen_string_literal: true
-require "benchmark"
-require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
-
-unless YARD::CodeObjects::Proxy.private_instance_methods.include?('to_obj')
-  raise "This benchmark is dependent on YARD::CodeObjects::Proxy#to_obj"
-end
-
-def rungen
-  YARD::Registry.clear
-  YARD::CLI::Yardoc.run('--quiet', '--use-cache')
-end
-
-def redef(lock = false)
-  eval <<-eof
-    class YARD::CodeObjects::Proxy;
-      def to_obj
-        @obj #{lock ? '||' : ''}= YARD::Registry.resolve(@namespace, @name)
-      end
-    end
-  eof
-end
-
-Benchmark.bmbm do |x|
-  x.report("gen-w/o-locking")  { redef;       rungen }
-  x.report("gen-with-locking") { redef(true); rungen }
-end
-
-=begin Results from 2008-06-07
-Rehearsal ----------------------------------------------------
-gen-w/o-locking    9.650000   0.450000  10.100000 ( 10.150556)
-gen-with-locking   7.790000   0.400000   8.190000 (  8.373811)
------------------------------------------- total: 18.290000sec
-
-                       user     system      total        real
-gen-w/o-locking    9.820000   0.430000  10.250000 ( 10.293283)
-gen-with-locking   7.820000   0.380000   8.200000 (  8.243326)
-=end
+# frozen_string_literal: true
+require "benchmark"
+require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
+
+unless YARD::CodeObjects::Proxy.private_instance_methods.include?('to_obj')
+  raise "This benchmark is dependent on YARD::CodeObjects::Proxy#to_obj"
+end
+
+def rungen
+  YARD::Registry.clear
+  YARD::CLI::Yardoc.run('--quiet', '--use-cache')
+end
+
+def redef(lock = false)
+  eval <<-eof
+    class YARD::CodeObjects::Proxy;
+      def to_obj
+        @obj #{lock ? '||' : ''}= YARD::Registry.resolve(@namespace, @name)
+      end
+    end
+  eof
+end
+
+Benchmark.bmbm do |x|
+  x.report("gen-w/o-locking")  { redef;       rungen }
+  x.report("gen-with-locking") { redef(true); rungen }
+end
+
+=begin Results from 2008-06-07
+Rehearsal ----------------------------------------------------
+gen-w/o-locking    9.650000   0.450000  10.100000 ( 10.150556)
+gen-with-locking   7.790000   0.400000   8.190000 (  8.373811)
+------------------------------------------ total: 18.290000sec
+
+                       user     system      total        real
+gen-w/o-locking    9.820000   0.430000  10.250000 ( 10.293283)
+gen-with-locking   7.820000   0.380000   8.200000 (  8.243326)
+=end