yard 0.9.5 → 0.9.6

data/spec/code_objects/constants_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects do
+RSpec.describe YARD::CodeObjects do
   describe :CONSTANTMATCH do
     it "matches a constant" do
       expect("Constant"[CodeObjects::CONSTANTMATCH]).to eq "Constant"
@@ -50,19 +51,29 @@ describe YARD::CodeObjects do
 
   describe :BUILTIN_EXCEPTIONS do
     it "includes all base exceptions" do
+      bad_names = []
       YARD::CodeObjects::BUILTIN_EXCEPTIONS.each do |name|
-        expect(eval(name)).to be <= Exception
+        begin
+          bad_names << name unless eval(name) <= Exception
+        rescue NameError
+          nil # noop
+        end
       end
+      expect(bad_names).to be_empty
     end
   end
 
   describe :BUILTIN_CLASSES do
     it "includes all base classes" do
+      bad_names = []
       YARD::CodeObjects::BUILTIN_CLASSES.each do |name|
-        next if name == "MatchingData" && !defined?(::MatchingData)
-        next if name == "Continuation"
-        expect(eval(name)).to be_instance_of(Class)
+        begin
+          bad_names << name unless eval(name).is_a?(Class)
+        rescue NameError
+          nil # noop
+        end
       end
+      expect(bad_names).to be_empty
     end
 
     it "includes all exceptions" do
@@ -77,7 +88,7 @@ describe YARD::CodeObjects do
       a = YARD::CodeObjects::BUILTIN_ALL
       b = YARD::CodeObjects::BUILTIN_CLASSES
       c = YARD::CodeObjects::BUILTIN_MODULES
-      expect(a).to eq b+c
+      expect(a).to eq b + c
     end
   end
 

data/spec/code_objects/extra_file_object_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::ExtraFileObject do
+RSpec.describe YARD::CodeObjects::ExtraFileObject do
   describe "#initialize" do
     it "attempts to read contents from filesystem if contents=nil" do
       expect(File).to receive(:read).with('file.txt').and_return('')
@@ -80,7 +81,7 @@ describe YARD::CodeObjects::ExtraFileObject do
 
     it "forces encoding to @encoding attribute if present" do
       expect(log).not_to receive(:warn)
-      data = "# @encoding sjis\nFOO"
+      data = String.new("# @encoding sjis\nFOO")
       data.force_encoding('binary')
       file = ExtraFileObject.new('file.txt', data)
       expect(['Shift_JIS', 'Windows-31J']).to include(file.contents.encoding.to_s)
@@ -88,7 +89,7 @@ describe YARD::CodeObjects::ExtraFileObject do
 
     it "warns if @encoding is invalid" do
       expect(log).to receive(:warn).with("Invalid encoding `INVALID' in file.txt")
-      data = "# @encoding INVALID\nFOO"
+      data = String.new("# @encoding INVALID\nFOO")
       encoding = data.encoding
       file = ExtraFileObject.new('file.txt', data)
       expect(file.contents.encoding).to eq encoding
@@ -96,12 +97,12 @@ describe YARD::CodeObjects::ExtraFileObject do
 
     it "ignores encoding in 1.8.x (or encoding-unaware platforms)" do
       expect(log).not_to receive(:warn)
-      file = ExtraFileObject.new('file.txt', "# @encoding INVALID\nFOO")
+      ExtraFileObject.new('file.txt', "# @encoding INVALID\nFOO")
     end if YARD.ruby18?
 
     it "attempts to re-parse data as 8-bit ascii if parsing fails" do
       expect(log).not_to receive(:warn)
-      str, out = *(["\xB0"] * 2)
+      str, out = *([String.new("\xB0")] * 2)
       if str.respond_to?(:force_encoding)
         str.force_encoding('utf-8')
         out.force_encoding('binary')

data/spec/code_objects/macro_object_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::MacroObject do
+RSpec.describe YARD::CodeObjects::MacroObject do
   before do
     Registry.clear
   end
@@ -75,7 +76,7 @@ describe YARD::CodeObjects::MacroObject do
     end
 
     it "appends docstring to existing macro" do
-      macro = MacroObject.create('name', '$3$2$1')
+      MacroObject.create('name', '$3$2$1')
       result = MacroObject.apply("@!macro name\nfoobar", args)
       expect(result).to eq "cba\nfoobar"
     end
