yard 0.9.16 → 0.9.17

data/spec/server/doc_server_helper_spec.rb

@@ -1,72 +1,72 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + "/spec_helper"
-
-class MyDocServerSerializerRouter
-  attr_accessor :request
-  def docs_prefix; 'PREFIX' end
-  def initialize; @request = mock_request end
-end
-
-class MockDocServerHelper
-  include YARD::Templates::Helpers::BaseHelper
-  include YARD::Templates::Helpers::HtmlHelper
-  include YARD::Server::DocServerHelper
-
-  attr_accessor :adapter
-  attr_accessor :single_library
-  attr_accessor :library
-
-  def initialize
-    @single_library = false
-    @library = LibraryVersion.new('foo')
-    @adapter = mock_adapter(:router => MyDocServerSerializerRouter.new)
-    @serializer = YARD::Server::DocServerSerializer.new
-    @object = YARD::Registry.root
-  end
-
-  def options; OpenStruct.new end
-end
-
-RSpec.describe YARD::Server::DocServerHelper do
-  before do
-    @helper = MockDocServerHelper.new
-  end
-
-  describe "#url_for" do
-    it "does not link to /library/ if single_library = true" do
-      @helper.single_library = true
-      expect(@helper.url_for(Registry.root)).to eq "/PREFIX/toplevel"
-    end
-
-    it "returns /PREFIX/foo/version if foo has a version" do
-      @helper.library = LibraryVersion.new('foo', 'bar')
-      @helper.adapter.router.request.version_supplied = true
-      expect(@helper.url_for(P('A'))).to eq '/PREFIX/foo/bar/A'
-    end
-
-    it "uses script name prefix if set" do
-      @helper.adapter.router.request.script_name = '/mount/point'
-      @helper.library = LibraryVersion.new('foo', 'bar')
-      @helper.adapter.router.request.version_supplied = true
-      expect(@helper.url_for(P('A'))).to eq '/mount/point/PREFIX/foo/bar/A'
-    end
-  end
-
-  describe "#url_for_file" do
-    it "properly links file objects using file/ prefix" do
-      file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
-      expect(@helper.url_for_file(file)).to eq '/PREFIX/foo/file/a/b/FooBar.md'
-    end
-
-    it "properly links anchor portion" do
-      file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
-      expect(@helper.url_for_file(file, 'anchor')).to eq '/PREFIX/foo/file/a/b/FooBar.md#anchor'
-    end
-
-    it "uses script name prefix if set" do
-      @helper.adapter.router.request.script_name = '/mount/point'
-      file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
-      expect(@helper.url_for_file(file)).to eq '/mount/point/PREFIX/foo/file/a/b/FooBar.md'
-    end
-  end
-end
+# frozen_string_literal: true
+require File.dirname(__FILE__) + "/spec_helper"
+
+class MyDocServerSerializerRouter
+  attr_accessor :request
+  def docs_prefix; 'PREFIX' end
+  def initialize; @request = mock_request end
+end
+
+class MockDocServerHelper
+  include YARD::Templates::Helpers::BaseHelper
+  include YARD::Templates::Helpers::HtmlHelper
+  include YARD::Server::DocServerHelper
+
+  attr_accessor :adapter
+  attr_accessor :single_library
+  attr_accessor :library
+
+  def initialize
+    @single_library = false
+    @library = LibraryVersion.new('foo')
+    @adapter = mock_adapter(:router => MyDocServerSerializerRouter.new)
+    @serializer = YARD::Server::DocServerSerializer.new
+    @object = YARD::Registry.root
+  end
+
+  def options; OpenStruct.new end
+end
+
+RSpec.describe YARD::Server::DocServerHelper do
+  before do
+    @helper = MockDocServerHelper.new
+  end
+
+  describe "#url_for" do
+    it "does not link to /library/ if single_library = true" do
+      @helper.single_library = true
+      expect(@helper.url_for(Registry.root)).to eq "/PREFIX/toplevel"
+    end
+
+    it "returns /PREFIX/foo/version if foo has a version" do
+      @helper.library = LibraryVersion.new('foo', 'bar')
+      @helper.adapter.router.request.version_supplied = true
+      expect(@helper.url_for(P('A'))).to eq '/PREFIX/foo/bar/A'
+    end
+
+    it "uses script name prefix if set" do
+      @helper.adapter.router.request.script_name = '/mount/point'
+      @helper.library = LibraryVersion.new('foo', 'bar')
+      @helper.adapter.router.request.version_supplied = true
+      expect(@helper.url_for(P('A'))).to eq '/mount/point/PREFIX/foo/bar/A'
+    end
+  end
+
+  describe "#url_for_file" do
+    it "properly links file objects using file/ prefix" do
+      file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
+      expect(@helper.url_for_file(file)).to eq '/PREFIX/foo/file/a/b/FooBar.md'
+    end
+
+    it "properly links anchor portion" do
+      file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
+      expect(@helper.url_for_file(file, 'anchor')).to eq '/PREFIX/foo/file/a/b/FooBar.md#anchor'
+    end
+
+    it "uses script name prefix if set" do
+      @helper.adapter.router.request.script_name = '/mount/point'
+      file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
+      expect(@helper.url_for_file(file)).to eq '/mount/point/PREFIX/foo/file/a/b/FooBar.md'
+    end
+  end
+end

