yard 0.9.5 → 0.9.6

data/spec/cli/yardoc_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::CLI::Yardoc do
+RSpec.describe YARD::CLI::Yardoc do
   before do
     @yardoc = YARD::CLI::Yardoc.new
     @yardoc.statistics = false
@@ -89,8 +89,8 @@ describe YARD::CLI::Yardoc do
       @counter ||= 0
       @counter += 1
       counter = @counter
+      define_method("test_options_#{@counter}", &block)
       args.each do |arg|
-        define_method("test_options_#{@counter}", &block)
         it("accepts #{arg}") { send("test_options_#{counter}", arg) }
       end
     end
@@ -127,7 +127,7 @@ describe YARD::CLI::Yardoc do
       expect(@yardoc.use_yardopts_file).to be true
     end
 
-    should_accept('--yardopts with filename') do |arg|
+    should_accept('--yardopts with filename') do |_arg|
       @yardoc = CLI::Yardoc.new
       expect(File).to receive(:read_binary).with('.foobar').and_return('')
       @yardoc.use_document_file = false
@@ -200,7 +200,7 @@ describe YARD::CLI::Yardoc do
     end
 
     it "aliases --main to the --readme flag" do
-      readme = File.join(File.dirname(__FILE__),'..','..','README.md')
+      readme = File.join(File.dirname(__FILE__), '..', '..', 'README.md')
 
       @yardoc.parse_arguments('--main', readme)
       expect(@yardoc.options.readme).to eq CodeObjects::ExtraFileObject.new(readme, '')
@@ -221,22 +221,22 @@ describe YARD::CLI::Yardoc do
     end
 
     it "accepts --default-return" do
-      @yardoc.parse_arguments *%w( --default-return XYZ )
+      @yardoc.parse_arguments(*%w(--default-return XYZ))
       expect(@yardoc.options.default_return).to eq "XYZ"
     end
 
     it "allows --hide-void-return to be set" do
-      @yardoc.parse_arguments *%w( --hide-void-return )
+      @yardoc.parse_arguments(*%w(--hide-void-return))
       expect(@yardoc.options.hide_void_return).to be true
     end
 
     it "accepts --embed-mixins" do
-      @yardoc.parse_arguments *%w( --embed-mixins )
+      @yardoc.parse_arguments(*%w(--embed-mixins))
       expect(@yardoc.options.embed_mixins).to eq ['*']
     end
 
     it "accepts --embed-mixin MODULE" do
-      @yardoc.parse_arguments *%w( --embed-mixin MyModule )
+      @yardoc.parse_arguments(*%w(--embed-mixin MyModule))
       expect(@yardoc.options.embed_mixins).to eq ['MyModule']
     end
 
@@ -245,19 +245,19 @@ describe YARD::CLI::Yardoc do
       expect(Registry).to receive(:load)
       expect(Registry).to receive(:load_all)
       allow(@yardoc).to receive(:generate).and_return(true)
-      @yardoc.run *%w( --use-cache )
+      @yardoc.run(*%w(--use-cache))
     end
 
     it "does not print statistics with --no-stats" do
       allow(@yardoc).to receive(:statistics).and_return(false)
       expect(CLI::Stats).not_to receive(:new)
-      @yardoc.run *%w( --no-stats )
+      @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 )
+      @yardoc.run(*%w(--no-progress))
       expect(log.show_progress).to eq false
       log.show_progress = old
     end
@@ -270,33 +270,33 @@ describe YARD::CLI::Yardoc do
 
       it "copies assets to output directory" do
         expect(FileUtils).to receive(:cp_r).with('a', 'doc/a')
-        @yardoc.run *%w( --asset a )
-        expect(@yardoc.assets).to eq({'a' => 'a'})
+        @yardoc.run(*%w(--asset a))
+        expect(@yardoc.assets).to eq('a' => 'a')
       end
 
       it "allows multiple --asset options" do
         expect(FileUtils).to receive(:cp_r).with('a', 'doc/a')
         expect(FileUtils).to receive(:cp_r).with('b', 'doc/b')
-        @yardoc.run *%w( --asset a --asset b )
-        expect(@yardoc.assets).to eq({'a' => 'a', 'b' => 'b'})
+        @yardoc.run(*%w(--asset a --asset b))
+        expect(@yardoc.assets).to eq('a' => 'a', 'b' => 'b')
       end
 
       it "does not allow from or to to refer to a path above current path" do
         expect(log).to receive(:warn).exactly(4).times.with(/invalid/i)
