yard 0.6.3 → 0.6.4

data/lib/yard/server/static_caching.rb

@@ -1,6 +1,35 @@
 module YARD
   module Server
+    # Implements static caching for requests.
+    # 
+    # @see Router Router documentation for "Caching"
     module StaticCaching
+      # Called by a router to return the cached object. By default, this
+      # method performs disk-based caching. To perform other forms of caching,
+      # implement your own +#check_static_cache+ method and mix the module into
+      # the Router class.
+      # 
+      # Note that caching does not occur here. This method simply checks for
+      # the existence of cached data. To actually cache a response, see
+      # {Commands::Base#cache}.
+      # 
+      # @example Implementing In-Memory Cache Checking
+      #   module MemoryCaching
+      #     def check_static_cache
+      #       # $memory_cache is filled by {Commands::Base#cache}
+      #       cached_data = $memory_cache[request.path]
+      #       if cached_data 
+      #         [200, {'Content-Type' => 'text/html'}, [cached_data]]
+      #       else
+      #         nil
+      #       end
+      #     end
+      #   end
+      # 
+      #   class YARD::Server::Router; include MemoryCaching; end
+      # @return [Array(Number,Hash,Array)] the Rack-style response
+      # @return [nil] if no cache is available and routing should continue
+      # @see Commands::Base#cache
       def check_static_cache
         return nil unless adapter.document_root
         cache_path = File.join(adapter.document_root, request.path.sub(/\.html$/, '') + '.html')

data/lib/yard/server/webrick_adapter.rb

@@ -2,7 +2,10 @@ require 'webrick'
 
 module YARD
   module Server
+    # The main adapter to initialize a WEBrick server.
     class WebrickAdapter < Adapter
+      # Initializes a WEBrick server. If {Adapter#server_options} contains a
+      # +:daemonize+ key set to true, the server will be daemonized.
       def start
         server_options[:ServerType] = WEBrick::Daemon if server_options[:daemonize]
         server = WEBrick::HTTPServer.new(server_options)
@@ -12,6 +15,7 @@ module YARD
       end
     end
 
+    # The main WEBrick servlet implementation, accepting only GET requests.
     class WebrickServlet < WEBrick::HTTPServlet::AbstractServlet
       attr_accessor :adapter
       

data/lib/yard/templates/engine.rb

@@ -2,7 +2,7 @@ require 'ostruct'
 
 module YARD
   module Templates
-    # This module manages all creation, handling and rendering of {Engine::Template} 
+    # This module manages all creation, handling and rendering of {Template} 
     # objects. 
     # 
     # * To create a template object at a path, use {template}. 

data/lib/yard/templates/helpers/markup_helper.rb

@@ -4,6 +4,22 @@ module YARD
   module Templates::Helpers
     # Helper methods for loading and managing markup types.
     module MarkupHelper
