yard 0.9.5 → 0.9.6

data/spec/handlers/dsl_handler_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 require 'ostruct'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}DSLHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}DSLHandler" do
   before(:all) { parse_file :dsl_handler_001, __FILE__ }
 
   it "creates a readable attribute when @!attribute r is found" do
@@ -215,4 +216,4 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}DSLHandler" do
     expect(Registry.at('DirectiveMethods#Bar')).to be nil
     expect(Registry.at('DirectiveMethods').mixins).to include P(:Bar)
   end
-end
+end

data/spec/handlers/examples/method_handler_001.rb.txt

@@ -40,6 +40,8 @@ end
   def /(x = File.new('x', 'w'), y = 2) end
   def |; end; def =~ ()
   def -@; end;
+  def d_splat(reg, **opts); end
+  def d_unnamed_splat(**); end
 end
   def *(o) def +@; end
     def ~@

data/spec/handlers/exception_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ExceptionHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ExceptionHandler" do
   before(:all) { parse_file :exception_handler_001, __FILE__ }
 
   it "does not document an exception outside of a method" do
@@ -45,4 +46,4 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ExceptionHandl
   it "ignores empty raise call" do
     expect(P('Testing#mymethod12').tag(:raise)).to be nil
   end
-end
+end

data/spec/handlers/extend_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ExtendHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ExtendHandler" do
   before(:all) { parse_file :extend_handler_001, __FILE__ }
 
   it "includes modules at class scope" do

data/spec/handlers/legacy_base_spec.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
 include Parser::Ruby::Legacy
 
-describe YARD::Handlers::Ruby::Legacy::Base, "#tokval" do
-
+RSpec.describe YARD::Handlers::Ruby::Legacy::Base, "#tokval" do
   before { @handler = Handlers::Ruby::Legacy::Base.new(nil, nil) }
 
   def tokval(code, *types)
@@ -61,10 +61,10 @@ describe YARD::Handlers::Ruby::Legacy::Base, "#tokval" do
     expect(tokval('methodname?', :identifier)).to eq "methodname?"
   end
 
-  #it "obeys documentation expectations" do docspec end
+  # it "obeys documentation expectations" do docspec end
 end
 
-describe YARD::Handlers::Base, "#tokval_list" do
+RSpec.describe YARD::Handlers::Base, "#tokval_list" do
   before { @handler = Handlers::Ruby::Legacy::Base.new(nil, nil) }
 
   def tokval_list(code, *types)
@@ -125,4 +125,4 @@ describe YARD::Handlers::Base, "#tokval_list" do
     #        tokval parser, but this is now the expected behaviour.
     expect(tokval_list("opts = {}", :all)).to eq ["opts={}"]
   end
-end
+end

data/spec/handlers/method_condition_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MethodConditionHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MethodConditionHandler" do
   before(:all) { parse_file :method_condition_handler_001, __FILE__ }
 
   it "does not parse regular if blocks in methods" do
@@ -11,4 +12,4 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MethodConditio
     expect(Registry.at('#c')).not_to be nil
     expect(Registry.at('#d')).not_to be nil
   end
-end
+end

data/spec/handlers/method_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MethodHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MethodHandler" do
   before(:all) do
     log.enter_level(Logger::ERROR) do
       parse_file :method_handler_001, __FILE__
@@ -50,6 +51,11 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MethodHandler"
     expect(P('Foo#blockmeth').parameters).to eq [['x', nil], ['&block', nil]]
   end
 
+  it "handles double splats" do
+    expect(P('Foo#d_splat').parameters).to eq [["reg", nil], ["**opts", nil]]
+    expect(P('Foo#d_unnamed_splat').parameters).to eq []
+  end
+
   it "handles overloads" do
     meth = P('Foo#foo')
 

data/spec/handlers/mixin_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MixinHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MixinHandler" do
   before(:all) { parse_file :mixin_handler_001, __FILE__ }
 
   it "handles includes from classes or modules" do
@@ -17,7 +18,7 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MixinHandler"
   end
 
   it "sets the type of non-existing modules to :module" do
-    o = Registry.at(:X).instance_mixins.find {|o| o.name == :NOTEXIST }
+    o = Registry.at(:X).instance_mixins.find {|obj| obj.name == :NOTEXIST }
     expect(o.type).to eq :module
   end
 

