yard 0.9.5 → 0.9.6

data/lib/yard/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
-  VERSION = '0.9.5'
+  VERSION = '0.9.6'
 end

data/spec/cli/command_parser_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::CLI::CommandParser do
+RSpec.describe YARD::CLI::CommandParser do
   describe "#run" do
     before do
       @cmd = CLI::CommandParser.new
@@ -11,7 +11,7 @@ describe YARD::CLI::CommandParser do
       expect(command).to receive(:run).with('--help')
       CLI::CommandParser.commands[:foo] = command
       @cmd.class.default_command = :foo
-      @cmd.run *%w( foo --help )
+      @cmd.run(*%w(foo --help))
     end
 
     it "uses default command if first argument is a switch" do
@@ -19,7 +19,7 @@ describe YARD::CLI::CommandParser do
       expect(command).to receive(:run).with('--a', 'b', 'c')
       CLI::CommandParser.commands[:foo] = command
       @cmd.class.default_command = :foo
-      @cmd.run *%w( --a b c )
+      @cmd.run(*%w(--a b c))
     end
 
     it "uses default command if no arguments are provided" do
@@ -32,12 +32,12 @@ describe YARD::CLI::CommandParser do
 
     it "lists commands if command is not found" do
       expect(@cmd).to receive(:list_commands)
-      @cmd.run *%w( unknown_command --args )
+      @cmd.run(*%w(unknown_command --args))
     end
 
     it "lists commands if --help is provided as sole argument" do
       expect(@cmd).to receive(:list_commands)
-      @cmd.run *%w( --help )
+      @cmd.run(*%w(--help))
     end
   end
-end
+end

data/spec/cli/command_spec.rb

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + "/../spec_helper"
+# frozen_string_literal: true
 require 'optparse'
 
-describe YARD::CLI::Command do
+RSpec.describe YARD::CLI::Command do
   describe "#parse_options" do
     before do
       @options = OptionParser.new

data/spec/cli/config_spec.rb

@@ -1,8 +1,7 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
+# frozen_string_literal: true
 require 'yaml'
 
-describe YARD::CLI::Config do
+RSpec.describe YARD::CLI::Config do
   before do
     @config = YARD::CLI::Config.new
     YARD::Config.options = YARD::Config::DEFAULT_CONFIG_OPTIONS.dup
@@ -146,4 +145,4 @@ describe YARD::CLI::Config do
       expect(Gem.configuration["gem"]).to eq "--opts x --document=yri"
     end
   end
-end
+end

data/spec/cli/diff_spec.rb

@@ -1,8 +1,8 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 require 'stringio'
 require 'open-uri'
 
-describe YARD::CLI::Diff do
+RSpec.describe YARD::CLI::Diff do
   before do
     allow(CLI::Yardoc).to receive(:run)
     allow(CLI::Gems).to receive(:run)
@@ -26,8 +26,8 @@ describe YARD::CLI::Diff do
     def run(*args)
       @all_call = -1
       @data = StringIO.new
