yard 0.9.5 → 0.9.6

data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb

@@ -1,11 +1,11 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::Templates::Helpers::HtmlSyntaxHighlightHelper do
+RSpec.describe YARD::Templates::Helpers::HtmlSyntaxHighlightHelper do
   include YARD::Templates::Helpers::HtmlHelper
   include YARD::Templates::Helpers::HtmlSyntaxHighlightHelper
 
   describe "#html_syntax_highlight" do
-    let(:object) { Registry.root }
+    let(:object) { CodeObjects::NamespaceObject.new(:root, :YARD) }
 
     before do
       Registry.root.source_type = :ruby
@@ -42,13 +42,24 @@ describe YARD::Templates::Helpers::HtmlSyntaxHighlightHelper do
     end if HAVE_RIPPER
 
     it "returns escaped unhighlighted source if a syntax error is found (ripper)" do
-      expect(self).to receive(:options).and_return(Options.new.update(:highlight => true))
+      allow(self).to receive(:options).and_return(Options.new.update(:highlight => true))
       expect(html_syntax_highlight("def &x; ... end")).to eq "def &x; ... end"
     end if HAVE_RIPPER
 
     it "returns escaped unhighlighted source if a syntax error is found (ripper)" do
-      expect(self).to receive(:options).and_return(Options.new.update(:highlight => true))
+      allow(self).to receive(:options).and_return(Options.new.update(:highlight => true))
       expect(html_syntax_highlight("$ git clone http://url")).to eq "$ git clone http://url"
     end if HAVE_RIPPER