data/spec/handlers/module_function_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}VisibilityHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}VisibilityHandler" do
   after { Registry.clear }
 
   def assert_module_function(namespace, name)

data/spec/handlers/module_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ModuleHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ModuleHandler" do
   before(:all) { parse_file :module_handler_001, __FILE__ }
 
   it "parses a module block" do
@@ -31,4 +32,4 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ModuleHandler"
   it "creates proper module when constant is in namespace" do
     expect(Registry.at('Q::FOO::A')).not_to be nil
   end
-end
+end

data/spec/handlers/private_class_method_handler_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 require File.dirname(__FILE__) + '/class_method_handler_shared_examples'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PrivateClassMethodHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PrivateClassMethodHandler" do
   before { Registry.clear }
 
   let(:visibility) { :private }

data/spec/handlers/private_constant_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PrivateConstantHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PrivateConstantHandler" do
   before(:all) { parse_file :private_constant_handler_001, __FILE__ }
 
   it "handles private_constant statement" do

data/spec/handlers/processor_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Handlers::Processor do
+RSpec.describe YARD::Handlers::Processor do
   before do
     @proc = Handlers::Processor.new(OpenStruct.new(:parser_type => :ruby))
   end

data/spec/handlers/public_class_method_handler_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 require File.dirname(__FILE__) + '/class_method_handler_shared_examples'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PublicClassMethodHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PublicClassMethodHandler" do
   before { Registry.clear }
 
   let(:visibility) { :public }

data/spec/handlers/ruby/base_spec.rb

@@ -1,7 +1,8 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::Handlers::Ruby::Base, '#valid_handler?' do
-  include YARD::Parser::Ruby; YARD::Parser::Ruby::AstNode
+RSpec.describe YARD::Handlers::Ruby::Base, '#valid_handler?' do
+  include YARD::Parser::Ruby
+  YARD::Parser::Ruby::AstNode # rubocop:disable Lint/Void
 
   before do
     allow(Handlers::Ruby::Base).to receive(:inherited)
@@ -28,7 +29,7 @@ describe YARD::Handlers::Ruby::Base, '#valid_handler?' do
       handles :list
     end
     allow(Handlers::Base).to receive(:subclasses).and_return [IgnoredHandler, NotIgnoredHandler]
-    expect(@processor.find_handlers(s())).to eq [NotIgnoredHandler]
+    expect(@processor.find_handlers(s)).to eq [NotIgnoredHandler]
   end
 
   it "handles string input (matches AstNode#source)" do
@@ -52,7 +53,7 @@ describe YARD::Handlers::Ruby::Base, '#valid_handler?' do
 
   it "handles regex input (matches AstNode#source)" do
     class RegexHandler < Handlers::Ruby::Base
-      handles %r{^if x ==}
+      handles(/^if x ==/)
     end
     allow(Handlers::Base).to receive(:subclasses).and_return [RegexHandler]
     ast = Parser::Ruby::RubyParser.parse("if x == 2 then true end").ast

data/spec/handlers/ruby/legacy/base_spec.rb

@@ -1,8 +1,8 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+# frozen_string_literal: true
 
 include Parser::Ruby::Legacy
 
-describe YARD::Handlers::Ruby::Legacy::Base, "#handles and inheritance" do
+RSpec.describe YARD::Handlers::Ruby::Legacy::Base, "#handles and inheritance" do
   before do
     allow(Handlers::Ruby::Legacy::Base).to receive(:inherited)
     if RUBY_VERSION > '1.8.7'
@@ -41,7 +41,7 @@ describe YARD::Handlers::Ruby::Legacy::Base, "#handles and inheritance" do
 
   it "handles regex input" do
     class TestRegexHandler < Handlers::Ruby::Legacy::Base
-      handles /^nothello$/
+      handles(/^nothello$/)
     end
 
     expect(TestRegexHandler.handles?(stmt("nothello"))).to be true
@@ -59,7 +59,7 @@ describe YARD::Handlers::Ruby::Legacy::Base, "#handles and inheritance" do
 
   it "parses a do/end or { } block with #parse_block" do
     class MyBlockHandler < Handlers::Ruby::Legacy::Base
-      handles /\AmyMethod\b/
+      handles(/\AmyMethod\b/)
       def process
         parse_block(:owner => "test")
       end

