yard 0.6.8 → 0.7.0

data/spec/templates/examples/module001.txt

@@ -16,7 +16,7 @@ Defined Under Namespace:
 Includes:
 ---------
 
-    A::B::C, F, E, D, B
+    A::B::C, F, E, D, B, BaseMod
 
 
 Class methods:

data/spec/templates/helpers/base_helper_spec.rb

@@ -79,7 +79,7 @@ describe YARD::Templates::Helpers::BaseHelper do
     end
     
     it "should call #link_file for file: links" do
-      should_receive(:link_file).with('Filename', 'Filename', 'anchor')
+      should_receive(:link_file).with('Filename', nil, 'anchor')
       linkify("file:Filename#anchor")
     end
     
@@ -112,9 +112,14 @@ describe YARD::Templates::Helpers::BaseHelper do
       linkify('include:file:path/to/file').should == 'FOO'
     end
     
+    it "should not allow include:file for path above pwd" do
+      log.should_receive(:warn).with("Cannot include file from path `a/b/../../../../file'")
+      linkify('include:file:a/b/../../../../file').should == ''
+    end
+    
     it "should warn if include:file:path does not exist" do
       log.should_receive(:warn).with(/Cannot find file .+ for inclusion/)
-      linkify('include:file:/notexist').should == ''
+      linkify('include:file:notexist').should == ''
     end
   end
   

data/spec/templates/helpers/html_helper_spec.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 require File.dirname(__FILE__) + "/shared_signature_examples"
+require 'ostruct'
 
 describe YARD::Templates::Helpers::HtmlHelper do
   include YARD::Templates::Helpers::BaseHelper
@@ -29,6 +30,16 @@ describe YARD::Templates::Helpers::HtmlHelper do
       end
     end
     
+    it "should take file encoding if there is a file" do
+      @file = OpenStruct.new(:contents => 'foo'.force_encoding('sjis'))
+      charset.should == 'Shift_JIS' # not the correct charset name, but good enough
+    end if RUBY19
+
+    it "should take file encoding if there is a file" do
+      @file = OpenStruct.new(:contents => 'foo')
+      charset.should == 'utf-8'
+    end if RUBY18
+    
     if RUBY18
       it "should return utf-8 if no LANG env is set" do
         ENV.should_receive(:[]).with('LANG').and_return(nil)
@@ -93,6 +104,23 @@ describe YARD::Templates::Helpers::HtmlHelper do
     it "should return regular text with :none markup" do
       htmlify("fo\no\n\nbar<>", :none).should == "fo\no<br/>bar&lt;&gt;"
     end
+    
+    it "should highlight ruby if markup is :ruby" do
+      htmlify("class Foo; end", :ruby).should =~ /\A<pre class="code"><span/
+    end
+    
+    it "should include file and htmlify it" do
+      File.should_receive(:file?).with('foo.rdoc').and_return(true)
+      File.should_receive(:read).with('foo.rdoc').and_return('= HI')
+      htmlify("{include:file:foo.rdoc}", :rdoc).gsub(/\s+/, '').should == "<p><h1>HI</h1></p>"
+    end
+    
+    it "should autolink URLs (markdown specific)" do
+      log.enter_level(Logger::FATAL) do
+        pending 'This test depends on markdown' unless markup_class(:markdown)
+      end
+      htmlify('http://example.com', :markdown).should include('<a href="http://example.com"')
+    end
   end
   
   describe "#link_object" do
@@ -207,14 +235,20 @@ describe YARD::Templates::Helpers::HtmlHelper do
       end
       results
     end