-        @yardoc.run *%w( --asset ../../../etc/passwd )
+        @yardoc.run(*%w(--asset ../../../etc/passwd))
         expect(@yardoc.assets).to be_empty
-        @yardoc.run *%w( --asset a/b/c/d/../../../../../../etc/passwd )
+        @yardoc.run(*%w(--asset a/b/c/d/../../../../../../etc/passwd))
         expect(@yardoc.assets).to be_empty
-        @yardoc.run *%w( --asset /etc/passwd )
+        @yardoc.run(*%w(--asset /etc/passwd))
         expect(@yardoc.assets).to be_empty
-        @yardoc.run *%w( --asset normal:/etc/passwd )
+        @yardoc.run(*%w(--asset normal:/etc/passwd))
         expect(@yardoc.assets).to be_empty
       end
 
       it "allows from:to syntax" do
         expect(FileUtils).to receive(:cp_r).with('foo', 'doc/bar')
-        @yardoc.run *%w( --asset foo:bar )
-        expect(@yardoc.assets).to eq({'foo' => 'bar'})
+        @yardoc.run(*%w(--asset foo:bar))
+        expect(@yardoc.assets).to eq('foo' => 'bar')
       end
 
       it "does not put from inside of to/ if from is a directory" do
@@ -369,7 +369,7 @@ describe YARD::CLI::Yardoc do
       eof
       @yardoc.run('--api', 'private', '--api', 'public')
       expect(@yardoc.options.verifier.run(Registry.all).
-        sort_by {|o| o.path }).to eq [P('Bar'), P('Foo')]
+        sort_by(&:path)).to eq [P('Bar'), P('Foo')]
     end
 
     it "allows --no-api to specify objects with no @api tag" do
@@ -397,7 +397,7 @@ describe YARD::CLI::Yardoc do
       eof
       @yardoc.run('--no-api', '--api', 'public')
       expect(@yardoc.options.verifier.run(Registry.all).
-        sort_by {|o| o.path }).to eq [P('Bar'), P('Baz')]
+        sort_by(&:path)).to eq [P('Bar'), P('Baz')]
     end
 
     it "ensures Ruby code cannot be used" do
@@ -419,7 +419,7 @@ describe YARD::CLI::Yardoc do
       eof
       @yardoc.run('--hide-api', 'private')
       expect(@yardoc.options.verifier.run(Registry.all).
-        sort_by {|o| o.path }).to eq [P('Bar'), P('Baz')]
+        sort_by(&:path)).to eq [P('Bar'), P('Baz')]
     end
 
     it "allows --hide-api to work with --api" do
@@ -432,7 +432,7 @@ describe YARD::CLI::Yardoc do
       eof
       @yardoc.run('--api', 'public', '--hide-api', 'private')
       expect(@yardoc.options.verifier.run(Registry.all).
-        sort_by {|o| o.path }).to eq [P('Bar')]
+        sort_by(&:path)).to eq [P('Bar')]
     end
   end
 
@@ -440,7 +440,7 @@ describe YARD::CLI::Yardoc do
     it "accepts --no-private" do
       obj = double(:object)
       expect(obj).to receive(:tag).ordered.with(:private).and_return(true)
-      @yardoc.parse_arguments *%w( --no-private )
+      @yardoc.parse_arguments(*%w(--no-private))
       expect(@yardoc.options.verifier.call(obj)).to be false
     end
 
@@ -449,7 +449,7 @@ describe YARD::CLI::Yardoc do
       expect(ns).to receive(:tag).with(:private).and_return(true)
       obj = double(:object, :namespace => ns)
       expect(obj).to receive(:tag).with(:private).and_return(false)
-      @yardoc.parse_arguments *%w( --no-private )
+      @yardoc.parse_arguments(*%w(--no-private))
       expect(@yardoc.options.verifier.call(obj)).to be false
     end
 
@@ -459,7 +459,7 @@ describe YARD::CLI::Yardoc do
       expect(ns).not_to receive(:tag)
       obj = double(:object, :type => :class, :namespace => ns, :visibility => :public)
       expect(obj).to receive(:tag).ordered.with(:private).and_return(false)
-      @yardoc.parse_arguments *%w( --no-private )
+      @yardoc.parse_arguments(*%w(--no-private))
       expect(@yardoc.options.verifier.call(obj)).to be true
     end
 
@@ -469,12 +469,12 @@ describe YARD::CLI::Yardoc do
       YARD.parse_string "module Qux; class Foo::Bar; end; end"
       foobar = Registry.at('Foo::Bar')
       foobar.namespace.type = :module
