yard 0.7.5 → 0.8.0

data/spec/serializers/file_system_serializer_spec.rb

@@ -7,7 +7,7 @@ describe YARD::Serializers::FileSystemSerializer do
     FileUtils.stub!(:mkdir_p)
     File.stub!(:open)
   end
-  
+
   describe '#basepath' do
     it "should default the base path to the 'doc/'" do
       obj = Serializers::FileSystemSerializer.new
@@ -21,7 +21,7 @@ describe YARD::Serializers::FileSystemSerializer do
       obj.extension.should == "html"
     end
   end
-  
+
   describe '#serialized_path' do
     it "should allow no extension to be used" do
       obj = Serializers::FileSystemSerializer.new :extension => nil
@@ -38,17 +38,17 @@ describe YARD::Serializers::FileSystemSerializer do
       s = Serializers::FileSystemSerializer.new(:basepath => 'foo', :extension => 'txt')
       s.serialized_path('test.txt').should == 'test.txt'
     end
-    
+
     it "should remove special chars from path" do
       m = CodeObjects::MethodObject.new(nil, 'a')
       s = Serializers::FileSystemSerializer.new
 
       { :/ => '_2F_i.html',
-        :gsub! => 'gsub_21_i.html', 
-        :ask? => 'ask_3F_i.html', 
-        :=== => '_3D_3D_3D_i.html', 
-        :+ => '_2B_i.html', 
-        :- => '-_i.html', 
+        :gsub! => 'gsub_21_i.html',
+        :ask? => 'ask_3F_i.html',
+        :=== => '_3D_3D_3D_i.html',
+        :+ => '_2B_i.html',
+        :- => '-_i.html',
         :[]= => '_5B_5D_3D_i.html',
         :<< => '_3C_3C_i.html',
         :>= => '_3E_3D_i.html',
@@ -63,7 +63,7 @@ describe YARD::Serializers::FileSystemSerializer do
         s.serialized_path(m).should == value
       end
     end
-    
+
     it "should handle ExtraFileObject's" do
       s = Serializers::FileSystemSerializer.new
       e = CodeObjects::ExtraFileObject.new('filename.txt', '')
@@ -76,7 +76,7 @@ describe YARD::Serializers::FileSystemSerializer do
       m2 = CodeObjects::MethodObject.new(nil, 'meth', :class)
       s.serialized_path(m1).should_not == s.serialized_path(m2)
     end
-    
+
     it "should serialize path from overload tag" do
       YARD.parse_string <<-'eof'
         class Foo
@@ -84,13 +84,13 @@ describe YARD::Serializers::FileSystemSerializer do
           def bar; end
         end
       eof
-      
+
       serializer = Serializers::FileSystemSerializer.new
       object = Registry.at('Foo#bar').tag(:overload)
       serializer.serialized_path(object).should == "Foo/bar_i.html"
     end
   end
-  
+
   describe '#serialize' do
     it "should serialize to the correct path" do
       yard = CodeObjects::ClassObject.new(nil, :FooBar)

data/spec/serializers/yardoc_serializer_spec.rb

@@ -25,14 +25,14 @@ describe YARD::Serializers::YardocSerializer do
       @foo.should == newfoo
       newfoo.hash.should == @foo.hash
     end
-    
+
     it "should maintain hash key equality when loading a dumped object" do
       newfoo = @serializer.internal_dump(@foo)
       {@foo => 1}.should have_key(newfoo)
       {newfoo => 1}.should have_key(@foo)
     end
   end
-  
+
   describe '#serialize' do
     it "should accept a hash of codeobjects (and write to root)" do
       data = {:root => Registry.root}

data/spec/server/adapter_spec.rb

@@ -12,13 +12,13 @@ describe YARD::Server::Adapter do
       a.libraries['yard'].should == [lib]
     end
   end
-  
+
   describe '#start' do
     it "should not implement #start" do
       lambda { Adapter.new({}).start }.should raise_error(NotImplementedError)
     end
   end
-  
+
   describe '.setup' do
     it 'should add template paths and helpers' do
       Adapter.setup
@@ -26,7 +26,7 @@ describe YARD::Server::Adapter do
       Templates::Engine.template_paths.should include(YARD::ROOT + '/yard/server/templates')
     end
   end
-  
+
   describe '.shutdown' do
     it 'should cleanup template paths and helpers' do
       Adapter.setup

data/spec/server/commands/base_spec.rb

@@ -20,13 +20,13 @@ describe YARD::Server::Commands::Base do
       @command.caching = false
       @command.run
     end
-    
+
     it "should require document root to cache" do
       File.should_not_receive(:open)
       @command.adapter.document_root = nil
       @command.run
     end
-    
+
     it "should cache to path/to/file.html and create directories" do
       FileUtils.should_receive(:mkdir_p).with('/public/path/to')
       File.should_receive(:open).with('/public/path/to/file.html', anything)
@@ -34,15 +34,15 @@ describe YARD::Server::Commands::Base do
       @command.run
     end
   end
-  
+
   describe '#redirect' do
     it "should return a valid redirection" do
       cmd = MyProcCommand.new { redirect '/foo' }
-      cmd.call(mock_request('/foo')).should == 
+      cmd.call(mock_request('/foo')).should ==
         [302, {"Content-Type" => "text/html", "Location" => "/foo"}, [""]]
     end
   end
-  
+
   describe '#call' do
     it "should handle a NotFoundError and use message as body" do
       cmd = MyProcCommand.new { raise NotFoundError, "hello world" }
@@ -64,20 +64,20 @@ describe YARD::Server::Commands::Base do
       s.should == 404
       b.should == ["Not found: /foo"]
     end
-    
+
     it "should not override body if status is 404 and body is defined" do
       cmd = MyProcCommand.new { self.body = "foo"; self.status = 404 }
       s, h, b = *cmd.call(mock_request('/bar'))
       s.should == 404
       b.should == ['foo']
     end
-    
+
     it "should handle body as Array" do
       cmd = MyProcCommand.new { self.body = ['a', 'b', 'c'] }
       s, h, b = *cmd.call(mock_request('/foo'))
       b.should == %w(a b c)
     end
-    
+
     it "should allow headers to be defined" do
       cmd = MyProcCommand.new { self.headers['Foo'] = 'BAR' }
       s, h, b = *cmd.call(mock_request('/foo'))

data/spec/server/commands/library_command_spec.rb

@@ -15,16 +15,16 @@ describe YARD::Server::Commands::LibraryCommand do
     @cmd.library = @library
     @cmd.stub!(:load_yardoc).and_return(nil)
   end
-  
+
   def call
     lambda { @cmd.call(@request) }.should raise_error(NotImplementedError)
   end
-  
+
   describe "#call" do
     it "should raise NotImplementedError" do
       call
     end
-    
+
     it "should set :rdoc as the default markup in incremental mode" do
       @cmd.incremental = true
       call

data/spec/server/commands/static_file_command_spec.rb

@@ -6,7 +6,7 @@ describe YARD::Server::Commands::StaticFileCommand do
     adapter.document_root = '/c'
     @cmd = StaticFileCommand.new(:adapter => adapter)
   end
-  
+
   describe '#run' do
     def run(path, status = nil, body = nil)
       s, h, b = *@cmd.call(mock_request(path))
@@ -14,7 +14,7 @@ describe YARD::Server::Commands::StaticFileCommand do
       status.should == s if status
       [s, h, b]
     end
-    
+
     it "should search through document root before static paths" do
       File.should_receive(:exist?).with('/c/path/to/file.txt').ordered.and_return(false)
       StaticFileCommand::STATIC_PATHS.reverse.each do |path|
@@ -22,7 +22,7 @@ describe YARD::Server::Commands::StaticFileCommand do
       end
       run '/path/to/file.txt'
     end
-    
+
     it "should return file contents if found" do
       path = File.join(StaticFileCommand::STATIC_PATHS.last, '/path/to/file.txt')
       File.should_receive(:exist?).with('/c/path/to/file.txt').and_return(false)
@@ -30,7 +30,7 @@ describe YARD::Server::Commands::StaticFileCommand do
       File.should_receive(:read).with(path).and_return('FOO')
       run('/path/to/file.txt', 200, 'FOO')
     end
-    
+
     it "should allow registering of new paths and use those before other static paths" do
       Server.register_static_path '/foo'
       path = '/foo/path/to/file.txt'
@@ -47,7 +47,7 @@ describe YARD::Server::Commands::StaticFileCommand do
       File.should_receive(:read).with('/c/path/to/file.txt').and_return('FOO')
       run('/c/path/to/file.txt', 200, 'FOO')
     end
-    
+
     it "should return 404 if not found" do
       File.should_receive(:exist?).with('/c/path/to/file.txt').ordered.and_return(false)
       StaticFileCommand::STATIC_PATHS.reverse.each do |path|
@@ -55,14 +55,14 @@ describe YARD::Server::Commands::StaticFileCommand do
       end
       run('/path/to/file.txt', 404)
     end
-    
+
     it "should return text/html for file with no extension" do
       File.should_receive(:exist?).with('/c/file').and_return(true)
       File.should_receive(:read).with('/c/file')
       s, h, b = *run('/file')
       h['Content-Type'].should == 'text/html'
     end
-    
+
     {
       "js" => "text/javascript",
       "css" => "text/css",

data/spec/server/doc_server_helper_spec.rb

@@ -41,7 +41,7 @@ describe YARD::Server::DocServerHelper do
       @helper.url_for(P('A')).should == '/PREFIX/foo/bar/A'
     end
   end
-  
+
   describe '#url_for_file' do
     it "should properly link file objects using file/ prefix" do
       file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')

data/spec/server/doc_server_serializer_spec.rb

@@ -8,15 +8,15 @@ describe YARD::Server::DocServerSerializer do
     end
 
     after(:all) { Server::Adapter.shutdown }
-    
+
     it "should return '/PREFIX/library/toplevel' for root" do
       @serializer.serialized_path(Registry.root).should == "toplevel"
     end
-    
+
     it "should return /PREFIX/library/Object for Object in a library" do
       @serializer.serialized_path(P('A::B::C')).should == 'A/B/C'
     end
-    
+
     it "should link to instance method as Class:method" do
       obj = CodeObjects::MethodObject.new(:root, :method)
       @serializer.serialized_path(obj).should == 'toplevel:method'
@@ -26,17 +26,17 @@ describe YARD::Server::DocServerSerializer do
       obj = CodeObjects::MethodObject.new(:root, :method, :class)
       @serializer.serialized_path(obj).should == 'toplevel.method'
     end
-    
+
     it "should link to anchor for constant" do
       obj = CodeObjects::ConstantObject.new(:root, :FOO)
       @serializer.serialized_path(obj).should == 'toplevel#FOO-constant'
     end
-    
+
     it "should link to anchor for class variable" do
       obj = CodeObjects::ClassVariableObject.new(:root, :@@foo)
       @serializer.serialized_path(obj).should == 'toplevel#@@foo-classvariable'
     end
-    
+
     it "should link files using file/ prefix" do
       file = CodeObjects::ExtraFileObject.new('a/b/FooBar.md', '')
       @serializer.serialized_path(file).should == 'file/FooBar'

data/spec/server/rack_adapter_spec.rb

@@ -6,13 +6,13 @@ describe "YARD::Server::RackMiddleware" do
     @superapp = mock(:superapp)
     @app = YARD::Server::RackMiddleware.new(@superapp, :libraries => {'foo' => [LibraryVersion.new('foo', nil)]})
   end
-  
+
   after(:all) { YARD::Server::Adapter.shutdown }
-  
+
   it "should handle requests" do
     @app.call(Rack::MockRequest.env_for('/'))[0].should == 200
   end
-  
+
   it "should pass up to the next middleware on 404" do
     @superapp.should_receive(:call).and_return([200, {}, ['OK']])
     @app.call(Rack::MockRequest.env_for('/INVALID')).should == [200, {}, ['OK']]

data/spec/server/router_spec.rb

@@ -4,7 +4,7 @@ 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
 
@@ -22,12 +22,12 @@ describe YARD::Server::Router do
       @router.request = @request
       @router.parse_library_from_path(args.flatten)
     end
-    
+
     it "should parse library and version name out of path" do
       parse('project', '1.0.0').should == [@projects[0], []]
       @request.version_supplied.should be_true
     end
-    
+
     it "should parse library and use latest version if version is not supplied" do
       parse('project').should == [@projects[1], []]
       @request.version_supplied.should be_false
@@ -37,17 +37,17 @@ describe YARD::Server::Router do
       parse('project', 'notaversion').should == [@projects[1], ['notaversion']]
       @request.version_supplied.should be_false
     end
-    
+
     it "should return nil library if no library is found" do
       parse('notproject').should == [nil, ['notproject']]
     end
-    
+
     it "should not parse library or version if single_library == true" do
       @adapter.stub!(:options).and_return(:single_library => true)
       parse('notproject').should == [@projects[0], ['notproject']]
     end
   end
-  
+
   describe '#route' do
     def route_to(route, command, *args)
       req = mock_request(route)
@@ -60,56 +60,56 @@ describe YARD::Server::Router do
       end
       router.call(req)
     end
-    
+
     it "should route /docs/OBJECT to object if single_library = true" do
       @adapter.stub!(:options).and_return(:single_library => true)
       route_to('/mydocs/foo/FOO', DisplayObjectCommand)
     end
-    
+
     it "should route /docs" do
       route_to('/mydocs/foo', LibraryIndexCommand)
     end
-    
+
     it "should route /docs as index for library if single_library == true" do
       @adapter.stub!(:options).and_return(:single_library => true)
       route_to('/mydocs/foo/', DisplayObjectCommand)
     end
-    
+
     it "should route /docs/name/version" do
       route_to('/mydocs/foo/project/1.0.0', DisplayObjectCommand)
       @command.library.should == @projects[0]
     end
-    
+
     it "should route /docs/name/ to latest version of library" do
       route_to('/mydocs/foo/project', DisplayObjectCommand)
       @command.library.should == @projects[1]
     end
-    
+
     it "should route /list/name/version/class" do
-      route_to('/mylist/foo/project/1.0.0/class', ListClassesCommand)
+      route_to('/mylist/foo/project/1.0.0/class', ListCommand)
       @command.library.should == @projects[0]
     end
 
     it "should route /list/name/version/methods" do
-      route_to('/mylist/foo/project/1.0.0/methods', ListMethodsCommand)
+      route_to('/mylist/foo/project/1.0.0/methods', ListCommand)
       @command.library.should == @projects[0]
     end
 
     it "should route /list/name/version/files" do
-      route_to('/mylist/foo/project/1.0.0/files', ListFilesCommand)
+      route_to('/mylist/foo/project/1.0.0/files', ListCommand)
       @command.library.should == @projects[0]
     end
-    
+
     it "should route /list/name to latest version of library" do
-      route_to('/mylist/foo/project/class', ListClassesCommand)
+      route_to('/mylist/foo/project/class', ListCommand)
       @command.library.should == @projects[1]
     end
-    
+
     it "should route /search/name/version" do
       route_to('/mysearch/foo/project/1.0.0', SearchCommand)
       @command.library.should == @projects[0]
     end
-    
+
     it "should route /search/name to latest version of library" do
       route_to('/mysearch/foo/project', SearchCommand)
       @command.library.should == @projects[1]

data/spec/server/static_caching_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe YARD::Server::StaticCaching do
   include StaticCaching
-  
+
   describe '#check_static_cache' do
     def adapter; @adapter ||= mock_adapter end
     def request; @request ||= OpenStruct.new end
@@ -11,7 +11,7 @@ describe YARD::Server::StaticCaching do
       adapter.document_root = nil
       check_static_cache.should be_nil
     end
-    
+
     it "should read a file from document root if path matches file on system" do
       request.path = '/hello/world.html'
       File.should_receive(:file?).with('/public/hello/world.html').and_return(true)
@@ -20,7 +20,7 @@ describe YARD::Server::StaticCaching do
       s.should == 200
       b.should == ["body"]
     end
-    
+
     it "should read a file if path matches file on system + .html" do
       request.path = '/hello/world'
       File.should_receive(:file?).with('/public/hello/world.html').and_return(true)
@@ -29,7 +29,7 @@ describe YARD::Server::StaticCaching do
       s.should == 200
       b.should == ["body"]
     end
-    
+
     it "should return nil if no matching file is found" do
       request.path = '/hello/foo'
       File.should_receive(:file?).with('/public/hello/foo.html').and_return(false)