yard 0.9.16 → 0.9.17

data/spec/serializers/spec_helper.rb

@@ -1,2 +1,2 @@
-# frozen_string_literal: true
-include YARD
+# frozen_string_literal: true
+include YARD

data/spec/serializers/yardoc_serializer_spec.rb

@@ -1,78 +1,78 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + "/spec_helper"
-
-instance_eval do
-  class YARD::Serializers::YardocSerializer
-    public :dump
-    public :internal_dump
-  end
-end
-
-RSpec.describe YARD::Serializers::YardocSerializer do
-  before do
-    @serializer = YARD::Serializers::YardocSerializer.new('.yardoc')
-
-    Registry.clear
-    @foo = CodeObjects::ClassObject.new(:root, :Foo)
-    @bar = CodeObjects::MethodObject.new(@foo, :bar)
-  end
-
-  describe "#dump" do
-    it "maintains object equality when loading a dumped object" do
-      newfoo = @serializer.internal_dump(@foo)
-      expect(newfoo).to equal(@foo)
-      expect(newfoo).to eq @foo
-      expect(@foo).to equal(newfoo)
-      expect(@foo).to eq newfoo
-      expect(newfoo.hash).to eq @foo.hash
-    end
-
-    it "maintains hash key equality when loading a dumped object" do
-      newfoo = @serializer.internal_dump(@foo)
-      expect(@foo => 1).to have_key(newfoo)
-      expect(newfoo => 1).to have_key(@foo)
-    end
-  end
-
-  describe "#serialize" do
-    it "accepts a hash of codeobjects (and write to root)" do
-      data = {:root => Registry.root}
-      marshaldata = Marshal.dump(data)
-      filemock = double(:file)
-      expect(filemock).to receive(:write).with(marshaldata)
-      expect(File).to receive(:open!).with('.yardoc/objects/root.dat', 'wb').and_yield(filemock)
-      @serializer.serialize(data)
-    end
-  end
-
-  describe "#lock_for_writing" do
-    it "creates a lock file during writing and cleans up" do
-      expect(File).to receive(:open!).with(@serializer.processing_path, 'w')
-      expect(File).to receive(:exist?).with(@serializer.processing_path).exactly(2).times.and_return(true)
-      expect(File).to receive(:unlink).with(@serializer.processing_path)
-      @serializer.lock_for_writing do
-        expect(@serializer.locked_for_writing?).to eq true
-      end
-    end
-  end
-
-  describe "#complete?" do
-    it "returns false if complete file does not exist" do
-      allow(File).to receive(:exist?).with(@serializer.complete_lock_path).and_return(false)
-      allow(File).to receive(:exist?).with(@serializer.processing_path).and_return(false)
-      expect(@serializer.complete?).to eq false
-    end
-
-    it "returns false if processing file exists" do
-      allow(File).to receive(:exist?).with(@serializer.complete_lock_path).and_return(true)
-      allow(File).to receive(:exist?).with(@serializer.processing_path).and_return(true)
-      expect(@serializer.complete?).to eq false
-    end
-
-    it "returns true if complete file exists with no processing file" do
-      allow(File).to receive(:exist?).with(@serializer.complete_lock_path).and_return(true)
-      allow(File).to receive(:exist?).with(@serializer.processing_path).and_return(false)
-      expect(@serializer.complete?).to eq true
-    end
-  end
-end
+# frozen_string_literal: true
+require File.dirname(__FILE__) + "/spec_helper"
+
+instance_eval do
+  class YARD::Serializers::YardocSerializer
+    public :dump
+    public :internal_dump
+  end
+end
+
+RSpec.describe YARD::Serializers::YardocSerializer do
+  before do
+    @serializer = YARD::Serializers::YardocSerializer.new('.yardoc')
+
+    Registry.clear
+    @foo = CodeObjects::ClassObject.new(:root, :Foo)
+    @bar = CodeObjects::MethodObject.new(@foo, :bar)
+  end
+
+  describe "#dump" do
+    it "maintains object equality when loading a dumped object" do
+      newfoo = @serializer.internal_dump(@foo)
+      expect(newfoo).to equal(@foo)
+      expect(newfoo).to eq @foo
+      expect(@foo).to equal(newfoo)
+      expect(@foo).to eq newfoo
+      expect(newfoo.hash).to eq @foo.hash
+    end
+
+    it "maintains hash key equality when loading a dumped object" do
+      newfoo = @serializer.internal_dump(@foo)
+      expect(@foo => 1).to have_key(newfoo)
+      expect(newfoo => 1).to have_key(@foo)
+    end
+  end
+
+  describe "#serialize" do
+    it "accepts a hash of codeobjects (and write to root)" do
+      data = {:root => Registry.root}
+      marshaldata = Marshal.dump(data)
+      filemock = double(:file)
+      expect(filemock).to receive(:write).with(marshaldata)
+      expect(File).to receive(:open!).with('.yardoc/objects/root.dat', 'wb').and_yield(filemock)
+      @serializer.serialize(data)
+    end
+  end
+
+  describe "#lock_for_writing" do
+    it "creates a lock file during writing and cleans up" do
+      expect(File).to receive(:open!).with(@serializer.processing_path, 'w')
+      expect(File).to receive(:exist?).with(@serializer.processing_path).exactly(2).times.and_return(true)
+      expect(File).to receive(:unlink).with(@serializer.processing_path)
+      @serializer.lock_for_writing do
+        expect(@serializer.locked_for_writing?).to eq true
+      end
+    end
+  end
+
+  describe "#complete?" do
+    it "returns false if complete file does not exist" do
+      allow(File).to receive(:exist?).with(@serializer.complete_lock_path).and_return(false)
+      allow(File).to receive(:exist?).with(@serializer.processing_path).and_return(false)
+      expect(@serializer.complete?).to eq false
+    end
+
+    it "returns false if processing file exists" do
+      allow(File).to receive(:exist?).with(@serializer.complete_lock_path).and_return(true)
+      allow(File).to receive(:exist?).with(@serializer.processing_path).and_return(true)
+      expect(@serializer.complete?).to eq false
+    end
+
+    it "returns true if complete file exists with no processing file" do
+      allow(File).to receive(:exist?).with(@serializer.complete_lock_path).and_return(true)
+      allow(File).to receive(:exist?).with(@serializer.processing_path).and_return(false)
+      expect(@serializer.complete?).to eq true
+    end
+  end
+end

