yard 0.5.8 → 0.6.0

data/spec/templates/constant_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe YARD::Templates::Engine.template(:default, :constant) do
+  describe 'fully dressed constant' do
+    it "should render text format correctly" do
+      YARD.parse_string <<-'eof'
+        class YARD::CLI::YRI
+          # Default search paths that should be loaded dynamically into YRI. These paths
+          # take precedence over all other paths ({SEARCH_PATHS_FILE} and RubyGems
+          # paths). To add a path, call: 
+          # 
+          #   DEFAULT_SEARCH_PATHS.push("/path/to/.yardoc")
+          # 
+          # @return [Array<String>] a list of extra search paths
+          # @since 0.6.0
+          DEFAULT_SEARCH_PATHS = []
+        end
+      eof
+      text_equals(Registry.at('YARD::CLI::YRI::DEFAULT_SEARCH_PATHS').format, :constant001)
+    end
+  end
+  
+  describe 'simple constant with no documentation' do
+    it "should render text format correctly" do
+      # Short constant should show on single line
+      YARD.parse_string <<-'eof'
+        MYCONST = 'foo'
+      eof
+      text_equals(Registry.at('MYCONST').format, :constant002)
+
+      # Long constant should show on multiple lines, indented
+      YARD.parse_string <<-'eof'
+        MYCONST = [A, B, C, D, E, F, G, H, I, J, K, L,
+          M, N, O, P, Q, R, S, T, U, V, W,
+          X, Y, Z]
+      eof
+      text_equals(Registry.at('MYCONST').format, :constant003)
+    end
+  end
+end

data/spec/templates/engine_spec.rb

@@ -66,7 +66,7 @@ describe YARD::Templates::Engine do
   describe '.generate' do
     it "should generate with fulldoc template" do
       mod = mock(:template)
-      mod.should_receive(:run).with(:format => :text, :template => :default, :objects => [:a, :b, :c])
+      mod.should_receive(:run).with(:__globals => OpenStruct.new, :format => :text, :template => :default, :objects => [:a, :b, :c])
       Engine.should_receive(:template).with(:default, :fulldoc, :text).and_return(mod)
       Engine.generate([:a, :b, :c])
     end
@@ -85,7 +85,8 @@ describe YARD::Templates::Engine do
   
     it "should accept method call with no parameters" do
       loads_template(:default, :method, :text)
-      @template.should_receive(:run).with :type => :method,
+      @template.should_receive(:run).with :__globals => OpenStruct.new,
+                                          :type => :method,
                                           :template => :default,
                                           :format => :text,
                                           :object => @object
@@ -94,7 +95,8 @@ describe YARD::Templates::Engine do
   
     it "should allow template key to be changed" do
       loads_template(:javadoc, :method, :text)
-      @template.should_receive(:run).with :type => :method,
+      @template.should_receive(:run).with :__globals => OpenStruct.new,
+                                          :type => :method,
                                           :template => :javadoc,
                                           :format => :text,
                                           :object => @object
@@ -103,7 +105,8 @@ describe YARD::Templates::Engine do
 
     it "should allow type key to be changed" do
       loads_template(:default, :fulldoc, :text)
-      @template.should_receive(:run).with :type => :fulldoc,
+      @template.should_receive(:run).with :__globals => OpenStruct.new,
+                                          :type => :fulldoc,
                                           :template => :default,
                                           :format => :text,
                                           :object => @object
@@ -112,7 +115,8 @@ describe YARD::Templates::Engine do
   
     it "should allow format key to be changed" do
       loads_template(:default, :method, :html)
-      @template.should_receive(:run).with :type => :method,
+      @template.should_receive(:run).with :__globals => OpenStruct.new,
+                                          :type => :method,
                                           :template => :default,
                                           :format => :html,
                                           :object => @object

data/spec/templates/examples/class002.html

@@ -27,9 +27,7 @@
   
   
     <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">(stdin)<span class="defines">,<br />
-  (stdin),<br /> (stdin)</span>
-</dd>
+    <dd class="r2 last">(stdin)</dd>
   
 </dl>
 <div class="clear"></div>

data/spec/templates/examples/constant001.txt

@@ -0,0 +1,25 @@
+------------------------- Constant: YARD::CLI::YRI::DEFAULT_SEARCH_PATHS
+
+DEFAULT_SEARCH_PATHS = []
+
+------------------------------------------------------------------------
+
+    Default search paths that should be loaded dynamically into YRI.
+    These paths take precedence over all other paths
+    ({SEARCH_PATHS_FILE} and RubyGems paths). To add a path, call:  
+    
+      DEFAULT_SEARCH_PATHS.push("/path/to/.yardoc")
+
+Returns:
+--------
+
+    (Array<String>) - a list of extra search paths
+
+
+Since:
+------
+
+    0.6.0
+
+
+------------------------------------------------------------------------

data/spec/templates/examples/constant002.txt

@@ -0,0 +1,7 @@
+------------------------------------------------------ Constant: MYCONST
+
+MYCONST = 'foo'
+
+------------------------------------------------------------------------
+
+------------------------------------------------------------------------

data/spec/templates/examples/constant003.txt

@@ -0,0 +1,11 @@
+------------------------------------------------------ Constant: MYCONST
+
+MYCONST = 
+
+    [A, B, C, D, E, F, G, H, I, J, K, L,
+    M, N, O, P, Q, R, S, T, U, V, W,
+    X, Y, Z]
+
+------------------------------------------------------------------------
+
+------------------------------------------------------------------------

data/spec/templates/examples/module001.txt

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

data/spec/templates/examples/module002.html

@@ -0,0 +1,319 @@
+<h1>Module: A
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">(stdin)</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+  <h2>Foo <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="#foo_attr (instance method)">- <strong>foo_attr</strong> </a>
+    
+
+    
+  </span>
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>Returns the value of attribute foo_attr.</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+  
+    <h2>
+      Foo
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="bar (class method)">+ <strong>bar</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="#foo (instance method)">- <strong>foo</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+    <h2>
+      Bar
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="#baz (instance method)">- <strong>baz</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a  title="baz (class method)">+ <strong>baz</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="foo_attr=-instance_method"></span>
+      <span id="foo_attr-instance_method"></span>
+      <div class="method_details first">
+  <p class="signature first" id="foo_attr-instance_method">
+  
+    - <strong>foo_attr</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    Returns the value of attribute foo_attr
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+3
+4
+5</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 3</span>
+
+def foo_attr
+  @foo_attr
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="bar-class_method">
+  
+    + <strong>bar</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+5</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 5</span>
+
+def self.bar; end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="baz-class_method">
+  
+    + <strong>baz</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+12</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 12</span>
+
+def self.baz; end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="baz-instance_method">
+  
+    - <strong>baz</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+8</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 8</span>
+
+def baz; end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="foo-instance_method">
+  
+    - <strong>foo</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+4</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 4</span>
+
+def foo; end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>