yard-link_stdlib 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35e1ca61be63e6ca2ec8b75762cf24cb2139e375
-  data.tar.gz: c5be9c26529b4fea0ebb8e32f84603090bf2b193
+  metadata.gz: 8b2891135626961fd0982cc28dc8eb233937afef
+  data.tar.gz: b8329bd8d7dd34f6d63e578f96f7b0d050506625
 SHA512:
-  metadata.gz: 374248e1ffd21df5717efc40de3dccbd7bc0ae62d804ce4acb36f84776cfa9293ea620547954d497c407ec91e040d408ca550dd831d5a375d6fcf4e2c6aca1e3
-  data.tar.gz: f4638c958009fbeccf3c6fedbdcac2ba14af45d21286ac6ac0988c6b94e093c1b7db7983e5a067460b1b2e8e4f96fab935f8f1615f0e0884e36b96b0abc2302d
+  metadata.gz: 891798c75cffee0e471498618ae9a77e4fd74ef355405a3e15f8741924661e39f85ddcd3bd45c0fc84ec2d9880516cb3cfeffad1ca81bbe499e1b3466bf71456
+  data.tar.gz: dbfa391daf2a95683d21442e62eb2e3935e834eb3eaf216b4f3734add748159bfea58eab44ef441ad924a1dbcaaf21ec498fe1a0fe5bcb60db0424bd36aab1d0

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/bin/make_map.rb

@@ -90,6 +90,45 @@ class RDoc::RDoc
 end # class RDoc::RDoc
 
 
+def load_pry
+  require 'pry'
+  # In most project you probably *don't* want to load the RC file,
+  # as it may have dependencies
+  Pry.config.should_load_rc = false
+end
+
+
+# Add pre-defined global variables and constants, which are hand-documented in
+#     RUBY_SRC/doc/globals.rdoc
+# 
+# and available on the site at
+# 
+#     https://docs.ruby-lang.org/en/<MAJOR.MINOR.0>/globals_rdoc.html
+# 
+# like https://docs.ruby-lang.org/en/2.3.0/globals_rdoc.html
+# 
+# 
+def add_globals_and_constants map
+  rdoc_path = './doc/globals.rdoc'
+  html_path = 'globals_rdoc.html'
+  
+  unless File.file? rdoc_path
+    warn  "Can't find globals and constants RDoc file at " +
+          "#{ File.expand_path rdoc_path }"
+    warn  "Pre-defined global variables and constants will NOT be available" +
+          "in this map!"
+    return
+  end
+  
+  contents = File.read rdoc_path
+  
+  contents.scan /^(\S+)::\s/ do |(name)|
+    map[ name ] = html_path
+    # puts "Added #{ name.inspect } => #{ html_path }"
+  end
+end
+
+
 def main args
   src = Pathname.new( args.shift ).expand_path
   dest = Pathname.new( args.shift ).expand_path
@@ -112,8 +151,12 @@ def main args
   rd.almost_document args
 
   map = {}
-
+  
+  add_globals_and_constants map
+  
+  # Add all classes and modules
   rd.store.all_classes_and_modules.each do |mod|
+    # Example of how to stop and inspect a particular module when debugging
     # if mod.full_name == 'Gem::Specification'
     #   require 'pry'
     #   Pry.config.should_load_rc = false
@@ -129,6 +172,7 @@ def main args
       mod.instance_method_list,
     ].flatten.each { |entry|
       map[ entry.full_name ] = entry.path
+      # puts "Added #{ entry.full_name.inspect } => #{ entry.path }"
     }
     
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-link_stdlib
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-23 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard