yard 0.9.16 → 0.9.17

data/benchmarks/marshal_vs_dbm.rb

@@ -1,64 +1,64 @@
-# frozen_string_literal: true
-require 'benchmark'
-require 'dbm'
-
-MARSHAL_FILE = "marshal_test.db"
-DBM_FILE = "dbm_test"
-WRITE_TIMES = 1
-READ_TIMES = 100
-NUM_INDICES = 10_000
-INDICES = ['33', '857', '5022', '8555']
-
-def generate_index
-  '0' * (rand * 4096).floor
-end
-
-def write_dbm
-  File.unlink(DBM_FILE + ".db") if File.exist?(DBM_FILE + ".db")
-  handle = DBM.new(DBM_FILE)
-  NUM_INDICES.times {|t| handle[t.to_s] = Marshal.dump(generate_index) }
-  handle.close
-end
-
-def read_dbm
-  db = DBM.open(DBM_FILE)
-  INDICES.each {|index| Marshal.load(db[index]) }
-  db.close
-end
-
-def write_marshal
-  File.unlink(MARSHAL_FILE) if File.exist?(MARSHAL_FILE)
-  handle = {}
-  NUM_INDICES.times {|t| handle[t.to_s] = generate_index }
-  File.open(MARSHAL_FILE, "wb") {|f| f.write(Marshal.dump(handle)) }
-end
-
-def read_marshal
-  db = Marshal.load(File.read(MARSHAL_FILE))
-  INDICES.each {|index| db[index] }
-end
-
-Benchmark.bmbm do |x|
-  x.report("marshal-write") { WRITE_TIMES.times { write_marshal } }
-  x.report("dbm-write") { WRITE_TIMES.times { write_dbm } }
-  x.report("marshal-read ") { READ_TIMES.times { read_marshal } }
-  x.report("dbm-read ") { READ_TIMES.times { read_dbm } }
-end
-
-File.unlink(MARSHAL_FILE)
-File.unlink(DBM_FILE + ".db")
-
-__END__
-
-Rehearsal -------------------------------------------------
-marshal-write   0.090000   0.070000   0.160000 (  0.465820)
-dbm-write       0.560000   0.570000   1.130000 (  3.045556)
-marshal-read    4.640000   3.180000   7.820000 (  7.821978)
-dbm-read        0.020000   0.020000   0.040000 (  0.070920)
----------------------------------------- total: 9.150000sec
-
-                    user     system      total        real
-marshal-write   0.080000   0.050000   0.130000 (  0.436561)
-dbm-write       0.560000   0.550000   1.110000 (  2.030530)
-marshal-read    4.670000   3.180000   7.850000 (  7.842232)
-dbm-read        0.010000   0.020000   0.030000 (  0.053928)
+# frozen_string_literal: true
+require 'benchmark'
+require 'dbm'
+
+MARSHAL_FILE = "marshal_test.db"
+DBM_FILE = "dbm_test"
+WRITE_TIMES = 1
+READ_TIMES = 100
+NUM_INDICES = 10_000
+INDICES = ['33', '857', '5022', '8555']
+
+def generate_index
+  '0' * (rand * 4096).floor
+end
+
+def write_dbm
+  File.unlink(DBM_FILE + ".db") if File.exist?(DBM_FILE + ".db")
+  handle = DBM.new(DBM_FILE)
+  NUM_INDICES.times {|t| handle[t.to_s] = Marshal.dump(generate_index) }
+  handle.close
+end
+
+def read_dbm
+  db = DBM.open(DBM_FILE)
+  INDICES.each {|index| Marshal.load(db[index]) }
+  db.close
+end
+
+def write_marshal
+  File.unlink(MARSHAL_FILE) if File.exist?(MARSHAL_FILE)
+  handle = {}
+  NUM_INDICES.times {|t| handle[t.to_s] = generate_index }
+  File.open(MARSHAL_FILE, "wb") {|f| f.write(Marshal.dump(handle)) }
+end
+
+def read_marshal
+  db = Marshal.load(File.read(MARSHAL_FILE))
+  INDICES.each {|index| db[index] }
+end
+
+Benchmark.bmbm do |x|
+  x.report("marshal-write") { WRITE_TIMES.times { write_marshal } }
+  x.report("dbm-write") { WRITE_TIMES.times { write_dbm } }
+  x.report("marshal-read ") { READ_TIMES.times { read_marshal } }
+  x.report("dbm-read ") { READ_TIMES.times { read_dbm } }
+end
+
+File.unlink(MARSHAL_FILE)
+File.unlink(DBM_FILE + ".db")
+
+__END__
+
+Rehearsal -------------------------------------------------
+marshal-write   0.090000   0.070000   0.160000 (  0.465820)
+dbm-write       0.560000   0.570000   1.130000 (  3.045556)
+marshal-read    4.640000   3.180000   7.820000 (  7.821978)
+dbm-read        0.020000   0.020000   0.040000 (  0.070920)
+---------------------------------------- total: 9.150000sec
+
+                    user     system      total        real
+marshal-write   0.080000   0.050000   0.130000 (  0.436561)
+dbm-write       0.560000   0.550000   1.110000 (  2.030530)
+marshal-read    4.670000   3.180000   7.850000 (  7.842232)
+dbm-read        0.010000   0.020000   0.030000 (  0.053928)

