yard 0.9.1 → 0.9.2

data/lib/yard/handlers/ruby/private_constant_handler.rb

@@ -1,7 +1,8 @@
-# Sets visibility of a constant (class, module, const)
 module YARD
   module Handlers
     module Ruby
+
+      # Sets visibility of a constant (class, module, const)
       class PrivateConstantHandler < YARD::Handlers::Ruby::Base
         handles method_call(:private_constant)
         namespace_only

data/lib/yard/registry.rb

@@ -50,24 +50,31 @@ module YARD
       # @return [nil] if +for_writing+ is set to false and no yardoc file
       #   is found, returns nil.
       def yardoc_file_for_gem(gem, ver_require = ">= 0", for_writing = false)
-        spec = Gem.source_index.find_name(gem, ver_require)
-        return if spec.empty?
-        spec = spec.first
+        specs = Gem.source_index.find_name(gem, ver_require)
+        return if specs.empty?
+
+        result = nil
+        specs.reverse.each do |spec|
+          if gem =~ /^yard-doc-/
+            path = File.join(spec.full_gem_path, DEFAULT_YARDOC_FILE)
+            result = File.exist?(path) && !for_writing ? path : nil
+            result ? break : next
+          end
 
-        if gem =~ /^yard-doc-/
-          path = File.join(spec.full_gem_path, DEFAULT_YARDOC_FILE)
-          return File.exist?(path) && !for_writing ? path : nil
-        end
+          if for_writing
+            result = global_yardoc_file(spec, for_writing) ||
+              old_global_yardoc_file(spec, for_writing) ||
+              local_yardoc_file(spec, for_writing)
+          else
+            result = local_yardoc_file(spec, for_writing) ||
+              global_yardoc_file(spec, for_writing) ||
+              old_global_yardoc_file(spec, for_writing)
+          end
 
-        if for_writing
-          global_yardoc_file(spec, for_writing) ||
-            old_global_yardoc_file(spec, for_writing) ||
-            local_yardoc_file(spec, for_writing)
-        else
-          local_yardoc_file(spec, for_writing) ||
-            global_yardoc_file(spec, for_writing) ||
-            old_global_yardoc_file(spec, for_writing)
+          break if result
         end
+
+        result
       end
 
       # Gets/sets the yardoc filename

data/lib/yard/registry_resolver.rb

@@ -4,6 +4,7 @@ module YARD
   # directly.
   #
   # @see Registry.resolve
+  # @since 0.9.1
   class RegistryResolver
     include CodeObjects::NamespaceMapper
 
@@ -155,7 +156,7 @@ module YARD
 
     # Collects and returns all inherited namespaces for a given object
     def collect_namespaces(object)
-      return [] if !object
+      return [] unless object.respond_to?(:inheritance_tree)
 
       nss = object.inheritance_tree(true)
       if object.respond_to?(:superclass)

data/lib/yard/rubygems/hook.rb

@@ -52,7 +52,16 @@ module YARD
       generate_yri = types.include? 'yri'
 
       specs.each do |spec|
-        new(spec, generate_yard, generate_yri).generate
+        gen_yard, gen_yri = generate_yard, generate_yri
+        gen_yri = false if gen_yard # never generate both, no need
+        if types.size > 0 # --no-document is not in effect
+          # look at spec.metadata['yard.run'] for override
+          run_yard = spec.metadata['yard.run']
+          gen_yard = true if run_yard && run_yard != 'yri'
+          gen_yri = true if run_yard == 'yri'
+        end
+
+        new(spec, gen_yard, gen_yri).generate
       end
 
       return unless generate_yard or generate_yri
@@ -116,14 +125,14 @@ module YARD
       FileUtils.rm_rf @yard_dir
 
       say "Installing YARD documentation for #{@spec.full_name}..."
-      run_yardoc '-o', @yard_dir
+      run_yardoc '--no-progress', '--db', @yri_dir, '-o', @yard_dir
     end
 
     def install_yri
       FileUtils.rm_rf @yri_dir
 
       say "Building YARD (yri) index for #{@spec.full_name}..."
-      run_yardoc '-c', '-n', '--db', @yri_dir
+      run_yardoc '--no-progress', '-c', '-n', '--db', @yri_dir
     end
 
     ##

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/spec/cli/config_spec.rb

@@ -89,4 +89,61 @@ describe YARD::CLI::Config do
       run('foo', 'true')
     end
   end
+
+  describe "RubyGems hooks" do
+    require 'rubygems'
+
+    class FakeGemConfig < Hash
+      attr_accessor :written
+      def write; @written = true end
+      def path; nil end
+    end
+
+    before do
+      allow(Gem).to receive(:configuration).and_return(FakeGemConfig.new)
+    end
+
+    it "accepts --gem-install-yri" do
+      @config.send(:optparse, '--gem-install-yri')
+      expect(@config.gem_install_cmd).to eq 'yri'
+    end
+
+    it "accepts --gem-install-yard" do
+      @config.send(:optparse, '--gem-install-yard')
+      expect(@config.gem_install_cmd).to eq 'yard'
+    end
+
+    it "does not change back to yri if yard was specified" do
+      @config.send(:optparse, '--gem-install-yard', '--gem-install-yri')
+      expect(@config.gem_install_cmd).to eq 'yard'
+    end
+
+    it "ignores actual config options" do
+      run('--gem-install-yri', 'foo', 'true')
+      expect(YARD::Config).not_to receive(:save)
+    end
+
+    it "updates configuration as :gem if no configuration exists" do
+      run('--gem-install-yri')
+      expect(Gem.configuration[:gem]).to eq "--document=yri"
+      expect(Gem.configuration.written).to eq true
+    end
+
+    [:install, "install", :gem, "gem"].each do |type|
+      it "finds existing config in #{type.inspect} and updates that line without changing anything else" do
+        Gem.configuration[type] = "--opts x"
+        run('--gem-install-yri')
+        expect(Gem.configuration[type]).to eq "--opts x --document=yri"
+        ([:install, "install", :gem, "gem"] - [type]).each do |other|
+          expect(Gem.configuration[other]).to eq nil
+        end
+      end
+    end
+
+    it "scrubs --document values from existing config" do
+      Gem.configuration["gem"] = "--document=yri,ri --no-document --opts x"
+      run('--gem-install-yri')
+      expect(Gem.configuration["gem"]).to eq "--opts x --document=yri"
+    end
+  end
 end

data/spec/cli/yardoc_spec.rb

@@ -253,6 +253,14 @@ describe YARD::CLI::Yardoc do
       @yardoc.run *%w( --no-stats )
     end
 
+    it "disables progress bar with --no-progress" do
+      old = log.show_progress
+      log.show_progress = true
+      @yardoc.run *%w( --no-progress )
+      expect(log.show_progress).to eq false
+      log.show_progress = old
+    end
+
     describe "--asset" do
       before do
         @yardoc.generate = true