data/spec/server/doc_server_serializer_spec.rb

@@ -1,60 +1,60 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe YARD::Server::DocServerSerializer do
-  describe "#serialized_path" do
-    before do
-      Registry.clear
-      @serializer = Server::DocServerSerializer.new
-    end
-
-    after(:all) { Server::Adapter.shutdown }
-
-    it "returns '/PREFIX/library/toplevel' for root" do
-      expect(@serializer.serialized_path(Registry.root)).to eq "toplevel"
-    end
-
-    it "returns /PREFIX/library/Object for Object in a library" do
-      expect(@serializer.serialized_path(P('A::B::C'))).to eq 'A/B/C'
-    end
-
-    it "links to instance method as Class:method" do
-      obj = CodeObjects::MethodObject.new(:root, :method)
-      expect(@serializer.serialized_path(obj)).to eq 'toplevel:method'
-    end
-
-    it "links to class method as Class.method" do
-      obj = CodeObjects::MethodObject.new(:root, :method, :class)
-      expect(@serializer.serialized_path(obj)).to eq 'toplevel.method'
-    end
-
-    it "links to anchor for constant" do
-      obj = CodeObjects::ConstantObject.new(:root, :FOO)
-      expect(@serializer.serialized_path(obj)).to eq 'toplevel#FOO-constant'
-    end
-
-    it "links to anchor for class variable" do
-      obj = CodeObjects::ClassVariableObject.new(:root, :@@foo)
-      expect(@serializer.serialized_path(obj)).to eq 'toplevel#@@foo-classvariable'
-    end
-
-    it "links files using file/ prefix" do
-      file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
-      expect(@serializer.serialized_path(file)).to eq 'file/FooBar'
-    end
-
-    it "escapes special characters" do
-      obj = CodeObjects::MethodObject.new(:root, :method?)
-      expect(@serializer.serialized_path(obj)).to eq 'toplevel:method%3F'
-    end
-
-    it "handles unicode data" do
-      file = CodeObjects::ExtraFileObject.new("test\u0160", '')
-      if file.name.encoding == Encoding.find("Windows-1252")
-        expect(@serializer.serialized_path(file)).to eq 'file/test_8A'
-      else
-        expect(@serializer.serialized_path(file)).to eq 'file/test_C5A0'
-      end
-    end if defined?(::Encoding)
-  end
-end
+# frozen_string_literal: true
+require File.dirname(__FILE__) + '/spec_helper'
+
+RSpec.describe YARD::Server::DocServerSerializer do
+  describe "#serialized_path" do
+    before do
+      Registry.clear
+      @serializer = Server::DocServerSerializer.new
+    end
+
+    after(:all) { Server::Adapter.shutdown }
+
+    it "returns '/PREFIX/library/toplevel' for root" do
+      expect(@serializer.serialized_path(Registry.root)).to eq "toplevel"
+    end
+
+    it "returns /PREFIX/library/Object for Object in a library" do
+      expect(@serializer.serialized_path(P('A::B::C'))).to eq 'A/B/C'
+    end
+
+    it "links to instance method as Class:method" do
+      obj = CodeObjects::MethodObject.new(:root, :method)
+      expect(@serializer.serialized_path(obj)).to eq 'toplevel:method'
+    end
+
+    it "links to class method as Class.method" do
+      obj = CodeObjects::MethodObject.new(:root, :method, :class)
+      expect(@serializer.serialized_path(obj)).to eq 'toplevel.method'
+    end
+
+    it "links to anchor for constant" do
+      obj = CodeObjects::ConstantObject.new(:root, :FOO)
+      expect(@serializer.serialized_path(obj)).to eq 'toplevel#FOO-constant'
+    end
+
+    it "links to anchor for class variable" do
+      obj = CodeObjects::ClassVariableObject.new(:root, :@@foo)
+      expect(@serializer.serialized_path(obj)).to eq 'toplevel#@@foo-classvariable'
+    end
+
+    it "links files using file/ prefix" do
+      file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
+      expect(@serializer.serialized_path(file)).to eq 'file/FooBar'
+    end
+
+    it "escapes special characters" do
+      obj = CodeObjects::MethodObject.new(:root, :method?)
+      expect(@serializer.serialized_path(obj)).to eq 'toplevel:method%3F'
+    end
+
+    it "handles unicode data" do
+      file = CodeObjects::ExtraFileObject.new("test\u0160", '')
+      if file.name.encoding == Encoding.find("Windows-1252")
+        expect(@serializer.serialized_path(file)).to eq 'file/test_8A'
+      else
+        expect(@serializer.serialized_path(file)).to eq 'file/test_C5A0'
+      end
+    end if defined?(::Encoding)
+  end
+end