@@ -95,7 +96,8 @@ describe YARD::CodeObjects::MacroObject do
 
     it "keeps other tags" do
       expect(apply("@!macro\n  foo$1$2$3\n@param name foo\nfoo")).to eq(
-        "fooabc\nfoo\n@param name\n  foo")
+        "fooabc\nfoo\n@param name\n  foo"
+      )
     end
   end
 

data/spec/code_objects/method_object_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::MethodObject do
+RSpec.describe YARD::CodeObjects::MethodObject do
   before do
     Registry.clear
     @yard = ModuleObject.new(:root, :YARD)
@@ -35,11 +36,11 @@ describe YARD::CodeObjects::MethodObject do
   end
 
   it "exists in the registry after successful creation" do
-    obj = MethodObject.new(@yard, :something, :class)
+    MethodObject.new(@yard, :something, :class)
     expect(Registry.at("YARD.something")).not_to be nil
     expect(Registry.at("YARD#something")).to be nil
     expect(Registry.at("YARD::something")).to be nil
-    obj = MethodObject.new(@yard, :somethingelse)
+    MethodObject.new(@yard, :somethingelse)
     expect(Registry.at("YARD#somethingelse")).not_to be nil
   end
 
@@ -82,7 +83,7 @@ describe YARD::CodeObjects::MethodObject do
 
     it "never shows a prefix for a class method" do
       obj = MethodObject.new(nil, :something, :class)
-      expect(obj.name).to eq :"something"
+      expect(obj.name).to eq :something
       expect(obj.name(true)).to eq "something"
     end
   end
@@ -104,7 +105,7 @@ describe YARD::CodeObjects::MethodObject do
     end
 
     it "returns nil if namespace is proxy" do
-      obj = MethodObject.new(P(:ProxyClass), :foo)
+      MethodObject.new(P(:ProxyClass), :foo)
       expect(MethodObject.new(@yard, :foo).attr_info).to eq nil
     end
 

data/spec/code_objects/module_object_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::ModuleObject do
+RSpec.describe YARD::CodeObjects::ModuleObject do
   describe "#meths" do
     before do
       Registry.clear
@@ -138,4 +139,4 @@ describe YARD::CodeObjects::ModuleObject do
       expect(recvmod.inheritance_tree(true)).to eq [recvmod, mod]
     end
   end
-end
+end

data/spec/code_objects/namespace_object_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::NamespaceObject do
+RSpec.describe YARD::CodeObjects::NamespaceObject do
   before { Registry.clear }
 
   describe "#child" do
@@ -59,9 +60,9 @@ describe YARD::CodeObjects::NamespaceObject do
       c = NamespaceObject.new(nil, :YARD)
       c.class_mixins << b
 
-      [bmeth, bmeth2].each { |o| expect(o.scope).to eq :instance }
+      [bmeth, bmeth2].each {|o| expect(o.scope).to eq :instance }
       meths = c.included_meths(:scope => :class)
-      meths.each { |o| expect(o.scope).to eq :class }
+      meths.each {|o| expect(o.scope).to eq :class }
     end
 
     it "does not list methods overridden by another included module" do
@@ -88,9 +89,9 @@ describe YARD::CodeObjects::NamespaceObject do
   describe "#class_attributes" do
     it "lists class attributes" do
       a = NamespaceObject.new(nil, :Mod)
-      a.attributes[:instance][:a] = { :read => MethodObject.new(a, :a), :write => nil }
-      a.attributes[:instance][:b] = { :read => MethodObject.new(a, :b), :write => nil }
-      a.attributes[:class][:a] = { :read => MethodObject.new(a, :a, :class), :write => nil }
+      a.attributes[:instance][:a] = {:read => MethodObject.new(a, :a), :write => nil}
+      a.attributes[:instance][:b] = {:read => MethodObject.new(a, :b), :write => nil}
+      a.attributes[:class][:a] = {:read => MethodObject.new(a, :a, :class), :write => nil}
       expect(a.class_attributes.keys).to include(:a)
       expect(a.class_attributes.keys).not_to include(:b)
     end
@@ -99,9 +100,9 @@ describe YARD::CodeObjects::NamespaceObject do
   describe "#instance_attributes" do
     it "lists instance attributes" do
       a = NamespaceObject.new(nil, :Mod)
-      a.attributes[:instance][:a] = { :read => MethodObject.new(a, :a), :write => nil }
-      a.attributes[:instance][:b] = { :read => MethodObject.new(a, :b), :write => nil }
-      a.attributes[:class][:a] = { :read => MethodObject.new(a, :a, :class), :write => nil }
+      a.attributes[:instance][:a] = {:read => MethodObject.new(a, :a), :write => nil}
+      a.attributes[:instance][:b] = {:read => MethodObject.new(a, :b), :write => nil}
+      a.attributes[:class][:a] = {:read => MethodObject.new(a, :a, :class), :write => nil}
       expect(a.instance_attributes.keys).to include(:a)
       expect(a.instance_attributes.keys).to include(:b)
     end