-      @yardoc.parse_arguments *%w( --no-private )
+      @yardoc.parse_arguments(*%w(--no-private))
       expect(@yardoc.options.verifier.call(foobar)).to be true
     end
 
     it "does not call #tag on proxy object" do # @bug gh-197
-      @yardoc.parse_arguments *%w( --no-private )
+      @yardoc.parse_arguments(*%w(--no-private))
       expect(@yardoc.options.verifier.call(P('ProxyClass'))).to be true
     end
 
@@ -486,7 +486,7 @@ describe YARD::CLI::Yardoc do
           def foo; end
         end
       eof
-      @yardoc.parse_arguments *%w( --no-private )
+      @yardoc.parse_arguments(*%w(--no-private))
       expect(@yardoc.options.verifier.call(Registry.at('ABC'))).to be false
       expect(@yardoc.options.verifier.call(Registry.at('ABC#foo'))).to be false
     end
@@ -507,7 +507,7 @@ describe YARD::CLI::Yardoc do
     end
 
     it "uses String#shell_split to split .yardopts tokens" do
-      optsdata = "foo bar"
+      optsdata = String.new("foo bar")
       expect(optsdata).to receive(:shell_split)
       expect(File).to receive(:read_binary).with("test").and_return(optsdata)
       @yardoc.options_file = "test"
@@ -550,7 +550,7 @@ describe YARD::CLI::Yardoc do
     end
 
     it "accepts a --query" do
-      @yardoc.parse_arguments *%w( --query @return )
+      @yardoc.parse_arguments(*%w(--query @return))
       expect(@yardoc.options.verifier).to be_a(Verifier)
     end
 
@@ -558,7 +558,7 @@ describe YARD::CLI::Yardoc do
       obj = double(:object)
       expect(obj).to receive(:tag).ordered.with('return').and_return(true)
       expect(obj).to receive(:tag).ordered.with('tag').and_return(false)
-      @yardoc.parse_arguments *%w( --query @return --query @tag )
+      @yardoc.parse_arguments(*%w(--query @return --query @tag))
       expect(@yardoc.options.verifier).to be_a(Verifier)
       expect(@yardoc.options.verifier.call(obj)).to be false
     end
@@ -571,16 +571,17 @@ describe YARD::CLI::Yardoc do
       expect(File).to receive(:file?).with('extra_file2').and_return(true)
       expect(File).to receive(:read).with('extra_file1').and_return('')
       expect(File).to receive(:read).with('extra_file2').and_return('')
-      @yardoc.parse_arguments *%w( file1 file2 - extra_file1 extra_file2 )
-      expect(@yardoc.files).to eq %w( file1 file2 )
+      @yardoc.parse_arguments(*%w(file1 file2 - extra_file1 extra_file2))
+      expect(@yardoc.files).to eq %w(file1 file2)
       expect(@yardoc.options.files).to eq(
         [CodeObjects::ExtraFileObject.new('extra_file1', ''),
-          CodeObjects::ExtraFileObject.new('extra_file2', '')])
+          CodeObjects::ExtraFileObject.new('extra_file2', '')]
+      )
     end
 
     it "accepts files section only containing extra files" do
       expect(Dir).to receive(:glob).with('README{,*[^~]}').and_return([])
-      @yardoc.parse_arguments *%w( - LICENSE )
+      @yardoc.parse_arguments(*%w(- LICENSE))
       expect(@yardoc.files).to eq Parser::SourceParser::DEFAULT_PATH_GLOB
       expect(@yardoc.options.files).to eq [CodeObjects::ExtraFileObject.new('LICENSE', '')]
     end
@@ -592,35 +593,36 @@ describe YARD::CLI::Yardoc do
       expect(File).to receive(:read).with('b.txt').and_return('')
       expect(File).to receive(:file?).with('a.txt').and_return(true)
       expect(File).to receive(:file?).with('b.txt').and_return(true)
-      @yardoc.parse_arguments *%w( file1 file2 - *.txt )
-      expect(@yardoc.files).to eq %w( file1 file2 )
+      @yardoc.parse_arguments(*%w(file1 file2 - *.txt))
+      expect(@yardoc.files).to eq %w(file1 file2)
       expect(@yardoc.options.files).to eq(
         [CodeObjects::ExtraFileObject.new('a.txt', ''),
-          CodeObjects::ExtraFileObject.new('b.txt', '')])
+          CodeObjects::ExtraFileObject.new('b.txt', '')]
+      )
     end
 
     it "warns if extra file is not found" do
       expect(log).to receive(:warn).with(/Could not find extra file: UNKNOWN/)