data/spec/server/rack_adapter_spec.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + "/spec_helper"
-
-RSpec.describe "YARD::Server::RackMiddleware" do
-  before do
-    begin; require 'rack'; rescue LoadError; pending "rack required for these tests" end
-    @superapp = double(:superapp)
-    @app = YARD::Server::RackMiddleware.new(@superapp, :libraries => {'foo' => [LibraryVersion.new('foo', nil)]})
-  end
-
-  after(:all) { YARD::Server::Adapter.shutdown }
-
-  it "handles requests" do
-    expect(@app.call(Rack::MockRequest.env_for('/'))[0]).to eq 200
-  end
-
-  it "passes up to the next middleware on 404" do
-    expect(@superapp).to receive(:call).and_return([200, {}, ['OK']])
-    expect(@app.call(Rack::MockRequest.env_for('/INVALID'))).to eq [200, {}, ['OK']]
-  end
-end
+# frozen_string_literal: true
+require File.dirname(__FILE__) + "/spec_helper"
+
+RSpec.describe "YARD::Server::RackMiddleware" do
+  before do
+    begin; require 'rack'; rescue LoadError; pending "rack required for these tests" end
+    @superapp = double(:superapp)
+    @app = YARD::Server::RackMiddleware.new(@superapp, :libraries => {'foo' => [LibraryVersion.new('foo', nil)]})
+  end
+
+  after(:all) { YARD::Server::Adapter.shutdown }
+
+  it "handles requests" do
+    expect(@app.call(Rack::MockRequest.env_for('/'))[0]).to eq 200
+  end
+
+  it "passes up to the next middleware on 404" do
+    expect(@superapp).to receive(:call).and_return([200, {}, ['OK']])
+    expect(@app.call(Rack::MockRequest.env_for('/INVALID'))).to eq [200, {}, ['OK']]
+  end
+end

data/spec/server/router_spec.rb