data/spec/code_objects/proxy_spec.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::CodeObjects::Proxy do
+RSpec.describe YARD::CodeObjects::Proxy do
   before { Registry.clear }
 
   it "returns the object if it's in the Registry" do
-    pathobj = ModuleObject.new(:root, :YARD)
+    ModuleObject.new(:root, :YARD)
     proxyobj = P(:root, :YARD)
     expect(proxyobj.type).to eq :module
     expect(Proxy === proxyobj).to be false
@@ -12,7 +13,7 @@ describe YARD::CodeObjects::Proxy do
 
   it "handles complex string namespaces" do
     ModuleObject.new(:root, :A)
-    pathobj = ModuleObject.new(P(nil, :A), :B)
+    ModuleObject.new(P(nil, :A), :B)
     expect(P(:root, "A::B")).to be_instance_of(ModuleObject)
   end
 
@@ -33,8 +34,8 @@ describe YARD::CodeObjects::Proxy do
   end
 
   it "responds to respond_to?" do
-    obj = ClassObject.new(:root, :Object)
-    yardobj = ModuleObject.new(:root, :YARD)
+    ClassObject.new(:root, :Object)
+    ModuleObject.new(:root, :YARD)
     expect(P(:YARD).respond_to?(:children)).to be true
     expect(P(:NOTYARD).respond_to?(:children)).to be false
 
@@ -51,7 +52,7 @@ describe YARD::CodeObjects::Proxy do
   end
 
   it "pretends it's the object's type if it can resolve" do
-    pathobj = ModuleObject.new(:root, :YARD)
+    ModuleObject.new(:root, :YARD)
     proxyobj = P(:root, :YARD)
     expect(proxyobj).to be_instance_of(ModuleObject)
   end
@@ -117,14 +118,14 @@ describe YARD::CodeObjects::Proxy do
   it "ensures that the correct object was resolved" do
     foo = ModuleObject.new(:root, :Foo)
     foobar = ModuleObject.new(foo, :Bar)
-    foobaz = ClassObject.new(foo, :Baz)
+    ClassObject.new(foo, :Baz)
 
     # Remember, we're looking for Qux::Bar, not just 'Bar'
     proxy = Proxy.new(foobar, 'Foo::Qux::Bar')
     expect(proxy.type).to eq :proxy
 
     qux = ModuleObject.new(foo, :Qux)
-    quxbar = ModuleObject.new(qux, :Bar)
+    ModuleObject.new(qux, :Bar)
 
     # Now it should resolve
     expect(proxy.type).to eq :module

data/spec/code_objects/spec_helper.rb

@@ -1,3 +1,3 @@
-require File.join(File.dirname(__FILE__), "..", "spec_helper")
+# frozen_string_literal: true
 
-include CodeObjects
+include CodeObjects

data/spec/config_spec.rb

@@ -1,8 +1,7 @@
-require File.join(File.dirname(__FILE__), "spec_helper")
-
+# frozen_string_literal: true
 require 'yaml'
 
-describe YARD::Config do
+RSpec.describe YARD::Config do
   describe ".load" do
     before do
       expect(File).to receive(:file?).twice.with(CLI::Yardoc::DEFAULT_YARDOPTS_FILE).and_return(false)
@@ -18,7 +17,7 @@ describe YARD::Config do
     it "overwrites options with data in ~/.yard/config" do
       expect(File).to receive(:file?).with(YARD::Config::CONFIG_FILE).and_return(true)
       expect(File).to receive(:file?).with(YARD::Config::IGNORED_PLUGINS).and_return(false)
-      expect(YAML).to receive(:load_file).with(YARD::Config::CONFIG_FILE).and_return({'test' => true})
+      expect(YAML).to receive(:load_file).with(YARD::Config::CONFIG_FILE).and_return('test' => true)
       YARD::Config.load
       expect(YARD::Config.options[:test]).to be true
     end
@@ -81,7 +80,7 @@ describe YARD::Config do
 
     it "logs error if plugin is not found" do
       expect(YARD::Config).to receive(:require).with('yard-foo').and_raise(LoadError)
-      expect(log).to receive(:warn).with(/Error loading plugin 'yard-foo'/).once
+      expect(log).to receive(:error).with(/Error loading plugin 'yard-foo'/).once
       expect(YARD::Config.load_plugin('yard-foo')).to be false
     end
 