+
+    it "links constants/methods" do
+      other = CodeObjects::NamespaceObject.new(:root, :Other)
+      allow(self).to receive(:options).and_return(Options.new.update(:highlight => true))
+      allow(self).to receive(:run_verifier).with([other]).and_return([other])
+      allow(self).to receive(:link_object).with(other, "Other").and_return("LINK!")
+      result = html_syntax_highlight("def x; Other end")
+      html_equals_string(result, "<span class='kw'>def</span>
+        <span class='id identifier rubyid_x'>x</span><span class='semicolon'>;</span>
+        <span class='const'>LINK!</span> <span class='kw'>end</span>")
+    end if HAVE_RIPPER
   end
-end
+end

data/spec/templates/helpers/markup/rdoc_markup_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + "/../../spec_helper"
+# frozen_string_literal: true
 
-describe YARD::Templates::Helpers::Markup::RDocMarkup do
+RSpec.describe YARD::Templates::Helpers::Markup::RDocMarkup do
   describe "loading mechanism" do
     before { @good_libs = [] }
 
@@ -10,18 +10,16 @@ describe YARD::Templates::Helpers::Markup::RDocMarkup do
     end
 
     def load_markup
+      require 'rdoc/markup'
+      require 'rdoc/markup/to_html'
+      return :RDoc2
+    rescue LoadError
       begin
-        require 'rdoc/markup'
-        require 'rdoc/markup/to_html'
-        return :RDoc2
+        require 'rdoc/markup/simple_markup'
+        require 'rdoc/markup/simple_markup/to_html'
+        return :RDoc1
       rescue LoadError
-        begin
-          require 'rdoc/markup/simple_markup'
-          require 'rdoc/markup/simple_markup/to_html'
-          return :RDoc1
-        rescue LoadError
-          raise NameError, "could not load RDocMarkup (rdoc is not installed)"
-        end
+        raise NameError, "could not load RDocMarkup (rdoc is not installed)"
       end
     end
 
@@ -83,4 +81,4 @@ describe YARD::Templates::Helpers::Markup::RDocMarkup do
       expect(fix_typewriter("<p>+foo+</p>")).to eq "<p><tt>foo</tt></p>"
     end
   end
-end
+end

data/spec/templates/helpers/markup_helper_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+# frozen_string_literal: true
 
 module YARD::Templates::Helpers::MarkupHelper
   public :load_markup_provider, :markup_class, :markup_provider
@@ -12,7 +12,7 @@ class GeneratorMock
   end
 end
 
-describe YARD::Templates::Helpers::MarkupHelper do
+RSpec.describe YARD::Templates::Helpers::MarkupHelper do
   before do
     YARD::Templates::Helpers::MarkupHelper.clear_markup_cache
   end

data/spec/templates/helpers/method_helper_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + "/../spec_helper"
+# frozen_string_literal: true
 
-describe YARD::Templates::Helpers::MethodHelper do
+RSpec.describe YARD::Templates::Helpers::MethodHelper do
   include YARD::Templates::Helpers::BaseHelper
   include YARD::Templates::Helpers::MethodHelper
 
@@ -79,4 +79,4 @@ describe YARD::Templates::Helpers::MethodHelper do
       expect(format_block(Registry.at('#foo'))).to eq "{|a, b, c| ... }"
     end
   end
-end
+end

data/spec/templates/helpers/module_helper_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + "/../spec_helper"
+# frozen_string_literal: true
 
-describe YARD::Templates::Helpers::ModuleHelper do
+RSpec.describe YARD::Templates::Helpers::ModuleHelper do
   include YARD::Templates::Helpers::BaseHelper
   include YARD::Templates::Helpers::ModuleHelper
 

data/spec/templates/helpers/shared_signature_examples.rb

@@ -1,4 +1,5 @@
-shared_examples_for "signature" do
+# frozen_string_literal: true
+RSpec.shared_examples_for "signature" do
   before do
     YARD::Registry.clear
     @options = Templates::TemplateOptions.new

data/spec/templates/helpers/text_helper_spec.rb

@@ -1,7 +1,7 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+# frozen_string_literal: true
 require File.dirname(__FILE__) + "/shared_signature_examples"
 
-describe YARD::Templates::Helpers::TextHelper do
+RSpec.describe YARD::Templates::Helpers::TextHelper do
   include YARD::Templates::Helpers::BaseHelper
   include YARD::Templates::Helpers::TextHelper
   include YARD::Templates::Helpers::MethodHelper
@@ -39,14 +39,15 @@ describe YARD::Templates::Helpers::TextHelper do
 
     it "truncates text that is longer than allowed width" do
       text = "(Defined in: /home/user/.rip/.packages/some_gem-2460672e333ac07b9190ade88ec9a91c/long/path.rb)"
-      expect(align_right(text)).to eq ' ' + text[0,68] + '...'
+      expect(align_right(text)).to eq ' ' + text[0, 68] + '...'
     end
   end
 
   describe "#h" do
     let(:object) do
-      o = YARD::CodeObjects::MethodObject.new(:root, :foo, :instance)
-      o.tap {|o| o.docstring = "test" }
+      YARD::CodeObjects::MethodObject.new(:root, :foo, :instance).tap do |o|
+        o.docstring = "test"
+      end
     end
 
     it "resolves links" do
@@ -61,4 +62,4 @@ describe YARD::Templates::Helpers::TextHelper do
       expect(h("{A}").strip).to eq "A"
     end
   end
-end
+end

data/spec/templates/method_spec.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
 # $COPY = :method001
 # $COPYT = :html
 
-describe YARD::Templates::Engine.template(:default, :method) do
+RSpec.describe YARD::Templates::Engine.template(:default, :method) do
   before { Registry.clear }
 
   shared_examples_for "all formats" do
@@ -99,4 +100,19 @@ describe YARD::Templates::Engine.template(:default, :method) do
 
     it_should_behave_like "all formats"
   end
-end
+
+  describe "method with keyword arguments spalt" do
+    before do
+      @template = :method006
+      YARD.parse_string <<-'eof'
+        # @param [String] x the x argument
+        # @param [Boolean] y the y argument
+        # @param [kword1] keyword 1
+        # @param [kword2] keyword 2
+        def m(x, y, *args, kword1: 123, kword2:, **) end
+      eof
+    end
+
+    it_should_behave_like "all formats"
+  end
+end

data/spec/templates/module_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Templates::Engine.template(:default, :module) do
+RSpec.describe YARD::Templates::Engine.template(:default, :module) do
   before do
     Registry.clear
     YARD.parse_string <<-'eof'
@@ -124,8 +125,8 @@ describe YARD::Templates::Engine.template(:default, :module) do
       end
     eof
 
-    html_equals(Registry.at('A').format(html_options(
-      :verifier => Verifier.new('!@private'))), :module003)
+    html_equals(Registry.at('A').
+      format(html_options(:verifier => Verifier.new('!@private'))), :module003)
   end
 
   it "embeds mixins with :embed_mixins = ['Foo', 'Bar', 'Baz::A*']" do

data/spec/templates/onefile_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
 class StringSerializer < YARD::Serializers::Base
@@ -13,12 +14,14 @@ class StringSerializer < YARD::Serializers::Base
   end
 end
 
-describe YARD::Templates::Engine.template(:default, :onefile) do
+RSpec.describe YARD::Templates::Engine.template(:default, :onefile) do
   before do
     Registry.clear
     if defined?(::Encoding)
-      @eenc, Encoding.default_external = Encoding.default_external, 'ascii-8bit'
-      @ienc, Encoding.default_internal = Encoding.default_internal, 'ascii-8bit'
+      @eenc = Encoding.default_external
+      Encoding.default_external = 'ascii-8bit'
+      @ienc = Encoding.default_internal
+      Encoding.default_internal = 'ascii-8bit'
     end
   end
 
@@ -31,7 +34,7 @@ describe YARD::Templates::Engine.template(:default, :onefile) do
 
   def render
     @files = []
-    @output = ''
+    @output = String.new("")
     YARD.parse_string <<-eof
       class A
         # Foo method
@@ -48,8 +51,7 @@ describe YARD::Templates::Engine.template(:default, :onefile) do
     Templates::Engine.generate Registry.all(:class),
       :serializer => StringSerializer.new(@files, @output),
       :onefile => true, :format => :html, :readme => readme, :files => [readme,
-        CodeObjects::ExtraFileObject.new('LICENSE', 'This is a license!')
-      ]
+        CodeObjects::ExtraFileObject.new('LICENSE', 'This is a license!')]
   end
 
   it "renders html" do