+      class << self
+        # Clears the markup provider cache information. Mainly used for testing.
+        # @return [void]
+        def clear_markup_cache
+          self.markup_cache = {}
+        end
+        
+        # @return [Hash{Symbol=>{(:provider,:class)=>Object}}] the cached markup providers
+        # @private
+        # @since 0.6.4
+        attr_accessor :markup_cache
+      end
+      
+      MarkupHelper.clear_markup_cache
+      
+      # The default list of markup providers for each markup type
       MARKUP_PROVIDERS = {
         :markdown => [
           {:lib => :bluecloth, :const => 'BlueCloth'},
@@ -61,9 +77,8 @@ module YARD
       # 
       # @return [Boolean] whether the markup provider was successfully loaded.
       def load_markup_provider(type = options[:markup])
-        return true if type == :rdoc || (@markup_cache && @markup_cache[type])
-        @markup_cache ||= {}
-        @markup_cache[type] ||= {}
+        return true if type == :rdoc || MarkupHelper.markup_cache[type]
+        MarkupHelper.markup_cache[type] ||= {}
         
         providers = MARKUP_PROVIDERS[type]
         return true if providers && providers.empty?
@@ -79,8 +94,8 @@ module YARD
         # Search for provider, return the library class name as const if found
         providers.each do |provider|
           begin require provider[:lib].to_s; rescue LoadError; next end
-          @markup_cache[type][:provider] = provider[:lib] # Cache the provider
-          @markup_cache[type][:class] = eval(provider[:const])
+          MarkupHelper.markup_cache[type][:provider] = provider[:lib] # Cache the provider
+          MarkupHelper.markup_cache[type][:class] = eval("::" + provider[:const])
           return true
         end
         
@@ -130,7 +145,7 @@ module YARD
       # @param [Symbol] the markup type (:rdoc, :markdown, etc.)
       # @return [Class] the markup class
       def markup_class(type = options[:markup])
-        type == :rdoc ? SimpleMarkup : @markup_cache[type][:class]
+        type == :rdoc ? SimpleMarkup : MarkupHelper.markup_cache[type][:class]
       end
       
       # Gets the markup provider name for a markup type
@@ -139,7 +154,7 @@ module YARD
       # @param [Symbol] the markup type (:rdoc, :markdown, etc.)
       # @return [Symbol] the markup provider name (usually the gem name of the library)
       def markup_provider(type = options[:markup])
-        type == :rdoc ? nil : @markup_cache[type][:provider]
+        type == :rdoc ? nil : MarkupHelper.markup_cache[type][:provider]
       end
     end
   end

data/spec/cli/diff_spec.rb

@@ -31,8 +31,8 @@ describe YARD::CLI::Diff do
       @diff.should_receive(:load_gem_data).ordered.with('gem2').and_return(true)
       Registry.should_receive(:all).ordered.and_return(@objects1.map {|o| P(o) })
       Registry.should_receive(:all).ordered.and_return(@objects2.map {|o| P(o) })
-      @diff.stub!(:print).with {|data| @data << data }
-      @diff.stub!(:puts).with {|*args| @data << args.join("\n"); @data << "\n" }
+      @diff.stub!(:print) {|data| @data << data }
+      @diff.stub!(:puts) {|*args| @data << args.join("\n"); @data << "\n" }
       @diff.run(*(args + ['gem1', 'gem2']))
     end
 

data/spec/cli/stats_spec.rb

@@ -28,7 +28,7 @@ describe YARD::CLI::Stats do
     @stats = CLI::Stats.new(false)
     @stats.stub!(:support_rdoc_document_file!).and_return([])
     @stats.stub!(:yardopts).and_return([])
-    @stats.stub!(:puts).with {|*args| @output << args.join("\n") << "\n" }
+    @stats.stub!(:puts) {|*args| @output << args.join("\n") << "\n" }
   end
   
   it "should list undocumented objects with --list-undoc" do

data/spec/cli/yardoc_spec.rb

@@ -446,7 +446,7 @@ describe YARD::CLI::Yardoc do
       visible_tags = []
       Tags::Library.stub!(:define_tag)
       Tags::Library.stub!(:visible_tags).and_return([:foo])
-      Tags::Library.stub!(:visible_tags=).with {|value| visible_tags = value }
+      Tags::Library.stub!(:visible_tags=) {|value| visible_tags = value }
       @yardoc.parse_arguments('--tag', 'foo', '--tag', 'foo')
       visible_tags.should == [:foo]
     end

data/spec/cli/yri_spec.rb

@@ -63,4 +63,25 @@ describe YARD::CLI::Yardoc do
       YARD::CLI::YRI::DEFAULT_SEARCH_PATHS.replace([])
     end
   end
+  
+  describe '#run' do
+    it "should search for objects and print their documentation" do
+      obj = YARD::CodeObjects::ClassObject.new(:root, 'Foo')
+      @yri.should_receive(:print_object).with(obj)
+      @yri.run('Foo')
+      Registry.clear
+    end
+    
+    it "should print usage if no object is provided" do
+      @yri.should_receive(:print_usage)
+      @yri.should_receive(:exit).with(1)
+      @yri.run('')
+    end
+    
+    it "should print no documentation exists for object if object is not found" do
+      STDERR.should_receive(:puts).with("No documentation for `Foo'")
+      @yri.should_receive(:exit).with(1)
+      @yri.run('Foo')
+    end
+  end
 end

data/spec/handlers/class_handler_spec.rb

@@ -57,6 +57,7 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassHandler" do
   
   it "should handle a superclass of the same name in the form ::ClassName" do
     P('Q::Logger').superclass.should == P(:Logger)
+    P('Q::Foo').superclass.should_not == P('Q::Logger')
   end
   
   ["CallMethod('test')", "VSD^#}}", 'not.aclass', 'self'].each do |klass|

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

@@ -65,6 +65,7 @@ end
 
 module Q
   class Logger < ::Logger; end
+  class Foo < ::Logger; end
 end
 
 class << Symbol

data/spec/parser/ruby/legacy/statement_list_spec.rb

@@ -281,4 +281,10 @@ eof
     s = stmt("alias do x if 2 ==\n 2")
     s.tokens.to_s.should == "alias do x if 2 ==\n 2"
   end
+  
+  it "should convert heredoc to string" do
+    src = "<<-XML\n  foo\n\nXML"
+    s = stmt(src)
+    s.source.should == '"foo\n\n"'
+  end
 end

data/spec/parser/ruby/ruby_parser_spec.rb

@@ -10,6 +10,10 @@ if RUBY19
       YARD::Parser::Ruby::RubyParser.new(stmts, nil).parse.root
     end
     
+    def tokenize(stmt)
+      YARD::Parser::Ruby::RubyParser.new(stmt, nil).parse.tokens
+    end
+    
     describe '#parse' do
       it "should get comment line numbers" do
         s = stmt <<-eof
@@ -166,6 +170,31 @@ if RUBY19
       it "should show proper source for assignment" do
         stmt("A=1").jump(:assign).source.should == "A=1"
       end
+      
+      it "should show proper source for a top_const_ref" do
+        s = stmt("::\nFoo::Bar")
+        s.jump(:top_const_ref).source.should == "::\nFoo"
+        s.should be_ref
+        s.jump(:top_const_ref).should be_ref
+        s.source.should == "::\nFoo::Bar"
+        s.line_range.to_a.should == [1, 2]
+      end
+      
+      it "should show proper source for heredoc" do
+        src = "def foo\n  foo(<<-XML, 1, 2)\n    bar\n\n  XML\nend"
+        s = stmt(src)
+        t = tokenize(src)
+        s.source.should == src
+        t.map {|x| x[1] }.join.should == src
+      end
+      
+      it "should show proper source for string" do
+        ["'", '"'].each do |q|
+          src = "#{q}hello\n\nworld#{q}"
+          s = stmt(src)
+          s.source.should == src
+        end
+      end
     end
   end
 end

data/spec/server/rack_adapter_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe "YARD::Server::RackMiddleware" do
+  before do
+    begin; require 'rack'; rescue LoadError; pending "rack required for these tests" end
+    @superapp = mock(:superapp)
+    @app = YARD::Server::RackMiddleware.new(@superapp, :libraries => {'foo' => [LibraryVersion.new('foo', nil)]})
+  end
+  
+  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']
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
 require "rubygems"
-require "spec"
+begin
+  require "rspec"
+rescue LoadError
+  require "spec"
+end
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'yard'))
 