data/spec/server/adapter_spec.rb

@@ -1,39 +1,39 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe YARD::Server::Adapter do
-  after(:all) { Server::Adapter.shutdown }
-
-  describe "#add_library" do
-    it "adds a library" do
-      lib = LibraryVersion.new('yard')
-      a = Adapter.new({})
-      expect(a.libraries).to be_empty
-      a.add_library(lib)
-      expect(a.libraries['yard']).to eq [lib]
-    end
-  end
-
-  describe "#start" do
-    it "does not implement #start" do
-      expect { Adapter.new({}).start }.to raise_error(NotImplementedError)
-    end
-  end
-
-  describe ".setup" do
-    it "adds template paths and helpers" do
-      Adapter.setup
-      expect(Templates::Template.extra_includes).to include(DocServerHelper)
-      expect(Templates::Engine.template_paths).to include(YARD::ROOT + '/yard/server/templates')
-    end
-  end
-
-  describe ".shutdown" do
-    it "cleans up template paths and helpers" do
-      Adapter.setup
-      Adapter.shutdown
-      expect(Templates::Template.extra_includes).not_to include(DocServerHelper)
-      expect(Templates::Engine.template_paths).not_to include(YARD::ROOT + '/yard/server/templates')
-    end
-  end
-end
+# frozen_string_literal: true
+require File.dirname(__FILE__) + '/spec_helper'
+
+RSpec.describe YARD::Server::Adapter do
+  after(:all) { Server::Adapter.shutdown }
+
+  describe "#add_library" do
+    it "adds a library" do
+      lib = LibraryVersion.new('yard')
+      a = Adapter.new({})
+      expect(a.libraries).to be_empty
+      a.add_library(lib)
+      expect(a.libraries['yard']).to eq [lib]
+    end
+  end
+
+  describe "#start" do
+    it "does not implement #start" do
+      expect { Adapter.new({}).start }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe ".setup" do
+    it "adds template paths and helpers" do
+      Adapter.setup
+      expect(Templates::Template.extra_includes).to include(DocServerHelper)
+      expect(Templates::Engine.template_paths).to include(YARD::ROOT + '/yard/server/templates')
+    end
+  end
+
+  describe ".shutdown" do
+    it "cleans up template paths and helpers" do
+      Adapter.setup
+      Adapter.shutdown
+      expect(Templates::Template.extra_includes).not_to include(DocServerHelper)
+      expect(Templates::Engine.template_paths).not_to include(YARD::ROOT + '/yard/server/templates')
+    end
+  end
+end