data/benchmarks/parsing.rb

@@ -1,46 +1,46 @@
-# frozen_string_literal: true
-require "benchmark"
-require 'yard'
-require 'logger'
-
-PATH_ORDER = [
-  'lib/yard/autoload.rb',
-  'lib/yard/code_objects/base.rb',
-  'lib/yard/code_objects/namespace_object.rb',
-  'lib/yard/handlers/base.rb',
-  'lib/yard/generators/helpers/*.rb',
-  'lib/yard/generators/base.rb',
-  'lib/yard/generators/method_listing_generator.rb',
-  'lib/yard/serializers/base.rb',
-  'lib/**/*.rb'
-]
-
-Benchmark.bmbm do |x|
-  x.report("parse in order") { YARD::Registry.clear; YARD.parse PATH_ORDER, [], Logger::ERROR }
-  x.report("parse") { YARD::Registry.clear; YARD.parse 'lib/**/*.rb', [], Logger::ERROR }
-end
-
-=begin
-load_order branch (2008-06-07):
-
-Rehearsal --------------------------------------------------
-parse in order   6.510000   0.050000   6.560000 (  6.563223)
-parse            6.300000   0.040000   6.340000 (  6.362272)
----------------------------------------- total: 12.900000sec
-
-                     user     system      total        real
-parse in order   6.310000   0.060000   6.370000 (  6.390945)
-parse            6.300000   0.050000   6.350000 (  6.366709)
-
-
-api_changes branch before merge (2008-06-07)
-
-Rehearsal --------------------------------------------------
-parse in order   6.330000   0.050000   6.380000 (  6.397552)
-parse            6.380000   0.050000   6.430000 (  6.446954)
----------------------------------------- total: 12.810000sec
-
-                     user     system      total        real
-parse in order   6.320000   0.040000   6.360000 (  6.394460)
-parse            6.040000   0.040000   6.080000 (  6.099738)
-=end
+# frozen_string_literal: true
+require "benchmark"
+require 'yard'
+require 'logger'
+
+PATH_ORDER = [
+  'lib/yard/autoload.rb',
+  'lib/yard/code_objects/base.rb',
+  'lib/yard/code_objects/namespace_object.rb',
+  'lib/yard/handlers/base.rb',
+  'lib/yard/generators/helpers/*.rb',
+  'lib/yard/generators/base.rb',
+  'lib/yard/generators/method_listing_generator.rb',
+  'lib/yard/serializers/base.rb',
+  'lib/**/*.rb'
+]
+
+Benchmark.bmbm do |x|
+  x.report("parse in order") { YARD::Registry.clear; YARD.parse PATH_ORDER, [], Logger::ERROR }
+  x.report("parse") { YARD::Registry.clear; YARD.parse 'lib/**/*.rb', [], Logger::ERROR }
+end
+
+=begin
+load_order branch (2008-06-07):
+
+Rehearsal --------------------------------------------------
+parse in order   6.510000   0.050000   6.560000 (  6.563223)
+parse            6.300000   0.040000   6.340000 (  6.362272)
+---------------------------------------- total: 12.900000sec
+
+                     user     system      total        real
+parse in order   6.310000   0.060000   6.370000 (  6.390945)
+parse            6.300000   0.050000   6.350000 (  6.366709)
+
+
+api_changes branch before merge (2008-06-07)
+
+Rehearsal --------------------------------------------------
+parse in order   6.330000   0.050000   6.380000 (  6.397552)
+parse            6.380000   0.050000   6.430000 (  6.446954)
+---------------------------------------- total: 12.810000sec
+
+                     user     system      total        real
+parse in order   6.320000   0.040000   6.360000 (  6.394460)
+parse            6.040000   0.040000   6.080000 (  6.099738)
+=end

data/benchmarks/pathname_vs_string.rb