@@ -1,123 +1,123 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-class MyRouterSpecRouter < Router
-  def docs_prefix; 'mydocs/foo' end
-  def list_prefix; 'mylist/foo' end
-  def search_prefix; 'mysearch/foo' end
-
-  def check_static_cache; nil end
-end
-
-RSpec.describe YARD::Server::Router do
-  before do
-    @adapter = mock_adapter
-    @projects = @adapter.libraries['project']
-    @request = mock_request
-  end
-
-  describe "#parse_library_from_path" do
-    def parse(*args)
-      @request.path_info = '/' + args.join('/')
-      @router = MyRouterSpecRouter.new(@adapter)
-      @router.request = @request
-      @router.parse_library_from_path(args.flatten)
-    end
-
-    it "parses library and version name out of path" do
-      expect(parse('project', '1.0.0')).to eq [@projects[0], []]
-      expect(@request.version_supplied).to be true
-    end
-
-    it "parses library and use latest version if version is not supplied" do
-      expect(parse('project')).to eq [@projects[1], []]
-      expect(@request.version_supplied).to be false
-    end
-
-    it "parses library and use latest version if next component is not a version" do
-      expect(parse('project', 'notaversion')).to eq [@projects[1], ['notaversion']]
-      expect(@request.version_supplied).to be false
-    end
-
-    it "returns nil library if no library is found" do
-      expect(parse('notproject')).to eq [nil, ['notproject']]
-    end
-
-    it "does not parse library or version if single_library == true" do
-      allow(@adapter).to receive(:options).and_return(:single_library => true)
-      expect(parse('notproject')).to eq [@projects[0], ['notproject']]
-    end
-  end
-
-  describe "#route" do
-    def route_to(route, command, script_name = '')
-      req = mock_request(route, script_name)
-      router = MyRouterSpecRouter.new(@adapter)
-      expect(command).to receive(:new) do |*args|
-        @command = command.allocate
-        @command.send(:initialize, *args)
-        class << @command; define_method(:call) {|*| self } end
-        @command
-      end
-      router.call(req)
-    end
-
-    it "routes /docs/OBJECT to object if single_library = true" do
-      allow(@adapter).to receive(:options).and_return(:single_library => true)
-      route_to('/mydocs/foo/FOO', DisplayObjectCommand)
-    end
-
-    it "routes /docs" do
-      route_to('/mydocs/foo', LibraryIndexCommand)
-    end
-
-    it "routes /docs as index for library if single_library == true" do
-      allow(@adapter).to receive(:options).and_return(:single_library => true)
-      route_to('/mydocs/foo/', DisplayObjectCommand)
-    end
-
-    it "routes /docs/name/version" do
-      route_to('/mydocs/foo/project/1.0.0', DisplayObjectCommand)
-      expect(@command.library).to eq @projects[0]
-    end
-
-    it "routes /docs/name/ to latest version of library" do
-      route_to('/mydocs/foo/project', DisplayObjectCommand)
-      expect(@command.library).to eq @projects[1]
-    end
-
-    it "routes /list/name/version/class" do
-      route_to('/mylist/foo/project/1.0.0/class', ListCommand)
-      expect(@command.library).to eq @projects[0]
-    end
-
-    it "routes /list/name/version/methods" do
-      route_to('/mylist/foo/project/1.0.0/methods', ListCommand)
-      expect(@command.library).to eq @projects[0]
-    end
-
-    it "routes /list/name/version/files" do
-      route_to('/mylist/foo/project/1.0.0/files', ListCommand)
-      expect(@command.library).to eq @projects[0]
-    end
-
-    it "routes /list/name to latest version of library" do
-      route_to('/mylist/foo/project/class', ListCommand)
-      expect(@command.library).to eq @projects[1]
-    end
-
-    it "routes /search/name/version" do
-      route_to('/mysearch/foo/project/1.0.0', SearchCommand)
-      expect(@command.library).to eq @projects[0]
-    end
-
-    it "routes /search/name to latest version of library" do
-      route_to('/mysearch/foo/project', SearchCommand)
-      expect(@command.library).to eq @projects[1]
-    end
-
-    it "searches static files for non-existent library" do
-      route_to('/mydocs/foo/notproject', RootRequestCommand)
-    end
-  end
-end
+# frozen_string_literal: true
+require File.dirname(__FILE__) + '/spec_helper'
+
+class MyRouterSpecRouter < Router
+  def docs_prefix; 'mydocs/foo' end
+  def list_prefix; 'mylist/foo' end
+  def search_prefix; 'mysearch/foo' end
+
+  def check_static_cache; nil end
+end
+
+RSpec.describe YARD::Server::Router do
+  before do
+    @adapter = mock_adapter
+    @projects = @adapter.libraries['project']
+    @request = mock_request
+  end
+
+  describe "#parse_library_from_path" do
+    def parse(*args)
+      @request.path_info = '/' + args.join('/')
+      @router = MyRouterSpecRouter.new(@adapter)
+      @router.request = @request
+      @router.parse_library_from_path(args.flatten)
+    end
+
+    it "parses library and version name out of path" do
+      expect(parse('project', '1.0.0')).to eq [@projects[0], []]
+      expect(@request.version_supplied).to be true
+    end
+
+    it "parses library and use latest version if version is not supplied" do
+      expect(parse('project')).to eq [@projects[1], []]
+      expect(@request.version_supplied).to be false
+    end
+
+    it "parses library and use latest version if next component is not a version" do
+      expect(parse('project', 'notaversion')).to eq [@projects[1], ['notaversion']]
+      expect(@request.version_supplied).to be false
+    end
+
+    it "returns nil library if no library is found" do
+      expect(parse('notproject')).to eq [nil, ['notproject']]
+    end
+
+    it "does not parse library or version if single_library == true" do
+      allow(@adapter).to receive(:options).and_return(:single_library => true)
+      expect(parse('notproject')).to eq [@projects[0], ['notproject']]
+    end
+  end
+
+  describe "#route" do
+    def route_to(route, command, script_name = '')
+      req = mock_request(route, script_name)
+      router = MyRouterSpecRouter.new(@adapter)
+      expect(command).to receive(:new) do |*args|
+        @command = command.allocate
+        @command.send(:initialize, *args)
+        class << @command; define_method(:call) {|*| self } end
+        @command
+      end
+      router.call(req)
+    end
+
+    it "routes /docs/OBJECT to object if single_library = true" do
+      allow(@adapter).to receive(:options).and_return(:single_library => true)
+      route_to('/mydocs/foo/FOO', DisplayObjectCommand)
+    end
+
+    it "routes /docs" do
+      route_to('/mydocs/foo', LibraryIndexCommand)
+    end
+
+    it "routes /docs as index for library if single_library == true" do
+      allow(@adapter).to receive(:options).and_return(:single_library => true)
+      route_to('/mydocs/foo/', DisplayObjectCommand)
+    end
+
+    it "routes /docs/name/version" do
+      route_to('/mydocs/foo/project/1.0.0', DisplayObjectCommand)
+      expect(@command.library).to eq @projects[0]
+    end
+
+    it "routes /docs/name/ to latest version of library" do
+      route_to('/mydocs/foo/project', DisplayObjectCommand)
+      expect(@command.library).to eq @projects[1]
+    end
+
+    it "routes /list/name/version/class" do
+      route_to('/mylist/foo/project/1.0.0/class', ListCommand)
+      expect(@command.library).to eq @projects[0]
+    end
+
+    it "routes /list/name/version/methods" do
+      route_to('/mylist/foo/project/1.0.0/methods', ListCommand)
+      expect(@command.library).to eq @projects[0]
+    end
+
+    it "routes /list/name/version/files" do
+      route_to('/mylist/foo/project/1.0.0/files', ListCommand)
+      expect(@command.library).to eq @projects[0]
+    end
+
+    it "routes /list/name to latest version of library" do
+      route_to('/mylist/foo/project/class', ListCommand)
+      expect(@command.library).to eq @projects[1]
+    end
+
+    it "routes /search/name/version" do
+      route_to('/mysearch/foo/project/1.0.0', SearchCommand)
+      expect(@command.library).to eq @projects[0]
+    end
+
+    it "routes /search/name to latest version of library" do
+      route_to('/mysearch/foo/project', SearchCommand)
+      expect(@command.library).to eq @projects[1]
+    end
+
+    it "searches static files for non-existent library" do
+      route_to('/mydocs/foo/notproject', RootRequestCommand)
+    end
+  end
+end