+    
+    it "should escape {} syntax with backslash (\\{foo bar})" do
+      input  = '\{foo bar} \{XYZ} \{file:FOO}'
+      output = '{foo bar} {XYZ} {file:FOO}'
+      resolve_links(input).should == output
+    end
 
     it "should link static files with file: prefix" do
       stub!(:serializer).and_return Serializers::FileSystemSerializer.new
       stub!(:object).and_return Registry.root
 
       parse_link(resolve_links("{file:TEST.txt#abc}")).should == {
-        :inner_text => "TEST.txt",
-        :title => "TEST.txt",
+        :inner_text => "TEST",
+        :title => "TEST",
         :href => "file.TEST.html#abc"
       }
       parse_link(resolve_links("{file:TEST.txt title}")).should == {
@@ -258,6 +292,11 @@ describe YARD::Templates::Helpers::HtmlHelper do
       resolve_links("{|x|x == 1}").should == "{|x|x == 1}"
     end
     
+    it "should gracefully ignore {} in links" do
+      should_receive(:linkify).with('Foo', 'Foo').and_return('FOO')
+      resolve_links("{} {} {Foo Foo}").should == '{} {} FOO'
+    end
+    
     %w(tt code pre).each do |tag|
       it "should ignore links in <#{tag}>" do
         text = "<#{tag}>{Foo}</#{tag}>"
@@ -266,12 +305,12 @@ describe YARD::Templates::Helpers::HtmlHelper do
     end
 
     it "should resolve {Name}" do
-      should_receive(:link_file).with('TEST', 'TEST', nil).and_return('')
+      should_receive(:link_file).with('TEST', nil, nil).and_return('')
       resolve_links("{file:TEST}")
     end
 
     it "should resolve ({Name})" do
-      should_receive(:link_file).with('TEST', 'TEST', nil).and_return('')
+      should_receive(:link_file).with('TEST', nil, nil).and_return('')
       resolve_links("({file:TEST})")
     end
     
@@ -321,7 +360,7 @@ describe YARD::Templates::Helpers::HtmlHelper do
     end
     
     it "should warn about missing reference for file template (no object)" do
-      @file = "myfile.txt"
+      @file = CodeObjects::ExtraFileObject.new('myfile.txt', '')
       logger = mock(:log)
       logger.should_receive(:warn).ordered.with("In file `myfile.txt':3: Cannot resolve link to InvalidObject from text:")
       logger.should_receive(:warn).ordered.with("...{InvalidObject Some Title}")
@@ -414,6 +453,11 @@ describe YARD::Templates::Helpers::HtmlHelper do
       should_not_receive(:html_syntax_highlight_NAME)
       html_syntax_highlight("!!!NAME\ndef x; end").should == "def x; end"
     end
+    
+    it "should highlight as ruby if htmlify(text, :ruby) is called" do
+      should_receive(:html_syntax_highlight_ruby).with('def x; end').and_return('x')
+      htmlify('def x; end', :ruby).should == '<pre class="code">x</pre>'
+    end
   end
   
   describe '#link_url' do

data/spec/templates/helpers/markup_helper_spec.rb

@@ -46,30 +46,31 @@ describe YARD::Templates::Helpers::MarkupHelper do
     end
   
     it "should search through available markup providers for the markup type if none is set" do
-      @gen.should_receive(:eval).with('::BlueCloth').and_return(mock(:bluecloth))
-      @gen.should_receive(:require).with('bluecloth').and_return(true)
+      @gen.should_receive(:eval).with('::RDiscount').and_return(mock(:bluecloth))
+      @gen.should_receive(:require).with('rdiscount').and_return(true)
       @gen.should_not_receive(:require).with('maruku')
       @gen.stub!(:options).and_return({:markup => :markdown})
       # this only raises an exception because we mock out require to avoid 
       # loading any libraries but our implementation tries to return the library 
       # name as a constant
       @gen.load_markup_provider.should == true
-      @gen.markup_provider.should == :bluecloth
+      @gen.markup_provider.should == :rdiscount
     end
   
     it "should continue searching if some of the providers are unavailable" do
-      @gen.should_receive(:require).with('bluecloth').and_raise(LoadError)
+      @gen.should_receive(:require).with('rdiscount').and_raise(LoadError)
       @gen.should_receive(:require).with('kramdown').and_raise(LoadError)
+      @gen.should_receive(:require).with('bluecloth').and_raise(LoadError)
       @gen.should_receive(:require).with('maruku').and_raise(LoadError)
-      @gen.should_receive(:require).with('rpeg-markdown').and_raise(LoadError)
-      @gen.should_receive(:require).with('rdiscount').and_return(true)
-      @gen.should_receive(:eval).with('::RDiscount').and_return(true)
+      @gen.should_receive(:require).with('redcarpet').and_raise(LoadError)
+      @gen.should_receive(:require).with('rpeg-markdown').and_return(true)
+      @gen.should_receive(:eval).with('::PEGMarkdown').and_return(true)
       @gen.stub!(:options).and_return({:markup => :markdown})
       # this only raises an exception because we mock out require to avoid 
       # loading any libraries but our implementation tries to return the library 
       # name as a constant
       @gen.load_markup_provider.should rescue nil
-      @gen.markup_provider.should == :rdiscount
+      @gen.markup_provider.should == :"rpeg-markdown"
     end
   
     it "should override the search if `:markup_provider` is set in options" do

data/spec/templates/module_spec.rb

@@ -11,8 +11,15 @@ describe YARD::Templates::Engine.template(:default, :module) do
         def e; end
       end
 
+      module BaseMod
+        attr_reader :base_attr1
+        attr_writer :base_attr2
+        attr_accessor :base_attr3
+      end
+
       # Comments
       module A
+        include BaseMod
         attr_accessor :attr1
         attr_reader :attr2
         

data/spec/templates/onefile_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class StringSerializer < YARD::Serializers::Base
+  attr_accessor :files, :string
+  def initialize(files, string)
+    @files = files
+    @string = string
+  end
+  
+  def serialize(object, data)
+    files << object
+    string << data
+  end
+end
+
+describe YARD::Templates::Engine.template(:default, :onefile) do
+  before { Registry.clear }
+
+  it "should render html" do
+    files = []
+    string = ''
+    YARD.parse_string <<-eof
+      class A
+        # Foo method
+        # @return [String]
+        def foo; end
+        
+        # Bar method
+        # @return [Numeric]
+        def bar; end
+      end
+    eof
+    Templates::Engine.generate Registry.all(:class), 
+      :serializer => StringSerializer.new(files, string),
+      :onefile => true, :format => :html, :files => [
+        CodeObjects::ExtraFileObject.new('README', 
+          "# This is a code comment\n\n# Top of file\n\n\nclass C; end"),
+        CodeObjects::ExtraFileObject.new('LICENSE', 'This is a license!')
+      ]
+    files.should == ['index.html']
+    string.should include("This is a code comment")
+    string.should include("This is a license!")
+    string.should include("Class: A")
+    string.should include("Foo method")
+    string.should include("Bar method")
+  end
+end

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

@@ -70,23 +70,25 @@ p.inherited {
   margin-left: 25px;
 }
 
-dl.box {
+#filecontents dl.box, dl.box {
+  border: 0;
   width: 520px;
   font-size: 1em;
 }
-dl.box dt {
+#filecontents dl.box dt, dl.box dt {
   float: left;
   display: block;
   width: 100px;
   margin: 0;
   text-align: right;
   font-weight: bold;
+  background: transparent;
   border: 1px solid #aaa;
   border-width: 1px 0px 0px 1px;
   padding: 6px 0;
   padding-right: 10px;
 }
-dl.box dd {
+#filecontents dl.box dd, dl.box dd {
   float: left;
   display: block;
   width: 380px;
@@ -96,10 +98,10 @@ dl.box dd {
   border: 1px solid #aaa;
   border-width: 1px 1px 0 0;
 }
-dl.box .last {
+#filecontents dl.box .last, dl.box .last {
   border-bottom: 1px solid #aaa;
 }
-dl.box .r1 { background: #eee; }
+#filecontents dl.box .r1, dl.box .r1 { background: #eee; }
 
 ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
 #files { padding-left: 15px; font-size: 1.1em; }

data/templates/default/fulldoc/html/full_list.erb

@@ -2,11 +2,15 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html>
   <head>
-    <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
-    <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
-    <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
-    <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-    <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
+    <% stylesheets_full_list.each do |stylesheet| %>
+      <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" media="screen" charset="utf-8" />
+    <% end %>
+    
+    <% javascripts_full_list.each do |javascript| %>
+      <script type="text/javascript" charset="utf-8" src="<%= url_for(javascript) %>"></script>
+    <% end %>
+    
     <base id="base_target" target="_parent" />
   </head>
   <body>
@@ -19,16 +23,15 @@
     <div id="content">
       <h1 id="full_list_header"><%= @list_title %></h1>
       <div id="nav">
-        <a target="_self" href="class_list.html">Classes</a> | 
-        <a target="_self" href="method_list.html">Methods</a> |
-        <a target="_self" href="file_list.html">Files</a>
+        <% menu_lists.each do |list| %>
+          <a target="_self" href="<%= list[:type] %>_list.html"><%= list[:title] %></a>
+        <% end %>
       </div>
       <div id="search">Search: <input type="text" /></div>
 
-      <ul id="full_list" class="<%= @list_type %>">
+      <ul id="full_list" class="<%= @list_class || @list_type %>">
         <%= erb "full_list_#{@list_type}" %>
       </ul>
     </div>
   </body>
 </html>
-

data/templates/default/fulldoc/html/full_list_files.erb

@@ -1,5 +1,5 @@
 <% n = 1 %>
 <% @items.each do |item| %>
-  <li class="r<%= n %>"><%= link_file item, File.basename(item).gsub(/\.[^.]+$/, '') %></li>
+  <li class="r<%= n %>"><%= link_file item %></li>
   <% n = n == 2 ? 1 : 2 %>
 <% end %>

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

@@ -23,7 +23,7 @@ function createDefineLinks() {
     function() {
         $(this).prev().hide();
         $(this).parent().prev().height(tHeight);
-        $(this).text("more...")
+        $(this).text("more...");
     });
 }
 
@@ -38,7 +38,7 @@ function createFullTreeLinks() {
     function() {
         $(this).parent().toggleClass('showAll');
         $(this).parent().prev().height(tHeight);
-        $(this).text("show all")
+        $(this).text("show all");
     });
 }
 
@@ -93,13 +93,14 @@ function keyboardShortcuts() {
   if (window.top.frames.main) return;
   $(document).keypress(function(evt) {
     if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
-    if (typeof evt.orignalTarget !== "undefined" &&  
-        (evt.originalTarget.nodeName == "INPUT" || 
-        evt.originalTarget.nodeName == "TEXTAREA")) return;
+    if (typeof evt.target !== "undefined" &&
+        (evt.target.nodeName == "INPUT" ||
+        evt.target.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'
       case 70: case 102: $('#file_list_link').click(); break;   // 'f'
+      default: break;
     }
   });
 }
@@ -139,31 +140,32 @@ function fixOutsideWorldLinks() {
 }
 
 function generateTOC() {
-  if ($('#filecontents').length == 0) return;
+  if ($('#filecontents').length === 0) return;
   var _toc = $('<ol class="top"></ol>');
   var show = false;
   var toc = _toc;
   var counter = 0;
   var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
+  var i;
   if ($('#filecontents h1').length > 1) tags.unshift('h1');
-  for (i in tags) { tags[i] = '#filecontents ' + tags[i] }
-  var lastTag = parseInt(tags[0][1]);
+  for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
+  var lastTag = parseInt(tags[0][1], 10);
   $(tags.join(', ')).each(function() {
     if (this.id == "filecontents") return;
     show = true;
-    var thisTag = parseInt(this.tagName[1]);
-    if (this.id.length == 0) {
+    var thisTag = parseInt(this.tagName[1], 10);
+    if (this.id.length === 0) {
       var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
-      if ($('#' + proposedId).length > 0) proposedId += counter++;
+      if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
       this.id = proposedId;
     }
     if (thisTag > lastTag) { 
-      for (var i = 0; i < thisTag - lastTag; i++) { 
+      for (i = 0; i < thisTag - lastTag; i++) { 
         var tmp = $('<ol/>'); toc.append(tmp); toc = tmp; 
       } 
     }
     if (thisTag < lastTag) { 
-      for (var i = 0; i < lastTag - thisTag; i++) toc = toc.parent(); 
+      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent(); 
     }
     toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
     lastTag = thisTag;
@@ -185,7 +187,7 @@ function generateTOC() {
     $(this).text('float');
     $('#toc').toggleClass('nofloat');
   }, function() {
-    $(this).text('left')
+    $(this).text('left');
     $('#toc').toggleClass('nofloat');
   });
 }

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

@@ -13,7 +13,7 @@ function fullListSearch() {
   
   $('#search input').keyup(function() {
     searchString = this.value.toLowerCase();
-    if (searchString == "") {
+    if (searchString === "") {
       clearTimeout(inSearch);
       inSearch = null;
       $('#full_list, #content').removeClass('insearch');
@@ -40,7 +40,7 @@ function fullListSearch() {
   });
   
   $('#search input').focus();
-  $('#full_list').after("<div id='noresults'></div>")
+  $('#full_list').after("<div id='noresults'></div>");
 }
 
 var lastRowClass = '';
@@ -59,8 +59,9 @@ function searchItem() {
         '<strong>$1</strong>'));
     }
 
-    if (searchCache.length == searchIndex + 1) {
-      return searchDone();
+    if (searchCache.length === searchIndex + 1) {
+      searchDone();
+      return;
     }
     else {
       searchIndex++;
@@ -71,7 +72,7 @@ function searchItem() {
 
 function searchDone() {
   highlight(true);
-  if ($('#full_list li:visible').size() == 0) {
+  if ($('#full_list li:visible').size() === 0) {
     $('#noresults').text('No results were found.').hide().fadeIn();
   }
   else {
@@ -137,7 +138,7 @@ function escapeShortcut() {
   $(document).keydown(function(evt) {
     if (evt.which == 27) {
       $('#search_frame', window.top.document).slideUp(100);
-      $('#search a', window.top.document).removeClass('active inactive')
+      $('#search a', window.top.document).removeClass('active inactive');
       $(window.top).focus();
     }
   });