@@ -74,4 +78,4 @@ def docspec(objname = self.class.description, klass = self.class.described_type)
   end
 end
 
-include YARD
+include YARD

data/spec/templates/engine_spec.rb

@@ -78,9 +78,12 @@ describe YARD::Templates::Engine do
     end
   
     before(:all) do 
+      @object = CodeObjects::MethodObject.new(:root, :method)
+    end
+    
+    before do
       @template = mock(:template)
       @template.stub!(:include)
-      @object = CodeObjects::MethodObject.new(:root, :method)
     end
   
     it "should accept method call with no parameters" do

data/spec/templates/helpers/html_helper_spec.rb

@@ -5,6 +5,8 @@ describe YARD::Templates::Helpers::HtmlHelper do
   include YARD::Templates::Helpers::BaseHelper
   include YARD::Templates::Helpers::HtmlHelper
   include YARD::Templates::Helpers::MethodHelper
+  
+  def options; {} end
 
   describe '#h' do
     it "should use #h to escape HTML" do
@@ -357,6 +359,12 @@ describe YARD::Templates::Helpers::HtmlHelper do
       stub!(:object).and_return(Registry.root)
     end
     
+    def fix_rspec2_mock_teardown
+      return unless defined?(RSpec)
+      should_receive(:respond_to?).with(:teardown_mocks_for_rspec).and_return(false)
+      should_receive(:respond_to?).with(:verify_mocks_for_rspec).and_return(false)
+    end
+    
     it "should return empty string on nil input" do
       html_syntax_highlight(nil).should == ''
     end
@@ -369,12 +377,14 @@ describe YARD::Templates::Helpers::HtmlHelper do
     
     it "should call #html_syntax_highlight_NAME if there's an object with a #source_type" do
       Registry.root.source_type = :NAME
+      fix_rspec2_mock_teardown
       should_receive(:respond_to?).with('html_syntax_highlight_NAME').and_return(true)
       should_receive(:html_syntax_highlight_NAME).and_return("foobar")
       html_syntax_highlight('def x; end').should == 'foobar'
     end
 
     it "should call html_syntax_highlight_NAME if source starts with !!!NAME" do