data/spec/handlers/spec_helper.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "..", "spec_helper")
+# frozen_string_literal: true
 require 'stringio'
 
 include Handlers
@@ -7,7 +7,7 @@ def undoc_error(code)
   expect { StubbedSourceParser.parse_string(code) }.to raise_error(Parser::UndocumentableError)
 end
 
-def with_parser(parser_type, &block)
+def with_parser(parser_type)
   tmp = StubbedSourceParser.parser_type
   StubbedSourceParser.parser_type = parser_type
   yield
@@ -16,7 +16,7 @@ end
 
 class StubbedProcessor < Processor
   def process(statements)
-    statements.each_with_index do |stmt, index|
+    statements.each_with_index do |stmt, _index|
       find_handlers(stmt).each do |handler|
         handler.new(self, stmt).process
       end

data/spec/handlers/visibility_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}VisibilityHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}VisibilityHandler" do
   before(:all) { parse_file :visibility_handler_001, __FILE__ }
 
   it "is able to set visibility to public" do
@@ -36,7 +37,7 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}VisibilityHand
     expect(Registry.at('Testing::Bar').visibility).to eq :public
     expect(Registry.at('Testing::Baz').visibility).to eq :public
   end
-  
+
   it "can decorate a method definition" do
     expect(Registry.at('Testing#decpriv').visibility).to eq :private
   end unless LEGACY_PARSER

data/spec/handlers/yield_handler_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}YieldHandler" do
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}YieldHandler" do
   before(:all) { parse_file :yield_handler_001, __FILE__ }
 
   it "only parses yield blocks in methods" do
@@ -48,4 +49,4 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}YieldHandler"
     expect(P('Testing#mymethod9').tag(:yieldparam).types).to be nil
     expect(P('Testing#mymethod9').tag(:yieldparam).text).to eq "the result of the method from the superclass"
   end
-end
+end

data/spec/i18n/locale_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::I18n::Locale do
+RSpec.describe YARD::I18n::Locale do
   def locale(name)
     YARD::I18n::Locale.new(name)
   end
@@ -57,7 +57,7 @@ eop
       expect(GetText::POParser).to receive(:new).and_return(parser)
       expect(parser).to receive(:parse_file) do |file, hash|
         expect(file).to eq 'foo/fr.po'
-        parser.parse(data, hash)
+        parser.parse(String.new(data), hash)
       end
       expect(@locale.load('foo')).to be true
       expect(@locale.translate('Hello')).to eq "Bonjour"

data/spec/i18n/message_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::I18n::Message do
+RSpec.describe YARD::I18n::Message do
   def message(id)
     YARD::I18n::Message.new(id)
   end

data/spec/i18n/messages_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::I18n::Messages do
+RSpec.describe YARD::I18n::Messages do
   def message(id)
     YARD::I18n::Message.new(id)
   end
@@ -21,7 +21,7 @@ describe YARD::I18n::Messages do
       @messages.each do |message|
         enumerated_messages << message
       end
-      enumerated_messages = enumerated_messages.sort_by {|m| m.id }
+      enumerated_messages = enumerated_messages.sort_by(&:id)
       expect(enumerated_messages).to eq [message("Hello World!"), message("Title")]
     end
 

data/spec/i18n/pot_generator_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::I18n::PotGenerator do
+RSpec.describe YARD::I18n::PotGenerator do
   def create_messages(messages)
     yard_messages = YARD::I18n::Messages.new
     add_messages(yard_messages, messages)
@@ -56,11 +56,11 @@ eoh
       messages = {
         "tag|see|Parser::SourceParser.parse" => {
           :locations => [["yard.rb", 14]],
-          :comments => ["@see"],
+          :comments => ["@see"]
         },
         "Parses a path or set of paths" => {
           :locations => [["yard.rb", 12], ["yard/parser/source_parser.rb", 83]],
-          :comments => ["YARD.parse", "YARD::Parser::SourceParser.parse"],
+          :comments => ["YARD.parse", "YARD::Parser::SourceParser.parse"]
         }
       }
       add_messages(@generator.messages, messages)
@@ -85,7 +85,7 @@ eoh
 
   describe "Escape" do
     def generate_message_pot(message_id)
-      pot = ""
+      pot = String.new("")
       message = YARD::I18n::Message.new(message_id)
       @generator.send(:generate_message, pot, message)
       pot
