yard 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec4f1f12885dba0ad0385e0a1f7bd460275291cd
-  data.tar.gz: 2281f497dc0fa185ccc79d8eb5a374bdae40bee2
+  metadata.gz: 874e67d17c94b6c8537e39ec998abbe94f5c5ffc
+  data.tar.gz: 245011fea4112256d31eab954d5d8a6a54f4f156
 SHA512:
-  metadata.gz: 81280e2f91643f20e5fda61e118b97b5cb8868ca9eca7b15ff9572d9a65552df404961f7ad2af281e84937a3a6e67367f72d2746eb2add634e06f62cef126676
-  data.tar.gz: 4ab74c0f9d79622761098afcc0dd349308500d5593f9ea75414f211207b6798c3475aed0d8936eb4e317df76d6981f5b8499bf1e90ae41d180dc8405335aa829
+  metadata.gz: f25ccfa7b086f9cb61830a0d66955b077cefe76cd9ff9b6e0a9dc93d81d573343ba094c9e3eac9204da94f68d26c80991e6a973ec47caa7403482da8c811a0b7
+  data.tar.gz: ced2f2fbe04e8af5afe4878ccd1f40f39928271d44c2c4d5b9878b4b57e1cc2665635f89e4b74ed484a5ff78b8a9d1eea0b5d50a9b0ecc29cbb0f6b1d036d01d

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.9.2 - July 19th, 2016
+
+- Added `yard config --gem-install-[yri|yard]` commands which auto-configure
+  your `~/.gemrc` file to run yri/yard instead of ri/rdoc on a `gem install`.
+- Added support for gemspec metadata key `"yard.run"`, which can be either
+  `"yard"` or `"yri"` to run the respective commands on a `gem install`.
+- Added `yard doc --no-progress` to hide the progress bar.
+- Fix resolution error for compound proxy namespaces.
+- YRI will now search across all gem versions (latest first) for the .yardoc
+  database.
+
 # 0.9.1 - July 18th, 2016
 
 - Added "Attributes" section to `yard stats`.

data/lib/yard/cli/config.rb

@@ -18,6 +18,10 @@ module YARD
       # @return [Boolean] whether to append values to existing key
       attr_accessor :append
 
+      # @return [String, nil] command to use when configuring ~/.gemrc file.
+      #   If the string is nil, configuration should not occur.
+      attr_accessor :gem_install_cmd
+
       def initialize
         super
         self.key = nil
@@ -25,6 +29,7 @@ module YARD
         self.reset = false
         self.append = false
         self.as_list = false
+        self.gem_install_cmd = nil
       end
 
       def description
@@ -33,7 +38,9 @@ module YARD
 
       def run(*args)
         optparse(*args)
-        if key
+        if gem_install_cmd
+          configure_gemrc
+        elsif key
           if reset || values.size > 0
             modify_item
           else
@@ -46,6 +53,27 @@ module YARD
 
       private
 
+      def configure_gemrc
+        return unless gem_install_cmd
+
+        require 'rubygems'
+
+        ['install', :install, 'gem', :gem].find do |cmd|
+          conf = Gem.configuration[cmd] || ""
+          next if conf.empty? && cmd != :gem
+
+          conf = conf.split(/\s+/)
+          conf.delete_if {|c| c =~ /^--(no-)?document\b/ } # scrub doc args
+          conf |= ["--document=#{gem_install_cmd}"]
+          conf = conf.join(' ')
+
+          Gem.configuration[cmd] = conf
+          Gem.configuration.write
+          log.puts "Updated #{Gem.configuration.path || '~/.gemrc'}: '#{cmd}: #{conf}'"
+          true
+        end
+      end
+
       def modify_item
         if reset
           log.debug "Resetting #{key}"
@@ -104,6 +132,28 @@ module YARD
         opts.separator ""
         opts.separator "Note that `true` and `false` are reserved words."
         opts.separator ""
+        opts.separator "---------------------------------------------------------"
+        opts.separator ""
+        opts.separator "Configuring RubyGems support:"
+        opts.separator ""
+        opts.separator "YARD can automatically generate the YRI index or HTML"
+        opts.separator "documentation in a `gem install` by adding the following"
+        opts.separator "to your ~/.gemrc file:"
+        opts.separator ""
+        opts.separator "    gem: \"--document=yri\""
+        opts.separator ""
+        opts.separator "Note: you can add 'yard' to also generate HTML docs."
+        opts.separator "  You can also add 'ri' to continue generating RDoc."
+        opts.separator ""
+        opts.separator "You can also run the following command to configure this"
+        opts.separator "behavior automatically:"
+        opts.separator ""
+        opts.separator "    $ yard config --gem-install-yri"
+        opts.separator ""
+        opts.separator "Add --gem-install-yard to also generate HTML."
+        opts.separator ""
+        opts.separator "---------------------------------------------------------"
+        opts.separator ""
         opts.separator "General options:"
 
         opts.on('-l', '--list', 'List current configuration') do
@@ -123,6 +173,17 @@ module YARD
           self.as_list = true
         end
 
+        opts.separator ""
+        opts.separator "Add RubyGems install hook:"
+
+        opts.on('--gem-install-yri', 'Configures ~/.gemrc to run yri on a gem install') do
+          self.gem_install_cmd = 'yri' if gem_install_cmd != 'yard'
+        end
+
+        opts.on('--gem-install-yard', 'Configures ~/.gemrc to run yard on a gem install') do
+          self.gem_install_cmd = 'yard'
+        end
+
         common_options(opts)
         parse_options(opts, args)
         args = [] if list

data/lib/yard/cli/yardoc.rb

@@ -700,6 +700,10 @@ module YARD
           self.statistics = false
         end
 
+        opts.on('--no-progress', 'Don\'t show progress bar') do
+          log.show_progress = false
+        end
+
         opts.on('--locale LOCALE',
                 'The locale for generated documentation.',
                 '  (defaults to en)') do |locale|

data/lib/yard/config.rb

@@ -191,7 +191,7 @@ module YARD
       options[:autoload_plugins].each {|name| load_plugin(name) }
     end
 
-    # Load plugins from {#arguments}
+    # Load plugins from {arguments}
     def self.load_commandline_plugins
       with_yardopts do
         arguments.each_with_index do |arg, i|
@@ -201,7 +201,7 @@ module YARD
       end
     end
 
-    # Check for command-line safe_mode switch in {#arguments}
+    # Check for command-line safe_mode switch in {arguments}
     def self.load_commandline_safemode
       with_yardopts do
         arguments.each_with_index do |arg, i|

data/lib/yard/docstring_parser.rb

@@ -268,7 +268,7 @@ module YARD
 
     # @!group Parser Callback Methods
 
-    # Calls the {Directive#after_parse} callback on all the
+    # Calls the {Tags::Directive#after_parse} callback on all the
     # created directives.
     def call_directives_after_parse
       directives.each do |dir|