-      @yardoc.parse_arguments *%w( - UNKNOWN )
+      @yardoc.parse_arguments(*%w(- UNKNOWN))
     end
 
     it "warns if readme file is not found" do
       expect(log).to receive(:warn).with(/Could not find readme file: UNKNOWN/)
-      @yardoc.parse_arguments *%w( -r UNKNOWN )
+      @yardoc.parse_arguments(*%w(-r UNKNOWN))
     end
 
     it "uses first file as readme if no readme is specified when using --one-file" do
       expect(Dir).to receive(:glob).with('README{,*[^~]}').and_return []
       expect(Dir).to receive(:glob).with('lib/*.rb').and_return(['lib/foo.rb'])
       expect(File).to receive(:read).with('lib/foo.rb').and_return('')
-      @yardoc.parse_arguments *%w( --one-file lib/*.rb )
+      @yardoc.parse_arguments(*%w(--one-file lib/*.rb))
       expect(@yardoc.options.readme).to eq CodeObjects::ExtraFileObject.new('lib/foo.rb', '')
     end
 
     it "uses readme it exists when using --one-file" do
       expect(Dir).to receive(:glob).with('README{,*[^~]}').and_return ['README']
       expect(File).to receive(:read).with('README').and_return('')
-      @yardoc.parse_arguments *%w( --one-file lib/*.rb )
+      @yardoc.parse_arguments(*%w(--one-file lib/*.rb))
       expect(@yardoc.options.readme).to eq CodeObjects::ExtraFileObject.new('README', '')
     end
 
@@ -628,7 +630,7 @@ describe YARD::CLI::Yardoc do
       ienc = Encoding.default_internal
       eenc = Encoding.default_external
       expect(log).to receive(:warn).with(/not compatible with US-ASCII.*using ASCII-8BIT/)
-      @yardoc.parse_arguments *%w( --one-file --charset us-ascii )
+      @yardoc.parse_arguments(*%w(--one-file --charset us-ascii))
       expect(Encoding.default_internal.name).to eq 'ASCII-8BIT'
       expect(Encoding.default_external.name).to eq 'ASCII-8BIT'
       Encoding.default_internal = ienc

data/spec/cli/yri_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
 class TestYRI < YARD::CLI::YRI
   public :optparse, :find_object, :cache_object
@@ -6,7 +6,7 @@ class TestYRI < YARD::CLI::YRI
   def print_object(*args) test_stub; super end
 end
 
-describe YARD::CLI::YRI do
+RSpec.describe YARD::CLI::YRI do
   before do
     @yri = TestYRI.new
     allow(Registry).to receive(:load)
@@ -20,7 +20,7 @@ describe YARD::CLI::YRI do
       expect(Registry).to receive(:load).with('bar.yardoc')
       expect(Registry).to receive(:at).ordered.with('Foo').and_return(nil)
       expect(Registry).to receive(:at).ordered.with('Foo').and_return('OBJ')
-      @yri.instance_variable_set("@cache", {'Foo' => 'bar.yardoc'})
+      @yri.instance_variable_set("@cache", 'Foo' => 'bar.yardoc')
       expect(@yri.find_object('Foo')).to eq 'OBJ'
     end
 
@@ -30,7 +30,7 @@ describe YARD::CLI::YRI do
       expect(Registry).to receive(:load).with('.yardoc')
       expect(Registry).to receive(:at).ordered.with('Foo').and_return(nil)
       expect(Registry).to receive(:at).ordered.with('Foo').and_return('OBJ')
-      @yri.instance_variable_set("@cache", {'Foo' => 'bar.yardoc'})
+      @yri.instance_variable_set("@cache", 'Foo' => 'bar.yardoc')
       expect(@yri.find_object('Foo')).to eq 'OBJ'
       expect(@yri.instance_variable_get("@search_paths")[0]).to eq '.yardoc'
     end
@@ -63,7 +63,7 @@ describe YARD::CLI::YRI do
       expect(File).to receive(:readlines).with(path).and_return(%w(line1 line2))
       @yri = YARD::CLI::YRI.new
       spaths = @yri.instance_variable_get("@search_paths")
-      expect(spaths[0,4]).to eq %w(foo bar line1 line2)
+      expect(spaths[0, 4]).to eq %w(foo bar line1 line2)
       YARD::CLI::YRI::DEFAULT_SEARCH_PATHS.replace([])
     end
   end
@@ -89,7 +89,7 @@ describe YARD::CLI::YRI do
     end
 
     it "ensures output is serialized" do
-      obj = YARD::CodeObjects::ClassObject.new(:root, 'Foo')
+      YARD::CodeObjects::ClassObject.new(:root, 'Foo')
       allow(@yri).to receive(:test_stub) do
         expect(@yri.instance_variable_get(:@serializer)).to receive(:serialize).once
       end

data/spec/code_objects/base_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::Base do
+RSpec.describe YARD::CodeObjects::Base do
   before { Registry.clear }
 
   it "does not allow empty object name" do
@@ -199,7 +200,7 @@ describe YARD::CodeObjects::Base do
   it "maintains all file associations when objects are defined multiple times in multiple files" do
     3.times do |i|
       allow(File).to receive(:read_binary).and_return("class X; end")
-      Parser::SourceParser.new.parse("file#{i+1}.rb")
+      Parser::SourceParser.new.parse("file#{i + 1}.rb")
     end
 
     expect(Registry.at(:X).file).to eq 'file1.rb'
@@ -247,7 +248,8 @@ describe YARD::CodeObjects::Base do
     it "accepts a string" do
       YARD.parse_string "module A; class B; end; class C; end; end"
       expect(Registry.at('A::B').relative_path(Registry.at('A::C'))).to eq(
-        Registry.at('A::B').relative_path('A::C'))
+        Registry.at('A::B').relative_path('A::C')
+      )
     end
 
     it "returns full class name when objects share a common class prefix" do
@@ -408,7 +410,7 @@ describe YARD::CodeObjects::Base do
       expect(foo_c.tag(:return).types).to eq ['String']
       expect(foo_c.file).to eq '(stdin)'
       expect(foo_c.line).to eq 4
-      expect(foo_c.source).to match /source_code_here/
+      expect(foo_c.source).to match(/source_code_here/)
       expect(foo_c.signature).to eq 'def foo(a, b, c)'
       expect(foo_c.parameters).to eq [['a', nil], ['b', nil], ['c', nil]]
     end

data/spec/code_objects/class_object_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::ClassObject do
+RSpec.describe YARD::CodeObjects::ClassObject do
   describe "#inheritance_tree" do
     before(:all) do
       Registry.clear
@@ -173,18 +174,18 @@ describe YARD::CodeObjects::ClassObject do
     end
 
     it "does not set a superclass on BasicObject class" do
-      o = ClassObject.new(:root, :Object)
-      expect(o.superclass).to eq P(:BasicObject)
+      o = ClassObject.new(:root, :BasicObject)
+      expect(o.superclass).to be nil
     end
 
     it "sets superclass of Object to BasicObject" do
-      o = ClassObject.new(:root, :BasicObject)
-      expect(o.superclass).to be nil
+      o = ClassObject.new(:root, :Object)
+      expect(o.superclass).to eq P(:BasicObject)
     end
 
     it "raises ArgumentError if superclass == self" do
       expect do
-        o = ClassObject.new(:root, :Object) do |o|
+        ClassObject.new(:root, :Object) do |o|
           o.superclass = :Object
         end
       end.to raise_error(ArgumentError)
@@ -196,7 +197,7 @@ describe YARD::CodeObjects::ClassObject do
       o2.superclass = :SystemCallError
       o3 = ClassObject.new(:root, :StandardError)
       o3.superclass = :Object
-      o4 = ClassObject.new(:root, :Object)
+      ClassObject.new(:root, :Object)
 
       o.superclass = :Object
       expect(o.is_exception?).to be false
@@ -216,10 +217,10 @@ describe YARD::CodeObjects::ClassObject do
 
     it "does not raise ArgumentError if superclass is proxy in different namespace" do
       expect do
-        o = ClassObject.new(:root, :X) do |o|
+        ClassObject.new(:root, :X) do |o|
           o.superclass = P('OTHER::X')
         end
       end.not_to raise_error
     end
   end
-end
+end

data/spec/code_objects/code_object_list_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::CodeObjectList do
+RSpec.describe YARD::CodeObjects::CodeObjectList do
   before { Registry.clear }
 
   describe "#push" do
@@ -32,4 +33,4 @@ describe YARD::CodeObjects::CodeObjectList do
     list << "Test"
     expect(list.size).to eq 2
   end
-end
+end