@@ -128,12 +128,12 @@ eop
         o.docstring = "An alias to {Parser::SourceParser}'s parsing method"
       end
       @generator.parse_objects([object])
-      expect(@generator.messages).to eq create_messages({
+      expect(@generator.messages).to eq create_messages(
         "An alias to {Parser::SourceParser}'s parsing method" => {
           :locations => [],
-          :comments => ["YARD.parse"],
+          :comments => ["YARD.parse"]
         }
-      })
+      )
     end
 
     it "extracts at location" do
@@ -142,12 +142,12 @@ eop
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      expect(@generator.messages).to eq create_messages({
+      expect(@generator.messages).to eq create_messages(
         "An alias to {Parser::SourceParser}'s parsing method" => {
           :locations => [["yard.rb", 13]],
-          :comments => ["YARD.parse"],
+          :comments => ["YARD.parse"]
         }
-      })
+      )
     end
 
     it "extracts at tag name" do
@@ -156,12 +156,12 @@ eop
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      expect(@generator.messages).to eq create_messages({
+      expect(@generator.messages).to eq create_messages(
         "tag|see|Parser::SourceParser.parse" => {
           :locations => [["yard.rb", 12]],
-          :comments => ["@see"],
-        },
-      })
+          :comments => ["@see"]
+        }
+      )
     end
 
     it "extracts at tag text" do
@@ -173,16 +173,16 @@ eod
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      expect(@generator.messages).to eq create_messages({
+      expect(@generator.messages).to eq create_messages(
         "tag|example|Parse a glob of files" => {
           :locations => [["yard.rb", 12]],
-          :comments => ["@example"],
+          :comments => ["@example"]
         },
         "YARD.parse('lib/**/*.rb')" => {
           :locations => [["yard.rb", 12]],
-          :comments => ["@example Parse a glob of files"],
+          :comments => ["@example Parse a glob of files"]
         }
-      })
+      )
     end
 
     it "extracts at tag types" do
@@ -194,16 +194,16 @@ eod
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      expect(@generator.messages).to eq create_messages({
+      expect(@generator.messages).to eq create_messages(
         "tag|param|paths" => {
           :locations => [["yard.rb", 12]],
-          :comments => ["@param [String, Array<String>]"],
+          :comments => ["@param [String, Array<String>]"]
         },
         "a path, glob, or list of paths to\nparse" => {
           :locations => [["yard.rb", 12]],
-          :comments => ["@param [String, Array<String>] paths"],
+          :comments => ["@param [String, Array<String>] paths"]
         }
-      })
+      )
     end
 
     it "extracts at overload tag recursively" do
@@ -216,7 +216,7 @@ eod
       end
 
       @generator.parse_objects([object])
-      expect(@generator.messages).to eq create_messages({
+      expect(@generator.messages).to eq create_messages(
         "tag|overload|foo" => {
           :locations => [],
           :comments => ["@overload"]
@@ -232,8 +232,8 @@ eod
         "integer parameter" => {
           :locations => [],
           :comments => ["@param [Integer] i"]
-        },
-      })
+        }
+      )
     end
   end
 
@@ -249,16 +249,16 @@ eor
       allow(File).to receive(:read).with(path).and_return(text)
       file = YARD::CodeObjects::ExtraFileObject.new(path)
       @generator.parse_files([file])
-      expect(@generator.messages).to eq create_messages({
+      expect(@generator.messages).to eq create_messages(
         "Getting Started Guide" => {
           :locations => [[path, 1]],
-          :comments => ["title"],
+          :comments => ["title"]
         },
         "# Getting Started with YARD" => {
           :locations => [[path, 3]],
-          :comments => [],
+          :comments => []
         }
-      })
+      )
     end
 
     it "extracts at paragraphs" do
@@ -280,16 +280,16 @@ eot
       allow(File).to receive(:read).with(path).and_return(text)
       file = YARD::CodeObjects::ExtraFileObject.new(path)
       @generator.parse_files([file])
-      expect(@generator.messages).to eq create_messages({
+      expect(@generator.messages).to eq create_messages(
         paragraph1 => {
           :locations => [[path, 1]],
-          :comments => [],
+          :comments => []
         },
         paragraph2 => {
           :locations => [[path, 4]],
-          :comments => [],
+          :comments => []
         }
-      })
+      )
     end
   end
 end