@@ -142,15 +141,13 @@ describe YARD::Config do
         'yard_plugin' => double('yard_plugin'),
         'yard-plugin' => double('yard-plugin'),
         'my-yard-plugin' => double('yard-plugin'),
-        'rspec' => double('rspec'),
+        'rspec' => double('rspec')
       }
       plugins.each do |k, v|
         expect(v).to receive(:name).at_least(1).times.and_return(k)
       end
 
-      source_mock = double(:source_index)
-      expect(source_mock).to receive(:find_name).with('').and_return(plugins.values)
-      expect(Gem).to receive(:source_index).and_return(source_mock)
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with('').and_return(plugins.values)
       expect(YARD::Config).to receive(:load_plugin).with('yard_plugin').and_return(false)
       expect(YARD::Config).to receive(:load_plugin).with('yard-plugin').and_return(true)
       expect(YARD::Config.load_plugins).to be true
@@ -165,12 +162,10 @@ describe YARD::Config do
         expect(v).to receive(:name).at_least(1).times.and_return(k)
       end
 
-      source_mock = double(:source_index)
-      expect(source_mock).to receive(:find_name).with('').and_return(plugins.values)
-      expect(Gem).to receive(:source_index).and_return(source_mock)
+      expect(YARD::GemIndex).to receive(:find_all_by_name).with('').and_return(plugins.values)
       expect(YARD::Config).to receive(:load_plugin).with('yard-plugin').and_raise(Gem::LoadError)
-      expect(log).to receive(:warn).with(/Error loading plugin 'yard-plugin'/)
+      expect(log).to receive(:error).with(/Error loading plugin 'yard-plugin'/)
       expect(YARD::Config.load_plugins).to be false
     end
   end
-end
+end

data/spec/core_ext/array_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe Array do
+RSpec.describe Array do
   describe "#place" do
     it "creates an Insertion object" do
       expect([].place('x')).to be_kind_of(Insertion)
@@ -11,4 +11,3 @@ describe Array do
     end
   end
 end
-

data/spec/core_ext/file_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe File do
+RSpec.describe File do
   describe ".relative_path" do
     it "returns the relative path between two files" do
       expect(File.relative_path('a/b/c/d.html', 'a/b/d/q.html')).to eq '../d/q.html'
@@ -65,4 +65,4 @@ describe File do
       File.open!('/path/to/file', 'w')
     end
   end
-end
+end

data/spec/core_ext/hash_spec.rb

@@ -1,14 +1,14 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe Hash do
+RSpec.describe Hash do
   describe ".[]" do
     it "accepts an Array argument (Ruby 1.8.6 and older)" do
       list = [['foo', 'bar'], ['foo2', 'bar2']]
-      expect(Hash[list]).to eq({'foo' => 'bar', 'foo2' => 'bar2'})
+      expect(Hash[list]).to eq('foo' => 'bar', 'foo2' => 'bar2')
     end
 
     it "accepts an array as a key" do
-      expect(Hash[['a', 'b'], 1]).to eq({['a', 'b'] => 1})
+      expect(Hash[['a', 'b'], 1]).to eq(['a', 'b'] => 1)
     end
   end
-end
+end

data/spec/core_ext/insertion_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe Insertion do
+RSpec.describe Insertion do
   describe "#before" do
     it "places an object before another" do
       expect([1, 2].place(3).before(2)).to eq [1, 3, 2]

data/spec/core_ext/module_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe Module do
+RSpec.describe Module do
   describe "#class_name" do
     it "returns just the name of the class/module" do
       expect(YARD::CodeObjects::Base.class_name).to eq "Base"
@@ -12,4 +12,4 @@ describe Module do
       expect(YARD::CodeObjects::Base.namespace_name).to eq "YARD::CodeObjects"
     end
   end
-end
+end

data/spec/core_ext/string_spec.rb

@@ -1,9 +1,9 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-#described_in_docs String, '#camelcase'
-#described_in_docs String, '#underscore'
+# described_in_docs String, '#camelcase'
+# described_in_docs String, '#underscore'
 
-describe String do
+RSpec.describe String do
   describe "#shell_split" do
     it "splits simple non-quoted text" do
       expect("a b c".shell_split).to eq %w(a b c)
@@ -39,4 +39,4 @@ describe String do
       expect(text.shell_split).to eq ["hello", "\"world", "1 2\" 3", "a", "b \"\\'", "c"]
     end
   end
-end
+end