yard 0.2.3.5 → 0.4.0

data/spec/templates/examples/module001.html

@@ -0,0 +1,294 @@
+<h1>Module: A 
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+      <dt class="r1">Includes:</dt>
+      <dd class="r1">B</dd>
+      
+    
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">(stdin)</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    Comments
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+   
+    
+      <strong class="modules">Modules:</strong> Z
+    
+   
+    
+      <strong class="classes">Classes:</strong> Q, X, Y
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="CONSTANT-constant ">CONSTANT =
+            <span class="summary_desc"></span>
+        </dt>
+        <dd><pre class="code">'value'</pre></dd>
+      
+        <dt id="cvar-classvariable ">@@cvar =
+            <span class="summary_desc"></span>
+        </dt>
+        <dd><pre class="code">'value'</pre></dd>
+      
+    </dl>
+  
+
+
+  
+  
+  
+  
+  <h2>Attribute Summary</h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature"><a  title="#attr1 (instance method)">- (Object) <strong>attr1</strong> </a>
+  
+  </span>
+  
+    
+    
+  
+  
+  
+  
+
+  
+    <span class="summary_desc">Returns the value of attribute +attr1+.</span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature"><a  title="#attr2 (instance method)">- (Object) <strong>attr2</strong> </a>
+  
+  </span>
+  
+    <span class="note title readonly">readonly</span>
+    
+  
+  
+  
+  
+
+  
+    <span class="summary_desc">Returns the value of attribute +attr2+.</span>
+  
+</li>
+
+    
+  </ul>
+
+
+  <h2>Method Summary</h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature"><a  title="a (class method)">+ (Object) <strong>a</strong> </a>
+  
+  </span>
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature"><a  title="#a (instance method)">- (Object) <strong>a</strong> </a>
+  
+    (also: #b)
+  
+  </span>
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"></span>
+  
+</li>
+
+    
+  </ul>
+
+
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods included from B</h3>
+  <p class="inherited">#c, #d</p>
+
+  <div id="attr_details">
+    <h2>Attribute Details</h2>
+    
+      
+      <span id="attr1=-instance_method"></span>
+      <span id="attr1-instance_method"></span>
+      <div class="method_details first">
+  <p class="signature first" id="attr1-instance_method">
+  
+    - (<tt>Object</tt>) <strong>attr1</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    Returns the value of attribute +attr1+
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 8</span>
+
+def attr1
+  @attr1
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <span id="attr2-instance_method"></span>
+      <div class="method_details ">
+  <p class="signature " id="attr2-instance_method">
+  
+    - (<tt>Object</tt>) <strong>attr2</strong>  <span class="extras">(readonly)</span>
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    Returns the value of attribute +attr2+
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 9</span>
+
+def attr2
+  @attr2
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+  <div id="method_details">
+    <h2>Method Details</h2>
+    
+      <div class="method_details first">
+  <p class="signature first" id="a-class_method">
+  
+    + (<tt>Object</tt>) <strong>a</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 11</span>
+
+def self.a; end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="a-instance_method">
+  
+    - (<tt>Object</tt>) <strong>a</strong> 
+  
+
+  
+    <span class="aliases">Also known as:
+    <span class="names">b</span>
+    </span>
+  
+</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 a; end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>

data/spec/templates/examples/module001.txt

@@ -0,0 +1,33 @@
+-------------------------------------------------------------- Module: A
+
+    Comments 
+
+
+
+------------------------------------------------------------------------
+
+Defined Under Namespace:
+------------------------
+
+    Z (modules)
+
+    Q, X, Y (classes)
+
+Includes:
+---------
+
+    B, D, E, F, A::B::C
+
+
+Class methods:
+--------------
+
+    a
+
+
+Instance methods:
+-----------------
+
+    a
+
+

data/spec/templates/examples/tag001.txt

@@ -0,0 +1,82 @@
+------------------------------------------------------------- Method: #m
+                                                   (Defined in: (stdin))
+
+    root.m(opts = {}) {|a| ... } -> String 
+------------------------------------------------------------------------
+
+    Deprecated. for great justice
+
+    Abstract. override me
+
+    Comments 
+
+Examples:
+---------
+
+    # Wash your car
+    car.wash
+
+    # To kill a mockingbird
+    a = String.new
+    flip(a.reverse)
+
+Parameters:
+-----------
+
+    (Hash) opts - the options
+
+Options Hash (opts):
+--------------------
+
+    (Object) :key - default: '' - hello
+
+    (Object) :key2 - default: X - hello
+
+Yields:
+-------
+
+    - a block
+
+Yield Parameters:
+-----------------
+
+    (String) a - a value
+
+Yield Returns:
+--------------
+
+    (Hash) - a hash
+
+Returns:
+--------
+
+    (String) - the result
+
+Raises:
+-------
+
+    (Exception) - Exception class
+
+See Also:
+---------
+
+    - A
+    - http://url.com
+    - http://url.com - Example
+
+Author:
+-------
+
+    Name
+
+Since:
+------
+
+    1.0
+
+Version:
+--------
+
+    1.0
+
+

data/spec/templates/helpers/base_helper_spec.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YARD::Templates::Helpers::BaseHelper do
+  include YARD::Templates::Helpers::BaseHelper
+  
+  describe '#run_verifier' do
+    it "should run verifier proc against list if provided" do
+      mock = mock(:verifier)
+      mock.should_receive(:call).with(1)
+      mock.should_receive(:call).with(2)
+      mock.should_receive(:call).with(3)
+      should_receive(:options).at_least(1).times.and_return(:verifier => mock)
+      run_verifier [1, 2, 3]      
+    end
+    
+    it "should prune list if lambda returns false and only false" do
+      mock = mock(:verifier)
+      should_receive(:options).at_least(1).times.and_return(:verifier => mock)
+      mock.should_receive(:call).with(1).and_return(false)
+      mock.should_receive(:call).with(2).and_return(true)
+      mock.should_receive(:call).with(3).and_return(nil)
+      mock.should_receive(:call).with(4).and_return("value")
+      run_verifier([1, 2, 3, 4]).should == [2, 3, 4]
+    end
+    
+    it "should return list if no verifier exists" do
+      should_receive(:options).at_least(1).times.and_return({})
+      run_verifier([1, 2, 3]).should == [1, 2, 3]
+    end
+  end
+  
+  describe '#h' do
+    it "should return just the text" do
+      h("hello world").should == "hello world"
+      h(nil).should == nil
+    end
+  end
+  
+  describe '#link_object' do
+    it "should return the title if provided" do
+      link_object(1, "title").should == "title"
+      link_object(Registry.root, "title").should == "title"
+    end
+    
+    it "should return a path if argument is a Proxy or object" do
+      link_object(Registry.root).should == ""
+      link_object(P("Array")).should == "Array"
+    end
+    
+    it "should should return path of Proxified object if argument is a String or Symbol" do
+      link_object("Array").should == "Array"
+      link_object(:"A::B").should == "A::B"
+    end
+    
+    it "should return the argument if not an object, proxy, String or Symbol" do
+      link_object(1).should == 1
+    end
+  end
+  
+  describe '#link_url' do
+    it "should return the URL" do
+      link_url("http://url").should == "http://url"
+    end
+  end
+  
+  describe '#format_types' do
+    it "should return the list of types separated by commas surrounded by brackets" do
+      format_types(['a', 'b', 'c']).should == '(a, b, c)'
+    end
+    
+    it "should return the list of types without brackets if brackets=false" do
+      format_types(['a', 'b', 'c'], false).should == 'a, b, c'
+    end
+    
+    it "should should return an empty string if list is empty or nil" do
+      format_types(nil).should == ""
+      format_types([]).should == ""
+    end
+  end
+  
+  describe '#format_object_type' do
+    it "should return Exception if type is Exception" do
+      obj = mock(:object)
+      obj.stub!(:class).and_return(YARD::CodeObjects::ClassObject)
+      obj.stub!(:is_exception?).and_return(true)
+      format_object_type(obj).should == "Exception"
+    end
+    
+    it "should return Class if type is Class" do
+      obj = mock(:object)
+      obj.stub!(:class).and_return(YARD::CodeObjects::ClassObject)
+      obj.stub!(:is_exception?).and_return(false)
+      format_object_type(obj).should == "Class"
+    end
+    
+    it "should return object type in other cases" do
+      obj = mock(:object)
+      obj.stub!(:type).and_return("value")
+      format_object_type(obj).should == "Value"
+    end
+  end
+  
+  describe '#format_object_title' do
+    it "should return Top Level Namespace for root object" do
+      format_object_title(Registry.root).should == "Top Level Namespace"
+    end
+    
+    it "should return 'type: path' in other cases" do
+      obj = mock(:object)
+      obj.stub!(:type).and_return(:class)
+      obj.stub!(:path).and_return("A::B::C")
+      format_object_title(obj).should == "Class: A::B::C"
+    end
+  end
+
+  describe "#linkify" do
+    it "should pass off to #link_object if argument is an object" do
+      obj = CodeObjects::NamespaceObject.new(nil, :YARD)
+      should_receive(:link_object).with(obj)
+      linkify obj
+    end
+  
+    it "should pass off to #link_url if argument is recognized as a URL" do
+      url = "http://yardoc.org/"
+      should_receive(:link_url).with(url)
+      linkify url
+    end
+  end
+end