data/spec/server/commands/base_spec.rb

@@ -1,91 +1,91 @@
-# frozen_string_literal: true
-
-class MyProcCommand < Base
-  def initialize(&block)
-    self.class.send(:undef_method, :run)
-    self.class.send(:define_method, :run, &block)
-  end
-end
-
-class MyCacheCommand < Base
-  def run; cache 'foo' end
-end
-
-RSpec.describe YARD::Server::Commands::Base do
-  describe "#cache" do
-    before do
-      @command = MyCacheCommand.new(:adapter => mock_adapter, :caching => true)
-      @command.request = mock_request(nil)
-    end
-
-    it "does not cache if caching == false" do
-      expect(File).not_to receive(:open)
-      @command.caching = false
-      @command.run
-    end
-
-    it "requires document root to cache" do
-      expect(File).not_to receive(:open)
-      @command.adapter.document_root = nil
-      @command.run
-    end
-
-    it "caches to path/to/file.html and create directories" do
-      expect(FileUtils).to receive(:mkdir_p).with('/public/path/to')
-      expect(File).to receive(:open).with('/public/path/to/file.html', anything)
-      @command.request.path_info = '/path/to/file.html'
-      @command.run
-    end
-  end
-
-  describe "#redirect" do
-    it "returns a valid redirection" do
-      cmd = MyProcCommand.new { redirect '/foo' }
-      expect(cmd.call(mock_request('/foo'))).to eq(
-        [302, {"Content-Type" => "text/html", "Location" => "/foo"}, [""]]
-      )
-    end
-  end
-
-  describe "#call" do
-    it "handles a NotFoundError and use message as body" do
-      cmd = MyProcCommand.new { raise NotFoundError, "hello world" }
-      s, _, b = *cmd.call(mock_request('/foo'))
-      expect(s).to eq 404
-      expect(b).to eq ["hello world"]
-    end
-
-    it "does not use message as body if not provided in NotFoundError" do
-      cmd = MyProcCommand.new { raise NotFoundError }
-      s, _, b = *cmd.call(mock_request('/foo'))
-      expect(s).to eq 404
-      expect(b).to eq ["Not found: /foo"]
-    end
-
-    it "handles 404 status code from #run" do
-      cmd = MyProcCommand.new { self.status = 404 }
-      s, _, b = *cmd.call(mock_request('/foo'))
-      expect(s).to eq 404
-      expect(b).to eq ["Not found: /foo"]
-    end
-
-    it "does not override body if status is 404 and body is defined" do
-      cmd = MyProcCommand.new { self.body = "foo"; self.status = 404 }
-      s, _, b = *cmd.call(mock_request('/bar'))
-      expect(s).to eq 404
-      expect(b).to eq ['foo']
-    end
-
-    it "handles body as Array" do
-      cmd = MyProcCommand.new { self.body = ['a', 'b', 'c'] }
-      _, _, b = *cmd.call(mock_request('/foo'))
-      expect(b).to eq %w(a b c)
-    end
-
-    it "allows headers to be defined" do
-      cmd = MyProcCommand.new { headers['Foo'] = 'BAR' }
-      _, h, = *cmd.call(mock_request('/foo'))
-      expect(h['Foo']).to eq 'BAR'
-    end
-  end
-end
+# frozen_string_literal: true
+
+class MyProcCommand < Base
+  def initialize(&block)
+    self.class.send(:undef_method, :run)
+    self.class.send(:define_method, :run, &block)
+  end
+end
+
+class MyCacheCommand < Base
+  def run; cache 'foo' end
+end
+
+RSpec.describe YARD::Server::Commands::Base do
+  describe "#cache" do
+    before do
+      @command = MyCacheCommand.new(:adapter => mock_adapter, :caching => true)
+      @command.request = mock_request(nil)
+    end
+
+    it "does not cache if caching == false" do
+      expect(File).not_to receive(:open)
+      @command.caching = false
+      @command.run
+    end
+
+    it "requires document root to cache" do
+      expect(File).not_to receive(:open)
+      @command.adapter.document_root = nil
+      @command.run
+    end
+
+    it "caches to path/to/file.html and create directories" do
+      expect(FileUtils).to receive(:mkdir_p).with('/public/path/to')
+      expect(File).to receive(:open).with('/public/path/to/file.html', anything)
+      @command.request.path_info = '/path/to/file.html'
+      @command.run
+    end
+  end
+
+  describe "#redirect" do
+    it "returns a valid redirection" do
+      cmd = MyProcCommand.new { redirect '/foo' }
+      expect(cmd.call(mock_request('/foo'))).to eq(
+        [302, {"Content-Type" => "text/html", "Location" => "/foo"}, [""]]
+      )
+    end
+  end
+
+  describe "#call" do
+    it "handles a NotFoundError and use message as body" do
+      cmd = MyProcCommand.new { raise NotFoundError, "hello world" }
+      s, _, b = *cmd.call(mock_request('/foo'))
+      expect(s).to eq 404
+      expect(b).to eq ["hello world"]
+    end
+
+    it "does not use message as body if not provided in NotFoundError" do
+      cmd = MyProcCommand.new { raise NotFoundError }
+      s, _, b = *cmd.call(mock_request('/foo'))
+      expect(s).to eq 404
+      expect(b).to eq ["Not found: /foo"]
+    end
+
+    it "handles 404 status code from #run" do
+      cmd = MyProcCommand.new { self.status = 404 }
+      s, _, b = *cmd.call(mock_request('/foo'))
+      expect(s).to eq 404
+      expect(b).to eq ["Not found: /foo"]
+    end
+
+    it "does not override body if status is 404 and body is defined" do
+      cmd = MyProcCommand.new { self.body = "foo"; self.status = 404 }
+      s, _, b = *cmd.call(mock_request('/bar'))
+      expect(s).to eq 404
+      expect(b).to eq ['foo']
+    end
+
+    it "handles body as Array" do
+      cmd = MyProcCommand.new { self.body = ['a', 'b', 'c'] }
+      _, _, b = *cmd.call(mock_request('/foo'))
+      expect(b).to eq %w(a b c)
+    end
+
+    it "allows headers to be defined" do
+      cmd = MyProcCommand.new { headers['Foo'] = 'BAR' }
+      _, h, = *cmd.call(mock_request('/foo'))
+      expect(h['Foo']).to eq 'BAR'
+    end
+  end
+end