@@ -1,51 +1,51 @@
-# frozen_string_literal: true
-require 'pathname'
-require "benchmark"
-require File.dirname(__FILE__) + '/../lib/yard'
-
-pathobj = Pathname.new("a/b/c")
-strobj  = "a/b/c"
-
-TIMES = 1_000
-
-log.puts "join:"
-Benchmark.bmbm do |x|
-  x.report("pathname") { TIMES.times { Pathname.new("a/b/c").join("d", "e", "f") } }
-  x.report("string  ") { TIMES.times { File.join("a/b/c", "d", "e", "f") } }
-  x.report("pathname-sameobject") { TIMES.times { pathobj.join("d", "e", "f") } }
-  x.report("string-sameobject  ") { TIMES.times { File.join(strobj, "d", "e", "f") } }
-end
-
-log.puts
-log.puts
-log.puts "cleanpath:"
-Benchmark.bmbm do |x|
-  x.report("pathname") { TIMES.times { Pathname.new("a/b//.././c").cleanpath } }
-  x.report("string  ") { TIMES.times { File.cleanpath("a/b//.././c") } }
-end
-
-__END__
-join:
-Rehearsal -------------------------------------------------------
-pathname              0.330000   0.020000   0.350000 (  0.353481)
-string                0.010000   0.000000   0.010000 (  0.001390)
-pathname-sameobject   0.360000   0.020000   0.380000 (  0.384473)
-string-sameobject     0.000000   0.000000   0.000000 (  0.001187)
----------------------------------------------- total: 0.740000sec
-
-                          user     system      total        real
-pathname              0.330000   0.020000   0.350000 (  0.350820)
-string                0.000000   0.000000   0.000000 (  0.001055)
-pathname-sameobject   0.330000   0.010000   0.340000 (  0.346949)
-string-sameobject     0.000000   0.000000   0.000000 (  0.001141)
-
-
-cleanpath:
-Rehearsal --------------------------------------------
-pathname   0.060000   0.000000   0.060000 (  0.059767)
-string     0.010000   0.000000   0.010000 (  0.013775)
------------------------------------ total: 0.070000sec
-
-               user     system      total        real
-pathname   0.060000   0.000000   0.060000 (  0.059697)
+# frozen_string_literal: true
+require 'pathname'
+require "benchmark"
+require File.dirname(__FILE__) + '/../lib/yard'
+
+pathobj = Pathname.new("a/b/c")
+strobj  = "a/b/c"
+
+TIMES = 1_000
+
+log.puts "join:"
+Benchmark.bmbm do |x|
+  x.report("pathname") { TIMES.times { Pathname.new("a/b/c").join("d", "e", "f") } }
+  x.report("string  ") { TIMES.times { File.join("a/b/c", "d", "e", "f") } }
+  x.report("pathname-sameobject") { TIMES.times { pathobj.join("d", "e", "f") } }
+  x.report("string-sameobject  ") { TIMES.times { File.join(strobj, "d", "e", "f") } }
+end
+
+log.puts
+log.puts
+log.puts "cleanpath:"
+Benchmark.bmbm do |x|
+  x.report("pathname") { TIMES.times { Pathname.new("a/b//.././c").cleanpath } }
+  x.report("string  ") { TIMES.times { File.cleanpath("a/b//.././c") } }
+end
+
+__END__
+join:
+Rehearsal -------------------------------------------------------
+pathname              0.330000   0.020000   0.350000 (  0.353481)
+string                0.010000   0.000000   0.010000 (  0.001390)
+pathname-sameobject   0.360000   0.020000   0.380000 (  0.384473)
+string-sameobject     0.000000   0.000000   0.000000 (  0.001187)
+---------------------------------------------- total: 0.740000sec
+
+                          user     system      total        real
+pathname              0.330000   0.020000   0.350000 (  0.350820)
+string                0.000000   0.000000   0.000000 (  0.001055)
+pathname-sameobject   0.330000   0.010000   0.340000 (  0.346949)
+string-sameobject     0.000000   0.000000   0.000000 (  0.001141)
+
+
+cleanpath:
+Rehearsal --------------------------------------------
+pathname   0.060000   0.000000   0.060000 (  0.059767)
+string     0.010000   0.000000   0.010000 (  0.013775)
+----------------------------------- total: 0.070000sec
+
+               user     system      total        real
+pathname   0.060000   0.000000   0.060000 (  0.059697)
 string     0.020000   0.000000   0.020000 (  0.013624)