+      fix_rspec2_mock_teardown
       should_receive(:respond_to?).with('html_syntax_highlight_NAME').and_return(true)
       should_receive(:html_syntax_highlight_NAME).and_return("foobar")
       html_syntax_highlight(<<-eof
@@ -391,6 +401,7 @@ describe YARD::Templates::Helpers::HtmlHelper do
     end
     
     it "should not highlight if there is no highlight method specified by !!!NAME" do
+      fix_rspec2_mock_teardown
       should_receive(:respond_to?).with('html_syntax_highlight_NAME').and_return(false)
       should_not_receive(:html_syntax_highlight_NAME)
       html_syntax_highlight("!!!NAME\ndef x; end").should == "def x; end"

data/spec/templates/helpers/markup_helper_spec.rb

@@ -4,21 +4,25 @@ module YARD::Templates::Helpers::MarkupHelper
   public :load_markup_provider, :markup_class, :markup_provider
 end
 
-class MyMock
+class GeneratorMock
   attr_accessor :options
   include YARD::Templates::Helpers::MarkupHelper
+  def initialize(options = {}) self.options = options end
 end
 
 describe YARD::Templates::Helpers::MarkupHelper do
+  before do
+    YARD::Templates::Helpers::MarkupHelper.clear_markup_cache
+  end
+  
   describe '#load_markup_provider' do
     before do
       log.stub!(:error)
-      @gen = mock('Generator')
-      @gen.extend(YARD::Templates::Helpers::MarkupHelper)
+      @gen = GeneratorMock.new
     end
   
     it "should exit on an invalid markup type" do
-      @gen.stub!(:options).and_return({:markup => :invalid})
+      @gen.options = {:markup => :invalid}
       @gen.load_markup_provider.should == false
     end
 
@@ -35,7 +39,7 @@ describe YARD::Templates::Helpers::MarkupHelper do
     end
   
     it "should search through available markup providers for the markup type if none is set" do
-      module YARD::Templates::Helpers::MarkupHelper::BlueCloth; end
+      @gen.should_receive(:eval).with('::BlueCloth').and_return(mock(:bluecloth))
       @gen.should_receive(:require).with('bluecloth').and_return(true)
       @gen.should_not_receive(:require).with('maruku')
       @gen.stub!(:options).and_return({:markup => :markdown})

data/spec/templates/module_spec.rb

@@ -76,7 +76,7 @@ describe YARD::Templates::Engine.template(:default, :module) do
   end
   
   it "should render dot format correctly" do
-    Registry.at('A').format(:format => :dot, :dependencies => true, :full => true).should == example(:module001, 'dot')
+    Registry.at('A').format(:format => :dot, :dependencies => true, :full => true).should == example_contents(:module001, 'dot')
   end
   
   it "should render groups correctly in html" do

data/spec/templates/spec_helper.rb

@@ -11,7 +11,7 @@ end
 
 def text_equals(result, expected_example)
   return if only_copy?(result, expected_example, :text)
-  text_equals_string(result, example(expected_example, :txt))
+  text_equals_string(result, example_contents(expected_example, :txt))
 end
 
 def text_equals_string(result, expected)
@@ -20,7 +20,7 @@ end
 
 def html_equals(result, expected_example)
   return if only_copy?(result, expected_example, :html)
-  html_equals_string(result, example(expected_example))
+  html_equals_string(result, example_contents(expected_example))
 end
 
 def html_equals_string(result, expected)
@@ -31,7 +31,7 @@ def html_equals_string(result, expected)
   text_equals_string(result, expected)
 end
 
-def example(filename, ext = 'html')
+def example_contents(filename, ext = 'html')
   File.read(File.join(File.dirname(__FILE__), 'examples', "#{filename}.#{ext}"))
 end
 

data/templates/default/fulldoc/html/css/style.css

@@ -168,7 +168,7 @@ ul.summary li { margin-bottom: 5px; }
   -moz-border-radius: 3px; -webkit-border-radius: 3px; 
 }
 .summary_signature:hover { background: #eeeeff; cursor: pointer; }
-ul.summary.compact li { display: inline; margin-right: 5px; line-height: 2.6em;}
+ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
 ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
 #content .summary_signature:hover a:link, 
 #content .summary_signature:hover a:visited {

data/templates/default/fulldoc/html/js/app.js

@@ -93,8 +93,9 @@ function keyboardShortcuts() {
   if (window.top.frames.main) return;
   $(document).keypress(function(evt) {
     if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
-    if (evt.originalTarget.nodeName == "INPUT" || 
-        evt.originalTarget.nodeName == "TEXTAREA") return;
+    if (typeof evt.orignalTarget !== "undefined" &&  
+        (evt.originalTarget.nodeName == "INPUT" || 
+        evt.originalTarget.nodeName == "TEXTAREA")) return;
     switch (evt.charCode) {
       case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
       case 77: case 109: $('#method_list_link').click(); break; // 'm'