data/spec/server/commands/library_command_spec.rb

@@ -1,39 +1,39 @@
-# frozen_string_literal: true
-require 'ostruct'
-
-RSpec.describe YARD::Server::Commands::LibraryCommand do
-  before do
-    allow(Templates::Engine).to receive(:render)
-    allow(Templates::Engine).to receive(:generate)
-    allow(YARD).to receive(:parse)
-    allow(Registry).to receive(:load)
-    allow(Registry).to receive(:save)
-
-    @cmd = LibraryCommand.new(:adapter => mock_adapter)
-    @request = mock_request("/foo", :xhr? => false)
-    @library = OpenStruct.new(:source_path => '.')
-    @cmd.library = @library
-    allow(@cmd).to receive(:load_yardoc).and_return(nil)
-  end
-
-  def call
-    expect { @cmd.call(@request) }.to raise_error(NotImplementedError)
-  end
-
-  describe "#call" do
-    it "raises NotImplementedError" do
-      call
-    end
-
-    it "sets :rdoc as the default markup in incremental mode" do
-      @cmd.incremental = true
-      call
-      expect(@cmd.options[:markup]).to eq :rdoc
-    end
-
-    it "sets :rdoc as the default markup in regular mode" do
-      call
-      expect(@cmd.options[:markup]).to eq :rdoc
-    end
-  end
-end
+# frozen_string_literal: true
+require 'ostruct'
+
+RSpec.describe YARD::Server::Commands::LibraryCommand do
+  before do
+    allow(Templates::Engine).to receive(:render)
+    allow(Templates::Engine).to receive(:generate)
+    allow(YARD).to receive(:parse)
+    allow(Registry).to receive(:load)
+    allow(Registry).to receive(:save)
+
+    @cmd = LibraryCommand.new(:adapter => mock_adapter)
+    @request = mock_request("/foo", :xhr? => false)
+    @library = OpenStruct.new(:source_path => '.')
+    @cmd.library = @library
+    allow(@cmd).to receive(:load_yardoc).and_return(nil)
+  end
+
+  def call
+    expect { @cmd.call(@request) }.to raise_error(NotImplementedError)
+  end
+
+  describe "#call" do
+    it "raises NotImplementedError" do
+      call
+    end
+
+    it "sets :rdoc as the default markup in incremental mode" do
+      @cmd.incremental = true
+      call
+      expect(@cmd.options[:markup]).to eq :rdoc
+    end
+
+    it "sets :rdoc as the default markup in regular mode" do
+      call
+      expect(@cmd.options[:markup]).to eq :rdoc
+    end
+  end
+end