-      @objects1 ||= %w( C#fooey C#baz D.bar )
-      @objects2 ||= %w( A A::B A::B::C A.foo A#foo B C.foo C.bar C#baz )
+      @objects1 ||= %w(C#fooey C#baz D.bar)
+      @objects2 ||= %w(A A::B A::B::C A.foo A#foo B C.foo C.bar C#baz)
       @objects = [@objects1, @objects2]
       expect(@diff).to receive(:load_gem_data).ordered.with('gem1') do
         Registry.clear
@@ -59,7 +59,7 @@ describe YARD::CLI::Diff do
         eof
       end
       allow(log).to receive(:print) {|data| @data << data }
-      allow(log).to receive(:puts) {|*args| @data << args.join("\n"); @data << "\n" }
+      allow(log).to receive(:puts) {|*pargs| @data << pargs.join("\n"); @data << "\n" }
       @diff.run(*(args + ['gem1', 'gem2']))
     end
 
@@ -197,11 +197,9 @@ eof
       expect(File).to receive(:directory?).with('gem2-1.0.0/.yardoc').and_return(false)
       expect(File).to receive(:directory?).with('gem1-1.0.0.gem').and_return(false)
       expect(File).to receive(:directory?).with('gem2-1.0.0').and_return(false)
-      gemmock = double(:gemmock)
       spec1   = double(:spec)
       spec2   = double(:spec)
-      expect(gemmock).to receive(:find_name).at_least(1).times.and_return([spec1, spec2])
-      expect(Gem).to receive(:source_index).at_least(1).times.and_return(gemmock)
+      expect(YARD::GemIndex).to receive(:find_all_by_name).at_least(1).times.and_return([spec1, spec2])
       allow(spec1).to receive(:full_name).and_return('gem1-1.0.0')
       allow(spec1).to receive(:name).and_return('gem1')
       allow(spec1).to receive(:version).and_return('1.0.0')
@@ -253,4 +251,4 @@ eof
       @diff.run('gem1', 'gem2.gem')
     end
   end
-end
+end

data/spec/cli/display_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::CLI::Display do
+RSpec.describe YARD::CLI::Display do
   before do
     allow(Registry).to receive(:load)
     @object = CodeObjects::ClassObject.new(:root, :Foo)

data/spec/cli/gems_spec.rb

@@ -1,8 +1,8 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 require 'ostruct'
 require 'rubygems'
 
-describe YARD::CLI::Gems do
+RSpec.describe YARD::CLI::Gems do
   before do
     @rebuild = false
     @gem1 = build_mock('gem1')
@@ -32,40 +32,40 @@ describe YARD::CLI::Gems do
   describe "#run" do
     it "builds all gem indexes if no gem is specified" do
       build_specs(@gem1, @gem2)
-      expect(Gem.source_index).to receive(:find_name).with('').and_return([@gem1, @gem2])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with('').and_return([@gem1, @gem2])
       CLI::Gems.run
     end
 
     it "allows gem to be specified" do
       build_specs(@gem1)
-      expect(Gem.source_index).to receive(:find_name).with(@gem1.name, '>= 0').and_return([@gem1])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 0').and_return([@gem1])
       CLI::Gems.run(@gem1.name)
     end
 
     it "allows multiple gems to be specified for building" do
       build_specs(@gem1, @gem2)
-      expect(Gem.source_index).to receive(:find_name).with(@gem1.name, @gem1.version).and_return([@gem1])
-      expect(Gem.source_index).to receive(:find_name).with(@gem2.name, '>= 0').and_return([@gem2])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, @gem1.version).and_return([@gem1])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem2.name, '>= 0').and_return([@gem2])
       CLI::Gems.run(@gem1.name, @gem1.version, @gem2.name)
     end
 
     it "allows version to be specified with gem" do
       build_specs(@gem1)
-      expect(Gem.source_index).to receive(:find_name).with(@gem1.name, '>= 1.0').and_return([@gem1])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 1.0').and_return([@gem1])
       CLI::Gems.run(@gem1.name, '>= 1.0')
     end
 
     it "warns if one of the gems is not found, but it should process others" do
       build_specs(@gem2)
-      expect(Gem.source_index).to receive(:find_name).with(@gem1.name, '>= 2.0').and_return([])
-      expect(Gem.source_index).to receive(:find_name).with(@gem2.name, '>= 0').and_return([@gem2])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 2.0').and_return([])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem2.name, '>= 0').and_return([@gem2])
       expect(log).to receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
       CLI::Gems.run(@gem1.name, '>= 2.0', @gem2.name)
     end
 
     it "fails if specified gem(s) is/are not found" do
       expect(CLI::Yardoc).not_to receive(:run)
-      expect(Gem.source_index).to receive(:find_name).with(@gem1.name, '>= 2.0').and_return([])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with(@gem1.name, '>= 2.0').and_return([])
       expect(log).to receive(:warn).with(/#{@gem1.name} >= 2.0 could not be found/)
       expect(log).to receive(:error).with(/No specified gems could be found/)
       CLI::Gems.run(@gem1.name, '>= 2.0')
@@ -74,7 +74,7 @@ describe YARD::CLI::Gems do
     it "accepts --rebuild" do
       @rebuild = true
       build_specs(@gem1)
-      expect(Gem.source_index).to receive(:find_name).with('').and_return([@gem1])
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with('').and_return([@gem1])
       CLI::Gems.run('--rebuild')
     end
   end

data/spec/cli/graph_spec.rb

@@ -1,14 +1,15 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::CLI::Graph do
+RSpec.describe YARD::CLI::Graph do
   it "serializes output" do
-    expect(Registry).to receive(:load).at_least(1).times
+    allow(Registry).to receive(:load).at_least(1).times
     allow(subject).to receive(:yardopts) { [] }
     expect(subject.options.serializer).to receive(:serialize).once
     subject.run
   end
 
   it "reads yardoc file from .yardopts" do
+    allow(Registry).to receive(:load).at_least(1).times
     allow(subject).to receive(:yardopts) { %w(--db /path/to/db) }
     expect(subject.options.serializer).to receive(:serialize).once
     subject.run

data/spec/cli/help_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::CLI::Help do
+RSpec.describe YARD::CLI::Help do
   describe "#run" do
     it "accepts help command" do
       expect(CLI::Yardoc).to receive(:run).with('--help')
@@ -19,4 +19,4 @@ describe YARD::CLI::Help do
       help.run('unknown')
     end
   end
-end
+end

data/spec/cli/i18n_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::CLI::I18n do
+RSpec.describe YARD::CLI::I18n do
   before do
     @i18n = YARD::CLI::I18n.new
     @i18n.use_document_file = false
@@ -48,7 +48,7 @@ describe YARD::CLI::I18n do
       expect(@i18n.use_yardopts_file).to be true
     end
 
-    should_accept('--yardopts with filename') do |arg|
+    should_accept('--yardopts with filename') do |_arg|
       @i18n = YARD::CLI::I18n.new
       expect(File).to receive(:read_binary).with('.yardopts_i18n').and_return('')
       @i18n.use_document_file = false

data/spec/cli/list_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::CLI::List do
+RSpec.describe YARD::CLI::List do
   it "passes command off to Yardoc with --list" do
     expect(YARD::CLI::Yardoc).to receive(:run).with('-c', '--list', '--foo')
     YARD::CLI::List.run('--foo')

data/spec/cli/markup_types_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::CLI::MarkupTypes do
+RSpec.describe YARD::CLI::MarkupTypes do
   it "lists all available markup types" do
     YARD::CLI::MarkupTypes.run
     data = log.io.string

data/spec/cli/server_spec.rb

@@ -1,8 +1,8 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
 class Server::WebrickAdapter; def start; end end
 
-describe YARD::CLI::Server do
+RSpec.describe YARD::CLI::Server do
   before do
     allow(CLI::Yardoc).to receive(:run)
     @no_verify_libraries = false
@@ -24,11 +24,15 @@ describe YARD::CLI::Server do
   end
 
   def rack_required
-    begin; require 'rack'; rescue LoadError; pending "rack required for this test" end
+    require 'rack'
+  rescue LoadError
+    pending "rack required for this test"
   end
 
   def bundler_required
-    begin; require 'bundler'; rescue LoadError; pending "bundler required for this test" end
+    require 'bundler'
+  rescue LoadError
+    pending "bundler required for this test"
   end
 
   def unstub_adapter
@@ -38,7 +42,8 @@ describe YARD::CLI::Server do
   def run(*args)
     if @set_libraries && @libraries.empty?
       library = Server::LibraryVersion.new(
-        File.basename(Dir.pwd), nil, File.expand_path('.yardoc'))
+        File.basename(Dir.pwd), nil, File.expand_path('.yardoc')
+      )
       @libraries = {library.name => [library]}
     end
     unless @no_verify_libraries
@@ -63,7 +68,7 @@ describe YARD::CLI::Server do
   def assert_libraries(expected_libs, actual_libs)
     expect(actual_libs).to eq expected_libs
     expected_libs.each do |name, libs|
-      libs.each_with_index do |expected,i|
+      libs.each_with_index do |expected, i|
         actual = actual_libs[name][i]
         [:source, :source_path, :yardoc_file].each do |m|
           expect(actual.send(m)).to eq expected.send(m)
@@ -83,7 +88,7 @@ describe YARD::CLI::Server do
   context 'when .yardopts file exists' do
     before :each do
       Registry.yardoc_file = Registry::DEFAULT_YARDOC_FILE
-      allow(File).to receive(:exist?).with(/\.yardoc\/complete$/).and_return(false)
+      allow(File).to receive(:exist?).with(%r{\.yardoc/complete$}).and_return(false)
       allow(Dir).to receive(:pwd).and_return('/path/to/bar')
       allow(Dir).to receive(:chdir).and_yield
       @name = 'bar'
@@ -97,7 +102,7 @@ describe YARD::CLI::Server do
     end
 
     it "uses the yardoc db location specified by .yardopts" do
-      allow(File).to receive(:exist?).with(/\/foo\/complete$/).and_return(false)
+      allow(File).to receive(:exist?).with(%r{/foo/complete$}).and_return(false)
       mock_file '/path/to/bar/.yardopts', '--db foo'
       @libraries[@name] = [Server::LibraryVersion.new(@name, nil, File.expand_path('/path/to/bar/foo'))]
       @libraries.values[0][0].source_path = File.expand_path('/path/to/bar')
@@ -114,11 +119,12 @@ describe YARD::CLI::Server do
 
   context "when .yardopts file doesn't exist" do
     before :each do
-      allow(File).to receive(:exist?).with(/\.yardoc\/complete$/).and_return(false)
-      allow(File).to receive(:exist?).with(/^(.*[\\\/])?\.yardopts$/).and_return(false)
+      allow(File).to receive(:exist?).with(%r{\.yardoc/complete$}).and_return(false)
+      allow(File).to receive(:exist?).with(%r{^(.*[\\/])?\.yardopts$}).and_return(false)
     end
 
     it "defaults to .yardoc if no library is specified" do
+      allow(Dir).to receive(:chdir).and_yield
       expect(Dir).to receive(:pwd).at_least(:once).and_return(File.expand_path('/path/to/foo'))
       @libraries['foo'] = [Server::LibraryVersion.new('foo', nil, File.expand_path('/path/to/foo/.yardoc'))]
       run
@@ -147,7 +153,7 @@ describe YARD::CLI::Server do
 
   describe "General options" do
     before do
-      allow(File).to receive(:exist?).with(/\.yardoc\/complete$/).and_return(false)
+      allow(File).to receive(:exist?).with(%r{\.yardoc/complete$}).and_return(false)
       allow(File).to receive(:exist?).with(/\.yardopts$/).and_return(false)
     end
 
@@ -179,19 +185,19 @@ describe YARD::CLI::Server do
       @server_options[:Host] = 'example.com'
       run '-B', 'example.com'
       run '--bind', 'example.com'
-    end    
+    end
 
     it "binds address with WebRick adapter" do
       @server_options[:Host] = 'example.com'
       run '-B', 'example.com', '-a', 'webrick'
       run '--bind', 'example.com', '-a', 'webrick'
-    end  
+    end
 
     it "binds address with Rack adapter" do
       @server_options[:Host] = 'example.com'
       run '-B', 'example.com', '-a', 'rack'
       run '--bind', 'example.com', '-a', 'rack'
-    end          
+    end
 
     it "accepts -p, --port" do
       @server_options[:Port] = 10
@@ -244,11 +250,9 @@ describe YARD::CLI::Server do
       gem1 = double(:gem1, :name => 'gem1', :version => '1.0.0', :full_gem_path => '/path/to/foo')
       gem2 = double(:gem2, :name => 'gem2', :version => '1.0.0', :full_gem_path => '/path/to/bar')
       specs = {'gem1' => gem1, 'gem2' => gem2}
-      source = double(:source_index)
-      allow(source).to receive(:find_name) do |k, ver|
+      allow(YARD::GemIndex).to receive(:find_all_by_name) do |k, _ver|
         k == '' ? specs.values : specs.grep(k).map {|name| specs[name] }
       end
-      allow(Gem).to receive(:source_index).and_return(source)
       run '-g'
       run '--gems'
     end
@@ -262,7 +266,6 @@ describe YARD::CLI::Server do
       @libraries['gem2'] = [Server::LibraryVersion.new('gem2', '1.0.0', nil, :gem)]
       gem1 = double(:gem1, :name => 'gem1', :version => '1.0.0', :full_gem_path => '/path/to/foo')
       gem2 = double(:gem2, :name => 'gem2', :version => '1.0.0', :full_gem_path => '/path/to/bar')
-      specs = {'gem1' => gem1, 'gem2' => gem2}
       lockfile_parser = double(:new, :specs => [gem1, gem2])
       allow(Bundler::LockfileParser).to receive(:new).and_return(lockfile_parser)
 

data/spec/cli/stats_spec.rb

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 require 'stringio'
 
-describe YARD::CLI::Stats do
+RSpec.describe YARD::CLI::Stats do
   before do
     Registry.clear
     YARD.parse_string <<-eof
@@ -19,12 +19,12 @@ describe YARD::CLI::Stats do
     eof
 
     @main_stats =
-      "Files:           1\n" +
-      "Modules:         1 (    1 undocumented)\n" +
-      "Classes:         1 (    1 undocumented)\n" +
-      "Constants:       1 (    1 undocumented)\n" +
-      "Attributes:      1 (    0 undocumented)\n" +
-      "Methods:         2 (    1 undocumented)\n" +
+      "Files:           1\n" \
+      "Modules:         1 (    1 undocumented)\n" \
+      "Classes:         1 (    1 undocumented)\n" \
+      "Constants:       1 (    1 undocumented)\n" \
+      "Attributes:      1 (    0 undocumented)\n" \
+      "Methods:         2 (    1 undocumented)\n" \
       " 33.33% documented\n"
 
     @output = StringIO.new
@@ -55,13 +55,13 @@ eof
       def foo; end
     eof
     @stats.run('--list-undoc')
-    expect(@output.string).to eq "Files:           1\n" +
-                              "Modules:         0 (    0 undocumented)\n" +
-                              "Classes:         0 (    0 undocumented)\n" +
-                              "Constants:       0 (    0 undocumented)\n" +
-                              "Attributes:      0 (    0 undocumented)\n" +
-                              "Methods:         1 (    0 undocumented)\n" +
-                              " 100.00% documented\n"
+    expect(@output.string).to eq "Files:           1\n" \
+                                 "Modules:         0 (    0 undocumented)\n" \
+                                 "Classes:         0 (    0 undocumented)\n" \
+                                 "Constants:       0 (    0 undocumented)\n" \
+                                 "Attributes:      0 (    0 undocumented)\n" \
+                                 "Methods:         1 (    0 undocumented)\n" \
+                                 " 100.00% documented\n"
   end
 
   it "lists undocumented objects in compact mode with --list-undoc --compact" do
@@ -84,12 +84,13 @@ eof
   it "ignores everything with --no-public" do
     @stats.run('--no-public')
     expect(@output.string).to eq(
-      "Files:           0\n" +
-      "Modules:         0 (    0 undocumented)\n" +
-      "Classes:         0 (    0 undocumented)\n" +
-      "Constants:       0 (    0 undocumented)\n" +
-      "Attributes:      0 (    0 undocumented)\n" +
-      "Methods:         0 (    0 undocumented)\n" +
-      " 100.00% documented\n")
+      "Files:           0\n" \
+      "Modules:         0 (    0 undocumented)\n" \
+      "Classes:         0 (    0 undocumented)\n" \
+      "Constants:       0 (    0 undocumented)\n" \
+      "Attributes:      0 (    0 undocumented)\n" \
+      "Methods:         0 (    0 undocumented)\n" \
+      " 100.00% documented\n"
+    )
   end
 end