data/benchmarks/rdoc_vs_yardoc.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-require "benchmark"
-
-files = Dir.glob(File.dirname(__FILE__) + '/../lib/**/*.rb').join(" ")
-Benchmark.bmbm do |x|
-  x.report("rdoc") { `rm -rf rdoc && rdoc -q -o rdoc #{files} && rm -rf rdoc` }
-  x.report("yardoc") { `rm -rf yard && ./bin/yardoc -q -o yard #{files} && rm -rf yard` }
-  x.report("yardoc-cached") { `rm -rf yard && ./bin/yardoc -c -q -o yard #{files} && rm -rf yard` }
-  x.report("yardoc-legacy") { `rm -rf yard && ./bin/yardoc --legacy -q -o yard #{files} && rm -rf yard` }
-  x.report("yardoc-legacy-cached") { `rm -rf yard && ./bin/yardoc --legacy -c -q -o yard #{files} && rm -rf yard` }
-end
+# frozen_string_literal: true
+require "benchmark"
+
+files = Dir.glob(File.dirname(__FILE__) + '/../lib/**/*.rb').join(" ")
+Benchmark.bmbm do |x|
+  x.report("rdoc") { `rm -rf rdoc && rdoc -q -o rdoc #{files} && rm -rf rdoc` }
+  x.report("yardoc") { `rm -rf yard && ./bin/yardoc -q -o yard #{files} && rm -rf yard` }
+  x.report("yardoc-cached") { `rm -rf yard && ./bin/yardoc -c -q -o yard #{files} && rm -rf yard` }
+  x.report("yardoc-legacy") { `rm -rf yard && ./bin/yardoc --legacy -q -o yard #{files} && rm -rf yard` }
+  x.report("yardoc-legacy-cached") { `rm -rf yard && ./bin/yardoc --legacy -c -q -o yard #{files} && rm -rf yard` }
+end

data/benchmarks/registry_store_types.rb

@@ -1,49 +1,49 @@
-# frozen_string_literal: true
-require 'benchmark'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
-
-def parse_and_select_objects
-  YARD::Registry.load_yardoc(File.join(File.dirname(__FILE__), '..', '.yardoc'))
-  YARD::Registry.load_all
-  $paths = []
-  4.times { $paths << YARD::Registry.paths[rand(YARD::Registry.paths.size)] }
-
-  $regular_registry = {}
-  $types_registry = {}
-  YARD::Registry.all.each do |object|
-    $regular_registry[object.path] = object
-    ($types_registry[object.type] ||= {})[object.path] = object
-  end
-end
-
-def run_lookup
-  $paths.select {|path| $regular_registry[path] }
-end
-
-def run_lookup_with_types
-  $paths.select {|path| $types_registry.values.find {|list| list[path] } }
-end
-
-TIMES = 100_000
-
-parse_and_select_objects
-p $paths
-Benchmark.bmbm do |x|
-  x.report("normal") { TIMES.times { run_lookup } }
-  x.report("types")  { TIMES.times { run_lookup_with_types } }
-end
-
-__END__
-# Run on March 22 2012
-["YARD::Parser::Ruby::Legacy::RubyToken::TkUnknownChar#initialize",
-  "YARD::Parser::C::CParser#enumerator",
-  "YARD::CodeObjects::ClassObject#inherited_meths",
-  "YARD::Parser::C::Statement#source="]
-Rehearsal ----------------------------------------------
-normal       0.180000   0.000000   0.180000 (  0.182640)
-types        1.150000   0.010000   1.160000 (  1.160219)
-------------------------------------- total: 1.340000sec
-
-                 user     system      total        real
-normal       0.170000   0.000000   0.170000 (  0.165621)
-types        1.140000   0.000000   1.140000 (  1.142269)
+# frozen_string_literal: true
+require 'benchmark'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
+
+def parse_and_select_objects
+  YARD::Registry.load_yardoc(File.join(File.dirname(__FILE__), '..', '.yardoc'))
+  YARD::Registry.load_all
+  $paths = []
+  4.times { $paths << YARD::Registry.paths[rand(YARD::Registry.paths.size)] }
+
+  $regular_registry = {}
+  $types_registry = {}
+  YARD::Registry.all.each do |object|
+    $regular_registry[object.path] = object
+    ($types_registry[object.type] ||= {})[object.path] = object
+  end
+end
+
+def run_lookup
+  $paths.select {|path| $regular_registry[path] }
+end
+
+def run_lookup_with_types
+  $paths.select {|path| $types_registry.values.find {|list| list[path] } }
+end
+
+TIMES = 100_000
+
+parse_and_select_objects
+p $paths
+Benchmark.bmbm do |x|
+  x.report("normal") { TIMES.times { run_lookup } }
+  x.report("types")  { TIMES.times { run_lookup_with_types } }
+end
+
+__END__
+# Run on March 22 2012
+["YARD::Parser::Ruby::Legacy::RubyToken::TkUnknownChar#initialize",
+  "YARD::Parser::C::CParser#enumerator",
+  "YARD::CodeObjects::ClassObject#inherited_meths",
+  "YARD::Parser::C::Statement#source="]
+Rehearsal ----------------------------------------------
+normal       0.180000   0.000000   0.180000 (  0.182640)
+types        1.150000   0.010000   1.160000 (  1.160219)
+------------------------------------- total: 1.340000sec
+
+                 user     system      total        real
+normal       0.170000   0.000000   0.170000 (  0.165621)
+types        1.140000   0.000000   1.140000 (  1.142269)

data/benchmarks/ri_vs_yri.rb

@@ -1,19 +1,19 @@
-# 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)
+# 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)