data/spec/templates/section_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Templates::Section do
+RSpec.describe YARD::Templates::Section do
   include YARD::Templates
 
   describe "#initialize" do
@@ -140,4 +141,4 @@ describe YARD::Templates::Section do
       expect(s.to_a).to eq [:foo, [:bar, [:baz, [:qux]]]]
     end
   end
-end
+end

data/spec/templates/spec_helper.rb

@@ -1,8 +1,10 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
 include YARD::Templates
 
 def only_copy?(result, example, type)
+  return false unless defined?($COPY)
+
   if $COPY == :all || $COPY == example
     puts(result) unless $COPYT && $COPYT != type
   end
@@ -24,6 +26,8 @@ def html_equals(result, expected_example)
 end
 
 def html_equals_string(result, expected)
+  result = String.new(result)
+  expected = String.new(expected)
   [expected, result].each do |value|
     value.gsub!(/(>)\s+|\s+(<)/, '\1\2')
     value.gsub!(/&#39;/, "'")
@@ -70,4 +74,3 @@ def template_options(opts, klass)
   options.update(opts)
   options
 end
-

data/spec/templates/tag_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Templates::Engine.template(:default, :tags) do
+RSpec.describe YARD::Templates::Engine.template(:default, :tags) do
   before { Registry.clear }
 
   describe "all known tags" do
@@ -48,4 +49,4 @@ describe YARD::Templates::Engine.template(:default, :tags) do
       expect(proc).not_to raise_error
     end
   end
-end
+end

data/spec/templates/template_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Templates::Template do
+RSpec.describe YARD::Templates::Template do
   def template(path)
     YARD::Templates::Engine.template!(path, '/full/path/' + path.to_s)
   end
@@ -21,8 +22,8 @@ describe YARD::Templates::Template do
       expect(File).to receive(:directory?).with('/bar/a/b').and_return(false)
       expect(File).to receive(:directory?).with('/foo/a').at_least(1).times.and_return(true)
       expect(File).to receive(:directory?).with('/bar/a').at_least(1).times.and_return(true)
-      ancestors = Engine.template('a/b').ancestors.map {|c| c.class_name }
-      expect(ancestors[0, 3]).to eq %w( Template__foo_a_b Template__bar_a Template__foo_a )
+      ancestors = Engine.template('a/b').ancestors.map(&:class_name)
+      expect(ancestors[0, 3]).to eq %w(Template__foo_a_b Template__bar_a Template__foo_a)
     end
 
     it "includes parent directory template if exists" do
@@ -61,7 +62,7 @@ describe YARD::Templates::Template do
   describe ".load_setup_rb" do
     it "loads setup.rb file for module" do
       expect(File).to receive(:file?).with('/full/path/e/setup.rb').and_return(true)
-      expect(File).to receive(:read).with('/full/path/e/setup.rb').and_return('def success; end')
+      expect(File).to receive(:read).with('/full/path/e/setup.rb').and_return(String.new('def success; end'))
       expect(template(:e).new).to respond_to(:success)
     end
   end
@@ -133,7 +134,7 @@ describe YARD::Templates::Template do
 
   describe "#init" do
     it "is called during initialization" do
-      module YARD::Templates::Engine::Template__full_path_e
+      module YARD::Templates::Engine::Template__full_path_e # rubocop:disable Style/ClassAndModuleCamelCase
         def init; sections 1, 2, 3 end
       end
       expect(template(:e).new.sections).to eq Section.new(nil, 1, 2, 3)
@@ -155,8 +156,8 @@ describe YARD::Templates::Template do
     it "replaces {{{__super__}}} with inherited template contents if allow_inherited=true" do
       expect(File).to receive(:file?).with('/full/path/a/abc').twice.and_return(true)
       expect(File).to receive(:file?).with('/full/path/b/abc').and_return(true)
-      expect(IO).to receive(:read).with('/full/path/a/abc').and_return('foo {{{__super__}}}')
-      expect(IO).to receive(:read).with('/full/path/b/abc').and_return('bar')
+      expect(IO).to receive(:read).with('/full/path/a/abc').and_return(String.new('foo {{{__super__}}}'))
+      expect(IO).to receive(:read).with('/full/path/b/abc').and_return(String.new('bar'))
       expect(template(:a).new.file('abc', true)).to eq "foo bar"
     end
 
@@ -199,14 +200,14 @@ describe YARD::Templates::Template do
   describe "#run" do
     it "renders all sections" do
       mod = template(:e).new
-      allow(mod).to receive(:render_section) { |section| section.name.to_s }
+      allow(mod).to receive(:render_section) {|section| section.name.to_s }
       mod.sections :a, :b, :c
       expect(mod.run).to eq 'abc'
     end
 
     it "renders all sections with options" do
       mod = template(:e).new
-      allow(mod).to receive(:render_section) { |section| section.name.to_s }
+      allow(mod).to receive(:render_section) {|section| section.name.to_s }
       expect(mod).to receive(:add_options).with(:a => 1).and_yield
       mod.sections :a
       expect(mod.run(:a => 1)).to eq 'a'
@@ -232,18 +233,18 @@ describe YARD::Templates::Template do
   describe "#add_options" do
     it "sets instance variables in addition to options" do
       mod = template(:f).new
-      mod.send(:add_options, {:a => 1, :b => 2})
-      expect(mod.options).to eq({:a => 1, :b => 2})
+      mod.send(:add_options, :a => 1, :b => 2)
+      expect(mod.options).to eq(:a => 1, :b => 2)
       expect(mod.instance_variable_get("@a")).to eq 1
       expect(mod.instance_variable_get("@b")).to eq 2
     end
 
     it "sets instance variables and options only for the block" do
       mod = template(:f).new
-      mod.send(:add_options, {:a => 100, :b => 200}) do
-        expect(mod.options).to eq({:a => 100, :b => 200})
+      mod.send(:add_options, :a => 100, :b => 200) do
+        expect(mod.options).to eq(:a => 100, :b => 200)
       end
-      expect(mod.options).not_to eq({:a => 100, :b => 200})
+      expect(mod.options).not_to eq(:a => 100, :b => 200)
     end
   end
 

data/spec/verifier_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/spec_helper'
+# frozen_string_literal: true
 
-describe YARD::Verifier do
+RSpec.describe YARD::Verifier do
   describe "#parse_expressions" do
     it "creates #__execute method" do
       v = Verifier.new("expr1")
@@ -103,4 +103,4 @@ describe YARD::Verifier do
       v.call(obj)
     end
   end
-end
+end

data/templates/default/class/dot/setup.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 include T('default/module/dot')
 
 def init
   super
   sections.push :superklass
-end
+end

data/templates/default/class/html/setup.rb

@@ -1 +1,2 @@
-include T('default/module/html')
+# frozen_string_literal: true
+include T('default/module/html')